7_tk-mybatis 实现反向生成

需求： 根据数据库字段反向生成实体类、接口、映射文件，并且对实体类使用swagger加上注解说明

数据库表：

---

1、配置环境

（1）引入 pom

<dependencies>
    <dependency>
        <groupId>tk.mybatis</groupId>
        <artifactId>mapper-spring-boot-starter</artifactId>
        <version>2.0.2</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.8.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.8.0</version>
    </dependency>
</dependencies>

（2）引入插件

<build>
    <plugins>
        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.7</version>
            <configuration>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>tk.mybatis</groupId>
                    <artifactId>mapper</artifactId>
                    <version>4.1.5</version>
                </dependency>
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>8.0.19</version>
                </dependency>
                <dependency>
                    <groupId>com.github.misterchangray.mybatis.generator.plugins</groupId>
                    <artifactId>myBatisGeneratorPlugins</artifactId>
                    <version>1.2</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

（3）数据库连接文件

db.properties：

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql:///generator?serverTimezone=Asia/Shanghai
jdbc.username=root
jdbc.password=123456

（4）生成配置文件

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="db.properties"></properties>
    <!--指定特定数据库的jdbc驱动jar包的位置-->
    <!--<classPathEntry location="${jdbc.location}"/>-->
    <context id="default" targetRuntime="MyBatis3" defaultModelType="flat">

        <!--结合通用Mapper插件 指定生成 Mapper 的继承模板-->
        <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
            <!--<property name="mappers" value="com.kkb.utils.MyMapper"/>-->
            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>
        </plugin>
        <!--pojo实现序列化接口-->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />
        <!--pojo类中增加toString方法-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />
        <!--覆盖生成XML文件 每次执行，把以前的mapper.xml覆盖而不是合并-->
        <plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" />

        <!-- 自动为entity生成swagger2文档-->
        <plugin type="mybatis.generator.plugins.GeneratorSwagger2Doc">
            <property name="apiModelAnnotationPackage" value="io.swagger.annotations.ApiModel"/>
            <property name="apiModelPropertyAnnotationPackage" value="io.swagger.annotations.ApiModelProperty"/>
        </plugin>

        <!--注意， plugin 需要写在commentGenerator上面-->

        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="false" />
        </commentGenerator>
        <!--jdbc的数据库连接 -->
        <jdbcConnection
                driverClass="${jdbc.driver}"
                connectionURL="${jdbc.url}"
                userId="${jdbc.username}"
                password="${jdbc.password}">
        </jdbcConnection>

        <!-- 生成 JavaBean 对象重写 toString方法 -->
        <!--        <plugin type="org.mybatis.generator.plugins.ToStringPlugin" />-->
        <!-- 生成 JavaBean 对象继承 Serializable 类 -->
        <!--        <plugin type="org.mybatis.generator.plugins.SerializablePlugin" />-->
        <!-- 生成 JavaBean 对象重写 equals 和 hashCode 方法 -->
        <!-- <plugin type="org.mybatis.generator.plugins.EqualsHashCodePlugin" /> -->

        <!-- 对应生成的pojo所在包 -->
        <javaModelGenerator targetPackage="com.supergo.pojo" targetProject="src/main/java">
            <!-- 是否对model添加 构造函数 -->
            <property name="constructorBased" value="true"/>
        </javaModelGenerator>

        <!-- 对应生成的mapper所在目录 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"/>

        <!-- 配置mapper对应的java映射 -->
        <javaClientGenerator targetPackage="com.supergo.mapper" targetProject="src/main/java"
                             type="XMLMAPPER"/>

        <table schema="" tableName="husb"  enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <domainObjectRenamingRule searchString="^Tb" replaceString="" />
        </table>
        <table schema="" tableName="wife"  enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
            <domainObjectRenamingRule searchString="^Tb" replaceString="" />
        </table>


    </context>
</generatorConfiguration>

---

2、运行

3、生成效果

---

4、启动类

扫描接口

@SpringBootApplication
@MapperScan("com.supergo.mapper") //扫描mapper接口
public class TkMybatisApplication {
    public static void main(String[] args) {
        SpringApplication.run(TkMybatisApplication.class, args);
    }
}