mybatics自动生成mapper等

by 凯文

generator.properties-配置数据库ip，账号，密码等信息

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://111.111.111.111:3306/im_account?useUnicode=true&characterEncoding=UTF-8&useSSL=false
jdbc.user=root
jdbc.password=pwd
java.target.package=com.taoche.entity
example.target.package=com.taoche.entity.example
mapper.target.package=com.taoche.mapper
sql.mapper.target.package=mapper

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>
  <properties resource="generator/generator.properties"/>

  <context id="mysql" targetRuntime="MyBatis3">
    <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；
               一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖
            -->
    <property name="autoDelimitKeywords" value="false"/>
    <!-- 生成的Java文件的编码 -->
    <property name="javaFileEncoding" value="UTF-8"/>
    <!-- 格式化java代码 -->
    <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
    <!-- 格式化XML代码 -->
    <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>

    <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
    <property name="beginningDelimiter" value="`"/>
    <property name="endingDelimiter" value="`"/>

    <!--重新生成覆盖原mapper.XML文件-->
    <plugin type="com.mybatis.generator.plugin.OverIsMergeablePlugin"/>
    <!-- Example和mapper类中文注释 -->
    <plugin type="com.mybatis.generator.plugin.CommentPlugin"/>
    <!-- .Lombok插件 默认在实体类里增加@Data 不生成Get、Set方法 -->
    <plugin type="com.mybatis.generator.plugin.LombokPlugin">
      <property name="lombokAnnotations" value="@Data"/>
    </plugin>

    <!-- 修改生成的Example类的类名和Mapper类中的方法名或参数名-->
    <plugin type="com.mybatis.generator.plugin.ExampleConfigPlugin">
      <!-- example包名 -->
      <property name="targetPackage" value="${example.target.package}"/>
      <property name="classMethodSearchString" value="Example"/>
      <property name="classMethodReplaceString" value="Condition"/>
      <property name="parameterSearchString" value="example"/>
      <property name="parameterReplaceString" value="condition"/>
    </plugin>
    <!--生成中文注释-->
    <commentGenerator type="com.mybatis.generator.comment.MyCommentGenerator">
      <!-- 是否禁止显示日期 true：是 ： false:否 -->
      <property name="suppressDate" value="false"/>
      <!-- 是否去除自动生成的所有注释 true：是 ： false:否 -->
      <property name="suppressAllComments" value="false"/>
    </commentGenerator>

    <!--数据库链接URL，用户名、密码 -->
    <jdbcConnection driverClass="${jdbc.driverClass}" connectionURL="${jdbc.connectionURL}" userId="${jdbc.user}"
                    password="${jdbc.password}">
      <property name="useInformationSchema" value="true"/>
    </jdbcConnection>

    <!-- java类型处理器
        用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
        注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；
    -->
    <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
      <property name="forceBigDecimals" value="false"/>
      <property name="useJava8Time" value="${jdk.use_jdk8_time}"/>
    </javaTypeResolver>

    <!-- 配置生成实体类的包名和位置 -->
    <javaModelGenerator targetPackage="${java.target.package}" targetProject="src/main/java">
      <!--  for MyBatis3/MyBatis3Simple
          自动为每一个生成的类创建一个构造方法，构造方法包含了所有的field；而不是使用setter；
       -->
      <property name="constructorBased" value="false"/>

      <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
      <property name="enableSubPackages" value="true"/>

      <!-- for MyBatis3 / MyBatis3Simple
          是否创建一个不可变的类，如果为true，
          那么MBG会创建一个没有setter方法的类，取而代之的是类似constructorBased的类
       -->
      <property name="immutable" value="false"/>

      <!-- 设置一个根对象，
          如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项
          注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
              1，属性名相同，类型相同，有相同的getter/setter方法；
       -->
      <!--<property name="rootClass" value="com.indexes.server.domain.BaseDomain"/>-->

      <!-- 设置是否在getter方法中，对String类型字段调用trim()方法 -->
      <property name="trimStrings" value="true"/>
    </javaModelGenerator>


    <!-- 生成SQL map的XML文件生成器，
        注意，在Mybatis3之后，我们可以使用mapper.xml文件+Mapper接口（或者不用mapper接口），
            或者只使用Mapper接口+Annotation，所以，如果 javaClientGenerator配置中配置了需要生成XML的话，这个元素就必须配置
        targetPackage/targetProject:同javaModelGenerator
     -->
    <sqlMapGenerator targetPackage="${sql.mapper.target.package}" targetProject="src/main/resources">
      <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
      <property name="enableSubPackages" value="true"/>
      <property name="" value=""/>
    </sqlMapGenerator>


    <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口
        targetPackage/targetProject:同javaModelGenerator
        type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
            1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
            2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
            3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
        注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
    -->
    <javaClientGenerator targetPackage="${mapper.target.package}" type="XMLMAPPER"
                         targetProject="src/main/java">
      <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
      <property name="enableSubPackages" value="true"/>

      <!-- 可以为所有生成的接口添加一个父接口，但是MBG只负责生成，不负责检查
      <property name="rootInterface" value=""/>
       -->
    </javaClientGenerator>


    <!-- 选择一个table来生成相关文件，可以有一个或多个table，必须要有table元素
        选择的table会生成一下文件：
        1，SQL map文件
        2，生成一个主键类；
        3，除了BLOB和主键的其他字段的类；
        4，包含BLOB的类；
        5，一个用户生成动态查询的条件类（selectByExample, deleteByExample），可选；
        6，Mapper接口（可选）

        tableName（必要）：要生成对象的表名；
        注意：大小写敏感问题。正常情况下，MBG会自动的去识别数据库标识符的大小写敏感度，在一般情况下，MBG会
            根据设置的schema，catalog或tablename去查询数据表，按照下面的流程：
            1，如果schema，catalog或tablename中有空格，那么设置的是什么格式，就精确的使用指定的大小写格式去查询；
            2，否则，如果数据库的标识符使用大写的，那么MBG自动把表名变成大写再查找；
            3，否则，如果数据库的标识符使用小写的，那么MBG自动把表名变成小写再查找；
            4，否则，使用指定的大小写格式查询；
        另外的，如果在创建表的时候，使用的""把数据库对象规定大小写，就算数据库标识符是使用的大写，在这种情况下也会使用给定的大小写来创建表名；
        这个时候，请设置delimitIdentifiers="true"即可保留大小写格式；

        可选：
        1，schema：数据库的schema；
        2，catalog：数据库的catalog；
        3，alias：为数据表设置的别名，如果设置了alias，那么生成的所有的SELECT SQL语句中，列名会变成：alias_actualColumnName
        4，domainObjectName：生成的domain类的名字，如果不设置，直接使用表名作为domain类的名字；可以设置为somepck.domainName，那么会自动把domainName类再放到somepck包里面；
        5，enableInsert（默认true）：指定是否生成insert语句；
        6，enableSelectByPrimaryKey（默认true）：指定是否生成按照主键查询对象的语句（就是getById或get）；
        7，enableSelectByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询语句；
        8，enableUpdateByPrimaryKey（默认true）：指定是否生成按照主键修改对象的语句（即update)；
        9，enableDeleteByPrimaryKey（默认true）：指定是否生成按照主键删除对象的语句（即delete）；
        10，enableDeleteByExample（默认true）：MyBatis3Simple为false，指定是否生成动态删除语句；
        11，enableCountByExample（默认true）：MyBatis3Simple为false，指定是否生成动态查询总条数语句（用于分页的总条数查询）；
        12，enableUpdateByExample（默认true）：MyBatis3Simple为false，指定是否生成动态修改语句（只修改对象中不为空的属性）；
        13，modelType：参考context元素的defaultModelType，相当于覆盖；
        14，delimitIdentifiers：参考tableName的解释，注意，默认的delimitIdentifiers是双引号，如果类似MYSQL这样的数据库，使用的是`（反引号，那么还需要设置context的beginningDelimiter和endingDelimiter属性）
        15，delimitAllColumns：设置是否所有生成的SQL中的列名都使用标识符引起来。默认为false，delimitIdentifiers参考context的属性

        注意，table里面很多参数都是对javaModelGenerator，context等元素的默认属性的一个复写；
     -->


     <!--<table tableName="im_def_field" domainObjectName="IMDefField"-->
            <!--enableSelectByExample="true"-->
            <!--enableCountByExample="true"-->
            <!--enableDeleteByExample="true"-->
            <!--enableUpdateByExample="true">-->
         <!--<property name="useActualColumnNames" value="false"/>-->
         <!--<property name="selectAllOrderByClause" value="id DESC"/>-->
         <!--<generatedKey column="id" sqlStatement="MySql" identity="true"/>-->
         <!--&lt;!&ndash;<columnOverride column="work_status_update_at" javaType="java.time.Instant"/>-->
         <!--<columnOverride column="create_at" javaType="java.time.Instant"/>-->
         <!--<columnOverride column="update_at" javaType="java.time.Instant"/>&ndash;&gt;-->
     <!--</table>-->

    <table tableName="im_group_sync" domainObjectName="IMGroupSync"
           enableSelectByExample="true"
           enableCountByExample="true"
           enableDeleteByExample="true"
           enableUpdateByExample="true">
      <property name="useActualColumnNames" value="false"/>
      <property name="selectAllOrderByClause" value="id DESC"/>
      <generatedKey column="id" sqlStatement="MySql" identity="true"/>
    </table>

  </context>

</generatorConfiguration>

pom.xml中添加以下配置

<plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.6</version>
        <configuration>
          <configurationFile>src/main/resources/generator/generatorConfig.xml</configurationFile>
          <verbose>true</verbose>
          <overwrite>true</overwrite>
        </configuration>
        <dependencies>
          <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.45</version>
          </dependency>
          <dependency>
            <groupId>com.mybatis.generator.plugin</groupId>
            <artifactId>generator-plugin</artifactId>
            <version>1.0-SNAPSHOT</version>
          </dependency>
          <dependency>
            <groupId>com.squareup.okhttp3</groupId>
            <artifactId>okhttp</artifactId>
            <version>3.4.1</version>
          </dependency>
        </dependencies>
      </plugin>

执行插件