利用MyBatis Generator自動建立代碼

如果你使用過hibernate的eclipse插件自動建立DAO檔案，那麼就容易了解下面介紹的内容；如果你還沒有用過hibernate也無妨。下面介紹使用mybatis 3的eclipse插件自動生成相關檔案以及如何使用這些檔案。

eclipse插件安裝位址：http://mybatis.googlecode.com/svn/sub-projects/generator/trunk/eclipse/UpdateSite/

附件有link安裝包，link安裝方式參考http://maimode.iteye.com/admin/blogs/1164524

MyBatis Generator詳細介紹參見：http://code.google.com/p/mybatis/wiki/Generator

安裝插件的過程就不說了，安裝完後，eclipse中File-》new-》other中會發現多了mybatis選項說明插件安裝成功。

如何使用插件

在任意項目中利用上圖中的向導建立generatorConfig.xml檔案（名稱可修改）然後修改檔案内容，主要是設定連接配接資料的相關參數：

Xml代碼  

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd" >  
3. <generatorConfiguration >  
4. <classPathEntry location="WebRoot/WEB-INF/lib/ojdbc14-10.2.0.4.0.jar" />
5. <!--生成映射的類型，也可以生成ibatis的。具體參看mybatis-generator--> 
6. <context id="context1"  targetRuntime="MyBatis3">  
7. <jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver" connectionURL="jdbc:oracle:thin:@192.168.2.21:1521:ORCL" userId="atfm" password="atfm" />  

8. <!--以下三個标簽主要解析targetPackage和targetProject。其它的具體參看mybatis-generator--> 

   <!--targetPackage，是生成檔案所在的包路徑--> 

   <!--targetProject，是相對于本xml配置檔案的相對路徑，是targetPackage包路徑的父級目錄。--> 

9. <!-- domain 類 -->
10.     <javaModelGenerator targetPackage="com.topsci.atfm.persistence.mybatis.model" targetProject="ATFM" />  
11. <!-- mybatis xml檔案 -->
12.     <sqlMapGenerator targetPackage="com.topsci.atfm.persistence.mybatis.mapper" targetProject="ATFM" ></sqlMapGenerator>  
13. <!-- 使用SQLSessionTemplate -->
14.     <javaClientGenerator targetPackage="com.topsci.atfm.persistence.mybatis.client" targetProject="ATFM" type="XMLMAPPER" />  
15.     <table schema="" tableName="ATFM_ROUTE_CTRL" ></table>  
16.     <table tableName="SYN_TRACK_EST" domainObjectName="AtfmTrack"></table>  
17.   </context>  
18. </generatorConfiguration>  

根據名稱應該能才出來大緻的意思。

配置好連接配接資料庫及表的資訊後就可以利用插件自動生成代碼了。

點選上圖中的選項，如果配置正确，便自動建立相關檔案了。

檔案主要有三類：

client包，mapper 接口檔案

model包，實體bean檔案

mapper包，mapper xml檔案

如何使用這些自動生成的檔案

首先需要将mapper包下的xml檔案添加到mybatis的sqlmapper檔案中

然後程式中這樣使用：

Java代碼  

1. public List<TrackBean> selectTrackOnRoute(String routeName) {  
2.         List<TrackBean> rt = null;  
3.         SqlSession session = null;  
4.         try {  
5.             session = sqlSessionFactory.openSession();  
6.             AtfmTrackMapper mapper = session.getMapper(AtfmTrackMapper.class);  
7.             // 構造查詢條件  
8.             AtfmTrackExample example = new AtfmTrackExample();  
9.             example.createCriteria()  
10.             .andRouteIs(routeName);  
11.             // 查詢  
12.             List<AtfmTrack> list = mapper.selectByExample(example);  
13.             // 包裝成TrackBean  
14.             rt = this.toTrackBean(list);  
15.         } catch (Exception e) {  
16.             e.printStackTrace();  
17.             logger.error(e.getMessage());  
18.         } finally {  
19.             if (session != null)  
20.                 session.close();  
21.         }  
22.         return rt;  
23.     }  

如果where條件比較複雜，還可以自定義查詢條件，如上例中andRouteIs(routeName)就是自定義的查詢條件。可以在

具體的Example的内部類Criteria中自定義查詢條件：

Java代碼  

1. public Criteria andRouteIs(String routeName){  
2.             StringBuffer sb = new StringBuffer("point_name in " +  
3.                     "(select p.point from route_point p where p.route = '" + routeName + "') " +  
4.                     "AND FLIGHT_NO IN " +  
5.                     "(select D.FLIGHT_NO from syn_aftn_dynamic_recent d " +  
6.                     "where d.route like '%" + routeName + "%')");  
7.             addCriterion(sb.toString());  
8.             return this;  
9.         }  

我們可能會擔心一旦重新執行generate的時候，我們自己編寫的代碼會不會丢失，不會的，插件不會修改或丢棄我們自己編寫的代碼。

一旦掌握了插件如何使用，重要的工作就是如何使用XXXExample類了。這種方式，完全不用編寫繁瑣的mapper xml檔案。

MyBatis_Generator_1.3.1.zip (2.2 MB)