基于注解的mybatis和spring整合

Bertha 。 2022-04-23 10:36 269阅读 0赞

### [基于注解的mybatis和spring整合][mybatis_spring] ###

*  **博客分类：**
 *  [mybatis][]
 *  [spring][]
 *  [java][]
 *  [ibatis][]
 *  [注解][Link 1]

[java][java 1] [ibatis][ibatis 1] [mybatis][mybatis 1] [spring][spring 1] [注解][Link 2]

ibatis改名为mybatis已经将近一年了，mybatis3也发布了，但是相关的开发文档却很少，查阅了官方的使用指南，也是说的模糊不清，一笔 带过，尤其是注解部分，只是列举了注解种类，却没有对应的例子，因此可能会给某些兄弟使用mybatis注解带来困惑，我想就我微薄的知识想对 mybatis注解的使用以及和spring整合谈谈自己的看法，也希望大家猛烈的指正我的错误。  
  
首先当然得下载mybatis-3.0.5.jar和mybatis-spring-1.0.1.jar两个JAR包，并放在WEB-INF的 lib目录下(如果你使用maven，则jar会根据你的pom配置的依赖自动下载，并存放在你指定的maven本地库中，默认是~/.m2 /repository)，前一个是mybatis核心包，后一个是和spring整合的包。  
  
使用mybatis，必须有个全局配置文件configuration.xml，来配置mybatis的缓存，延迟加载等等一系列属性，该配置文件示例如下：

Java代码 ![收藏代码][icon_star.png]

1.  <?xml version="1.0" encoding="UTF-8" ?>
2.  <!DOCTYPE configuration
3.  PUBLIC "-//ibatis.apache.org//DTD Config 3.0//EN"
4.  "http://ibatis.apache.org/dtd/ibatis-3-config.dtd">
5.  <configuration>
6.  <settings>
7.  
8.  <setting name="cacheEnabled" value="true" />
9.  
10. <setting name="lazyLoadingEnabled" value="true" />
11. 
12. <setting name="aggressiveLazyLoading" value="false" />
13. 
14. <setting name="multipleResultSetsEnabled" value="true" />
15. 
16. <setting name="useColumnLabel" value="true" />
17. 
18. <setting name="useGeneratedKeys" value="true" />
19. 
20. <setting name="autoMappingBehavior" value="FULL" />
21. 
22. <setting name="defaultExecutorType" value="BATCH" />
23. 
24. <setting name="defaultStatementTimeout" value="25000" />
25. </settings>
26. 
27. <typeAliases>
28. <typeAlias alias="TestBean"
29. type="com.wotao.taotao.persist.test.dataobject.TestBean" />
30. </typeAliases>
31. 
32. <mappers>
33. <mapper resource="persist/test/orm/test.xml" />
34. </mappers>
35. </configuration>

该文件放在资源文件的任意classpath目录下，假设这里就直接放在资源根目录，等会spring需要引用该文件。  
  
查看ibatis-3-config.dtd发现除了settings和typeAliases还有其他众多元素，比如 properties,objectFactory,environments等等，这些元素基本上都包含着一些环境配置，数据源定义，数据库事务等等， 在单独使用mybatis的时候非常重要，比如通过以构造参数的形式去实例化一个sqlsessionFactory，就像这样：

Java代码 ![收藏代码][icon_star.png]

1.  SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader);
2.  SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, properties);
3.  SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment, properties);

而typeHandlers则用来自定义映射规则，如你可以自定义将Character映射为varchar，plugins元素则放了一些拦截器接口，你可以继承他们并做一些切面的事情，至于每个元素的细节和使用，你参考mybatis用户指南即可。  
  
现在我们用的是spring，因此除settings和typeAliases元素之外，其他元素将会失效，故不在此配置，spring会覆盖这些元素的配置，比如在spring配置文件中指定c3p0数据源定义如下：

Java代码 ![收藏代码][icon_star.png]

1.  
2.  <bean id="testDataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"
3.  destroy-method="close">
4.  
5.  <property name="driverClass" value="$\{db.driver.class\}" />
6.  
7.  <property name="jdbcUrl" value="$\{db.url\}" />
8.  
9.  <property name="user" value="$\{db.username\}" />
10. 
11. <property name="password" value="$\{db.password\}" />
12. 
13. <property name="initialPoolSize" value="5" />
14. 
15. <property name="minPoolSize" value="5" />
16. 
17. <property name="maxPoolSize" value="20" />
18. 
19. <property name="maxStatements" value="100" />
20. 
21. <property name="maxIdleTime" value="3600" />
22. 
23. <property name="acquireIncrement" value="2" />
24. 
25. <property name="acquireRetryAttempts" value="10" />
26. 
27. <property name="acquireRetryDelay" value="600" />
28. 
29. <property name="testConnectionOnCheckin" value="true" />
30. 
31. <property name="idleConnectionTestPeriod" value="1200" />
32. 
33. <property name="checkoutTimeout" value="10000" />
34. </bean>

