eclipse 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 version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
  PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>
    <!-- <classPathEntry location="y:\workspacepojoWebContentWEB-INFlibojdbc14.jar" 
        /> -->
    <classPathEntry
        location="e:\pojoWebContentWEB-INFlibmysql-connector-java-5.1.26-bin.jar" />
    <context id="Oracle" targetRuntime="MyBatis3">
        <!-- 开启注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="false" />
        </commentGenerator>

        <!-- 数据库连接 -->
        <!-- connectionURL="jdbc:oracle:thin:@127.0.0.1:1521:orcl" userId="orcl" 
            password="orcl"> -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:mysql://localhost:3306/test" userId="root"
            password="">
        </jdbcConnection>

        <!--允许数值类型转换成不同类型,否则都映射为BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 模型文件 -->
        <javaModelGenerator targetPackage="cn.com.sgcc.model"
            targetProject="webserver/src">
            <property name="enableSubPackages" value="true" />
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- XML映射文件 -->
        <sqlMapGenerator targetPackage="com.my.xml"
            targetProject="webserver/src">
            <property name="enableSubPackages" value="true" />
        </sqlMapGenerator>

        <!-- DAO文件(mapper接口) -->
        <javaClientGenerator targetPackage="com.my.dao"
            targetProject="webserver/src" type="XMLMAPPER">
            <property name="enableSubPackages" value="true" />
        </javaClientGenerator>

        <!-- 数据库表 -->
        <!--  <table tableName="T_USER" domainObjectName="User">
            <property name="useActualColumnNames" value="false" />-->
            <!-- <generatedKey column="ID" sqlStatement="DB2" identity="true" /> <columnOverride 
                column="DATE_FIELD" property="startDate" /> <ignoreColumn column="FRED" /> 
                <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" /> -->
        <!-- </table> -->

        <table tableName="T_USERDETAIL" domainObjectName="UserDetail">
            <!-- useActualColumnNames属性是为了使生成的model字段与数据库的字段大小写不一致 -->
            <property name="useActualColumnNames" value="false" />
        </table>

    </context>
</generatorConfiguration>

根据名称应该能才出来大致的意思。

配置好连接数据库及表的信息后就可以利用插件自动生成代码了。

点击上图中的选项，如果配置正确，便自动创建相关文件了。

文件主要有三类：

client包，mapper 接口文件

model包，实体bean文件

mapper包，mapper xml文件

如何使用这些自动生成的文件

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

然后程序中这样使用：

public List<TrackBean> selectTrackOnRoute(String routeName) {
        List<TrackBean> rt = null;
        SqlSession session = null;
        try {
            session = sqlSessionFactory.openSession();
            AtfmTrackMapper mapper = session.getMapper(AtfmTrackMapper.class);
            // 构造查询条件
            AtfmTrackExample example = new AtfmTrackExample();
            example.createCriteria()
            .andRouteIs(routeName);
            // 查询
            List<AtfmTrack> list = mapper.selectByExample(example);
            // 包装成TrackBean
            rt = this.toTrackBean(list);
        } catch (Exception e) {
            e.printStackTrace();
            logger.error(e.getMessage());
        } finally {
            if (session != null)
                session.close();
        }
        return rt;
    }

如果where条件比较复杂，还可以自定义查询条件，如上例中andRouteIs(routeName)就是自定义的查询条件。可以在

具体的Example的内部类Criteria中自定义查询条件：

public Criteria andRouteIs(String routeName){
            StringBuffer sb = new StringBuffer("point_name in " +
                    "(select p.point from route_point p where p.route = '" + routeName + "') " +
                    "AND FLIGHT_NO IN " +
                    "(select D.FLIGHT_NO from syn_aftn_dynamic_recent d " +
                    "where d.route like '%" + routeName + "%')");

            addCriterion(sb.toString());
            return this;
        }

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

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