springboot整合mybatis-plus-generator
作者：互联网
一、创建一个springboot工程，引入相关依赖
<dependencies>
<!-- springboot web 依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- springboot热部署依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<!-- mysql依赖-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<!-- mybatis-plus依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.3.2</version>
</dependency>
<!-- mybatis-plus-generator代码生成器依赖-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.3.2</version>
</dependency>
<!-- mybatis-plus-generator配置中需要用到freemarker模板-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-freemarker</artifactId>
</dependency>
<!-- springboot默认使用yml配置，如果要用传统xml和properties配置需要引入如下依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<!-- 引入小辣椒lombok依赖，idea编辑器还需要安装lombok插件才可以使用-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- springboot集成单元测试依赖-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
二、创建一个数据库表，用做代码生成示例
-- 创建用户表
DROP TABLE IF EXISTS m_user;
CREATE TABLE m_user
(
`id` BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
`username` VARCHAR(64) DEFAULT NULL COMMENT '姓名',
`password` VARCHAR(64) DEFAULT NULL COMMENT '密码',
`avatar` VARCHAR(255) DEFAULT NULL COMMENT '头像内容',
`age` INT(11) NULL DEFAULT NULL COMMENT '年龄',
`email` VARCHAR(64) DEFAULT NULL COMMENT '邮箱',
`status` INT(5) NOT NULL COMMENT '状态（0：正常，1：不正常）',
`created` TIMESTAMP DEFAULT NULL COMMENT '创建时间',
`last_login` TIMESTAMP DEFAULT NULL COMMENT '最后登录时间',
PRIMARY KEY (`id`),
KEY `UK_USERNAME` (`username`) USING BTREE
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=UTF8;
-- 数据初始化
INSERT INTO `m_user`
(`username`,`password`,`age`,`email`,`status`)
VALUES
('张飞','abc',20,'222222221@qq.com',0),
('关羽','abc',22,'222222222@qq.com',0),
('刘备','abc',24,'222222223@qq.com',1)
三、编写一个mybatis-plus-generator配置类
public class CodeGenerator {
/**
* <p>
* 读取控制台内容
* </p>
*/
public 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) {
//mybatis-plus代码生成器官网地址 https://baomidou.com/pages/d357af/
//只需要修改一部分自己的内容即可食用
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("moonlight");
gc.setOpen(false);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
//再次调用时是否覆盖原文件
//gc.setFileOverride(true);
//去掉Service接口自动生成的首字母I
gc.setServiceName("%sService");
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
//只需要把moon_light修改为你自己的数据库即可
dsc.setUrl("jdbc:mysql://localhost:3306/moon_light?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
//pc.setModuleName(scanner("模块名"));
//如果像我这样直接在项目里面写的配置，就不需要模块名，直接写null
pc.setModuleName(null);
//你的项目包结构名
pc.setParent("com.moonlight");
mpg.setPackageInfo(pc);
// 自定义配置
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";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
// ( pc.getModuleName()如果前面设置了null，这里应该不写)
//return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
return projectPath + "/src/main/resources/mapper/"
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录，自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在，不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
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.underline_to_camel);
//strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
//strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
//生成实体类等时去掉表前缀(没有前缀就只写_)
strategy.setTablePrefix("m_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
四、在properties配置文件中编写数据库相关配置
server.port=8080
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/moon_light?useUnicode=true&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=123456
mybatis-plus.mapper-locations=classpath:mapper/*.xml
五、启动CodeGenerator配置类中的main方法，在控制台输入表名即可
六、在单元测试里面编写一个查询用户信息接口测试一下
@SpringBootTest
class MoonLightBootApplicationTests {
@Autowired
private UserService userService;
@Test
void contextLoads() {
List<User> list = new QueryChainWrapper<>(userService.getBaseMapper()).list();
for (User user : list) {
System.out.println(user);
}
}
}
标签：mpg,generator,boot,strategy,plus,mybatis,new,NULL,true 来源： https://www.cnblogs.com/wlfs000000/p/15937499.html