mybatis系列-5分钟搞定mapper、pojo、xml代码自动生成

tk-mybatis 是mybatis的一个功能扩展，可以在原有方法的基础之上提供更多的功能可用，如一个基类Mapper, 继承他就相当于拥有了常用的增删改查等功能，无需再每个mapper文件中都写增删改查，非常方便。

那么接下来我们来开始看如何使用tk-mybatis generator从数据库直接生成代码（包括pojo实体类、mapper类以及对应的mapper.xml文件）。【注意，由于POM依赖之间的不同版本有可能存在兼容问题，所以如果使用中出现java.lang.NoSuchMethodException等类似的bug，可能是版本不匹配，请参考使用本章中的依赖版本】

1. 引入依赖包，在pom中引入tk.mybatis.mapper-spring-boot-starter的依赖

<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.0</version>
</dependency>

2. 引入自动生成插件

<build>
    <plugins>
    <!-- mybatis逆向工程插件 -->
    <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.5</version>
        <configuration>
            <!--逆向配置文件 -->
            <configurationFile>src/main/resources/generator.xml</configurationFile>
            <!-- 生成过程中是否输出详细信息 -->
            <verbose>false</verbose>
            <!--如果存在旧的文件，是否覆盖旧文件。值得注意的是，如果该值为true，则MyBatis Generator会覆盖旧的po、dao、
            和*mapper.xml,如果为false，则po和dao会生成加后缀的同名文件，如user.java.1,*mapper.xml会覆盖旧的 -->
            <overwrite>true</overwrite>
        </configuration>
        <dependencies>
            <!--下面这两个依赖不引入是不会逆向生成的-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <version>5.1.46</version>
            </dependency>
            <dependency>
                <groupId>tk.mybatis</groupId>
                <artifactId>mapper-spring-boot-starter</artifactId>
                <version>2.1.0</version>
            </dependency>
            <dependency>
                <groupId>tk.mybatis</groupId>
                <artifactId>mapper</artifactId>
                <version>3.4.5</version>
            </dependency>
        </dependencies>
    </plugin>
</plugins>
</build>

3. 在src/main/resources/ 下创建 generator.xml

该配置文件中只需要根据情况修改一下几个参数

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

<properties resource="application.properties" />：根据实际情况修改properties文件位置

<table tableName="users"></table>：需要进行逆向的数据库表，可以用通配符%表示所有的表

注意：$变量，如${generator.mappers}都是在resource指定的properties文件中定义的，在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>
    <!-- 引入 application.properties -->
    <properties resource="application.properties" />
    <!-- MyBatis3Simple：不生成 Example相关类及方法 defaultModelType="flat" -->
    <context id="MysqlContext" targetRuntime="MyBatis3Simple" >
        <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`反引号； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>
        <!-- 指定生成 Mapper 的继承模板 --> 
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin"> 
            <property name="mappers" value="${generator.mappers}"/> 
        </plugin> 
        <!--配置代码中是否可以生成**注释信息**，具体就是生成表或字段的备注信息--> 
        <commentGenerator> 
            <!-- 阻止生成的注释包含时间戳，默认为false--> 
            <property name="suppressDate" value="true"/> 
            <!-- 阻止生成注释 true：是 ： false:否 --> 
            <property name="suppressAllComments" value="true"/> 
        </commentGenerator> 
        <!-- jdbc 连接配置 --> 
        <jdbcConnection driverClass="${spring.datasource.driver-class-name}" 
                        connectionURL="${spring.datasource.url}" 
                        userId="${spring.datasource.username}" 
                        password="${spring.datasource.password}"> 
        </jdbcConnection> 
        <!--java类型处理器--> 
        <!--用于处理DB中的类型到Java中的类型，默认使用JavaTypeResolverDefaultImpl；--> 
        <!--注意一点，默认会先尝试使用Integer，Long，Short等来对应DECIMAL和 NUMERIC数据类型；--> 
        <javaTypeResolver> 
            <!-- true：使用BigDecimal对应DECIMAL和 NUMERIC数据类型false：默认--> 
            <property name="forceBigDecimals" value="false"/> 
        </javaTypeResolver> 
        <!-- 生成实体类的包名和位置 ，targetPackage指的是包名,targetProject值得是路径位置--> 
        <!-- 对于生成的pojo所在包,pojo其实就是domain Entity--> 
        <javaModelGenerator targetPackage="${generator.javaModel-targetPackage}" targetProject="${generator.targetProject}"> 
            <!--在targetPackage的基础上，根据数据库的schema再生成一层package，最终生成的类放在这个package下，默认为false--> 
            <property name="enableSubPackages" value="false"/> 
            <!--设置是否在setter方法中，对String类型字段调用trim()方法，一般可以设置为false，需要的时候在传入参数的地方做trim就好了--> 
            <property name="trimStrings" value="false"/> 
        </javaModelGenerator> 
        <!-- 对于生成的mapper.xml所在目录 --> 
        <sqlMapGenerator targetPackage="${generator.sqlMap-targetPackage}" targetProject="src/main/resources"/> 
        <!-- 配置mapper对应的java映射  也可以叫dao层 --> 
        <javaClientGenerator targetPackage="${generator.javaClient-targetPackage}" targetProject="${generator.targetProject}"
                              type="XMLMAPPER"/>
         <!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
         <table tableName="users"></table>
     </context>
 </generatorConfiguration>

4. 在application.properties文件中引入数据库的配置和generator的配置

application.properties配置项内容请根据实际情况修改

#datasource配置
 spring.datasource.driver-class-name=com.mysql.jdbc.Driver
 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/foodie-shop?useSSL=false&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&serverTimezone=GMT%2B8
 spring.datasource.username=root
 spring.datasource.password=123456
 # 目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
 generator.targetProject=src/main/java
 # mapper的父类,默认为tk.mybatis.mapper.common.Mapper，该类包含了基本的操作接口，也可以自己定义
 generator.mappers=tk.mybatis.mapper.common.Mapper
 # pojo所在包名
 generator.javaModel-targetPackage=com.example.demotkmybatisgenerator.pojo
 # mapper.xml位于resource文件夹下的哪个目录中
 generator.sqlMap-targetPackage=mapper
 # mapper所在包名
 generator.javaClient-targetPackage=com.example.demotkmybatisgenerator.mapper

5. 运行插件（Eclipse）： run-->configuration: mybatis-generator:generate

6. 运行插件（IDEA）：

在工程右侧的Maven模块中找到对应的mybatis-generator插件（需要pom.xml文件中引入了该插件，才会显示，如果pom.xml引入了，但是没有显示，点击Maven模块左上角的reimport一下即可）

6. 刷新项目，出现对应Mapper、xml和pojo文件。