springboot +mybatis-plus 实现代码生成器
一、代码生成器
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
二、实现过程
1.添加依赖
MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖,需要手动添加相关依赖:
- 添加 代码生成器 依赖
<!--mybatis-plus代码生成器-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
- 添加 模板引擎 依赖,MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。
<!--velocity 模板引擎,Mybatis Plus 代码生成器需要-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<!--mybatis-plus逆向功能所需的模板引擎-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
注意:如果您选择了非默认引擎,需要在 AutoGenerator 中 设置模板引擎。
AutoGenerator generator = new AutoGenerator();
// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());
// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());
// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());
// other config
...
2.编写生成器
package com.example.mybatisgenerator.utils;
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.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
/**
* @author qzz
*/
public class CodeGenerateUtils {
/**
* 运行main方法进行代码生成
* @param args
*/
public static void main(String[] args) {
//1.创建代码生成器
AutoGenerator autoGenerator = new AutoGenerator();
//2.全局配置
GlobalConfig gc = new GlobalConfig();
//String projectPath = System.getProperty("user.dir");
//建议直接使用项目绝对路径,以防相对路径找不到出错
gc.setOutputDir("D:\\generator" + "/src/main/java");
//作者
gc.setAuthor("admin");
//生成后是否打开资源管理员
gc.setOpen(false);
//重新生成时文件是否覆盖
gc.setFileOverride(false);
//主键策略
gc.setIdType(IdType.AUTO);
//定义生成的实体类中日期类型
gc.setDateType(DateType.ONLY_DATE);
//开启swagger2模式(Swagger和项目整合用于请求测试)
gc.setSwagger2(true);
autoGenerator.setGlobalConfig(gc);
//3.数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/db_test?serverTimezone=UTC&useUnicode=true&characterEncoding=UTF-8");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("root");
dsc.setDbType(DbType.MYSQL);
autoGenerator.setDataSource(dsc);
//4.包配置
PackageConfig pc = new PackageConfig();
//模块名
pc.setModuleName("");
pc.setParent("com.example");
pc.setController("controller");
pc.setEntity("entity");
pc.setService("service");
pc.setMapper("mapper");
autoGenerator.setPackageInfo(pc);
//5.策略配置
StrategyConfig strategy = new StrategyConfig();
//填写表名,帮助生成实体类等mapper相应代码
strategy.setInclude("test_user");
//数据库表映射到实体的命名策略
strategy.setNaming(NamingStrategy.underline_to_camel);
//生成实体时去掉表前缀
strategy.setTablePrefix(pc.getModuleName()+"_");
//数据库表字段映射到实体的命名策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
//lombok 模型 @Accessors(chain = true) setter链式操作
strategy.setEntityLombokModel(true);
//restful api 风格控制器
strategy.setRestControllerStyle(true);
//url 中驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
autoGenerator.setStrategy(strategy);
//6.执行
autoGenerator.execute();
}
}