配置中的$\{\}都是占位符，在你指定数据库驱动打war时会自动替换，替换的值在你的父pom中配置，至于c3p0连接池的各种属性详细信息和用 法，你自行参考c3p0的官方文档，这里要说明的是checkoutTimeout元素，记得千万要设大一点，单位是毫秒，假如设置太小，有可能会导致没 等数据库响应就直接超时了，小弟在这里吃了不少苦头，还是基本功太差。  
  
数据源配置妥当之后，我们就要开始非常重要的sessionFactory配置了，无论是hibernate还是mybatis，都需要一个sessionFactory来生成session，sessionFactory配置如下：

Java代码 ![收藏代码][icon_star.png]

1.  <bean id="testSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
2.  <property name="configLocation" value="classpath:configuration.xml" />
3.  <property name="dataSource" ref="testDataSource" />
4.  </bean>

testSqlSessionFactory有两处注入，一个就是前面提到的mybatis全局设置文件configuration.xml，另 一个就是上面定义的数据源了（注：hibernate的sessionFactory只需注入hibernate.cfg.xml，数据源定义已经包含在 该文件中），好了，sessionFactory已经产生了，由于我们用的mybatis3的注解，因此spring的 sqlSessionTemplate也不用配置了，sqlSessionTemplate也不用注入到我们的BaseDAO中了，相应的，我们需要配置 一个映射器接口来对应sqlSessionTemplate，该映射器接口定义了你自己的接口方法，具体实现不用关心，代码如下：

Java代码 ![收藏代码][icon_star.png]

1.  
2.  <bean id="testMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
3.  <property name="sqlSessionFactory" ref="testSqlSessionFactory" />
4.  <property name="mapperInterface" value="com.wotao.taotao.persist.test.mapper.TestMapper" />
5.  </bean>

对应于sqlSessionTemplate，testMapper同样需要testSqlSessionFactory注入，另外一个注入就是 你自己定义的Mapper接口，该接口定义了操作数据库的方法和SQL语句以及很多的注解，稍后我会讲到。到此，mybatis和spring整合的文件 配置就算OK了（注：如果你需要开通spring对普通类的代理功能，那么你需要在spring配置文件中加入<aop:aspectj- autoproxy />），至于其他的如事务配置，AOP切面注解等内容不在本文范围内，不作累述。  
  
至此，一个完整的myabtis整合spring的配置文件看起来应该如下所示：

Java代码 ![收藏代码][icon_star.png]

1.  <?xml version="1.0" encoding="UTF-8"?>
2.  <beans xmlns="http://www.springframework.org/schema/beans"
3.  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
4.  xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
5.  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd 
6.  http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd 
7.  http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd 
8.  http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd">
9.  
10. 
11. <bean id="testDataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"
12. destroy-method="close">
13. <property name="driverClass" value="$\{db.driver.class\}" />
14. <property name="jdbcUrl" value="$\{db.url\}" />
15. <property name="user" value="$\{db.username\}" />
16. <property name="password" value="$\{db.password\}" />
17. <property name="initialPoolSize" value="5" />
18. <property name="minPoolSize" value="5" />
19. <property name="maxPoolSize" value="20" />
20. <property name="maxStatements" value="100" />
21. <property name="maxIdleTime" value="3600" />
22. <property name="acquireIncrement" value="2" />
23. <property name="acquireRetryAttempts" value="10" />
24. <property name="acquireRetryDelay" value="600" />
25. <property name="testConnectionOnCheckin" value="true" />
26. <property name="idleConnectionTestPeriod" value="1200" />
27. <property name="checkoutTimeout" value="10000" />
28. </bean>
29. <bean id="testSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
30. <property name="configLocation" value="classpath:configuration.xml" />
31. <property name="dataSource" ref="testDataSource" />
32. </bean>
33. 
34. <bean id="testMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
35. <property name="sqlSessionFactory" ref="testSqlSessionFactory" />
36. <property name="mapperInterface" value="com.wotao.taotao.persist.test.mapper.TestMapper" />
37. </bean>
38. 
39. 
40. 
41. 
42. 
43. 
44. 
45. 
46. 
47. 
48. 
49.

[mybatis_spring]: http://huangmin001.iteye.com/blog/1185806
[mybatis]: http://huangmin001.iteye.com/category/180919
[spring]: http://huangmin001.iteye.com/category/180918
[java]: http://huangmin001.iteye.com/category/180915
[ibatis]: http://huangmin001.iteye.com/category/181037
[Link 1]: http://huangmin001.iteye.com/category/181038
[java 1]: http://www.iteye.com/blogs/tag/java
[ibatis 1]: http://www.iteye.com/blogs/tag/ibatis
[mybatis 1]: http://www.iteye.com/blogs/tag/mybatis
[spring 1]: http://www.iteye.com/blogs/tag/spring
[Link 2]: http://www.iteye.com/blogs/tag/%E6%B3%A8%E8%A7%A3
[icon_star.png]: /images/20220321/6652c8960e134fb3851929554144d6ea.png