Springboot Mybatis Plus代码自动生成工具类


前言

代码生成器,也叫逆向工程,是根据数据库里的表结构,自动生成对应的实体类、映射文件和接口。

看到很多小伙伴在为数据库生成实体类发愁,现分享给大家,提高开发效率。


一、pom依赖

<dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
            <version>3.4.1</version>
        </dependency>
        <dependency>
            <groupId>org.freemarker</groupId>
            <artifactId>freemarker</artifactId>
            <version>2.3.30</version>
        </dependency>

二、工具类

package com.his.utils;

import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.core.toolkit.StringPool;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
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;
import java.util.Scanner;

/**
 * Mybatis plus代码自动生成
 */
public class MybatisPlusUtil {
    /** 作者 */
    public static final String AUTHOR = "dd";

    /** 类命名 */
    /**
     * Entity命名
     */
    public static final String FILE_NAME_ENTITY = "%sEntity";
    /**
     * MAPPER命名
     */
    public static final String FILE_NAME_MAPPER = "%sMapper";
    /**
     * xml命名
     */
    public static final String FILE_NAME_XML = "%sMapper";
    /**
     * Service命名
     */
    public static final String FILE_NAME_SERVICE = "%sService";
    /**
     * ServiceImpl命名
     */
    public static final String FILE_NAME_SERVICE_IMPL = "%sDO";
    /**
     * Controller命名
     */
    public static final String FILE_NAME_CONTROLLER = "%sController";

    /**
     包命名,可以根据自己的项目情况自定义生成后的存放路径
     entity默认路径为父目录.entity
     mapper默认路径为父目录.mapper
     service默认路径为父目录.service
     serviceImpl默认路径为父目录.service.impl
     controller默认路径为父目录.controller
     */
    /**
     * PARENT命名
     */
    public static final String PACKAGE_NAME_PARENT = "com.his";
    /**
     * Entity命名
     */
    public static final String PACKAGE_NAME_ENTITY = "repository.entity.control";
    /**
     * MAPPER命名
     */
    public static final String PACKAGE_NAME_MAPPER = "repository.mapper.control";
    /**
     * xml命名
     */
    public static final String PACKAGE_NAME_XML = "sys";
    /**
     * Service命名
     */
    public static final String PACKAGE_NAME_SERVICE = "domain.control";
    /**
     * ServiceImpl命名
     */
    public static final String PACKAGE_NAME_SERVICE_IMPL = "domain.control";
    /**
     * Controller命名
     */
    public static final String PACKAGE_NAME_CONTROLLER = "facade.controller.control";

    /**
     * 读取控制台内容
     */
    private static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + ":");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    /**
     * 运行这个main方法进行代码生成
     */
    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setFileOverride(true);
        gc.setAuthor(AUTHOR);
        gc.setOpen(false);
        gc.setActiveRecord(false);// 不需要ActiveRecord特性的请改为false
        gc.setEnableCache(false);// XML 二级缓存
        gc.setSwagger2(true); // 实体属性 Swagger2 注解
        gc.setBaseResultMap(true);
        gc.setBaseColumnList(true);

        gc.setEntityName(FILE_NAME_ENTITY);
        gc.setMapperName(FILE_NAME_MAPPER);
        gc.setXmlName(FILE_NAME_XML);
        gc.setServiceName(FILE_NAME_SERVICE);
        gc.setServiceImplName(FILE_NAME_SERVICE_IMPL);
        gc.setControllerName(FILE_NAME_CONTROLLER);
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:oracle:thin:@ip:port/test");
        dsc.setDriverName("oracle.jdbc.OracleDriver");
        dsc.setUsername("user");
        dsc.setPassword("pass");
        mpg.setDataSource(dsc);

        //包配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName(null);
        pc.setParent(PACKAGE_NAME_PARENT);
        pc.setController(PACKAGE_NAME_CONTROLLER);
        pc.setService(PACKAGE_NAME_SERVICE);
        pc.setServiceImpl(PACKAGE_NAME_SERVICE_IMPL);
        pc.setMapper(PACKAGE_NAME_MAPPER);
        pc.setEntity(PACKAGE_NAME_ENTITY);
        pc.setXml(PACKAGE_NAME_XML);
        mpg.setPackageInfo(pc);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        // 设置表前缀
        strategy.setTablePrefix("IEMR_");
        mpg.setStrategy(strategy);
        mpg.setTemplateEngine(new FreemarkerTemplateEngine());

        // 自定义配置
        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 projectPath + "/src/main/resources/mapper/"
                        + "/" + tableInfo.getMapperName() + StringPool.DOT_XML;
            }
        });
        cfg.setFileOutConfigList(focList);
        mpg.setCfg(cfg);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        templateConfig.setXml(null);
        mpg.setTemplate(templateConfig);

        mpg.execute();
    }
}


