Mybatis plus代码生成器

最新推荐文章于 2024-03-25 07:08:52 发布

罗小爬EX

最新推荐文章于 2024-03-25 07:08:52 发布

阅读量754

点赞数

分类专栏： mysql # mybatis-plus Java & Spring 文章标签： java spring boot maven

本文链接：https://blog.csdn.net/luo15242208310/article/details/113472795

版权

Java & Spring 同时被 3 个专栏收录

56 篇文章 1 订阅

订阅专栏

mysql

15 篇文章 0 订阅

订阅专栏

mybatis-plus

7 篇文章 0 订阅

订阅专栏

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。
参考连接：
Mybatis-Plus官网 - 代码生成器
 Mybatis-Plus官网 - 代码生成器配置

一、maven依赖

<!-- mybatis-plus generator -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>
<!-- 集成mybatis-plus freemarker模版（支持Velocity、Freemarker、beetl，可根据自己需要选择） -->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
</dependency>

完整springboot maven依赖

<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.4.2</version>
        <relativePath/>
    </parent>
    <groupId>com.mx</groupId>
    <artifactId>mybatis-plus-generater</artifactId>
    <version>1.0-SNAPSHOT</version>
    <name>mybatis-plus-generater</name>
    <properties>
        <java.version>1.8</java.version>
        <mybatis.plus.version>3.4.2</mybatis.plus.version>
        <mybatis.plus.generator.version>3.4.1</mybatis.plus.generator.version>
    </properties>

    <dependencies>
        <!-- Spring -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <scope>compile</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <!-- mybatis-plus -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>${mybatis.plus.version}</version>
        </dependency>
        <!-- mybatis-plus generator -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>${mybatis.plus.generator.version}</version>
        </dependency>

        <!-- 集成mybatis-plus freemarker模版 -->
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
        </dependency>

        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

二、生成代码

import com.baomidou.mybatisplus.core.toolkit.ArrayUtils;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.po.TableInfo;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

import java.util.ArrayList;
import java.util.List;


/**
 * Mybatis-Plus generator示例
 *
 * @author luohq
 * @date 2021-01-31
 */
public class CodeGenerator {
    //作者名称
    private static final String AUTHOR = "luohq";
    //mysql数据源连接配置
    private static final String DATA_SOURCE_DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
    private static final String DATA_SOURCE_URL = "jdbc:mysql://localhost:3306/db_msg_push?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&nullCatalogMeansCurrent=true";
    private static final String DATA_SOURCE_USER_NAME = "root";
    private static final String DATA_SOURCE_PASSWORD = "root";
    //所包含的tables（为空则表示生成当前DB下的所有table）
    private static final String[] DATA_SOURCE_INCLUDE_TABLES = new String[] {};
    //java代码包名
    private static final String PACKAGE_NAME = "com.mx.demo";
    //java代码生成路径
    private static final String JAVA_OUTPUT_DIR = System.getProperty("user.dir") + "/src/main/java";
    //mapper.xml生成路径
    private static final String MAPPER_XML_OUTPUT_DIR = System.getProperty("user.dir") + "/src/main/resources/mapper";


