mybatis-plus-generator 代码生成工具快速使用
- 导入依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.1.tmp</version>
</dependency>
<!--mybatis-plus-generator 依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!--freemarker 依赖-->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
</dependency>
<!--mysql 依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
- 创建CodeGenerator 代码生成工具类
public class CodeGenerator {
// 需要自动构建的表 使用 “,” 隔开
static String TableNames = "t_admin,t_admin_role";
// 基本配置
static String outputDir = ""; // 输出路径 不设置则生成到当前工程中 / 设置后则生成到指定目录下的 generator 中
static String Author = "YangYuFu"; //作者
static boolean openSwagger = true; //是否开启 Swagger
// 数据源配置
static String dbDriverName = "com.mysql.cj.jdbc.Driver";
static String dbUrl = "jdbc:mysql://localhost:3306/yeb?useUnicode=true&useSSL=false&characterEncoding=utf8";
static String dbUserName = "root";
static String dbPassword = "root";
// 包配置
static String moduleName = "yeb-generator"; //设置模块名称,一个工程有多个模块时 可指定生成到哪个模块中 (在outputDir==null 或者 outputDir ==“” 时生效)
static String packageParent = "com.potato";
static String packageEntity = "pojo";
static String packageMapper = "mapper";
static String packageService = "service";
static String packageServiceImpl = "service.impl";
static String packageController = "controller";
// 策略配置
static boolean openLombok = true; // 是否设置 @Data 注解
static boolean openRestController = true; // 是否设置 @RestController 注解
static boolean openControllerMappingHyphenStyle = true; // 驼峰转连字符
static String tablePrefix = "t_"; // 表前缀
static {
// 设置输出路径
// System.getProperty("user.dir") 获取当前工程的路径
if (StringUtils.isBlank(outputDir)) {
outputDir = System.getProperty("user.dir") + "/" + moduleName + "/src/main";
}else {
outputDir = outputDir + "/generator";
}
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setOutputDir(outputDir + "/java");
gc.setAuthor(Author);
gc.setOpen(false);
// 实体属性 Swagger2 注解
gc.setSwagger2(openSwagger);
gc.setIdType(IdType.ASSIGN_UUID);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(dbUrl);
dsc.setDriverName(dbDriverName);
dsc.setUsername(dbUserName);
dsc.setPassword(dbPassword);
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent(packageParent)
.setEntity(packageEntity)
.setMapper(packageMapper)
.setService(packageService)
.setServiceImpl(packageServiceImpl)
.setController(packageController);
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
return outputDir + "/resources/mapper/"
+ tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
// 指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
// 数据库表映射到实体的命名策略
strategy.setNaming(NamingStrategy.underline_to_camel);
// 数据库表字段映射到实体属性的命名策略
strategy.setColumnNaming(NamingStrategy.no_change);
// 设置 Lombok
strategy.setEntityLombokModel(openLombok);
// 设置 RestController
strategy.setRestControllerStyle(openRestController);
strategy.setInclude(TableNames.split(","));
// 驼峰转连字符
strategy.setControllerMappingHyphenStyle(openControllerMappingHyphenStyle);
// 设置前缀
strategy.setTablePrefix(tablePrefix);
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
- 启动main方法 就可生成代码了
注意事项:
该配置中由于开启了swaager,并且设置了 Lombok ,RestController …等等相关的功能,所以当代码生成到当前工程里面后就不能二次运行,原因是缺少依赖
解决方案:
第一种:输出到其他位置,不输出到当前工程模块中
第二种:删除生成的 java文件
第三种:添加依赖(一劳永逸的方案) ,具体添加什么依赖,视情况而定
<!--web 依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--lombok 依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- swagger2 依赖 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.7.0</version>
</dependency>