springboot整合mybatis-plus用AutoGenerator搭建项目
最近公司一个项目在蓝图设计阶段讨论架构底层实现方面使用JPA还是Mybatis-Plus，JPA之前有过使用，决定再了解一下Mybatis-Plus，跟博客上另一个大牛学习搭建了框架，记录下来方便以后使用：
数据库脚本:
CREATE TABLE user
(
id BIGINT(20) NOT NULL COMMENT '主键ID',
name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
age INT(11) NULL DEFAULT NULL COMMENT '年龄',
email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
PRIMARY KEY (id)
);
数据库data脚本:
DELETE FROM user;
INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
数据库准备完成后通过idea创建初始化一个springboot工程。初始化工程的步骤我就不阐述了，有不知道的小伙伴百度一下
POM.XML
4.0.0
org.springframework.boot
spring-boot-starter-parent
2.1.1.RELEASE
com.edc
membership
0.0.1-SNAPSHOT
membership
Demo project for Spring Boot
1.8
org.springframework.boot
spring-boot-starter-freemarker
org.springframework.boot
spring-boot-starter-jdbc
org.springframework.boot
spring-boot-starter-web
org.projectlombok
lombok
true
com.baomidou
mybatis-plus-boot-starter
3.0.3
mysql
mysql-connector-java
runtime
org.springframework.boot
spring-boot-starter-test
test
org.springframework.boot
spring-boot-maven-plugin
applicaiton.yml配置
spring:
datasource:
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://IP:端口/xxxx?characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
username: xxxx
password: xxxx
schema: classpath:db/db-demo.sql
data: classpath:db/db-data.sql
在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹
@MapperScan("com.edc.membership.dao") //换成自己的包路径即可
@SpringBootApplication
public class MembershipApplication {
public static void main(String[] args) {
SpringApplication.run(MembershipApplication.class, args);
}
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
mybatis-plus.properties展示（可配置自动生成的位置）
#此处为本项目src所在路径（代码生成器输出路径）
OutputDir=F:/membership-demo/src/main/java
#mapper.xml的生成位置
OutputDirXml=F:/membership-demo/src/main/resources
#数据库表名(此处切不可为空，如果为空，则默认读取数据库的所有表名)
tableName=user
#装代码的文件夹名
className=membership
#设置作者
author=Gsy
#正常情况下，下面的代码无需修改！！！！！！！！！！
#自定义包路径
parent=com.edc.membership
#数据库地址
url=jdbc:mysql://IP:端口/xxxx?characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
username=xxxx
password=xxxx
接下来是重头戏，代码生成器的java类：
package com.edc.membership.generate;
import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.InjectionConfig;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import java.util.ArrayList;
import java.util.List;
import java.util.ResourceBundle;
public class CodeGenerate {
public static void main(String[] args){
//用来获取Mybatis-Plus.properties文件的配置信息
final ResourceBundle rb = ResourceBundle.getBundle("mybatis-plus");
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
gc.setOutputDir(rb.getString("OutputDir"));
gc.setOpen(false);
gc.setBaseResultMap(true);
gc.setBaseColumnList(true);
gc.setAuthor(rb.getString("author"));
gc.setMapperName("%sMapper");
gc.setXmlName("%sMapper");
gc.setServiceName("%sService");
gc.setServiceImplName("%sServiceImpl");
gc.setControllerName("%sController");
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setDbType(DbType.MYSQL);
dsc.setUrl(rb.getString("url"));
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername(rb.getString("userName"));
dsc.setPassword(rb.getString("password"));
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent(rb.getString("parent"));
pc.setController("controller." + rb.getString("className"));
pc.setService("service." + rb.getString("className"));
pc.setServiceImpl("service." + rb.getString("className") + ".impl");
pc.setEntity("bean." + rb.getString("className"));
pc.setMapper("dao." + rb.getString("className"));
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
List<FileOutConfig> focList = new ArrayList<>();
// focList.add(new FileOutConfig("/templates/mapper.xml.ftl") {
// @Override
// public String outputFile(TableInfo tableInfo) {
// // 自定义输入文件名称
// return rb.getString("OutputDirXml") + "/mapper/" + rb.getString("className") + "/" + tableInfo.getEntityName() + StringPool.DOT_XML;
// }
// });
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
mpg.setTemplate(new TemplateConfig().setXml(null));
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setInclude(new String[]{rb.getString("tableName")});
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
}
运行一下发现可以自动生成一整套的 Entity、Mapper、Service、Controller 各个模块的代码