Spring实现MybatisPlus代码自动生成实例

Spring实现MybatisPlus代码自动生成实例。

MyBatis简介

MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。MyBatis 免除了几乎所有的 JDBC 代码以及设置参数和获取结果集的工作。MyBatis 可以通过简单的 XML 或注解来配置和映射原始类型、接口和 Java POJO（Plain Old Java Objects，普通老式 Java 对象）为数据库中的记录。

MyBatis-Plus简介

MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。

AutoGenerator简介

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

引入依赖

MyBatis-Plus 引入的模板引擎为Velocity，也是MyBatis-Plus代码生成器默认的模板引擎。

// mybatis-plus
// https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-boot-starter
implementation group: 'com.baomidou', name: 'mybatis-plus-boot-starter', version: '3.4.1'

// mybatis-plus-generator
// https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-generator
implementation group: 'com.baomidou', name: 'mybatis-plus-generator', version: '3.4.1'

// 模板引擎：velocity
// https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-core
implementation group: 'org.apache.velocity', name: 'velocity-engine-core', version: '2.3'

// mysql-connector
// https://mvnrepository.com/artifact/mysql/mysql-connector-java
implementation group: 'mysql', name: 'mysql-connector-java', version: '8.0.22'

CodeGenerator类实现

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import static com.baomidou.mybatisplus.annotation.IdType.ASSIGN_ID;

/**
 * @author 曳戈泰尔
 * @description mybatis-plus代码生成器(全)
 * @date 2022-01-03
 */
public class CodeGeneratorUtil {

    private static String driverName = "com.mysql.cj.jdbc.Driver";

    private static String url =
            "jdbc:mysql://xxx:3306/xxx?useUnicode=true&characterEncoding=UTF-8&useSSL=false&autoReconnect=true&failOverReadOnly=false&serverTimezone=GMT%2B8&zeroDateTimeBehavior=convertToNull&allowPublicKeyRetrieval=true";

    private static String username = "xxx";

    private static String password = "xxx";

    /** 要自动生成代码的数据库表名 */
    private static String[] TABLE_NAMES = new String[] {"xxx"};

    // 执行入口
    public static void main(String[] args) {

        // 创建代码生成器
        AutoGenerator mpg = new AutoGenerator();

        /** MyBatis-Plus 的默认模板引擎是 Velocity 选择非默认引擎，需要在 AutoGenerator 中设置模板引擎。 */
        // set freemarker engine
        // mpg.setTemplateEngine(new FreemarkerTemplateEngine());
        // set beetl engine
        // mpg.setTemplateEngine(new BeetlTemplateEngine());
        // set custom engine (reference class is your custom engine class)
        // mpg.setTemplateEngine(new CustomTemplateEngine());

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        // 获取当前项目的路径
        String projectPath = System.getProperty("user.dir");
        // 项目源代码的路径，建议绝对路径
        gc.setOutputDir(projectPath + "/src/main/java");
        // 是否覆盖
        gc.setFileOverride(true);
        // 生成后是否打开资源管理器
        gc.setOpen(false);
        // 实体类继承Model
        gc.setActiveRecord(false);
        // XML 二级缓存
        // gc.setEnableCache(false);
        // 配置xml文件生成通用查询结果集
        // gc.setBaseResultMap(true);
        // 配置xml文件生成字段映射
        // gc.setBaseColumnList(true);
        // 生成注释的作者
        gc.setAuthor("曳戈泰尔");
        // 指定主键生成策略为雪花算法
        gc.setIdType(ASSIGN_ID);
        // 开启Swagger2模式
        gc.setSwagger2(true);
        // 自定义文件命名，注意 %s 会自动填充表实体属性
        // gc.setControllerName("%sController");
        // 默认service接口名IXXXService
        // 自定义指定为XXXService
        gc.setServiceName("%sService");
        // 自定义service实现类命名
        gc.setServiceImplName("%sServiceImpl");
        // 自定义注解实现Mapper命名
        gc.setMapperName("%sMapper");
        // 自定义XML实现Mapper命名
        // gc.setXmlName("%sXml");
        // 自定义实体Entity命名
        gc.setEntityName("%sEntity");
        // 设置全局配置
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        // 数据库类型
        dsc.setDbType(DbType.MYSQL);
        // 连接数据库Driver
        dsc.setDriverName(driverName);
        // 数据库用户名
        dsc.setUsername(username);
        // 数据库密码
        dsc.setPassword(password);
        // 数据库连接url
        dsc.setUrl(url);
        mpg.setDataSource(dsc);

        // 包配置
        PackageConfig pc = new PackageConfig();
        // 设置父包
        pc.setParent("com.cec");
        // 设置模块名
        pc.setModuleName("secondFloorSpace");
        // 设置实体模块，路径为com.cec.secondFloorSpace.model
        pc.setEntity("entity");
        // 设置mapper模块
        pc.setMapper("mapper");
        // 设置XML模块
        // pc.setXml("mapper.xml");
        // 设置服务层接口模块
        pc.setService("service");
        // 设置服务实现层模块
        pc.setServiceImpl("service.impl");
        // 设置控制层模块
        // pc.setController("controller");
        mpg.setPackageInfo(pc);

        // 配置模板
        TemplateConfig templateConfig = new TemplateConfig();
        // 不生成controller
        templateConfig.setController("");
        // 不生成mapper.xml
        templateConfig.setXml("");
        mpg.setTemplate(templateConfig);

        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        // 数据库表映射到实体的命名策略，驼峰命名法
        strategy.setNaming(NamingStrategy.underline_to_camel);
        // 表字段映射，驼峰命名法
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 需要进行自动生成的数据表名列表
        strategy.setInclude(TABLE_NAMES);
        // 生成实体时去掉表前缀
        // strategy.setTablePrefix("test_");
        // 实体增加Lombok模型
        strategy.setEntityLombokModel(true);
        // Restful API风格控制器
        strategy.setRestControllerStyle(true);
        // url中驼峰转连字符
        strategy.setControllerMappingHyphenStyle(false);
        mpg.setStrategy(strategy);

        // 执行生成
        mpg.execute();
    }
}

生成主体代码

右键执行main方法，代码自动生成。