前言
springboot--mybatis-plus
mybatis-plus极大地简化我们做crud的开发,从而让我们有更多精力来从事业务流程的开发。
我这边以版本mybatis-plus == 3.5.1
为例讲解新版的代码生成器的使用。
1.配置pom依赖
注:我的springboot版本为2.6.13,是阿里的镜像下的。mysql连接驱动是必须的。刷新依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.27</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.1</version>
</dependency>
<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.代码生成器的代码
注:在项目根目录建立utils包,然后里面在建立类文件:CodeGenerator
package com.mtp.mptadmin.utils;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* @author 31427
* @create 2023/4/26 16:02
* @description mybatis-plus 代码生成器
*/
public class CodeGenerator {
public static void main(String[] args) {
generate();
}
private static void generate() {
//1、使用你自己的mysql数据库,地址,数据库名,用户名和密码填写好
String url = "jdbc:mysql://localhost:3306/springboot?serverTimezone=GMT%2b8";
String username = "root";
String password = "123456";
//2、添加表名集合
List<String> tables = new ArrayList<>();
tables.add("tb_user");
FastAutoGenerator.create(url, username, password)
.globalConfig(builder -> {
builder.fileOverride() // 开启覆盖之前生成的文件
.disableOpenDir() //禁止打开输出目录
.outputDir(System.getProperty("user.dir") + "\\src\\main\\java") //指定输出目录
.author("chenyu") //作者名
// .enableKotlin() //开启 kotlin 模式
// .enableSwagger() //开启 swagger 模式
.dateType(DateType.TIME_PACK) //时间策略
.commentDate("yyyy-MM-dd"); //注释日期
})
//3、包配置 设置你自己项目下需要建立的各个目录的名字
.packageConfig(builder -> {
builder.parent("com.mtp.mptadmin") //父包名
.entity("entity") //Entity 包名
.service("service") // Service 包名
.serviceImpl("service.impl") //Service Impl 包名
.mapper("mapper") //Mapper 包名
.xml("mapper.xml") // Mapper XML 包名
.controller("controller") //Controller 包名
.other("config") //自定义文件包名 输出自定义文件时所用到的包名
.pathInfo(Collections.singletonMap(OutputFile.mapperXml, System.getProperty("user.dir") + "\\src\\main\\resources\\mapper"));//指定xml位置
})
.strategyConfig(builder -> {
builder.addInclude(tables)
//4、策略配置,配置你的表前缀
.addTablePrefix("tb_")//表名前缀,配置后生成的代码不会有此前缀
.serviceBuilder()
.formatServiceFileName("%sService")//服务层接口名后缀
.formatServiceImplFileName("%sServiceImpl")//服务层实现类名后缀
.entityBuilder()
.enableLombok()//实体类使用lombok记得引入哦
//.logicDeleteColumnName("status")//逻辑删除字段
.enableTableFieldAnnotation()//加上字段注解@TableField
.controllerBuilder()
.formatFileName("%sController")//控制类名称后缀
.enableRestStyle()
.mapperBuilder()
.superClass(BaseMapper.class)
.formatMapperFileName("%sMapper")
.enableMapperAnnotation()
.formatXmlFileName("%sMapper");
})
.execute();
}
}
3.自定义模板
注:在resources
下面建立templates
目录,然后创建controller.java.vm
文件
下面集成了增、删、多选项删除、查一个、查多个、查分页、和修改功能。
package ${
package.Controller};
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import java.util.List;
import $!{
package.Service}.$!{
table.serviceName};
import ${
package.Entity}.${
entity};
#if(${
superControllerClassPackage})
import ${
superControllerClassPackage};
#end
/**
* <p>
* $!{table.comment} 前端控制器
* </p>
*
* @author ${author}
* @since ${date}
*/
#if(${
restControllerStyle})
@RestController
#else
@Controller
#end
@RequestMapping("#if(${package.ModuleName})/${package.ModuleName}#end/#if(${controllerMappingHyphenStyle})${controllerMappingHyphen}#else${table.entityPath}#end")
#if(${
kotlin})
class ${
table.controllerName}#if(${
superControllerClass}) : ${
superControllerClass}()#end
#else
#if(${
superControllerClass})
public class ${
table.controllerName} extends ${
superControllerClass} {
#else
public class ${
table.controllerName} {
#end
@Resource
private ${
table.serviceName} ${
table.entityPath}Service;
@PostMapping
public Boolean save(@RequestBody ${
entity} ${
table.entityPath}) {
return ${
table.entityPath}Service.saveOrUpdate(${
table.entityPath});
}
@DeleteMapping("/{id}")
public Boolean delete(@PathVariable Integer id) {
return ${
table.entityPath}Service.removeById(id);
}
@PostMapping("/del/batch")
public Boolean delete(@RequestBody List<Integer> ids) {
return ${
table.entityPath}Service.removeByIds(ids);
}
@GetMapping
public List<${
entity}> findAll() {
return ${
table.entityPath}Service.list();
}
@GetMapping("/{id}")
public ${
entity} findOne(@PathVariable Integer id) {
return ${
table.entityPath}Service.getById(id);
}
@GetMapping("/page")
public Page<${
entity}> findPage(@RequestParam Integer pageNum,
@RequestParam Integer pageSize) {
return ${
table.entityPath}Service.page(new Page<>(pageNum, pageSize));
}
}
#end
4.参考资料
Mybatis-Plus自动生成代码,自定义Controller
mybatis-plus代码生成器
总结
这是一个比较全的资料了,通过整合形成的,能够满足大部分的crud工作。不妨收藏和点赞一下,
希望能够帮助到您,谢谢!