MyBatis Plus(简称 MyBatis-Plus 或 MP)是 MyBatis 的增强工具包,提供了许多实用的功能,包括代码生成器。MyBatis-Plus 的代码生成器可以帮助开发人员快速生成 Entity、Mapper、Mapper XML、Service、Controller 等基础代码,极大地提升了开发效率。
使用 MyBatis-Plus 代码生成器的步骤
-
引入 MyBatis-Plus 相关依赖
在项目的
pom.xml
(如果是 Maven 项目)或者build.gradle
(如果是 Gradle 项目)中,添加 MyBatis-Plus 的依赖:<!-- Maven 依赖 --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>最新版本号</version> </dependency>
如果需要使用代码生成器,还需要添加代码生成器的依赖:
<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>最新版本号</version> </dependency>
-
配置数据源
在
application.properties
或者application.yml
中配置数据源信息:spring.datasource.driver-class-name=com.mysql.jdbc.Driver spring.datasource.url=jdbc:mysql://localhost:3306/test spring.datasource.username=root spring.datasource.password=root
-
配置代码生成器
创建代码生成器的配置类,配置生成的包路径、作者信息、数据库表名等。
package com.atguigu.ssyx;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
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;
public class CodeGenerator {
public static void main(String[] args) {
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = "D:\\360MoveData\\Users\\LQC\\Desktop\\yx\\code\\guigu-ssyx-parent\\service\\service-acl";
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("author");
gc.setOpen(false);
gc.setIdType(IdType.AUTO);
gc.setDateType(DateType.ONLY_DATE);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/shequ-acl?useUnicode=true&characterEncoding=utf8&useSSL=false");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent("com.atguigu.ssyx");
pc.setEntity("entity");
pc.setMapper("mapper");
pc.setService("service");
pc.setController("controller");
mpg.setPackageInfo(pc);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude("user");
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);
strategy.setEntityTableFieldAnnotationEnable(true);
strategy.setLogicDeleteFieldName("deleted");
strategy.setEntityBooleanColumnRemoveIsPrefix(true);
strategy.setEntitySerialVersionUID(true);
strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
mpg.execute();
}
}
这段代码配置了生成代码的输出路径、作者信息、数据库连接信息、包结构、命名策略等。
-
运行代码生成器
编写完成配置类后,直接运行
CodeGenerator
的main
方法即可生成代码。 -
查看生成的代码
代码生成器会根据配置自动生成 Entity、Mapper、Mapper XML、Service、Controller 等文件,生成的文件位于指定的包路径下,可以根据实际需求进行进一步的修改和使用。
我这里使用的是这些版本
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.4.0</version>
</dependency>
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.2</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.4.1</version>
</dependency>