在SpringBoot使用MyBatis-Plus代码生成器

前言

在SpringBoot中，通过引入MyBatis-Plus 实现数据库代码生成器，我还写好了一些模板方法，可一键生成。

注意

适用版本：mybatis-plus-generator 3.5.1 及其以上版本

一、引入依赖

在pom.xml中引入代码生成器、以及代码生成器中默认使用的velocity引擎

<!-- 代码生成器 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.1</version>
</dependency>
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity</artifactId>
    <version>1.7</version>
</dependency>

二、使用步骤

1.创建一个类（例如CodeGenerator）

把以下代码放到一个方法中。

FastAutoGenerator.create("url", "username", "password")
    .globalConfig(builder -> {
        builder.author("baomidou") // 设置作者
            .enableSwagger() // 开启 swagger 模式
            .fileOverride() // 覆盖已生成文件
            .outputDir("D://"); // 指定输出目录
    })
    .packageConfig(builder -> {
        builder.parent("com.baomidou.mybatisplus.samples.generator") // 设置父包名
            .moduleName("system") // 设置父包模块名
            .pathInfo(Collections.singletonMap(OutputFile.xml, "D://")); // 设置mapperXml生成路径
    })
    .strategyConfig(builder -> {
        builder.addInclude("t_simple") // 设置需要生成的表名
            .addTablePrefix("t_", "c_"); // 设置过滤表前缀
    })
    .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
    .execute();

我的代码如下（示例）：

默认使用的Velocity引擎模板，所以就把使用Freemarker代码注释掉了

2.编辑生成模板

官方的模板位置如下：

将controller.java.vm复制到resources/templates下

可直接使用默认没有功能的模板，也可复制我的，编写了一些增删改查、分页的模板

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(${restControllerStyle})
import org.springframework.web.bind.annotation.RestController;
#else
import org.springframework.stereotype.Controller;
#end
#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);
    }

    // 查询所有数据
    @GetMapping
    public List<${entity}> findAll() {
        return ${table.entityPath}Service.list();
    }

    // 根据id查询
    @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

此处的增删改查调用了mybatis-plus的功能，不懂的小伙伴可以配置学习一下

三、一键生成代码

只需在CodeGenerator.java中运行一下代码

前端控制器UserController、数据库实体类User、service、UserMapper就一件生成好啦。

我们自定义的功能也在UserController中啦。

结尾

代码生成器可以一键省去我们一半花在创建和写SQL代码的时间，不过平时小伙伴不急着做项目，也可以手动写写，提高SQL语言能力。