[Java] SpringFrameworkとiBatisを連携させてみる

概要

今更ながら、SpringFrameworkとiBatisを連携を試してみます。
applicationContextの設定から、sqlMapの設定、テストまでを大まかに説明します。

---

動作環境

項目	内容
OS	Mac OS X 10.06
DB	MySQL 5.5
開発環境	eclipse3.6
SpringFramework	1.2
iBatis	2.0

---

前提事項

・以下のテーブルを作成していること。

view plainprint?

1. CREATE  TABLE `PERSON` (  
2.   `PER_ID` INT NOT NULL ,  
3.   `PER_FIRST_NAME` VARCHAR(40) NOT NULL ,  
4.   `PER_LAST_NAME` VARCHAR(40) NOT NULL ,  
5.   PRIMARY KEY (`PER_ID`) )  
6. ENGINE = InnoDB;  

CREATE  TABLE `PERSON` (
  `PER_ID` INT NOT NULL ,
  `PER_FIRST_NAME` VARCHAR(40) NOT NULL ,
  `PER_LAST_NAME` VARCHAR(40) NOT NULL ,
  PRIMARY KEY (`PER_ID`) )
ENGINE = InnoDB;

・mysqlのJDBCドライバを入手済であること。

---

内容

１．SpringFrameworkのライブラリを入手する。
現時点の最新バージョンは3.0.5ですが、今回は1.2系のライブラリを入手します。
以下のURLより入手できますので、入手し適当な場所に解凍して下さい。
こちら

２．iBatisのライブラリを入手する。
現時点では「iBatis」と言う名前から「MyBatis」という名前に変更になっています。
入手についてはこちらを参考にして下さい。

３．Springの定義ファイルを作成する。

Springの定義ファイル「applicationContext-ibatis.xml」を作成します。
このファイルでは、
　・データソースの設定
　・iBatis設定ファイルの設定
　・Daoに対してデータソースの設定
を行っています。

view plainprint?

1. <!--xml version="1.0" encoding="UTF-8"?-->  
2. <!--DOCTYPE beans PUBLIC  
3.     "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"-->  
4. <beans>  
5.   <!-- =============== RESOURCE DEFINITIONS =============== -->  
6.   <bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">  
7.       <property name="driverClassName">  
8.         <value>com.mysql.jdbc.Driver</value>  
9.       </property>  
10.       <property name="url">  
11.         <value>jdbc:mysql://localhost/ibatis</value>  
12.       </property>  
13.       <property name="username">  
14.         <value>ibatis</value>  
15.       </property>  
16.       <property name="password">  
17.         <value>ibatis</value>  
18.       </property>  
19.   </bean>  
20.   
21.   <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">  
22.       <property name="dataSource">  
23.         <ref local="dataSource">  
24.       </ref></property>  
25.   </bean>  
26.   
27.   <bean id="sqlMapClient" class="org.springframework.orm.ibatis.SqlMapClientFactoryBean">  
28.       <property name="configLocation">  
29.         <value>  
30.           dao/sqlMapConfig.xml  
31.         </value>  
32.       </property>  
33.   </bean>  
34.   
35.   <bean id="personDao" class="jp.co.wave.common.dao.PersonDaoImpl">  
36.       <property name="dataSource">  
37.         <ref local="dataSource">  
38.       </ref></property>  
39.       <property name="sqlMapClient">  
40.         <ref local="sqlMapClient">  
41.       </ref></property>  
42.   </bean>  
43.   
44.   <!-- =============== TRANSACTION DEFINITIONS =============== -->  
45. </beans>  

  
  
      
        com.mysql.jdbc.Driver
      
      
        jdbc:mysql://localhost/ibatis
      
      
        ibatis
      
      
        ibatis
      
  

  
      
        
      
  

  
      
        
          dao/sqlMapConfig.xml
        
      
  

  
      
        
      
      
        
      
  

  

４．iBatisの定義ファイルを作成する。

iBatisで使用する定義ファイル「sqlMapConfig.xml」を以下のように作成しました。

view plainprint?

1. <!--xml version="1.0" encoding="UTF-8"?-->  
2. <!--DOCTYPE sqlMapConfig  
3.   PUBLIC "-//ibatis.apache.org//DTD SQL Map Config 2.0//EN"  
4.   "http://ibatis.apache.org/dtd/sql-map-config-2.dtd"-->  
5.   
6. <sqlmapconfig>  
7.   <sqlmap resource="jp/co/wave/common/dao/ibatis/PersonDao.xml">  
8. </sqlmap></sqlmapconfig>  

５．O/Rマッピングファイルを作成する。

O/Rマッピングファイル「PersonDao.xml」を以下のように作成しました。

view plainprint?

1. <!--xml version="1.0" encoding="UTF-8"?-->  
2. <!--DOCTYPE sqlMap  
3.   PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN"  
4.   "http://ibatis.apache.org/dtd/sql-map-2.dtd"-->  
5.   
6. <sqlmap namespace="personDao">  
7.   <typealias alias="person" type="jp.co.wave.common.dto.Person">  
8.   <select id="selectAll" resultclass="person">  
9.       SELECT  
10.           PER_ID AS id,  
11.           PER_FIRST_NAME AS firstName,  
12.           PER_LAST_NAME AS lastName  
13.       FROM  
14.           PERSON  
15.   </select>  
16. </typealias></sqlmap>  

  
  
      SELECT
          PER_ID AS id,
          PER_FIRST_NAME AS firstName,
          PER_LAST_NAME AS lastName
      FROM
          PERSON
  

上記は見ての通り、SQLです。
Hibernateだと、確かかけないんです。SQLを。
iBatisだとSQLを書けるのでSQLを良く使用しているエンジニアだと取っ付きやすいと思います。

