Mybatis Plus 代码生成器 自定义模板

1. 创建数据库

DROP TABLE IF EXISTS `user`;

CREATE TABLE `user`
(
    id BIGINT NOT NULL COMMENT '主键ID',
    name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
    age INT NULL DEFAULT NULL COMMENT '年龄',
    email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
    PRIMARY KEY (id)
);

DELETE FROM `user`;

INSERT INTO `user` (id, name, age, email) VALUES
(1, 'Jone', 18, 'test1@baomidou.com'),
(2, 'Jack', 20, 'test2@baomidou.com'),
(3, 'Tom', 28, 'test3@baomidou.com'),
(4, 'Sandy', 21, 'test4@baomidou.com'),
(5, 'Billie', 24, 'test5@baomidou.com');

2. 引入依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
    <version>3.5.6</version>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.6</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-freemarker</artifactId>
    <version>3.2.5</version>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <scope>annotationProcessor</scope>
</dependency>
<dependency>
    <groupId>cn.hutool</groupId>
    <artifactId>hutool-all</artifactId>
    <version>5.8.27</version>
</dependency>

3. 编写工具类

package com.jackieyang.mybatisplusdemo.utils;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.builder.CustomFile;
import com.baomidou.mybatisplus.generator.config.rules.DbColumnType;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import freemarker.template.Configuration;
import freemarker.template.Template;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.io.File;
import java.io.FileWriter;
import java.io.Writer;
import java.nio.file.Paths;
import java.sql.Types;
import java.util.Collections;
import java.util.Map;

@Component
public class CodeGeneratorUtil {

    private static String url;
    private static String username;
    private static String password;
    private static final String AUTHOR = "Jackie Yang";
    private static final String PROJECT_PATH = String.valueOf(Paths.get(System.getProperty("user.dir")));
    private static final String PACKAGE_NAME = "com.jackieyang.mybatisplusdemo";


    public CodeGeneratorUtil(@Value("${spring.datasource.url}") String url, @Value("${spring.datasource.username}") String username, @Value("${spring.datasource.password}") String password) {
        CodeGeneratorUtil.url = url;
        CodeGeneratorUtil.username = username;
        CodeGeneratorUtil.password = password;
    }

    public static void generateResponseEntity() {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
        try {
            // 创建文件
            cfg.setDirectoryForTemplateLoading(new File(PROJECT_PATH + "/src/main/resources/templates"));
            cfg.setDefaultEncoding("UTF-8");
            Template template = cfg.getTemplate("responseEntity.java.ftl");
            Map<String, Object> data = Collections.singletonMap("packageName", PACKAGE_NAME);
            // 生成文件
            File outputFile = new File(PROJECT_PATH + "/src/main/java/" + PACKAGE_NAME.replace(".", "/") + "/entity/pojo/ResponseEntity.java");
            if (!outputFile.getParentFile().exists()) {
                outputFile.getParentFile().mkdirs();
            }
            Writer out = new FileWriter(outputFile);
            template.process(data, out);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void generateExceptionHandler() {
        Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
        try {
            // 创建文件
            cfg.setDirectoryForTemplateLoading(new File(PROJECT_PATH + "/src/main/resources/templates"));
            cfg.setDefaultEncoding("UTF-8");
            Template template = cfg.getTemplate("globalExceptionHandler.java.ftl");
            Map<String, Object> data = Collections.singletonMap("packageName", PACKAGE_NAME);
            // 生成文件
            File outputFile = new File(PROJECT_PATH + "/src/main/java/" + PACKAGE_NAME.replace(".", "/") + "/exception/GlobalExceptionHandler.java");
            if (!outputFile.getParentFile().exists()) {
                outputFile.getParentFile().mkdirs();
            }
            Writer out = new FileWriter(outputFile);
            template.process(data, out);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public static void generate(String dbTableName) {
        FastAutoGenerator.create(url, username, password)
                .globalConfig(builder -> {
                    builder.author(AUTHOR) // 设置作者
                            .outputDir(PROJECT_PATH + "/src/main/java"); // 设置输出目录
                })
                .dataSourceConfig(builder ->
                        builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
                            int typeCode = metaInfo.getJdbcType().TYPE_CODE;
                            if (typeCode == Types.SMALLINT) {
                                // 自定义类型转换
                                return DbColumnType.INTEGER;
                            }
                            return typeRegistry.getColumnType(metaInfo);
                        })
                )
                .injectionConfig(builder ->
                        builder.customFile(customFile("Dto.java", "/templates/dto.java.ftl", PROJECT_PATH + "/src/main/java/" + PACKAGE_NAME.replace(".", "/") + "/entity/dto")) // dto模板注入
                                .customFile(customFile("Vo.java", "/templates/vo.java.ftl", PROJECT_PATH + "/src/main/java/" + PACKAGE_NAME.replace(".", "/") + "/entity/vo")) // vo模板注入
                )
                .packageConfig(builder ->
                        builder.parent(PACKAGE_NAME) // 设置父包名
                                .controller("controller") // 设置controller包名
                                .entity("entity.pojo") // 设置entity包名
                                .mapper("mapper") // 设置mapper包名
                                .service("service") // 设置service包名
                                .serviceImpl("service.impl") // 设置serviceImpl包名
                                .pathInfo(Collections.singletonMap(OutputFile.xml, PROJECT_PATH + "/src/main/resources/mapper")) // 设置mapper.xml输出目录
                )
                .strategyConfig(builder ->
                        builder.addInclude(dbTableName) // 设置需要生成内容的表名
                                .controllerBuilder()
                                    .template("/templates/controller.java") // 设置controller模板
                                    .enableRestStyle() // 开启restController模式
                                    .enableFileOverride() // 开启文件覆盖
                                .entityBuilder()
                                    .javaTemplate("/templates/entity.java") // 设置entity模板
                                    .enableLombok() // 开启lombok模式
                                    .enableTableFieldAnnotation() // 开启字段注解
                                    .enableFileOverride() // 开启文件覆盖
                                .mapperBuilder()
                                    .mapperTemplate("/templates/mapper.java") // 设置mapper模板
                                    .mapperXmlTemplate("/templates/mapper.xml") // 设置mapper.xml模板
                                    .enableFileOverride() // 开启文件覆盖
                                .serviceBuilder()
                                    .serviceTemplate("/templates/service.java") // 设置service模板
                                    .serviceImplTemplate("/templates/serviceImpl.java") // 设置serviceImpl模板
                                    .formatServiceFileName("%sService") // 设置service接口名称, 去除自带的I前缀
                                    .enableFileOverride()
                )
                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板
                .execute();
    }

    private static CustomFile customFile(String fileName, String templatePath, String outputFilePath) {
        return new CustomFile.Builder()
                .filePath(outputFilePath)
                .fileName(fileName)
                .templatePath(templatePath)
                .build();
    }

}

4. 引入自定义模板 放入 resources下的templates目录中

下载顶部自定义模板资源

5. 连接数据库

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis-plus-demo?useUnicode=true&characterEncoding=utf-8&useSSL=false
    driver-class-name: com.mysql.cj.jdbc.Driver
    username: root
    password: 12345678

mybatis-plus:
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

6. 通过 test 完成生成

@SpringBootTest
class UserMapperTest {

    @Test
    void test() {
        CodeGeneratorUtil.generateResponseEntity();
        CodeGeneratorUtil.generateExceptionHandler();
        CodeGeneratorUtil.generate("user");
    }

}