利用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.               
8.             addCriterion(sb.toString());  
9.             return this;  
10.         }  

 

我们可能会担心一旦重新执行generate的时候，我们自己编写的代码会不会丢失，不会的，插件不会修改或丢弃我们自己编写的代码。

 

一旦掌握了插件如何使用，重要的工作就是如何使用XXXExample类了。这种方式，完全不用编写繁琐的mapper xml文件。

MyBatis_Generator_1.3.1.zip (2.2 MB)