mybatis自动生成代码mybatis-generator

1. 前言

Mybatis属于半自动ORM，在使用这个框架中，工作量最大的就是书写Mapping的映射文件( ***Entity, ***Dao, ***Mapper.xml)，由于手动书写很容易出错，我们可以利用Mybatis-Generator来帮我们自动生成文件。
界面模式： https://github.com/whbing/myb...

2. 步骤

使用mybatis-generator生成代码只需要两步：

1.pom中引入插件：

<!-- above are mybatis dependencies and other...-->
<build>
        <plugins>
            <plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.4</version>
                <configuration>
                    <!--是否将生成过程输出至控制台-->
                    <verbose>true</verbose>
                    <!--是否覆盖：否-->
                    <overwrite>false</overwrite>
                </configuration>
            </plugin>
        </plugins>
    </build>

2.资源目录（resources）下放置generatorConfig.xml文件：

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="/Users/{your_pc}/.m2/repository/mysql/mysql-connector-java/5.1.39/mysql-connector-java-5.1.39.jar" />
    <context id="context1" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple">
        <!-- 为了防止生成的代码中有很多注释，比较难看，加入下面的配置控制  -->
        <!-- 是否去除自动生成的注释 true：是 ：false:否 -->
        <commentGenerator >
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--去除注释的配置要放在数据库配置的前面，不然会报错-->
        <!-- 注释end -->
        
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
            connectionURL="jdbc:MySql://localhost/jms3?characterEncoding=UTF-8&amp;allowMultiQueries=true"
            userId="root" password="whb" />
        <javaModelGenerator targetPackage="com.***.domain.entity"
            targetProject="src/main/java" />
        <sqlMapGenerator targetPackage="sqlmap/mysql"
            targetProject="src/main/resources" />
        <javaClientGenerator targetPackage="com.***.dao"
            targetProject="src/main/java" type="XMLMAPPER" />

        <table tableName="capri_task" domainObjectName="TaskEntity"
            enableCountByExample="true" enableUpdateByExample="true"
            enableDeleteByExample="true" enableSelectByExample="true"
            selectByExampleQueryId="false"></table>


        <table tableName="other..." ...some config...></table>

    </context>
</generatorConfiguration>

使用Maven Project插件，双击mybatis-generator:generate即可在对应位置下生成文件。

上述仅仅引入了mybatis-generator插件，其依赖的mysql jar包需要在配置中明确写出。实际上，还可以通过同时引入mybatis-generator依赖和插件，来优化上述配置。 详情

3. 配置文件说明

详情

<generatorConfiguration>
    (1)
    <!-- 可以用于加载或者配置文件，使用${propertyKey}
    resource：从classpath开始找，比如*/generatorConfig.properties        
    url：使用URL的绝对路径方式
    注意 两个属性只能选址一个;
    另外，如果使用了mybatis-generator-maven-plugin，那么在pom.xml中定义的properties都可以直接在generatorConfig.xml中使用 -->
    <properties resource="" url="" />
    
    (2)
    <!-- 额外依赖包 如mysql连接包-->
    <classPathEntry location="..."/>
    
   （3）
    <!--
    context:生成一组对象的环境 
    id:必选，上下文id，用于在生成错误时提示
    defaultModelType:指定生成对象的样式
        1，conditional：类似hierarchical；
        2，flat：所有内容（主键，blob）等全部生成在一个对象中；
        3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
    targetRuntime:
        1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；
        2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；-->
    <context id="context1" defaultModelType="flat">
    
    ...

运行mybatis-generator插件，即可自动生成，即在指定的文件夹下，生成：

*Mapper.java, 
*Mapper.xml, 
Entity

---