６．DTOを作成する。
DBからの取得した結果を格納するためのDTOを作成します。
以下のようなクラスを作成しました。

view plainprint?

1. public class Person {  
2.   
3.  private int id;  
4.  private String firstName;  
5.  private String lastName;  
6.  public int getId() {  
7.   return id;  
8.  }  
9.  public void setId(int id) {  
10.   this.id = id;  
11.  }  
12.  public String getFirstName() {  
13.   return firstName;  
14.  }  
15.  public void setFirstName(String firstName) {  
16.   this.firstName = firstName;  
17.  }  
18.  public String getLastName() {  
19.   return lastName;  
20.  }  
21.  public void setLastName(String lastName) {  
22.   this.lastName = lastName;  
23.  }  
24. }  

public class Person {

 private int id;
 private String firstName;
 private String lastName;
 public int getId() {
  return id;
 }
 public void setId(int id) {
  this.id = id;
 }
 public String getFirstName() {
  return firstName;
 }
 public void setFirstName(String firstName) {
  this.firstName = firstName;
 }
 public String getLastName() {
  return lastName;
 }
 public void setLastName(String lastName) {
  this.lastName = lastName;
 }
}

７．Daoクラスを作成する。

今回の例では、インタフェースとその実装クラスそれぞれを作成しました。

・PersonDao

view plainprint?

1. public interface PersonDao {  
2.  public List<person> selectAll();  
3. }  
4. </person>  

public interface PersonDao {
 public List selectAll();
}

・PersonDaoImpl

view plainprint?

1. public class PersonDaoImpl extends SqlMapClientDaoSupport implements PersonDao {  
2.   
3.  @Override  
4.  public List<person> selectAll() {  
5.   return (List<person>) getSqlMapClientTemplate().queryForList("selectAll");  
6.  }  
7. }  
8. </person></person>  

public class PersonDaoImpl extends SqlMapClientDaoSupport implements PersonDao {

 @Override
 public List selectAll() {
  return (List) getSqlMapClientTemplate().queryForList("selectAll");
 }
}

---

テスト

１〜７で使用する準備が整ったので、実際に使用できるか試してみます。

view plainprint?

1. public class StartUp {  
2.   
3.  public static void main(String[] args) {  
4.   
5.   ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext-ibatis.xml");  
6.   BeanFactory factory = (BeanFactory) context;  
7.   PersonDao dao = (PersonDao) factory.getBean("personDao");  
8.   List<person> personList = dao.selectAll();  
9.   System.out.println(personList.size());  
10.  }  
11. }  
12. </person>  

public class StartUp {

 public static void main(String[] args) {

  ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("applicationContext-ibatis.xml");
  BeanFactory factory = (BeanFactory) context;
  PersonDao dao = (PersonDao) factory.getBean("personDao");
  List personList = dao.selectAll();
  System.out.println(personList.size());
 }
}

実行すると、以下のような感じでログが表示されました。
正常に連携できました。

view plainprint?

1. 2011/03/30 22:42:27 org.springframework.context.support.AbstractApplicationContext prepareRefresh  
2. 情報: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@39617189: display name [org.springframework.context.support.ClassPathXmlApplicationContext@39617189]; startup date [Wed Mar 30 22:42:27 JST 2011]; root of context hierarchy  
3. 2011/03/30 22:42:27 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions  
4. 情報: Loading XML bean definitions from class path resource [applicationContext-ibatis.xml]  
5. 2011/03/30 22:42:27 org.springframework.context.support.AbstractApplicationContext obtainFreshBeanFactory  
6. 情報: Bean factory for application context [org.springframework.context.support.ClassPathXmlApplicationContext@39617189]: org.springframework.beans.factory.support.DefaultListableBeanFactory@39b8d6f7  
7. 2011/03/30 22:42:27 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons  
8. 情報: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@39b8d6f7: defining beans [dataSource,transactionManager,sqlMapClient,personDao]; root of factory hierarchy  
9. 2011/03/30 22:42:27 org.springframework.jdbc.datasource.DriverManagerDataSource setDriverClassName  
10. 情報: Loaded JDBC driver: com.mysql.jdbc.Driver  
11. 1  

2011/03/30 22:42:27 org.springframework.context.support.AbstractApplicationContext prepareRefresh
情報: Refreshing org.springframework.context.support.ClassPathXmlApplicationContext@39617189: display name [org.springframework.context.support.ClassPathXmlApplicationContext@39617189]; startup date [Wed Mar 30 22:42:27 JST 2011]; root of context hierarchy
2011/03/30 22:42:27 org.springframework.beans.factory.xml.XmlBeanDefinitionReader loadBeanDefinitions
情報: Loading XML bean definitions from class path resource [applicationContext-ibatis.xml]
2011/03/30 22:42:27 org.springframework.context.support.AbstractApplicationContext obtainFreshBeanFactory
情報: Bean factory for application context [org.springframework.context.support.ClassPathXmlApplicationContext@39617189]: org.springframework.beans.factory.support.DefaultListableBeanFactory@39b8d6f7
2011/03/30 22:42:27 org.springframework.beans.factory.support.DefaultListableBeanFactory preInstantiateSingletons
情報: Pre-instantiating singletons in org.springframework.beans.factory.support.DefaultListableBeanFactory@39b8d6f7: defining beans [dataSource,transactionManager,sqlMapClient,personDao]; root of factory hierarchy
2011/03/30 22:42:27 org.springframework.jdbc.datasource.DriverManagerDataSource setDriverClassName
情報: Loaded JDBC driver: com.mysql.jdbc.Driver
1

---

参考情報

なし

---

最後に

説明をほとんどしませんでしたが、上記の内容をおのおのの環境に合わせて使って貰えれば動作すると思います。
次回以降、トランザクションに関して試してみたいと思います。