Spring Boot代码生成器模板

1. 前言

        Spring Boot代码生成器是Mybatis-plus提供的逆向生成代码的工具,通过编写生成器，进行数据库及相应生成路径配置，可在指定文件下生成entity、controller、mapper及service层；

        Mybatis-plus地址：代码生成器（新） | MyBatis-Plus

2. 使用

2.1 导入依赖

        在springboot使用mybatis-plus代码生成器要在pom.xml文件中导入相关依赖。

        <!--Mybatis-plus依赖-->  
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.2</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</artifactId>
            <version>1.7</version>
        </dependency>

2.2 代码复制与修改

        从mybatis-plus官网上copy生成器代码，在文件中新建一个CodeGenerator类复制代码并修改路径为你自己的文件路径，修改包名为你自己的包名：

package com.xxx.back;

import com.baomidou.mybatisplus.generator.FastAutoGenerator;
import com.baomidou.mybatisplus.generator.config.OutputFile;

import java.util.Collections;

/**
 * Author: abc
 * Description: 代码生成器
 */
public class CodeGenerator {
    public static void main(String[] args) {
        generator();
    }

    private static void generator(){
        // 连接你的数据库并填写你的用户名跟密码
        FastAutoGenerator.create("jdbc:mysql://localhost:3306/test?useUnicode=true&serverTimezone=GMT%2b8", "root", "123456")
                .globalConfig(builder -> {
                    builder.author("abc")      // 设置作者
//                            .enableSwagger() // 开启 swagger 模式
                            .fileOverride() // 覆盖已生成文件
                            .outputDir("E:\\back\\src\\main\\java\\"); // 指定输出目录
                })
                .packageConfig(builder -> {
                    builder.parent("com.xxx.back") // 设置父包名
                            .moduleName(null) // 设置父包模块名
                            .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "E:\\back\\src\\main\\resources\\mapper\\")); // 设置mapperXml生成路径
                })
                .strategyConfig(builder -> {
                    builder.entityBuilder().enableLombok();
                    builder.controllerBuilder().enableHyphenStyle()
                            .enableRestStyle(); //转驼峰,开启控制器生成
                    builder.addInclude("course") // 设置需要生成的表名
                            .addTablePrefix("t_", "sys_"); // 设置过滤表前缀
                })
//                .templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板，默认的是Velocity引擎模板
                .execute();

    }
}

2.3 模板配置

        maven包中提供了生成模板，可通过修改模板来设置生成各层的代码，通过找到maven包管理工具下的mybatis-plus-generator，找到templates文件夹，其中.vm为后缀的便是各层模板，我们将其复制到resources的templates文件夹下：

 

         以controller层为例，写了增删改查等一系列方法，其中Result是封装的一个返回结果类，详情请看：

package ${package.Controller};

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import org.springframework.beans.factory.annotation.Autowired;
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
        @Autowired
        private ${table.serviceName} ${table.entityPath}Service;

        // 新增或更新
        @PostMapping("/add")
        public Result save(@RequestBody ${entity} ${table.entityPath}){
            return Result.success(${table.entityPath}Service.saveOrUpdate(${table.entityPath}));
        }

        // 删除接口
        @DeleteMapping("/del/{id}")
        public Result delete(@PathVariable Integer id){
            ${table.entityPath}Service.removeById(id);
            return Result.success();
        }

        // 查询接口
        @GetMapping("/list")
        public Result list(){
            return Result.success(${table.entityPath}Service.list());
        }

        // 批量删除接口
        @PostMapping("/del/batch")
        public Result delete(@RequestBody List<Integer> ids){
             ${table.entityPath}Service.removeByIds(ids);
             return Result.success();
        }

        // 根据ID查询
        @GetMapping("/{id}")
        public Result findOne(@PathVariable Integer id) {
            return Result.success(${table.entityPath}Service.getById(id));
        }

        @GetMapping("/page")
        public Result findPage(@RequestParam Integer pageNum,
        @RequestParam Integer pageSize) {
            QueryWrapper<${entity}> queryWrapper = new QueryWrapper<>();
            queryWrapper.orderByDesc("id");
            return Result.success(${table.entityPath}Service.page(new Page<>(pageNum, pageSize),queryWrapper));
        }

}

#end

2.4 结果测试

2.4.1 设计数据库

        如下图所示，创建一个test的表格并新增两个字段

 2.4.2 运行codeGenerator

        运行CodeGenerator主函数，可进行文件生成，看到如图所示，显示文件生成完成，则表示生成成功（注意，修改生成器代码中的数据库表名为test）：

 2.4.3 结果展示

（1） Controller层

package com.xxx.back.controller;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.xxx.back.common.Result;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import java.util.List;

import com.wxw.back.service.ITestService;
import com.wxw.back.entity.Test;

import org.springframework.web.bind.annotation.RestController;

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author abc
 * @since 2023-08-03
 */
@RestController
@RequestMapping("/test")
public class TestController {
        @Autowired
        private ITestService testService;

        // 新增或更新
        @PostMapping("/add")
        public Result save(@RequestBody Test test){
            return Result.success(testService.saveOrUpdate(test));
        }

        // 删除接口
        @DeleteMapping("/del/{id}")
        public Result delete(@PathVariable Integer id){
            testService.removeById(id);
            return Result.success();
        }

        // 查询接口
        @GetMapping("/list")
        public Result list(){
            return Result.success(testService.list());
        }

        // 批量删除接口
        @PostMapping("/del/batch")
        public Result delete(@RequestBody List<Integer> ids){
             testService.removeByIds(ids);
             return Result.success();
        }

        // 根据ID查询
        @GetMapping("/{id}")
        public Result findOne(@PathVariable Integer id) {
            return Result.success(testService.getById(id));
        }

        @GetMapping("/page")
        public Result findPage(@RequestParam Integer pageNum,
        @RequestParam Integer pageSize) {
            QueryWrapper<Test> queryWrapper = new QueryWrapper<>();
            queryWrapper.orderByDesc("id");
            return Result.success(testService.page(new Page<>(pageNum, pageSize),queryWrapper));
        }

}

(2) Mapper层

package com.xxx.back.mapper;

import com.xxx.back.entity.Test;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;

/**
 * <p>
 *  Mapper 接口
 * </p>
 *
 * @author abc
 * @since 2023-08-03
 */
public interface TestMapper extends BaseMapper<Test> {

}

(3) entity层

package com.xxx.back.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableId;
import java.io.Serializable;
import lombok.Getter;
import lombok.Setter;

/**
 * <p>
 * 
 * </p>
 *
 * @author abc
 * @since 2023-08-03
 */
@Getter
@Setter
  public class Test implements Serializable {

    private static final long serialVersionUID = 1L;

      /**
     * 主键
     */
      @TableId(value = "id", type = IdType.AUTO)
      private Integer id;

      /**
     * 姓名
     */
      private String name;


}

(4) Isevice及 serviceImpl

package com.xxx.back.service;

import com.xxx.back.entity.Test;
import com.baomidou.mybatisplus.extension.service.IService;

/**
 * <p>
 *  服务类
 * </p>
 *
 * @author abc
 * @since 2023-08-03
 */
public interface ITestService extends IService<Test> {

}


// serviceImpl
package com.xxx.back.service.impl;

import com.xxx.back.entity.Test;
import com.xxx.back.mapper.TestMapper;
import com.xxx.back.service.ITestService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

/**
 * <p>
 *  服务实现类
 * </p>
 *
 * @author abc
 * @since 2023-08-03
 */
@Service
public class TestServiceImpl extends ServiceImpl<TestMapper, Test> implements ITestService {

}