Springboot +mybatis-plus 实现代码生成器（自定义默认模板引擎）

一、前言

1.在MyBatis-Plus的官网就为我们提供了代码生成器的使用教程，它可以为完成最基本的代码生成，但是想要实现自己的效果，还需要我们自己去设置生成模板。

2.AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

3.项目架构

二、实现过程

1.添加依赖

MyBatis-Plus 从 3.0.3 之后移除了代码生成器与模板引擎的默认依赖，需要手动添加相关依赖：

• 添加 代码生成器 依赖

<!--mybatis-plus代码生成器-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.4.1</version>
</dependency>

• 添加 自定义模板引擎 依赖

<!--mybatis-plus逆向功能所需的模板引擎(自定义模板引擎)-->
<dependency>
    <groupId>org.freemarker</groupId>
    <artifactId>freemarker</artifactId>
    <version>2.3.30</version>
</dependency>
<!--velocity 模板引擎，Mybatis Plus 代码生成器需要（默认模板引擎）-->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
</dependency>

注意：如果您选择了非默认引擎，需要在 AutoGenerator 中 设置模板引擎。

AutoGenerator generator = new AutoGenerator();

// set freemarker engine
generator.setTemplateEngine(new FreemarkerTemplateEngine());

// set beetl engine
generator.setTemplateEngine(new BeetlTemplateEngine());

// set custom engine (reference class is your custom engine class)
generator.setTemplateEngine(new CustomTemplateEngine());

// other config
...

2.复制maven包内的模板

maven仓库内搜索mybatis-plus-generator,打开，复制其中的templates目录至自己项目的resources下

由于我们后续使用的是FreemarkerTemplateEngine，仅用到.ftl文件，其他后缀文件可自行删除。

3.自定义模板内容

在上面模板的基础上，修改编写自己所需的模板内容：
controller.java.ftl

package ${
   package.Controller};

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.web.bind.annotation.*;
import org.springframework.beans.factory.annotation.Autowired;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import ${
   package.Entity}.${
   entity};
import ${
   package.Service}.${
   table.serviceName};
import java.util.Date;
<#if restControllerStyle>
import org.springframework.web.bind.annotation.RestController;
<#else>
import org.springframework.stereotype.Controller;
</#if>
<#if superControllerClassPackage??>
import ${
   superControllerClassPackage};
</#if>

import ${
   package.ModuleName}.utils.*;

/**
* ${table.comment!} 前端控制器
*
* @author ${author}
* @since ${date}
*/
@Api(tags = "${entity}API")
<#if restControllerStyle>
@RestController
<#else>
@Controller
</#if>
@RequestMapping("<#if package.ModuleName??>/${package.ModuleName}</#if>/<#if controllerMappingHyphenStyle??>${controllerMappingHyphen}<#else>${table.entityPath}</#if>")
<#if kotlin>
 class ${
   table.controllerName}<#if superControllerClass??> : ${
   superControllerClass}()</#if>
<#else>
 <#if superControllerClass??>
public class ${
   table.controllerName} extends ${
   superControllerClass} {
   
 <#else>
public class ${
   table.controllerName} {
   
 </#if>
    @Autowired
    private ${
   table.serviceName} service;

    @ApiOperation(value = "分页列表")
    @ApiImplicitParams({
   
        @ApiImplicitParam(name = "currentPage",value = "当前页码",paramType = "query",dataType = "int"),
        @ApiImplicitParam(name = "pageSize",value = "每页显示个数",paramType = "query",dataType = "int")
    })
    @PostMapping(value = "/page")
    public Result page(@RequestBody ${
   entity} entity,@RequestParam Integer currentPage,@RequestParam Integer pageSize){
   

        Page<${
   entity}> page = new Page<>(currentPage,pageSize);
        QueryWrapper<${
   entity}> queryWrapper = new QueryWrapper();
        //分页查看列表
        IPage<${
   entity}> pageInfo = service.selectPage(page,queryWrapper);
        //返回结果集
        return new Result().ok(new PageData<>(pageInfo.getRecords(),pageInfo.getTotal()));
    }

    /**
    * 添加信息
    */
    @PostMapping("add")
    @ApiOperation("添加信息")
    public Result add(@RequestBody ${
   entity} entity){
   
        entity.setCreate_by(1)