代码生成器MBG（tk.mybatis）的使用

前提

依赖

	<dependencies>
		<!--lombok依赖-->
		<dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
        </dependency>
		<!--tk.mybatis依赖-->
		<dependency>
		    <groupId>tk.mybatis</groupId>
		    <artifactId>mapper-spring-boot-starter</artifactId>
		    <version>2.1.5</version>
		</dependency>
    </dependencies>

正文

1. 把生成代码的存放位置提出来，配置到pom.xml的中

    <properties>
        <!-- MyBatis Generator 配置 -->
        <!-- ${basedir}：项目的根目录 -->
        <!-- targetJavaProject：声明存放java源码的位置 -->
        <targetJavaProject>${basedir}/src/main/java</targetJavaProject>
        <!-- targetModelPackage：声明存放实体类的位置 -->
        <targetModelPackage>com.shop.dao.pojo</targetModelPackage>
        <!-- targetMapperPackage：声明存放mapper接口的位置 -->
        <targetMapperPackage>com.shop.dao.mapper</targetMapperPackage>
        <!-- targetResourcesProject：声明存放资源文件的位置 -->
        <targetResourcesProject>${basedir}/src/main/resources</targetResourcesProject>
        <!-- targetXMLPackage：声明存放mapper.xml文件的位置 -->
        <targetXMLPackage>mybatis/mapper</targetXMLPackage>
    </properties>

2. pom中添加插件

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.7</version>
    <configuration>
        <verbose>true</verbose>
        <overwrite>true</overwrite>
        <configurationFile>${basedir}/src/main/resources/mybatis/mybatis-generator.xml</configurationFile>
    </configuration>

    <executions>
        <execution>
            <id>Generate MyBatis Artifacts</id>
            <goals>
                <goal>generate</goal>
            </goals>
            <phase>package</phase>
        </execution>
    </executions>
    <dependencies>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.25</version>
        </dependency>
        <!-- 想要在实体类中生成lombok注解，下面这个依赖必须是4.1.0版本以上 -->
        <dependency>
            <groupId>tk.mybatis</groupId>
            <artifactId>mapper</artifactId>
            <version>4.1.5</version>
        </dependency>
    </dependencies>
</plugin>

3.编写mybatis-generator.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>
    <!-- 引用外部配置文件。注意：配置文件的路径是从 resources 下开始的 -->
    <properties resource="mybatis/config.properties"/>
    
    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3Simple" >
        <property name="javaFileEncoding" value="UTF-8"/>
        <property name="useMapperCommentGenerator" value="true"/>
        <property name="autoDelimitKeywords" value="true"/>

        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
        	<!-- 必填属性。声明mapper接口需要继承哪些接口，多个mapper之间用 , 分隔开 -->
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
            <!-- 是否忽略大小写，当数据库表名区分大小写时，可以将该属性设置为true -->
            <property name="caseSensitive" value="false"/>
            <!-- 数据库表名及字段名开始的分隔符，例如mysql为`，sqlserver为[ -->
            <property name="beginningDelimiter" value="`"/>
            <!-- 数据库表名及字段名结束的分隔符，例如mysql为`，sqlserver为] -->
            <property name="endingDelimiter" value="`"/>
            <!-- 生成lombok注解，支持的注解有：@Data、@Getter、@Setter、@ToString、@EqualsAndHashCode、@Accessors；各注解之间用什么分隔无所谓 -->
            <!-- @Data注解优先级高于 @Getter @Setter @ToString @EqualsAndHashCode -->
            <property name="lombok" value="Data"/>
            <!-- 生成swagger注解，默认是false -->
            <property name="swagger" value="false"/>
        </plugin>

        <!-- 链接数据库的配置 -->
        <jdbcConnection
                driverClass="${jdbc.driverClass}"
                connectionURL="${jdbc.url}"
                userId="${jdbc.username}"
                password="${jdbc.password}">
        </jdbcConnection>

        <!-- java类型处理器
            用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；
            注意一点，默认会先尝试使用Integer，Long，Short等来对应 DECIMAL 和 NUMERIC 数据类型；-->
        <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl">
            <!--
                true：使用BigDecimal对应数据库的 DECIMAL 和 NUMERIC 数据类型
                false：默认,
                    精度>0 || 长度>18：使用java.math.BigDecimal
                    精度=0 && 长度[10,18]：使用java.lang.Long
                    精度=0 && 长度[5,9]：使用java.lang.Integer
                    精度=0 && 长度<5：使用java.lang.Short
             -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

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

            <!-- 设置一个根对象，如果设置，需要使用类的全限定名称。
                如果设置了这个根对象，那么生成的实体类会继承这个类；一般几张表里都有共同的属性时设置
                注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
                    属性名相同；属性类型相同；属性有相同的getter/setter方法；
             -->
            <!--<property name="rootClass" value="com.example.demo.entity.BaseEntity"/>-->
        </javaModelGenerator>

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

        <!-- 生成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="${targetMapperPackage}" type="XMLMAPPER" targetProject="${targetJavaProject}">
            <!-- 在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false -->
            <property name="enableSubPackages" value="true"/>

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

        <table tableName="t_wx_user" domainObjectName="WxUser">
            <generatedKey column="id" sqlStatement="JDBC"/>
        </table>
    </context>
</generatorConfiguration>

4. 引用外部配置文件

可以看到这个配置文件中的大多数属性都使用${}形式替代了。并且xml的开头还有这样的配置

<!-- 引用外部配置文件。注意：配置文件的路径是从 resouces 下开始的 -->
<properties resource="mybatis/config.properties"/>

该配置是引用了外部的配置文件，其中主要是配置了数据库连接信息

# 数据库连接信息
jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/tkmybatis?tinyInt1isBit=false
jdbc.username=root
jdbc.password=123456

在单模块的项目中，确实可以使用一些配置文件来统一配置数据库的连接，但是大多数项目使用的是多模块项目，dao就是用来生成和存放dao类的，所以不需要配置文件来配置数据库的连接信息

5. 引入后查看是否加载了该插件