spring-mybatis 之SqlSessionFactoryBean

本是古典何须时尚 2021-09-14 02:10 255阅读 0赞

[http://blog.csdn.net/liuxiao723846/article/details/52424802][http_blog.csdn.net_liuxiao723846_article_details_52424802]

在 MyBatis 中，使用 SqlSessionFactoryBuilder创建SqlSessionFactory ，进而来创建 SqlSession。一旦你获得一个 session 之后,你可以使用它来执行映射语句,提交或回滚连接,最后,当不再需要它的时候, 你可以关闭 session。

Mybatis社区自己开发了一个Mybatis-[spring][]用来满足Mybatis用户整合Spring的需求。

使用 MyBatis-Spring 之后, 会使用SqlSessionFactoryBean来代替SqlSessionFactoryBuilder创建SqlSessionFactory，然后可以使用下面两种方式使用sqlSession。

1、SqlSessionTemplate：

Mybatis-Spring提供了一种直接使用SqlSession的方式（一个实现了SqlSession接口的SqlSessionTemplate实现类）

1.  它是线程安全的，可以被多个Dao同时使用；
2.  它跟Spring的事务进行了关联，确保当前被使用的SqlSession是一个已经和Spring的事务进行绑定了的，而且它还可以自己管理Session的提交和关闭。

1）spring.xml

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****context:annotation-config****/>**  
2.         
3.      **<**context:component-scanbase-package**context:component-scanbase-package**="cn.edu.nuc" **/>**   
4.         
5.      **<**context:property-placeholderlocation**context:property-placeholderlocation**="classpath:jdbc.properties" **/>**   
6.         
7.         
8.      **<****bean** id="dataSource"class="com.mchange.v2.c3p0.ComboPooledDataSource"**>**   
9.          **<**propertyname**propertyname**="driverClass" value="$\{jdbc.driverClassName\}"**/>**   
10.         **<****property** name="jdbcUrl"value="$\{jdbc.url\}" **/>**   
11.         **<****property** name="user"value="$\{jdbc.username\}" **/>**   
12.         **<****property** name="password"value="$\{jdbc.password\}" **/>**   
13.     **</****bean****>**  
14.      
15.       
16.     **<****bean** id="sqlSessionFactory"class="org.mybatis.spring.SqlSessionFactoryBean"**>**   
17.         **<****propertyname**propertyname="dataSource" ref="dataSource" **/>**   
18.         **<****propertyname**propertyname="configLocation"value="classpath:mybatis/configuration.xml"**/>**  
19.         **<****propertyname**propertyname="mapperLocations"value="classpath\*:cn/edu/nuc/map/\*.xml"**/>**  
20.     **</****bean****>**  
21.      
22.     **<****bean** id="sqlSession"class="org.mybatis.spring.SqlSessionTemplate"**>**  
23.       **<****constructor-arg** index="0"ref="sqlSessionFactory" **/>**  
24.          **</****bean****>**

mybatis配置文件：

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<?**xmlversion**xmlversion**="1.0" encoding="UTF-8" **?>**      
2.  <!DOCTYPEconfiguration      
3.      PUBLIC "-//mybatis.org//DTD Config3.0//EN"      
4.      "http://mybatis.org/dtd/mybatis-3-config.dtd"**>**  
5.  **<****configuration****>**  
6.  **<****settings****>**  
7.    
8.  **<****settingname**settingname="cacheEnabled" value="false" **/>**  
9.  **<****settingname**settingname="useGeneratedKeys" value="true" **/>**  
10. **<****settingname**settingname="defaultExecutorType" value="REUSE" **/>**  
11. **<****settingname**settingname="lazyLoadingEnabled" value="false" **/>**  
12. **<****settingname**settingname="logImpl" value="LOG4J" **/>**  
13. **</****settings****>**  
14. **<****mappers****>**  
15.    
16.          **</****mappers****>**  
17. **</****configuration****>**

2）dao层实现：

**\[html\]**  [view plain][]   [copy][view plain]

1.  packagecn.edu.nuc.dao;  
2.  importorg.apache.ibatis.session.SqlSession;  
3.  importorg.springframework.beans.factory.annotation.Autowired;  
4.  importorg.springframework.stereotype.Component;  
5.  importcn.edu.nuc.bean.User;  
6.     
7.  @Component  
8.  public classUserDaoImpl implements UserDao \{  
9.  @Autowired  
10. private SqlSession sqlSession;  
11.    
12. publicvoid insertUsers(User user) \{  
13. sqlSession.insert("cn.edu.nuc.map.UserMapper1.insertUser",user);  
14. \}  
15. \}

3）mapper文件：

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<?****xmlversion**xmlversion="1.0" encoding="UTF-8" **?>**  
2.  <!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"**>**  
3.  **<**mappernamespace**mappernamespace**="cn.edu.nuc.map.UserMapper1"**>**  
4.           
5.       **<****insert** id="insertUser"parameterType="cn.edu.nuc.bean.User"**>**  
6.              insert into user (name)values (\#\{name\});  
7.       **</****insert****>**  
8.  **</****mapper****>**

4）[测试][Link 1]：

**\[html\]**  [view plain][]   [copy][view plain]

1.  @RunWith(SpringJUnit4ClassRunner.class)  
2.  @ContextConfiguration(\{"classpath:spring-sqlSessionTemplate.xml"\})  
3.  public classUserServiceSqlSesionTemplateTest \{  
4.             @Autowired  
5.        private UserDao userDao;   
6.     
7.  @Test  
8.  publicvoid testFindUserById() throws Exception \{  
9.  Useruser = new User();  
10. user.setName("lanxiaoli");  
11. userDao.insertUsers(user);  
12. \}  
13. \}

补充：在dao层sqlSession.insert("cn.edu.nuc.map.UserMapper1.insertUser",user);第一个参数前半部分是mapper文件的namespace，最后一个是sql的id；这两部分都是随意写的。

2、SqlSessionDaoSupport：

SqlSessionDaoSupport 是一个抽象的支持类, 用来为你提供 SqlSession。调用 getSqlSession()方法你会得到一个SqlSessionTemplate,之后可以用于执行 SQL 方法。

SqlSessionDaoSupport 需要一个 sqlSessionFactory 或sqlSessionTemplate 属性来设置 。 这 些要被 被 明 确地 设 置 或 者由 Spring 来 自 动 装 配 。 如 果 两 者 都 被 设 置 了 , 那 么 SqlSessionFactory 是被忽略的。（其实可以使用下面的MapperScannerConfigurer来自动装配）

1）spring.xml

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****context:annotation-config****/>**  
2.     
3.         
4.      **<****context:component-scanbase-package**context:component-scanbase-package="cn.edu.nuc" **/>**   
5.         
6.      **<**context:property-placeholderlocation**context:property-placeholderlocation**="classpath:jdbc.properties" **/>**   
7.         
8.         
9.      **<****bean** id="dataSource"class="com.mchange.v2.c3p0.ComboPooledDataSource"**>**   
10.         **<**propertyname**propertyname**="driverClass" value="$\{jdbc.driverClassName\}"**/>**   
11.         **<****property** name="jdbcUrl"value="$\{jdbc.url\}" **/>**   
12.         **<****property** name="user"value="$\{jdbc.username\}" **/>**   
13.         **<****property** name="password"value="$\{jdbc.password\}" **/>**   
14.     **</****bean****>**  
15.      
16.       
17.     **<****bean** id="sqlSessionFactory"class="org.mybatis.spring.SqlSessionFactoryBean"**>**   
18.         **<****propertyname**propertyname="dataSource" ref="dataSource" **/>**   
19.         **<****propertyname**propertyname="configLocation"value="classpath:mybatis/configuration.xml"**/>**  
20.         **<**propertyname**propertyname**="mapperLocations"value="classpath\*:cn/edu/nuc/map/\*.xml"**/>**  
21.     **</****bean****>**  
22.       
23.     **<****bean** id="sqlSession"class="org.mybatis.spring.SqlSessionTemplate"**>**  
24.       **<****constructor-arg** index="0"ref="sqlSessionFactory" **/>**  
25. **</****bean****>**  
26.      
27.     **<****bean** id="userDao"class="cn.edu.nuc.dao.UserDaoImpl1"**>**   
28.       
29.    **<****propertyname**propertyname="sqlSessionTemplate" ref="sqlSession" **/>**    
30.      
31.       
32. **</****bean****>**

2）dao层实现类：

**\[html\]**  [view plain][]   [copy][view plain]

1.  packagecn.edu.nuc.dao;  
2.  importorg.mybatis.spring.support.SqlSessionDaoSupport;  
3.  importcn.edu.nuc.bean.User;  
4.     
5.  public classUserDaoImpl1 extends SqlSessionDaoSupport implements UserDao \{  
6.  publicvoid insertUsers(User user) \{  
7.  getSqlSession().update("cn.edu.nuc.map.UserMapper1.updateUser",user);  
8.  \}  
9.  \}

3）mapper文件：

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<?**xmlversion**xmlversion**="1.0" encoding="UTF-8" **?>**  
2.  <!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd"**>**  
3.  **<**mappernamespace**mappernamespace**="cn.edu.nuc.map.UserMapper1"**>**  
4.           
5.  **<**updateid**updateid**="updateUser" parameterType="cn.edu.nuc.bean.User"**>**  
6.              update user setname=\#\{name\} where id=\#\{id\}  
7.       **</****update****>**  
8.  **</****mapper****>**

4）测试：

**\[html\]**  [view plain][]   [copy][view plain]

1.  @RunWith(SpringJUnit4ClassRunner.class)  
2.  @ContextConfiguration(\{"classpath:spring-sqlSessiondaosupport.xml"\})  
3.  public classUserServiceSqlSessionDaoSupportTest \{  
4.  @Autowired  
5.        private UserDaouserDao;  
6.     
7.  @Test  
8.  publicvoid testFindUserById() throws Exception \{  
9.  Useruser = new User();  
10. user.setId(2L);  
11. user.setName("12323");  
12. userDao.insertUsers(user);  
13. \}  
14. \}

分析：

上面做法没问题，但就是在spring.xml中需要配置所有的dao层实现，把sqlSession或者sqlSessionFactory注入进去。下面，可以使用MapperScannerConfigurer来解决这个问题。（通常使用这种方法作为dao层基础[架构][Link 2]）

1）spring.xml配置文件：

**\[html\]**  [view plain][]   [copy][view plain]

1.  **<****context:annotation-config****/>**  
2.     
3.         
4.      **<****context:component-scanbase-package**context:component-scanbase-package="cn.edu.nuc" **/>**   
5.         
6.      **<**context:property-placeholderlocation**context:property-placeholderlocation**="classpath:jdbc.properties" **/>**   
7.         
8.         
9.      **<****bean** id="dataSource"class="com.mchange.v2.c3p0.ComboPooledDataSource"**>**   
10.         **<****propertyname**propertyname="driverClass" value="$\{jdbc.driverClassName\}"**/>**   
11.         **<****property** name="jdbcUrl"value="$\{jdbc.url\}" **/>**   
12.         **<****property** name="user"value="$\{jdbc.username\}" **/>**   
13.         **<****property** name="password"value="$\{jdbc.password\}" **/>**   
14.         **<****propertyname**propertyname="maxPoolSize" value="$\{c3p0.pool.size.max\}" **/>**   
15.         **<****propertyname**propertyname="minPoolSize" value="$\{c3p0.pool.size.min\}" **/>**   
16.         **<****propertyname**propertyname="initialPoolSize" value="$\{c3p0.pool.size.ini\}"**/>**   
17.         **<**propertyname**propertyname**="acquireIncrement" value="$\{c3p0.pool.size.increment\}"**/>**   
18.     **</****bean****>**  
19.      
20.       
21.     **<****bean** id="sqlSessionFactory"class="org.mybatis.spring.SqlSessionFactoryBean"**>**   
22.         **<****propertyname**propertyname="dataSource" ref="dataSource" **/>**   
23.         **<**propertyname**propertyname**="configLocation"value="classpath:mybatis/configuration.xml"**/>**  
24.         **<****propertyname**propertyname="mapperLocations"value="classpath\*:cn/edu/nuc/map/\*.xml"**/>**  
25.     **</****bean****>**  
26. **<**beanclass**beanclass**="org.mybatis.spring.mapper.MapperScannerConfigurer"**>**  
27.         <!-- 可以不用指定，因为MapperScannerConfigurer会自动装配  
28.                   **<**propertyname**propertyname**="sqlSessionFactoryBeanName"value="sqlSessionFactory"**/>**\--**>**  
29.         **<**propertyname**propertyname**="basePackage" value="cn.edu.nuc.dao" **/>**  
30.     **</****bean****>**

2）dao层实现类：

**\[html\]**  [view plain][]   [copy][view plain]

1.  packagecn.edu.nuc.dao;  
2.  importjavax.annotation.Resource;  
3.  importorg.apache.ibatis.session.SqlSessionFactory;  
4.  importorg.mybatis.spring.support.SqlSessionDaoSupport;  
5.  importorg.springframework.stereotype.Component;  
6.  importcn.edu.nuc.bean.User;  
7.     
8.  @Component  
9.  public classUserDaoImpl1 extends SqlSessionDaoSupport implements UserDao \{  
10. @Resource(name="sqlSessionFactory")  
11. public void setSqlSessionFactory(SqlSessionFactorysqlSessionFactory) \{  
12. super.setSqlSessionFactory(sqlSessionFactory);  
13. \}  
14. publicvoid insertUsers(User user) \{  
15. getSqlSession().update("cn.edu.nuc.map.UserMapper1.updateUser",user);  
16. \}  
17. \}

3）测试类：

**\[html\]**  [view plain][]   [copy][view plain]

1.  @RunWith(SpringJUnit4ClassRunner.class)  
2.  @ContextConfiguration(\{"classpath:spring-sqlSessiondaosupport.xml"\})  
3.  public classUserServiceSqlSessionDaoSupportTest \{  
4.  @Autowired  
5.      private UserDao userDaoImpl1;   
6.     
7.  @Test  
8.  publicvoid testFindUserById() throws Exception \{  
9.  Useruser = new User();  
10. user.setId(2L);  
11. user.setName("4321");  
12. userDaoImpl1.insertUsers(user);  
13. \}  
14. \}

注：在dao层的实现里，必须指定public void setSqlSessionFactory(SqlSessionFactorysqlSessionFactory)；一般的做法是写一个baseDao，然后把所有常见的CRUD方法实现，每个业务模块的dao去继承该baseDao

MapperScannerConfigurer具有下面两个重要特性：

1）不需要指定SqlSessionFactory 或SqlSessionTemplate,MapperScannerConfigurer 将会创建 MapperFactoryBean,之后自动装配；

2）MapperScannerConfigurer 其实和MapperFactoryBean类似，都是创建代理然后注入到spring中；区别是前者是自动扫描数据映射器接口，生成代理类、并注入到Spring的容器中；

我们这里不需要用MapperScannerConfigurer来创建MapperFactoryBean，以及生成代理类注入到spring中（后面的使用中会用到），我们需要：

1）需要MapperScannerConfigurer帮我们自动装配SqlSessionFactory 或 SqlSessionTemplate（因为SqlSessionDaoSupport 需要一个 sqlSessionFactory 或 sqlSessionTemplate属性来设置）；

2）我们需要自己显示的在dao层加上@Component注解（否则依赖的时候会拿到注入到spring中的MapperScannerConfigurer生成的代理类）

3）dao层我们继承了SqlSessionDaoSupport，所以可以直接使用getSqlSession() 方法获取sqlSessionTemplate，然后操作数据映射文件（mapper文件）里的sql了；

[http_blog.csdn.net_liuxiao723846_article_details_52424802]: http://blog.csdn.net/liuxiao723846/article/details/52424802
[spring]: http://lib.csdn.net/base/javaee
[view plain]: http://blog.csdn.net/liuxiao723846/article/details/52424802#
[Link 1]: http://lib.csdn.net/base/softwaretest
[Link 2]: http://lib.csdn.net/base/architecture