MyBatis-Plus代码生成器(新)的使用

2024-05-19后端2 分钟233 次阅读
AI 摘要salmon-ai

本文详细解析了 MyBatis-Plus 3.5.2 新版

前言

最近在新项目引入 mybatis-plus,顺便附上之前写的代码生成器,但在这个项目我用了 3.5.2 版本,以前是 3.4.2 版本,发现之前挺多类变成私有了,简单看了源代码后,新的构建方式采用生成器模式来构建配置。

官方也给了新版代码生成器的例子:https://baomidou.com/guides/new-code-generator/

下面我给大家介绍下如何使用新版的生成器。

教程

1. 引入依赖

xml 复制代码
<!--mybatis-plus 代码自动生成-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.2</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>

2. 编写代码

java 复制代码
package com.salmon.backend.generate;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import com.baomidou.mybatisplus.generator.fill.Column;
import org.springframework.util.StringUtils;

import java.util.Collections;
import java.util.Scanner;

/**
 * 代码生成器
 *
 * @author Salmon
 * @since 2024-05-19
 */
public class CodeGenerator {

    private static final String ROOT_PACKAGE_NAME = "com.salmon.backend";
    private static final String MYSQL_URL = "127.0.0.1:3306";
    private static final String DATABASE = "my_db";
    private static final String MYSQL_USERNAME = "root";
    private static final String MYSQL_PASSWORD = "123456";


    private static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        String help = "请输入" + tip + ":";
        System.out.println(help);
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.hasText(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    public static void main(String[] args) {
        String projectPath = System.getProperty("user.dir") + "/my-backend";
        FastAutoGenerator.create(
                        "jdbc:mysql://" + MYSQL_URL + "/" + DATABASE + "?useUnicode=true&useSSL=false&characterEncoding=utf8",
                        MYSQL_USERNAME,
                        MYSQL_PASSWORD
                ).globalConfig(builder -> {
                    builder.author("Salmon") // 设置作者 baomidou 默认值:作者
                            .enableSwagger() // 开启 swagger 模式 默认值:false
                            .disableOpenDir() //禁止打开输出目录 默认值:true
                            .fileOverride() // 覆盖已生成文件 默认值:false
                            .commentDate("yyyy-MM-dd") // 注释日期
                            .dateType(DateType.TIME_PACK) // 定义生成的实体类中日期类型 DateType.ONLY_DATE 默认值: DateType.TIME_PACK
                            .outputDir(projectPath + "/src/main/java"); // 指定输出目录 /opt/baomidou/ 默认值: windows:D: // linux or mac : /tmp
                }).packageConfig(builder -> {
                    builder.parent(ROOT_PACKAGE_NAME) // 父包模块名 默认值:com.baomidou
                            .controller("controller") //Controller 包名 默认值:controller
                            .entity("model.entity") // Entity 包名 默认值:entity
                            .service("service") // Service 包名 默认值:service
                            .mapper("mapper") // Mapper 包名 默认值:mapper
                            .moduleName("") // 设置父包模块名 默认值:无
                            .pathInfo(Collections.singletonMap(OutputFile.xml, projectPath + "/src/main/resources/mapper")); // 设置 mapperXml 生成路径
                }).strategyConfig(builder -> {
                    builder.addInclude(scanner("表名,多个英文逗号分割").split(",")) // 设置需要生成的表名 可边长参数“user”, “user1”
                            .addTablePrefix("tb_") // 设置过滤表前缀
                            // service策略配置
                            .serviceBuilder()
                            .formatServiceFileName("I%sService")
                            .formatServiceImplFileName("%sServiceImpl")
                            // 实体类策略配置
                            .entityBuilder()
                            .idType(IdType.AUTO)//主键策略  数据库自增ID,可修改策略为雪花算法
                            .addTableFills(new Column("create_time", FieldFill.INSERT)) // 自动填充配置
                            .addTableFills(new Column("createTime", FieldFill.INSERT)) // 自动填充配置
                            .addTableFills(new Column("update_time", FieldFill.UPDATE)) // 自动填充配置
                            .addTableFills(new Column("updateTime", FieldFill.UPDATE)) // 自动填充配置
                            .enableLombok() //开启lombok
                            .logicDeleteColumnName("isDelete") // 说明逻辑删除是哪个字段
                            .versionColumnName("version") // 乐观锁字段
                            .enableTableFieldAnnotation() // 属性加上注解说明
                            // controller 策略配置
                            .controllerBuilder()
                            .formatFileName("%sController")
                            .enableRestStyle() // 开启RestController注解
                            // mapper策略配置
                            .mapperBuilder()
                            .formatMapperFileName("%sMapper")
                            .enableMapperAnnotation() // @mapper注解开启
                            .formatXmlFileName("%sMapper");
                }).templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
                .execute();
    }
}

3、测试

运行 main 方法,输入待生成的表名
image.png
查看目录,可以看到生成的文件了
image.png
image.png

觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句