一、前言
在项目开发中,如果我们的数据库表很多,那就需要花费大量的时间去写对应的Entity、Mapper、Service、Controller等等,如果每次都要去写这些跟业务毫不相干且又耗时耗力的重复代码的话,效率是很低的。所以我们可以利用代码生成器来生成这些固定的代码,大大提高了开发效率~
二、使用前的说明
-
版本说明
jdk
:1.8mysql
:8springboot
:2.7.3mybatis-plus
:3.5.3mybatis-plus-generator
:3.5.1
-
注意!!!
如果你的mybatis-plus-generator是3.5.1 及其以上版本参考代码生成器的使用(新)
如果你的mybatis-plus-generator是3.5.1 以下版本参考代码生成器的使用(老)
三、代码生成器的使用(新)
1、注入相关依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.3</version>
</dependency>
2、代码生成器(交互式生成)
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.fill.Column;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.ResourceBundle;
public class CodeGenerator {
private static List<String> getTables(String tables) {
return "all".equals(tables) ? Collections.emptyList() : Arrays.asList(tables.split(","));
}
public static void main(String[] args) {
ResourceBundle res = ResourceBundle.getBundle("database");
FastAutoGenerator.create(res.getString("db.url"), res.getString("db.username"), res.getString("db.password"))
// 全局配置
.globalConfig((scanner, builder) -> builder
.author(scanner.apply("请输入作者名称:"))
.fileOverride() //允许重新文件
.enableSwagger() //开启swagger
.disableOpenDir() //禁止生成成功打开文件夹
.outputDir(res.getString("g.output.dir")) //设置输出路径
)
// 包配置
.packageConfig((scanner, builder) -> builder
.parent(res.getString("pkg.name"))
.moduleName(scanner.apply("输入模块名称:"))
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, res.getString("g.output.dir") + "\\..\\resources\\" + res.getString("pkg.xml.dir")))
)
// 策略配置
.strategyConfig((scanner, builder) -> builder
.addInclude(getTables(scanner.apply("请输入表名,多个英文逗号分隔,所有输入all:")))
//过滤表名前缀
.addTablePrefix("")//
.serviceBuilder().formatServiceFileName("%sService").formatServiceImplFileName("%sServiceImpl")
.controllerBuilder().enableRestStyle().enableHyphenStyle()
.mapperBuilder().enableMapperAnnotation().superClass(BaseMapper.class)
.entityBuilder().enableLombok().enableTableFieldAnnotation().addTableFills(new Column("create_time", FieldFill.INSERT))
.logicDeleteColumnName("")//说明逻辑删除是哪个字段
.build()
)
.execute();
}
}
3、数据库配置文件(database.properties)
db.url=jdbc:mysql://localhost:3307/数据库名?useUnicode=true&useSSL=false&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
db.username=root
db.password=123456
g.output.dir=.\\XX模块名\\src\\main\\java
pkg.name=com.XXX
pkg.xml.dir=mapper
示例:
(1)导入依赖
(2)向项目中导入代码生成器类代码和数据库配置文件
(3)运行代码生成器
就可以看到数据库表对应的类就自动生成了~~
四、代码生成器的使用(老)
1、注入相关依赖
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.1</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
2、代码生成器(非交互生成)
import com.baomidou.mybatisplus.annotation.DbType;
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;
public class CodeGet {
public static void main(String[] args) {
// 1、创建代码生成器
AutoGenerator mpg = new AutoGenerator();
// 2、全局配置
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setOutputDir("D:\\idea\\项目名\\项目模块名" + "/src/main/java");
gc.setServiceName("%sService"); //去掉Service接口的首字母I
gc.setAuthor("letian");
gc.setOpen(false);
mpg.setGlobalConfig(gc);
// 3、数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3307/数据库名?serverTimezone=GMT%2B8&useSSL=false");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 4、包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.letian");
pc.setController("controller");
pc.setService("service");
pc.setMapper("mapper");
mpg.setPackageInfo(pc);
// 5、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("sys_user");
strategy.setNaming(NamingStrategy.underline_to_camel);//数据库表映射到实体的命名策略
strategy.setColumnNaming(NamingStrategy.underline_to_camel);//数据库表字段映射到实体的命名策略
strategy.setEntityLombokModel(true); // lombok 模型 @Accessors(chain = true) setter链式操作
strategy.setRestControllerStyle(true); //restful api风格控制器
strategy.setControllerMappingHyphenStyle(true); //url中驼峰转连字符
mpg.setStrategy(strategy);
// 6、执行
mpg.execute();
}
}
如果本篇文章对你有帮助的话,请点个赞叭~