Mybatis generator

mybatis 自动生成代码工具介绍

mybatis使用起来轻便，可编写Sql。受到很多开发者的喜爱。但是由于项目需要大量sql也让人很烦躁。
所以mybatis自己开发出了自动生成代码工具。

mybatis

官方文档很详细但是还是有一些很好用的功能细节没有提及，在这里简单介绍一下。

MBG生成的代码是可以和mybatis发行的版本兼容的。

• targetRuntime 生成代码的目标

  • MyBatis3DynamicSql 要求MyBatis3.4.2+，Java8+还需要依赖MyBatis Dynamic SQL选择该目标model为flat类型忽略defaultModelType配置。使用注解动态sql方式，不会生成XML文件。

  • MyBatis3 要求MyBatis3.0+ Java5+生成XML配置文件和额外的Example类，Example不用写Sql就可以实现对单表的复杂查询操作。

  • MyBatis3Simple 和MyBatis3类似，但是不会生成Example类。

• defaultModelType 这个是生成model的类型（实体类）

  • flat 一个table对应一个model

  • hierarchical 生成只含有主键的类，然后生成含有基本字段的类继承主键类， 生成只含有BLOB字段的类继承基础类，

  • conditional 和hierarchical类似，只不过如果主键只有一个字段，则会合并到基础类中

其他配置文件在文尾给出。

在使用MBG时。当对一个表重复生成代码，mybatis 生成的xml文件会根据id前缀ibatorgenerated_ abatorgenerated_或者生成的注释进行合并。有时候我们不喜欢自动生成乱七八糟的注释，希望根据ID合并 但是MBG没有这个选项。
MBG同样也不支持Model，Mapper类合并。这是很痛苦的事情，例如，我们在数据库添加一个字段，重新生成一遍。它会覆盖掉之前生成的Model，Mapper，Example类。如果我们在Model和其他Model类有了依赖，在配置一对一，一对多时，这是非常糟糕的。自动生成的Mapper里的方法包括了所有的单表操作，然而我们经常面对多表操作，如果我们在Mapper里定义自己的方法。重新执行MBG时也会被覆盖掉。

针对这些问题，我们自己可以稍微修改了一下MBG源码。支持以上功能
代码实现预想细节，
xml根据ID合并，如果存在的文件ID是自动生成的则删掉。
生成的Example不合并，直接覆盖。
Mapper类只合并方法。
Model类，已存在的类的字段如果不含有@mbg.generated（生成代码时自动添加的）注释则保留。新生成的字段+保留字段 为合并后的类。
同时也可以添加Lombok功能。不用写setter，getter方法。

实现源码
https://gitee.com/youth_is_doing/generator

可以直接下载 发行版mybatis-generator-core-1.4.0.jar包，然后使用maven安装到本地使用。
下载地址mybatis-generator-core-1.4.0.jar

需要注意的是。使用这个jar时需要引用javaparser

maven示例配置文件

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.4.0</version>
    <configuration>
        <overwrite>false</overwrite>
        <configurationFile>${basedir}/src/main/resources/generatorConfig.xml
        </configurationFile>
    </configuration>
    <dependencies>
        <dependency>
            <groupId>com.github.javaparser</groupId>
            <artifactId>javaparser-core</artifactId>
            <version>3.15.15</version>
        </dependency>
    </dependencies>
</plugin>

附上MBG详细配置

<?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="jdbc的jar包地址"/>

    <!--
    targetRuntime
    MyBatis3DynamicSql:要求MyBatis3.4.2+，Java8+还需要依赖MyBatis Dynamic SQL选择该目标model为flat类型忽略defaultModelType配置。使用注解动态sql方式，不会生成XML文件。
    MyBatis3:要求MyBatis3.0+ Java5+生成XML配置文件和额外的Example类，Example不用写Sql就可以实现对单表的复杂查询操作。
    MyBatis3Simple:和MyBatis3类似，但是不会生成Example类。
    -->
    <!--  defaultModelType 这个是生成model的类型（实体类）
    flat 一个table对应一个model
    hierarchical 生成只含有主键的类，然后生成含有基本字段的类继承主键类， 生成只含有BLOB字段的类继承基础类，
    conditional 和hierarchical类似，只不过如果主键只有一个字段，则会合并到基础类中-->
    <context id="DB2Tables" targetRuntime="MyBatis3" defaultModelType="flat">
        <!-- 生成Java文件的编码格式 -->
        <property name="javaFileEncoding" value="UTF-8"/>
        <!--   可以自己写插件，修改生成的代码 需要实现org.mybatis.generator.api.PluginAdapter    -->
        <plugin type=""/>

        <jdbcConnection driverClass="COM.ibm.db2.jdbc.app.DB2Driver"
                        connectionURL="jdbc:db2:TEST"
                        userId="db2admin"
                        password="db2admin">
        </jdbcConnection>

        <!--   数据库类型和Java类型处理   -->
        <javaTypeResolver>
            <!-- 为true时数据库类型为DECIMAL/NUMERIC都会被映射为java.math.BigDecimal
            false(默认值) 自动根据精度映射 -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成的实体类配置       -->
        <javaModelGenerator targetPackage="test.model" targetProject="\MBGTestProject\src">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
            <!-- 生成的example配置-->
            <property name="exampleTargetProjectTargetPackage" value=""/>
            <property name="exampleTargetProject" value=""/>
            <!-- 自己添加的功能-->
            <property name="useLombok" value="true"/>
        </javaModelGenerator>

        <sqlMapGenerator targetPackage="test.xml" targetProject="\MBGTestProject\src">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <javaClientGenerator type="XMLMAPPER" targetPackage="test.dao" targetProject="\MBGTestProject\src">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <table schema="DB2ADMIN" tableName="ALLTYPES" domainObjectName="Customer">
            <property name="useActualColumnNames" value="true"/>
            <generatedKey column="ID" sqlStatement="DB2" identity="true"/>
            <columnOverride column="DATE_FIELD" property="startDate"/>
            <ignoreColumn column="FRED"/>
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR"/>
        </table>
        <!-- 一般我们可以简化为这样写,生成实体类会自动使用驼峰命名法.添加别名也是很有用的.
        这样生成的sql 为 col AS t_col,col2 AS t_col2 ... 我们在其他Mapper.xml文件则可以直接include引用，如果这个表字段更改了则不用修改其他Mapper.xml文件
        生成的BaseResultMap我们不要去修改,如果想要添加依赖关系,可以新定义个resultMap 使用extends去继承这个BaseResultMap
         -->
        <table schema="DB2ADMIN" tableName="table" alias="t"/>

    </context>
</generatorConfiguration>