【第八章】對ORM的支持之 8.3 集成iBATIS ——跟我學spring3 · 跟我學 Spring 系列

# 【第八章】對ORM的支持之 8.3 集成iBATIS ——跟我學spring3 8.3? 集成iBATIS iBATIS是一個半自動化的ORM框架，需要通過配置方式指定映射SQL語句，而不是由框架本身生成（如Hibernate自動生成對應SQL來持久化對象），即Hibernate屬于全自動ORM框架。 Spring提供對iBATIS 2.X的集成，提供一致的異常體系、一致的DAO訪問支持、Spring管理事務支持。 **?????? Spring?2.5.5+版本支持iBATIS 2.3+版本，不支持低版本。** ### 8.3.1? 如何集成 Spring通過使用如下Bean進行集成iBATIS： * SqlMapClientFactoryBean：用于集成iBATIS。 configLocation和configLocations：用于指定SQL Map XML配置文件，用于指定如數據源等配置信息； mappingLocations：用于指定SQL Map映射文件，即半自動概念中的SQL語句定義； sqlMapClientProperties：定義iBATIS 配置文件配置信息； dataSource：定義數據源。如果在Spring配置文件中指定了DataSource，就不要在iBATIS配置文件指定了，否則Spring配置文件指定的DataSource將覆蓋iBATIS配置文件中定義的DataSource。接下來示例一下如何集成iBATIS： **1、準備需要的jar包，從spring-framework-3.0.5.RELEASE-dependencies.zip中拷貝如下jar包：** **? **com.springsource.com.ibatis-2.3.4.726.jar **2、?對象模型定義，此處使用第七章中的UserModel；** **3、?**iBATIS**映射定義（chapter8/sqlmaps/UserSQL.xml）：** ``` <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE sqlMap PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN" "http://ibatis.apache.org/dtd/sql-map-2.dtd"> <sqlMap namespace="UserSQL"> <statement id="createTable">  <![CDATA[ create memory table test( id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, name varchar(100)) ]]> </statement> <statement id="dropTable"> <![CDATA[ drop table test ]]> </statement> <insert id="insert" parameterClass="cn.javass.spring.chapter7.UserModel"> <![CDATA[ insert into test(name) values (#myName#) ]]> <selectKey resultClass="int" keyProperty="id" type="post">  call identity();  </selectKey> </insert> </sqlMap> ``` **4、?iBATIS配置文件（chapter8/sql-map-config.xml）定義：** ``` <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE sqlMapConfig PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN" "http://ibatis.apache.org/dtd/sql-map-config-2.dtd"> <sqlMapConfig> <settings enhancementEnabled="true" useStatementNamespaces="true" maxTransactions="20" maxRequests="32" maxSessions="10"/> <sqlMap resource="chapter8/sqlmaps/UserSQL.xml"/> </sqlMapConfig> ``` **5、?數據源定義，此處使用第7章的配置文件，即“chapter7/applicationContext-resources.xml”文件。** **6、?SqlMapClient配置（chapter8/applicationContext-ibatis.xml）定義：** ``` <bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean">  <property name="dataSource" ref="dataSource"/>  <property name="configLocation" value="chapter8/sql-map-config.xml"/> </bean> ``` **7、?獲取SqlMapClient：** ``` package cn.javass.spring.chapter8; //省略import public class IbatisTest { private static SqlMapClient sqlMapClient; @BeforeClass public static void setUpClass() { String[] configLocations = new String[] { "classpath:chapter7/applicationContext-resources.xml", "classpath:chapter8/applicationContext-ibatis.xml"}; ApplicationContext ctx = new ClassPathXmlApplicationContext(configLocations); sqlMapClient = ctx.getBean(SqlMapClient.class); } } ``` 此處我們使用了chapter7/applicationContext-resources.xml定義的“dataSource”數據源，通過ctx.getBean(SqlMapClient.class)獲取SqlMapClient。 **8、?通過SqlMapClient創建和刪除表：** ``` @Before public void setUp() throws SQLException { sqlMapClient.update("UserSQL.createTable"); } @After public void tearDown() throws SQLException { sqlMapClient.update("UserSQL.dropTable"); } ``` **9、?使用SqlMapClient進行對象持久化：** ``` @Test public void testFirst() throws SQLException { UserModel model = new UserModel(); model.setMyName("test"); SqlMapSession session = null; try { session = sqlMapClient.openSession(); beginTransaction(session); session.insert("UserSQL.insert", model); commitTransaction(session); } catch (SQLException e) { rollbackTransacrion(session); throw e; } finally { closeSession(session); } } private void closeSession(SqlMapSession session) { session.close(); } private void rollbackTransacrion(SqlMapSession session) throws SQLException { if(session != null) { session.endTransaction(); } } private void commitTransaction(SqlMapSession session) throws SQLException { session.commitTransaction(); } private void beginTransaction(SqlMapSession session) throws SQLException { session.startTransaction(); } ``` 同樣令人心煩的事務管理和冗長代碼，Spring通用提供了SqlMapClientTemplate模板類來解決這些問題。 ### 8.3.2? 使用 SqlMapClientTemplate SqlMapClientTemplate模板類同樣用于簡化事務管理及常見操作，類似于JdbcTemplate模板類，對于復雜操作通過提供SqlMapClientCallback回調接口來允許更復雜的操作。接下來示例一下SqlMapClientTemplate的使用： ``` @Test public void testSqlMapClientTemplate() { SqlMapClientTemplate sqlMapClientTemplate = new SqlMapClientTemplate(sqlMapClient); final UserModel model = new UserModel(); model.setMyName("myName"); sqlMapClientTemplate.insert("UserSQL.insert", model); //通過回調允許更復雜操作 sqlMapClientTemplate.execute(new SqlMapClientCallback<Void>() { @Override public Void doInSqlMapClient(SqlMapExecutor session) throws SQLException { session.insert("UserSQL.insert", model); return null; }}); } ``` 通過new SqlMapClientTemplate(sqlMapClient)創建HibernateTemplate模板類對象，通過調用模板類的save方法持久化對象，并且自動享受到Spring管理事務的好處。而且SqlMapClientTemplate提供使用SqlMapClientCallback回調接口的方法execute用來支持復雜操作，當然也自動享受到Spring管理事務的好處。 ### 8.3.3集成iBATIS及最佳實踐類似于JdbcDaoSupport類，Spring對iBATIS也提供了SqlMapClientDaoSupport類來支持一致的數據庫訪問。SqlMapClientDaoSupport也是DaoSupport實現：接下來示例一下Spring集成iBATIS的最佳實踐： **1、?定義Dao接口，此處使用cn.javass.spring.chapter7.dao.IUserDao：** **2、?定義Dao接口實現，此處是iBATIS實現：** ``` package cn.javass.spring.chapter8.dao.ibatis; //省略import public class UserIbatisDaoImpl extends SqlMapClientDaoSupport implements IUserDao { @Override public void save(UserModel model) { getSqlMapClientTemplate().insert("UserSQL.insert", model); } @Override public int countAll() { return (Integer) getSqlMapClientTemplate().queryForObject("UserSQL.countAll"); } } ``` **3、修改iBATS映射文件（chapter8/sqlmaps/UserSQL.xml），添加countAll查詢：** ``` <select id="countAll" resultClass="java.lang.Integer"> <![CDATA[ select count(*) from test ]]> </select> ``` 此處注意首先iBATIS實現放在dao.ibaitis包里，其次實現類命名如UserIbatisDaoImpl，即×××IbatisDaoImpl，當然如果自己有更好的命名規范可以遵循自己的，此處只是提個建議。 **4、進行資源配置，使用resources/chapter7/applicationContext-resources.xml：** **5、dao定義配置，在chapter8/applicationContext-ibatis.xml中添加如下配置：** ``` <bean id="abstractDao" abstract="true"> <property name="sqlMapClient" ref="sqlMapClient"/> </bean> <bean id="userDao" class="cn.javass.spring.chapter8.dao.ibatis.UserIbatisDaoImpl" parent="abstractDao"/> ``` 首先定義抽象的abstractDao，其有一個sqlMapClient屬性，從而可以讓繼承的子類自動繼承sqlMapClient屬性注入；然后定義userDao，且繼承abstractDao，從而繼承sqlMapClient注入；我們在此給配置文件命名為applicationContext-ibatis.xml表示iBAITIS實現。 **5、?最后測試一下吧（cn.javass.spring.chapter8\. IbatisTest）：** ``` @Test public void testBestPractice() { String[] configLocations = new String[] { "classpath:chapter7/applicationContext-resources.xml", "classpath:chapter8/applicationContext-ibatis.xml"}; ApplicationContext ctx = new ClassPathXmlApplicationContext(configLocations); IUserDao userDao = ctx.getBean(IUserDao.class); UserModel model = new UserModel(); model.setMyName("test"); userDao.save(model); Assert.assertEquals(1, userDao.countAll()); } ``` 和Spring JDBC框架的最佳實踐完全一樣，除了使用applicationContext-ibatis.xml代替了applicationContext-jdbc.xml，其他完全一樣。也就是說，DAO層的實現替換可以透明化。 ### 8.3.4Spring+iBATIS的CURD Spring集成iBATIS進行CURD（增刪改查），也非常簡單，首先配置映射文件，然后調用SqlMapClientTemplate相應的函數進行操作即可，此處就不介紹了。 ### 8.3.5集成MyBatis及最佳實踐 (本筆記寫于2010年底) 2010年4月份 iBATIS團隊發布iBATIS 3.0的GA版本的候選版本，在iBATIS 3中引入了泛型、注解支持等，因此需要Java5+才能使用，但在2010年6月16日，iBATIS團隊決定從apache遷出并遷移到Google Code，并更名為MyBatis。目前新網站上文檔并不完善。目前iBATIS 2.x和MyBatis 3不是100%兼容的，如配置文件的DTD變更，SqlMapClient直接由SqlSessionFactory代替了，包名也有com.ibatis變成org.ibatis等等。 ibatis 3.x和MyBatis是兼容的，只需要將DTD變更一下就可以了。感興趣的朋友可以到http://www.mybatis.org/官網去下載最新的文檔學習，作者只使用過iBATIS2.3.4及以前版本，沒在新項目使用過最新的iBATIS 3.x和Mybatis，因此如果讀者需要在項目中使用最新的MyBatis，請先做好調研再使用。接下來示例一下Spring集成MyBatis的最佳實踐： **1、準備需要的jar包，到MyBatis官網下載mybatis?3.0.4版本和mybatis-spring 1.0.0版本，并拷貝如下jar包到類路徑：** + **mybatis-3.0.4\mybatis-3.0.4.jar????????????? //核心MyBatis包** + **mybatis-spring-1.0.0\mybatis-spring-1.0.0.jar? //集成Spring包** **2、對象模型定義，此處使用第七章中的UserModel；** **3、MyBatis映射定義（chapter8/sqlmaps/UserSQL-mybatis.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="UserSQL"> <sql id="createTable">  <![CDATA[ create memory table test( id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, name varchar(100)) ]]> </sql> <sql id="dropTable"> <![CDATA[ drop table test ]]> </sql> <insert id="insert" parameterType="cn.javass.spring.chapter7.UserModel"> <![CDATA[ insert into test(name) values (#{myName}) ]]> <selectKey resultType="int" keyProperty="id" order="AFTER">  call identity();  </selectKey> </insert> <select id="countAll" resultType="java.lang.Integer"> <![CDATA[ select count(*) from test ]]> </select> </mapper> ``` 從映射定義中可以看出MyBatis與iBATIS2.3.4有如下不同： * http://ibatis.apache.org/dtd/sql-map-2.dtd 廢棄，而使用[http://mybatis.org/dtd/mybatis-3-mapper.dtd](http://mybatis.org/dtd/mybatis-3-mapper.dtd)。 * <sqlMap>廢棄，而使用<mapper>標簽； * <statement>廢棄了，而使用<sql>標簽； * parameterClass屬性廢棄，而使用parameterType屬性； * resultClass屬性廢棄，而使用resultType屬性； * #myName#方式指定命名參數廢棄，而使用#{myName}方式。 **3、?MyBatis配置文件（chapter8/sql-map-config-mybatis.xml）定義：** ``` <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <settings> <setting name="cacheEnabled" value="false"/> </settings> <mappers> <mapper resource="chapter8/sqlmaps/UserSQL-mybatis.xml"/> </mappers> </configuration> ``` 從配置定義中可以看出MyBatis與iBATIS2.3.4有如下不同： * [http://ibatis.apache.org/dtd/sql-map-config-2.dtd](http://ibatis.apache.org/dtd/sql-map-config-2.dtd)廢棄，而使用[http://mybatis.org/dtd/mybatis-3-config.dtd](http://mybatis.org/dtd/mybatis-3-config.dtd)； * < sqlMapConfig >廢棄，而使用<configuration>； * settings屬性配置方式廢棄，而改用子標簽< setting name=".." value=".."/>方式指定屬性，且一些屬性被廢棄，如maxTransactions； * < sqlMap>廢棄，而采用<mappers>標簽及其子標簽<mapper>定義。 **4、?定義Dao接口，此處使用cn.javass.spring.chapter7.dao. IUserDao：** **5、?定義Dao接口實**現，**此處是MyBatis實現：** ``` package cn.javass.spring.chapter8.dao.mybatis; //省略import public class UserMybatisDaoImpl extends SqlSessionDaoSupport implements IUserDao { @Override public void save(UserModel model) { getSqlSession().insert("UserSQL.insert", model); } @Override public int countAll() { return (Integer) getSqlSession().selectOne("UserSQL.countAll"); } } ``` 和Ibatis集成方式不同的有如下地方： * 使用SqlSessionDaoSupport來支持一致性的DAO訪問，該類位于org.mybatis.spring.support包中，非Spring提供； * 使用getSqlSession方法獲取SqlSessionTemplate，在較早版本中是getSqlSessionTemplate方法名，不知為什么改成getSqlSession方法名，因此這個地方在使用時需要注意。 * SqlSessionTemplate是SqlSession接口的實現，并且自動享受Spring管理事務好處，因此從此處可以推斷出為什么把獲取模板類的方法名改為getSqlSession而不是getSqlSessionTemplate。 **6、進行資源配置，使用resources/chapter7/applicationContext-resources.xml：** **7、dao定義配置，在chapter8/applicationContext-mybatis.xml中添加如下配置：** ``` <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <property name="dataSource" ref="dataSource"/> <property name="configLocation" value="chapter8/sql-map-config-mybatis.xml"/> </bean> <bean id="abstractDao" abstract="true"> <property name="sqlSessionFactory" ref="sqlSessionFactory"/> </bean> <bean id="userDao" class="cn.javass.spring.chapter8.dao.mybatis.UserMybatisDaoImpl" parent="abstractDao"/> ``` 和Ibatis集成方式不同的有如下地方： * SqlMapClient類廢棄，而使用SqlSessionFactory代替； * 使用SqlSessionFactoryBean進行集成MyBatis。首先定義抽象的abstractDao，其有一個sqlSessionFactory屬性，從而可以讓繼承的子類自動繼承sqlSessionFactory屬性注入；然后定義userDao，且繼承abstractDao，從而繼承sqlSessionFactory注入；我們在此給配置文件命名為applicationContext-mybatis.xml表示MyBatis實現。 **8、最后測試一下吧（cn.javass.spring.chapter8\. IbatisTest）：** ``` @Test public void testMybatisBestPractice() { String[] configLocations = new String[] { "classpath:chapter7/applicationContext-resources.xml", "classpath:chapter8/applicationContext-mybatis.xml"}; ApplicationContext ctx = new ClassPathXmlApplicationContext(configLocations); IUserDao userDao = ctx.getBean(IUserDao.class); UserModel model = new UserModel(); model.setMyName("test"); userDao.save(model); Assert.assertEquals(1, userDao.countAll()); } ``` 和Spring 集成Ibatis的最佳實踐完全一樣，除了使用applicationContext-mybatis.xml代替了applicationContext-ibatis.xml，其他完全一樣，且MyBatis 3.x與Spring整合只能運行在Spring3.x。在寫本書時，MyBatis與Spring集成所定義的API不穩定，且期待Spring能在發布新版本時將加入對MyBatis的支持。原創內容，轉載請注明出處【[http://sishuok.com/forum/blogPost/list/0/2498.html](http://sishuok.com/forum/blogPost/list/0/2498.html#7216)】