本文主要记录MyBatis-Plus的一个强大功能,自动生成entity、dao、service、controller四层代码,以及生成并关联好mapper.xml文件供我们手写一些复杂的SQL(单表下的CRUD操作不需要手写SQL了,框架内封装了各种方法我们调用即可)。
一、创建SpringBoot项目并引入相关依赖
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.5.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.47</version>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.12</version>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.16</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
<!--velocity 模板引擎,MyBatis-Plus 代码生成器需要-->
<dependency>
<groupId>org.apache.velocity</groupId>
<artifactId>velocity-engine-core</artifactId>
<version>2.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
</dependencies>
二、编写配置文件 application.properties
# 服务端口
server.port=8888
# 设置当前为开发环境
spring.profiles.active=dev
# 配置数据库连接
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/question_bank?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
# 配置逻辑删除,逻辑删除了的表中用1表示,没删除的0表示
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0
三、创建代码生成器,并进行相关配置(可根据需求自行选择配置)
写在测试类中的main方法中即可,启动main方法便能自动创建
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.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
/**
* Author:三井寿
* 代码自动生成器
* 自动生成entity、dao、service、controller 各层代码
*/
public class AutoCode {
public static void main(String[] args) {
//构建一个代码生成器对象
AutoGenerator mpg = new AutoGenerator();
//配置执行策略
//1、全局配置
GlobalConfig gc = new GlobalConfig();
String proPath = System.getProperty("user.dir"); //当前项目路径
gc.setOutputDir(proPath + "/src/main/java"); //设置代码生成路径
gc.setAuthor("科比门徒");
gc.setOpen(false); //生成后是否打开文件夹
gc.setFileOverride(false); //是否覆盖
gc.setServiceName("%sService"); //去service的 I 前缀
gc.setIdType(IdType.ID_WORKER); //主键生成策略
gc.setDateType(DateType.ONLY_DATE); //设置日期类型
gc.setSwagger2(true); //是否生成Swagger
mpg.setGlobalConfig(gc);
//2、设置数据源
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/question_bank?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);
//3、配置生成哪些包,这些包放在哪
PackageConfig pc=new PackageConfig();
pc.setModuleName("block"); //设置并生成该模块包
pc.setParent("com.lg"); //设置模块存放位置
pc.setEntity("entity"); //设置并生成存放实体类包
pc.setMapper("mapper");//设置并生成存放mapper接口的包
pc.setService("service"); //设置并生成service层所在的包
pc.setController("controller"); //设置并生成controller层所在的包
mpg.setPackageInfo(pc);
//4、策略配置
StrategyConfig strategy=new StrategyConfig();
strategy.setInclude("user"); //设置要映射的表名!!!!
strategy.setNaming(NamingStrategy.underline_to_camel); //表名中下划线转驼峰命名
strategy.setColumnNaming(NamingStrategy.underline_to_camel);//表中字段如果有下划线,转驼峰命名
strategy.setEntityLombokModel(true);//自动生成Lombok
strategy.setRestControllerStyle(true);//开启 RestFul 风格
strategy.setControllerMappingHyphenStyle(true);
//设置逻辑删除,对表中的那个字段
strategy.setLogicDeleteFieldName("deleted");
//自动填充 (表中如果有创建时间、修改时间话,可以使用自动填充)
TableFill createTime = new TableFill("create_time", FieldFill.INSERT);
TableFill updateTime = new TableFill("update_time", FieldFill.INSERT_UPDATE);
ArrayList<TableFill> tableFills = new ArrayList<>();
tableFills.add(createTime);
tableFills.add(updateTime);
strategy.setTableFillList(tableFills);
//乐观锁配置
strategy.setVersionFieldName("version");
mpg.setStrategy(strategy);
mpg.execute();//执行代码生成操作
}
}
四 、编写配置文件配置乐观锁,分页插件、逻辑删除、SQL性能分页插件(可以省略,但需要与上一步中的相关配置保持一致)
import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.transaction.annotation.EnableTransactionManagement;
/**
* Author:三井寿
*/
@Configuration //配置类
@EnableTransactionManagement //自动管理事务注解
public class MybatisPlusConfig {
/**
* 配置乐观锁
* @return
*/
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor() {
return new OptimisticLockerInterceptor();
}
/**
* 配置分页插件
* @return
*/
@Bean
public PaginationInterceptor paginationInterceptor(){
return new PaginationInterceptor();
}
/**
* 配置逻辑删除
* @return
*/
@Bean
public ISqlInjector sqlInjector(){
return new LogicSqlInjector();
}
/**
* 配置性能分析插件
* @return
*/
@Bean
@Profile({"dev","test"}) //设置 dev,test 环境开启
public PerformanceInterceptor performanceInterceptor(){
PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
//设置SQL最大可执行时间,超出这个时间说明SQL性能有问题,报超时异常
performanceInterceptor.setMaxTime(1000); //ms
//是否格式化SQL
performanceInterceptor.setFormat(true);
return performanceInterceptor;
}
}