结尾

  • 感谢大家的耐心阅读,如有建议请私信或评论留言。
  • 如有收获,劳烦支持,关注、点赞、评论、收藏均可,博主会经常更新,与大家共同进步
Mybatis Plus 是一款 Mybatis 的增强工具,可以简化开发人员的开发工作量。Mybatis Plus 提供了一个代码生成器,可以根据数据库表结构自动生成实体类、Mapper 接口和 XML 映射文件等代码,大大提高了开发效率。 下面是使用 Spring Boot 和 Mybatis Plus 的代码生成器的步骤: 1. 在 pom.xml 文件中添加 Mybatis Plus 和相应的数据库驱动依赖。 ```xml <!-- Mybatis Plus --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.4.3.1</version> </dependency> <!-- 数据库驱动 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>8.0.25</version> </dependency> ``` 2. 在 application.yml 文件中配置数据库连接信息。 ```yaml spring: datasource: url: jdbc:mysql://localhost:3306/db_name?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai username: root password: root ``` 3. 编写代码生成器的配置。 ```java package com.example.demo.config; import com.baomidou.mybatisplus.annotation.DbType; import com.baomidou.mybatisplus.annotation.IdType; import com.baomidou.mybatisplus.generator.AutoGenerator; import com.baomidou.mybatisplus.generator.config.DataSourceConfig; import com.baomidou.mybatisplus.generator.config.GlobalConfig; import com.baomidou.mybatisplus.generator.config.PackageConfig; import com.baomidou.mybatisplus.generator.config.StrategyConfig; import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy; import org.springframework.context.annotation.Configuration; @Configuration public class CodeGeneratorConfig { public void generateCode() { String packageName = "com.example.demo"; // 包名 String[] tableNames = {"user", "role"}; // 表名 // 全局配置 GlobalConfig config = new GlobalConfig(); config.setAuthor("Your Name") // 作者 .setOutputDir(System.getProperty("user.dir") + "/src/main/java") // 生成路径 .setFileOverride(true) // 是否覆盖已有文件 .setIdType(IdType.AUTO) // 主键策略 .setServiceName("%sService") // 生成的 Service 接口名称首字母是否为 I .setBaseResultMap(true) // 是否生成基本的 ResultMap .setBaseColumnList(true); // 是否生成基本的 SQL 片段 // 数据源配置 DataSourceConfig dataSourceConfig = new DataSourceConfig(); dataSourceConfig.setDbType(DbType.MYSQL) // 数据库型 .setUrl("jdbc:mysql://localhost:3306/db_name?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai") // 数据库连接地址 .setUsername("root") // 数据库用户名 .setPassword("root"); // 数据库密码 // 策略配置 StrategyConfig strategyConfig = new StrategyConfig(); strategyConfig.setCapitalMode(true) // 全局大写命名 .setNaming(NamingStrategy.underline_to_camel) // 数据库表映射到实体的命名策略 .setColumnNaming(NamingStrategy.underline_to_camel) // 数据库表字段映射到实体的命名策略 .setInclude(tableNames) // 需要生成的表 .setRestControllerStyle(true) // 是否生成 @RestController 控制器 .setEntityLombokModel(true) // 是否使用 Lombok 注解 .setControllerMappingHyphenStyle(true); // 驼峰转连字符 // 包名配置 PackageConfig packageConfig = new PackageConfig(); packageConfig.setParent(packageName) .setEntity("entity") .setMapper("mapper") .setService("service") .setController("controller"); // 代码生成器 AutoGenerator generator = new AutoGenerator(); generator.setGlobalConfig(config) .setDataSource(dataSourceConfig) .setStrategy(strategyConfig) .setPackageInfo(packageConfig); generator.execute(); } } ``` 4. 在启动中调用代码生成器的配置。 ```java package com.example.demo; import com.example.demo.config.CodeGeneratorConfig; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); // 调用代码生成器 CodeGeneratorConfig generatorConfig = new CodeGeneratorConfig(); generatorConfig.generateCode(); } } ``` 5. 运行程序,代码生成器将在指定的目录下生成相应的代码文件。 注意,代码生成器会覆盖指定目录下的已有文件。请在使用代码生成器前备份好原有代码。 以上是使用 Spring Boot 和 Mybatis Plus 的代码生成器的简单示例。你可以根据实际需要调整配置中的参数和方法来生成符合你需求的代码。
评论 33
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Xd聊架构

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值