mybatis-spring
将mybatis整合到spring下集成开发,
1, 首先导入相关依赖:
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>2.0.6</version>
</dependency></pre>
要注意mybatis和mysql-connection的版本要对应,相关情况请见mybatis-spring的官网: https://mybatis.org/mybatis-3/zh/getting-started.html
2,创建spring-dao.xml配置文件(文件名不固定)
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd">
<!-- dataSource使用spring的数据源代替mybatis的配置,这里使用spring提供的JDBC:org.springframework.jdbc.datasource-->
<bean id="dataDource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="123"/>
</bean>
<!-- sqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataDource"/>
<!-- 配置mybatis配置文件-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<property name="mapperLocations" value="classpath:com/yang/mapper/*.xml"/>
</bean>
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
<!-- 因为该类下没有setter方法,不能使用注入插入参数,所以只能使用构造器方法-->
<constructor-arg index="0" ref="sqlSessionFactory"/>
</bean>
<bean id="UserMapper" class="com.yang.mapper.UserMapperImpl">
<property name="sqlSession" ref="sqlSession"/>
</bean>
</beans>
下面分步骤讲述
<!-- dataSource使用spring的数据源代替mybatis的配置,这里使用spring提供的JDBC:org.springframework.jdbc.datasource-->
<bean id="dataDource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="123"/>
</bean></pre>
获取mysql数据库参数,这一步其实就把mybatis配置文件中的environment的部分代替了,有了数据库环境参数(DataSource)之后,接下来构造sqlSessionFactory
<!-- sqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataDource"/>
<!-- 配置mybatis配置文件-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<property name="mapperLocations" value="classpath:com/yang/mapper/*.xml"/>
</bean>
除了dataSource这个参数之外,mybatis-sping中的sqlSessionFactory还提供了很多其他参数,完全可以将mybatis中的核心配置文件的内容全部替换。 其中configLocation指定mybatis的核心配置文件,mapperLocations指定映射文件,当然,mybatis核心配置文件中的所有配置项均可在此替换,比如别名等。 下面构造sqlSession,需要用到sqlSession的模板进行创建。
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
<!-- 因为该类下没有setter方法,不能使用注入插入参数,所以只能使用构造器方法-->
<constructor-arg index="0" ref="sqlSessionFactory"/>
</bean>
这个没什么好说的,值得注意的是,该模板类没有定义setter方法,所以不能使用setter注入的形式传参,只能只用构造器传参。 到此为止,sqlSession便可以直接引用bean创建了,这里和mybatis不一样的地方是,我们还需要创建接口的实现类,在实现类中引用sqlsession执行数据库操作, 我们在测试中只需要直接调用bean方法就好了。这样做的目的其实是为了遵循MVC的架构,这里封装的xml可以认为是DAO层,在service层中我们不希望在看到sqlsession的创建步骤。 下面创建接口与实现类: 接口UserMapper:
package com.yang.mapper;
import com.yang.pojo.User;
import java.util.List;
public interface UserMapper {
public List<User> selectUser();
}
实现类UserMapperImpl:
package com.yang.mapper;
import com.yang.pojo.User;
import org.apache.ibatis.session.SqlSession;
import java.util.List;
public class UserMapperImpl implements UserMapper {
private SqlSession sqlSession;
public void setSqlSession(SqlSession sqlSession) {
this.sqlSession = sqlSession;
}
public List<User> selectUser(){
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
return userMapper.selectUser();
}
}
在实现类中我们看到我们其实还是使用的mybatis的映射实现数据库操作(这是根本啊),所以给出映射配置: Mapper.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.yang.mapper.UserMapper">
<select id="selectUser" resultType="user">
select * from user;
</select>
</mapper>
下面进行测试:
@Test
public void p() throws IOException {
ApplicationContext context = new ClassPathXmlApplicationContext("spring-dao.xml");
UserMapper mapper = (UserMapper) context.getBean("UserMapper");
List<User> userList = mapper.selectUser();
for (User user : userList) {
System.out.println(user);
}
}
}
上面的原理讲清了,为了符合MVC三层架构,我们可以在设计一个核心配置文件,将spring-dao.xml作为DAO层引入, Application.xml:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/aop https://www.springframework.org/schema/aop/spring-aop.xsd">
<import resource="spring-dao.xml"/>
<bean id="UserMapper" class="com.yang.mapper.UserMapperImpl">
<property name="sqlSession" ref="sqlSession"/>
</bean>
</beans>
另一种获取sqlsession的方式
在上面的方式中,我们使用SqlSessionTemplate获取sqlsession,具体方式为在在bean中调用SqlSessionTemplate的构造函数去获取。除此之外还有一种更为简单的获取方式,那就是使用 SqlSessionDaoSupport中的getSqlSession可以直接获取sqlsession,我们来测试一下,老规矩首先构造UserMapperde 实现类 UserMapperImpl2:
public class UserMapperImpl2 extends SqlSessionDaoSupport implements UserMapper {
@Override
public List<User> selectUser() {
SqlSession sqlSession = getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
return mapper.selectUser();
}
}
该类继承SqlSessionDaoSupport,可以调用getsqlsession,上面的代码是为了方便理解,为了简化代码我们可以将上面的类简化为:
public class UserMapperImpl2 extends SqlSessionDaoSupport implements UserMapper {
@Override
public List<User> selectUser() {
return getSqlSession().getMapper(UserMapper.class).selectUser();
}
}
然后在spring-dao.xml文件中加入该实现类的bean,加入下面的语句
<bean id="UserMapper2" class="com.yang.mapper.UserMapperImpl2">
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
下面进行测试,测试代码如下:
ApplicationContext context = new ClassPathXmlApplicationContext("spring-dao.xml");
UserMapper mapper = (UserMapper) context.getBean("UserMapper2");
List<User> userList = mapper.selectUser();
for (User user : userList) {
System.out.println(user);
}
测试结果:
事务回顾
下面我测试一下在mybatis-spring中加入不做任何配置的话,事务是否能保持一致性,或者说当某一条事务执行出错时,是否能做到将其他事务进行回滚,是数据库状态回退到没有执行任何事务的状态。 我们在UserMapper中就加入一个用户增加和删除操作,
public interface UserMapper {
public List<User> selectUser();
//添加一个用户
public int add(User user);
//删除用户
public int delete(int id);
}
mybatis映射文件做相应的操作: mapper.xml:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.yang.mapper.UserMapper">
<select id="selectUser" resultType="user">
select * from user;
</select>
<insert id="add" parameterType="User">
insert into mybatis.user(id,name,pwd) values(#{id},#{name},#{pwd});
</insert>
<delete id="delete" >
<!--故意写错-->
deletes from mybatis.user where id=#{id};
</delete>
</mapper>
delete的映射故意写错,看是否能回退 接口的实现类:
public class UserMapperImpl2 extends SqlSessionDaoSupport implements UserMapper {
@Override
public List<User> selectUser() {
return getSqlSession().getMapper(UserMapper.class).selectUser();
}
@Override
public int add(User user) {
return getSqlSession().getMapper(UserMapper.class).add(user);
}
@Override
public int delete(int id) {
return getSqlSession().getMapper(UserMapper.class).delete(id);
}
public void testsql(){
SqlSession sqlSession = getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.add(new User(10,"小王","123123"));
mapper.delete(10);
}
}
下面我们去执行testsql方法,看是否用户被写入,被成功写入说明没有回退。 测试后发现,程序虽然报错,但是用户依然成功写入,说明没有回滚。 spring中的事务管理
spring中提供了事务管理的类: 可以有两种事务管理的方式:
声明型事务管理
编程型事务管理
声明型事务管理是用AOP的方式进行事务管理,编程型事务管理就是将事务管理的代码显示的写入到程序当中,最常见的操作就是使用try catch进行事务管理 下面我们对声明型事务管理进行测试。 首先在spring-dao.xml中引入事务管理的类,传入数据源
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataDource"/>
</bean>
然后配置事务通知
<!-- 结合AOP实现事务的植入-->
<!-- 配置事务通知-->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
<!-- 给那些方法配置事务-->
<!-- propagation配置事务的传播特性,默认为REQUIRED,了解即可-->
<tx:attributes>
<tx:method name="add" propagation="REQUIRED"/>
<tx:method name="delete" propagation="REQUIRED"/>
<tx:method name="update" propagation="REQUIRED"/>
<tx:method name="qurey" read-only="true"/>
<tx:method name="selectUser" propagation="REQUIRED"/>
<!-- *表示所有方法-->
<tx:method name="*" propagation="REQUIRED"/>
</tx:attributes>
</tx:advice>
这里需要注意要引入tx的正确导入文件,在本小节最后贵给出完整的配置文件以供参考 最后配置AOP
<!-- 配置事务切入,AOP内容了-->
<aop:config>
<aop:pointcut id="txPointCut" expression="execution(* com.yang.mapper.*.*(..))"/>
<aop:advisor advice-ref="txAdvice" pointcut-ref="txPointCut"/>
</aop:config>
测试因为引入了AOP只能创建接口类的对象,所以我将add与delete方法全写入selectUser中进行测试:
public List<User> selectUser() {
SqlSession sqlSession = getSqlSession();
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
mapper.add(new User(10,"小王","123123"));
mapper.delete(10);
return getSqlSession().getMapper(UserMapper.class).selectUser();
}
发现并没有写入新用户,测试成功
完整的配置文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
https://www.springframework.org/schema/aop/spring-aop.xsd
http://www.springframework.org/schema/tx
http://www.springframework.org/schema/tx/spring-tx.xsd">
<!-- dataSource使用spring的数据源代替mybatis的配置,这里使用spring提供的JDBC:org.springframework.jdbc.datasource-->
<bean id="dataDource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="driverClassName" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=utf-8"/>
<property name="username" value="root"/>
<property name="password" value="123"/>
</bean>
<!-- sqlSessionFactory-->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataDource"/>
<!-- 配置mybatis配置文件-->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<property name="mapperLocations" value="classpath:com/yang/mapper/*.xml"/>
</bean>
<!--<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">-->
<!--<!– 因为该类下没有setter方法,不能使用注入插入参数,所以只能使用构造器方法–>-->
<!-- <constructor-arg index="0" ref="sqlSessionFactory"/>-->
<!--</bean>-->
<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
<constructor-arg index="0" ref="sqlSessionFactory" />
</bean>
<bean id="UserMapper" class="com.yang.mapper.UserMapperImpl">
<property name="sqlSession" ref="sqlSession"/>
</bean>
<bean id="UserMapper2" class="com.yang.mapper.UserMapperImpl2">
<property name="sqlSessionFactory" ref="sqlSessionFactory"/>
</bean>
<!-- 配置声明式事务管理-->
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataDource"/>
</bean>
<!-- 结合AOP实现事务的植入-->
<!-- 配置事务通知-->
<tx:advice id="txAdvice" transaction-manager="transactionManager">
<!-- 给那些方法配置事务-->
<!-- propagation配置事务的传播特性,默认为REQUIRED,了解即可-->
<tx:attributes>
<tx:method name="add" propagation="REQUIRED"/>
<tx:method name="delete" propagation="REQUIRED"/>
<tx:method name="update" propagation="REQUIRED"/>
<tx:method name="qurey" read-only="true"/>
<!-- *表示所有方法-->
<tx:method name="*" propagation="REQUIRED"/>
</tx:attributes>
</tx:advice>
<!-- 配置事务切入,AOP内容了-->
<aop:config>
<aop:pointcut id="txPointCut" expression="execution(* com.yang.mapper.*.*(..))"/>
<aop:advisor advice-ref="txAdvice" pointcut-ref="txPointCut"/>
</aop:config>
</beans>