1. mybatis mapper与xml文件自动生成

1.综述

      在做系统的过程中，一般都会用到数据库，会用到ORM框架，如果使用mybatis，需要编写mybatis的mapper.xml文件和mapper java映射文件，这些文件可以根据数据库表自动生成，本文分享怎样生成这些文件。

2. mybatis代码生成

      mybatis代码生成包括三个步骤

1. 在项目pom文件中加入代码生成的插件。
2. 编写代码生成的配置文件。
3. 执行插件生成代码。
   下面我们分别来看一下.

2.1 pom中加入代码生成的maven插件

      代码生成的插件配置如下所示，需要根据项目情况修改配置文件的名称和位置。

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.6</version>
    <configuration>
        <!-- 配置文件的名称 -->
        <configurationFile>generatorConfig.xml</configurationFile>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
    </configuration>
</plugin>

2.2 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>
    <!--JDBC驱动jar包的位置-->
    <classPathEntry location="D:\software\apache-maven-3.8.5\repo\mysql\mysql-connector-java\5.1.49\mysql-connector-java-5.1.49.jar"/>
    <context id="default" targetRuntime="MyBatis3">
        <!--创建Java类时是否取消生成注释-->
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--JDBC数据库连接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://127.0.0.1:3306/database_name?characterEncoding=utf8"
                        userId="root"
                        password="root">
        </jdbcConnection>
        <!--
        Model模型生成器,用来生成含有主键key的类，记录类以及查询Example类
        targetPackage     指定生成的model生成所在的包名
        targetProject     指定在该项目下所在的路径
        -->
        <javaModelGenerator targetPackage="com.XXX.gateway.manager.domain.model" targetProject="./src/main/java">
            <!-- 是否允许子包，即targetPackage.schemaName.tableName -->
            <property name="enableSubPackages" value="false"/>
            <!-- 是否对model添加构造函数 -->
            <property name="constructorBased" value="false"/>
            <!-- 是否对类CHAR类型的列的数据进行trim操作 -->
            <property name="trimStrings" value="true"/>
            <!-- 建立的Model对象是否不可改变,即生成的Model对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!-- mapper映射文件生成的目录-->
        <sqlMapGenerator targetPackage="mapper" targetProject="./src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!--
        客户端代码，生成易于使用的针对Model对象和XML配置文件的代码
        type="ANNOTATEDMAPPER",生成Java Model和基于注解的Mapper对象
        type="MIXEDMAPPER",生成基于注解的Java Model和相应的Mapper对象
        type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口
        -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.XXX.gateway.manager.domain.mapper"
                             targetProject="./src/main/java">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!--要生成代码的表信息-->     
        <table tableName="record" domainObjectName="Record"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
               <columnOverride column="数据库Text列" javaType="java.lang.String" jdbcType="VARCHAR"/>
        </table>
    </context>
</generatorConfiguration>

      需要多说一下的就是columnOverride标签的作用，如果表中有text列，会生成两个java文件，text列会单独放到一个文件中，继承另外一个java类，类似这样

public class RecordWithBLOBs extends Record {

      如果想把他们生成到一个文件中，就需要用到columnOverride标签了，使用方式如上配置文件所示。

2.3 运行插件生成代码

      双击mybatis-generator:generate运行插件即可生成代码。

3. 总结

      本文介绍了使用mybatis-generator-maven-plugin插件生成mapper.xml配置文件和dao映射java文件的方法。