    public static void main(String[] args) {
        /** 代码生成器 */
        AutoGenerator mpg = new AutoGenerator();

        /** ========== 1.全局配置 =========== */
        GlobalConfig gc = new GlobalConfig();
        //生成代码输出目录（当前项目根目录下/src/main/java）
        gc.setOutputDir(JAVA_OUTPUT_DIR);
        //作者
        gc.setAuthor(AUTHOR);
        //不打开输出目录
        gc.setOpen(false);
        //生成mapper.xml中包含BaseResultMap
        gc.setBaseResultMap(true);
        //生成mapper.xml中包含BaseResultList
        gc.setBaseColumnList(true);
        //是否覆盖已有文件
        //gc.setFileOverride(true);
        //实体属性 Swagger2 注解
        // gc.setSwagger2(true);
        //日期类型（默认DateType.TIME_PACK，即java.time包下，对应Java8日期类型）
        gc.setDateType(DateType.ONLY_DATE);       
        mpg.setGlobalConfig(gc);

        /** =========== 2.数据源配置 =========== */
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl(DATA_SOURCE_URL);
        // dsc.setSchemaName("public");
        dsc.setDriverName(DATA_SOURCE_DRIVER_NAME);
        dsc.setUsername(DATA_SOURCE_USER_NAME);
        dsc.setPassword(DATA_SOURCE_PASSWORD);
        mpg.setDataSource(dsc);

        /** =========== 4.包配置 =========== */
        PackageConfig pc = new PackageConfig();
        //包名
        pc.setParent(PACKAGE_NAME);
        //模块名
        //pc.setModuleName(scanner("模块名"));
        //设置Entity包名
        pc.setEntity("model.entity");
        mpg.setPackageInfo(pc);

        /** =========== 5.自定义配置（自定义mapper.xml输出至/resources/mapper下） =========== */
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };
        // 如果模板引擎是 freemarker
        String templatePath = "/templates/mapper.xml.ftl";
        // 如果模板引擎是 velocity
        // String templatePath = "/templates/mapper.xml.vm";
        List<FileOutConfig> focList = new ArrayList<>();
        // 自定义配置会被优先输出
        focList.add(new FileOutConfig(templatePath) {
            @Override
            public String outputFile(TableInfo tableInfo) {
                // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                //return String.format("%s/src/main/resources/mapper/%sMapper.xml", projectPath, tableInfo.getEntityName());
                return String.format("%s/%sMapper.xml", MAPPER_XML_OUTPUT_DIR, tableInfo.getEntityName());
            }
        });
        /*
        cfg.setFileCreate(new IFileCreate() {
            @Override
            public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                // 判断自定义文件夹是否需要创建
                checkDir("调用默认方法创建的目录，自定义目录用");
                if (fileType == FileType.MAPPER) {
                    // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                    return !new File(filePath).exists();
                }
                // 允许生成模板文件
                return true;
            }
        });
        */
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        /** =========== 6.配置代码生成模板 =========== */
        TemplateConfig templateConfig = new TemplateConfig();
        // 配置自定义输出模板
        //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
        // templateConfig.setEntity("templates/entity2.java");
        // templateConfig.setService();
        // templateConfig.setController();
        //设置xml为空则不生成mapper.xml（默认生成在代码路径mapper/xml）
        //此处禁用生成mapper.xml，使用上面的自定义配置：将mapper.xml生成至resources/mapper/文件夹下
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        /** =========== 7.策略配置 =========== */
        StrategyConfig strategy = new StrategyConfig();
        //表名、列 - 下划线分割转为驼峰风格
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //lombok风格
        //strategy.setEntityLombokModel(true);
        //@RestController风格
        strategy.setRestControllerStyle(true);


        //公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");

        //包含指定table
        if (ArrayUtils.isNotEmpty(DATA_SOURCE_INCLUDE_TABLES)) {
            strategy.setInclude(DATA_SOURCE_INCLUDE_TABLES);
        }
        //strategy.setControllerMappingHyphenStyle(true);
        //table前缀
        //strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);

        /** =========== 8.设置模版引擎 - freemarker =========== */
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        /** 生成代码 */
        mpg.execute();
    }

}

如上代码，将常用配置提取到static final常量里进行设置，如作者名称、数据源连接信息、包名设置等，通常仅需修改如下常量配置即可连接新的数据源生成新的代码。

 //作者名称
 private static final String AUTHOR = "luohq";
 //mysql数据源连接配置
 private static final String DATA_SOURCE_DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
 private static final String DATA_SOURCE_URL = "jdbc:mysql://localhost:3306/db_msg_push?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=utf-8&allowMultiQueries=true&nullCatalogMeansCurrent=true";
 private static final String DATA_SOURCE_USER_NAME = "root";
 private static final String DATA_SOURCE_PASSWORD = "root";
 //所包含的tables（为空则表示生成当前DB下的所有table）
 private static final String[] DATA_SOURCE_INCLUDE_TABLES = new String[] {};
 //java代码包名
 private static final String PACKAGE_NAME = "com.mx.demo";
 //java代码生成路径
 private static final String JAVA_OUTPUT_DIR = System.getProperty("user.dir") + "/src/main/java";
 //mapper.xml生成路径
 private static final String MAPPER_XML_OUTPUT_DIR = System.getProperty("user.dir") + "/src/main/resources/mapper";

执行上述生成代码后效果如下图：
在这里插入图片描述

三、自定义模版

Mybatis-Plus代码生成器支持Velocity、Freemarker、beetl模版语言，可根据自己需要选择模版语言重写模版，亦可重写mapper、service（如插入log日志）等基类。

默认模版路径（路径+模版类型后缀ftl, vm, btl ==> 即为真正的模版路径）如下图：
在这里插入图片描述
以上默认模版路径可通过TemplateConfig进行设置，
亦可通过InjectionConfig.FileOutConfig进行配置。

默认模版位置如下图：
在这里插入图片描述
红框中的即为不同模版语言对应的模版，由于之前使用rapid-generator + freemarker来生成代码，故对freemarker比较熟悉，
绿框中（*.ftl）的即为freemarker对应的模版，想要重写模版可以参考该默认模版。

罗小爬EX

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
打赏
3
评论
Mybatis plus代码生成器

一、maven依赖<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.4.1</version></dependency><!-- 集成mybati
复制链接

扫一扫