mybatis-generator配置和使用流程

MyBatis Generator 是 MyBatis 提供的一个代码生成工具。可以帮我们生成 表对应的持久化对象(po)、操作数据库的接口(dao)、CRUD sql的xml(mapper)。
MyBatis Generator 是一个独立工具，你可以下载它的jar包来运行、也可以在 Ant 和 maven 运行。

使用环境

引入插件

配置插件

MyBatis Generator 插件需要根据一个 MyBatis Generator config 文件，来具体运行
配置如下，版本我用的是目前最新的版本 1.4.0

配置 MyBatis Generator Config

MyBatis Generator 插件启动后，会根据你在 pom 中配置都路径找到该配置文件。
这个配置文件才是详细都配置 MyBatis Generator 生成代码的各种细节。
其中最重要的就是 context ，你的配置文件至少得包含一个context

<?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="C:\Users\redhood\3D Objects\repository\mysql\mysql-connector-java\8.0.19\mysql-connector-java-8.0.19.jar"/>

    <context id="mysql" defaultModelType="flat" targetRuntime="MyBatis3">
        <!-- 生成的 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"/>
        <!-- 生成mysql带有分页的sql的插件  这个可以自己写，-->
        <!--        <plugin type="generator.MysqlPaginationPlugin" />-->
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 自定义的注释规则，继承 DefaultCommentGenerator 重写 一些方法 -->

        <commentGenerator type="com.generator.NewbatisGenerator">
            <!-- 是否去除自动生成日期的注释 true：是 ： false:否 -->
            <property name="suppressDate" value="true"/>
            <!-- 是否去除所有自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>


        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/cathome_demo?useSSL=false&amp;characterEncoding=utf8&amp;serverTimezone=UTC"
                        userId="root"
                        password="12345">
            <!--            防止找错库-->
            <property name="nullCatalogMeansCurrent" value="true"/>
            <!-- 设置 useInformationSchema 属性为 true -->
            <property name="useInformationSchema" value="true"/>
        </jdbcConnection>

        <!--生成entity类存放位置-->
        <javaModelGenerator targetPackage="com.redhood.backend.cathome.test_generator.entity"
                            targetProject="src\main\java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
            <!-- 是否对modal添加构造函数 -->
            <property name="constructorBased" value="true"/>
            <!-- 建立modal对象是否不可改变 即生成的modal对象不会有setter方法，只有构造方法 -->
            <property name="immutable" value="false"/>
        </javaModelGenerator>

        <!--生成映射文件存放位置-->
        <sqlMapGenerator targetPackage="com.redhood.backend.cathome.test_generator.mapper"
                         targetProject="src\main\java">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!--生成Dao类存放位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.redhood.backend.cathome.test_generator.dao"
                             targetProject="src\main\java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <table schema="cathome_demo" tableName="user" domainObjectName="User">
        </table>
    </context>
</generatorConfiguration>

使用 MyBatis Generator

配置好后，双击 maven 中的 MyBatis Generator 运行

也可以使用工具类运行

public class MybatisGeneratorUtil {
    /**
     * 通过执行本方法，调用 Mybatis Generator 工具，生成相应代码。
     * 避免 Eclipse、IDEA 之间插件使用的差异。
     * @param args
     * @return
     */
    public static void main(String[] args) throws Exception {
        List<String> warnings = new ArrayList<>();
        String configFilePath = MybatisGeneratorUtil.class.getClassLoader().getResource("generatorConfig.xml").getFile(); // mybatis-generator.xml 配置文件放在 resources 目录里。
        File configFile = new File(configFilePath);
        ConfigurationParser parser = new ConfigurationParser(warnings);
        Configuration config = parser.parseConfiguration(configFile);
        DefaultShellCallback callback = new DefaultShellCallback(true); // 存在则覆盖
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        myBatisGenerator.generate(null);
    }
}

生成文件