idea根据数据表自动生成控制层、服务层、持久层的代码
写在前面,遇到的小问题:1.生成的mapper接口文件,需要自己加上@Mapper注解,2. 如果在当前项目中运行测试生成的代码,需要把代码生成器GeneratorApp.java以及依赖mybatis-plus-generator注释掉或者删掉
AutoGenerator 是 MyBatis-Plus 的代码生成器,通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码,极大的提升了开发效率。
适用版本:mybatis-plus-generator 3.5.1 以下版本
- 添加 数据库、 代码生成器、 模板引擎 和 swagger2 依赖。
MyBatis-Plus 支持 Velocity(默认)、Freemarker、Beetl等引擎,用户可以选择自己熟悉的模板引擎,如果都不满足您的要求,可以采用自定义模板引擎。默认模板Velocity足够使用
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.9</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>dzxx</groupId>
<artifactId>codegenerator</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>codegenerator</name>
<description>codegenerator project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--代码生成器的依赖-->
<!-- https://mvnrepository.com/artifact/com.baomidou/mybatis-plus-generator -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.velocity/velocity-engine-core -->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>com.mysql</groupId>
<artifactId>mysql-connector-j</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
2.编写生成代码文件,
MyBatis-Plus 的代码生成器提供了大量的自定义参数供用户选择,能够满足绝大部分人的使用需求。
在src\main\java\dzxx\crud\ 目录下创建在GeneratorApp.java文件,对参数进行配置。
然后执行 main 方法,在控制台输入模块名和表名,回车自动生成代码至对应项目目录中
package dzxx.crud;
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 java.util.ArrayList;
import java.util.List;
import java.util.Scanner;
public class GeneratorApp {
/**
* 读取控制台内容
*/
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 + "!");
}
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.setAuthor("chx");
//设置生成是不是要打开所在文件夹
gc.setOpen(false);
//设置生成swagger,需要添加swagger依赖
gc.setSwagger2(true);
//在mapper.xml生成一个基础的《resultMap>映射所有的字段
gc.setBaseResultMap(true);
//设置同文件生成的覆盖
gc.setFileOverride(true);
//设置实体名:直接用表名 %s=表名
gc.setEntityName("%s");
//设置mapper接口名
gc.setMapperName("%sMapper");
//设置mapper.xml名
gc.setXmlName("%sMapper");
//设置service 接口名称
gc.setServiceName("%sService");
//设置 serviceImp 名称
gc.setServiceImplName("%sServiceImp");
//设置controller 名称
gc.setControllerName("%sController");
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("1234");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
//设置包名
pc.setParent("dzxx.crud");
//完整的包名:dzxx.crud.模块名
mpg.setPackageInfo(pc);
//把已有的xml生成位置取消
TemplateConfig templateConfig=new TemplateConfig();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 自定义配置, 主要设置mapper.xml文件的生成名称和位置
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";
// 自定义输出配置 mapper.xml文件的位置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
//表名的生成策略,下划线转驼峰
strategy.setNaming(NamingStrategy.underline_to_camel);
//列名的生成策略,下划线转驼峰
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
// strategy.setEntityLombokModel(true);
//在controller类上是否生成@RestController
strategy.setRestControllerStyle(true);
// 公共父类
// strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
// strategy.setSuperEntityColumns("id");
//按表的前缀模糊生成实体
// strategy.setLikeTable(new LikeTable("stu_"));
//按表名生成实体
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
//设置controller请求路径:比如:表pms_product生成的对应controller路径为:@RequestMapping("/pms/product")
strategy.setControllerMappingHyphenStyle(true);
//设置把表前缀替换掉,比如shop_stu_cat_,生成entity、service、controller名称为:stu_cat
strategy.setTablePrefix("shop_");
mpg.setStrategy(strategy);
// mpg.setTemplateEngine(new FreemarkerTemplateEngine());
//进行生成
mpg.execute();
}
}