[开发工具]IDEA配置：EasyCode插件+lombok+SpringDoc快速生成代码

EasyCode 是一个可以从数据库表中快速生成代码的插件，但是原有的默认配置已经不太适用了。以下配置是笔者自用的，记录下来作备忘，也供大家借鉴。

涉及到的第三方库及版本：

模板配置

entity

##导入宏定义
$!init
$!define

##保存文件（宏定义）
#save("/pojo", ".java")

##包路径（宏定义）
#setPackageSuffix("pojo")

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.experimental.Accessors;

import java.io.Serializable;
##自动导入包（全局变量）
$!autoImport

##表注释（宏定义）
#tableComment("表实体类")
@Data
@Accessors(chain = true)
@Schema(title = "$!{tableInfo.name}实体类")
@TableName(value = "tb_$!tool.firstLowerCase($!tableInfo.name)")
public class $!{tableInfo.name} implements Serializable {
#foreach($column in $tableInfo.fullColumn)
    #if(${column.comment})/**
     * ${column.comment}
     */#end
    
    #{if}($column.name=="id")@TableId(type = IdType.AUTO)
    #{end}@TableField(value = "$!{tool.hump2Underline($column.name)}")
    @Schema(title = "#if(${column.comment})${column.comment}#end")
    private $!{tool.getClsNameByFullName($column.type)} $!{column.name};

#end
}

dao

##导入宏定义
$!init
$!define

##设置表后缀（宏定义）
#setTableSuffix("Mapper")

##保存文件（宏定义）
#save("/dao", "Mapper.java")

##包路径（宏定义）
#setPackageSuffix("dao")

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import $!{tableInfo.savePackageName}.pojo.$!tableInfo.name;

##表注释（宏定义）
#tableComment("表数据库访问层")
public interface $!{tableName} extends BaseMapper<$!tableInfo.name> {

}

service

##导入宏定义
$!init
$!define

##设置表后缀（宏定义）
#setTableSuffix("Service")

##保存文件（宏定义）
#save("/service", "Service.java")

##定义实体对象名
#set($entityName = $!tool.firstLowerCase($!tableInfo.name))

##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end

##包路径（宏定义）
#setPackageSuffix("service")

import com.baomidou.mybatisplus.extension.service.IService;
import $!{tableInfo.savePackageName}.pojo.$!tableInfo.name;
import top.zainzh.entity.PageResult;

import java.util.List;

##表注释（宏定义）
#tableComment("表服务接口")
public interface $!{tableName} extends IService<$!tableInfo.name> {

    /**
     * 分页查询
     *
     * @param page 当前页
     * @param size 每页数据量
     * @return 分页结果
     */
    PageResult<$!tableInfo.name> findPage(int page, int size);
    
    /**
     * 按条件分页查询
     *
     * @param page    当前页
     * @param size    每页数据量
     * @param article 条件
     * @return 分页结果
     */
     PageResult<$!tableInfo.name> findPage($!tableInfo.name $entityName, int page, int size);
     
    /**
     * 通过主键查询单条数据
     *
     * @param $!pk.name 主键
     * @return 实例对象
     */
    $!tableInfo.name selectOne($!pk.shortType $!pk.name);
    
    /**
     * 新增数据
     *
     * @param $!entityName 实体对象
     */
    void insert($!tableInfo.name $!entityName);
    
    /**
     * 修改数据
     *
     * @param $!entityName 实体对象
     */
    void update($!tableInfo.name $!entityName);
    
    /**
     * 通过主键删除
     *
     * @param $!pk.name 主键
     */
    void delete($!pk.shortType $!pk.name);
    
    /**
     * 多条件查询
     *
     * @param $!entityName 带条件的实例
     * @return $!{tableInfo.name}集合
     */
    List<$!tableInfo.name> selectList($!tableInfo.name $!entityName);
    
    /**
     * 查询所有
     *
     * @return $!{tableInfo.name}集合
     */
    List<$!tableInfo.name> selectAll();
}

serviceImpl

##导入宏定义
$!init
$!define

##设置表后缀（宏定义）
#setTableSuffix("ServiceImpl")

##保存文件（宏定义）
#save("/service/impl", "ServiceImpl.java")

##定义实体对象名
#set($entityName = $!tool.firstLowerCase($!tableInfo.name))

##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end

##包路径（宏定义）
#setPackageSuffix("service.impl")

import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.metadata.IPage;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;
import $!{tableInfo.savePackageName}.dao.$!{tableInfo.name}Mapper;
import $!{tableInfo.savePackageName}.pojo.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import top.zainzh.entity.PageResult;

import javax.annotation.Resource;
import java.util.List;

##表注释（宏定义）
#tableComment("表服务实现类")
@Service("$!tool.firstLowerCase($tableInfo.name)Service")
public class $!{tableName} extends ServiceImpl<$!{tableInfo.name}Mapper, $!{tableInfo.name}> implements $!{tableInfo.name}Service {

    @Resource
    private $!{tableInfo.name}Mapper $!{entityName}Mapper;
    
    /**
     * 分页查询
     *
     * @param page 当前页
     * @param size 每页数据量
     * @return 分页结果
     */
    @Override
    public PageResult<$!tableInfo.name> findPage(int page, int size) {
        IPage<$!tableInfo.name> iPage = this.page(new Page<>(page, size), new QueryWrapper<>());
        return new PageResult<>(iPage.getTotal(), iPage.getRecords());
    }
    
    /**
     * 按条件分页查询
     *
     * @param page    当前页
     * @param size    每页数据量
     * @param article 条件
     * @return 分页结果
     */
    @Override
    public PageResult<$!tableInfo.name> findPage($!tableInfo.name $entityName, int page, int size) {
        IPage<$!tableInfo.name> iPage = this.page(new Page<>(page, size), this.createQueryWrapper($entityName));
        return new PageResult<>(iPage.getTotal(), iPage.getRecords());
    }
     
    /**
     * 通过主键查询单条数据
     *
     * @param $!pk.name 主键
     * @return 实例对象
     */
    @Override
    public $!tableInfo.name selectOne($!pk.shortType $!pk.name) {
        return this.getById($!pk.name);
    }
    
    /**
     * 新增数据
     *
     * @param $!entityName 实体对象
     */
    @Override
    public void insert($!tableInfo.name $!entityName) {
        this.save($!entityName);
    }
    
    /**
     * 修改数据
     *
     * @param $!entityName 实体对象
     */
    @Override
    public void update($!tableInfo.name $!entityName) {
        this.updateById($!entityName);
    }
    
    /**
     * 通过主键删除
     *
     * @param $!pk.name 主键
     */
    @Override
    public void delete($!pk.shortType $!pk.name) {
        this.removeById($!pk.name);
    }
    
    /**
     * 多条件查询
     *
     * @param $!entityName 带条件的实例
     * @return $!{tableInfo.name}集合
     */
    @Override
    public List<$!tableInfo.name> selectList($!tableInfo.name $!entityName) {
        // 构建查询条件
        QueryWrapper<$!tableInfo.name> queryWrapper = this.createQueryWrapper($!entityName);
        // 根据构建的条件查询数据
        return this.list(queryWrapper);
    }
    
    /**
     * 查询所有
     *
     * @return $!{tableInfo.name}集合
     */
    @Override
    public List<$!tableInfo.name> selectAll() {
        return this.list(new QueryWrapper<>());
    }
    
    /**
     * 构建查询对象
     *
     * @param $!entityName 实例
     * @return 查询对象
     */
    public QueryWrapper<$!tableInfo.name> createQueryWrapper($!tableInfo.name $!entityName){
        QueryWrapper<$!tableInfo.name> queryWrapper = new QueryWrapper<>();
        if(null != $!entityName){
        #foreach($column in $tableInfo.fullColumn)    // ${column.comment}
            if(!StrUtil.hasEmpty(StrUtil.toString($!{entityName}.get$!{tool.firstUpperCase($column.name)}()))){
                queryWrapper.eq("$column.name", $!{entityName}.get$!{tool.firstUpperCase($column.name)}());
            }
        #end}
        return queryWrapper;
    }
}

controller

此处的PageResult与Result类为自封装的结果集类。

##导入宏定义
$!init
$!define

##设置表后缀（宏定义）
#setTableSuffix("Controller")

##保存文件（宏定义）
#save("/controller", "Controller.java")

##定义服务名
#set($serviceName = $!tool.append($!tool.firstLowerCase($!tableInfo.name), "Service"))

##定义实体对象名
#set($entityName = $!tool.firstLowerCase($!tableInfo.name))

##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end

##包路径（宏定义）
#setPackageSuffix("controller")

import cn.hutool.http.HttpStatus;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.*;
import $!{tableInfo.savePackageName}.pojo.$!tableInfo.name;
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import top.zainzh.entity.PageResult;
import top.zainzh.entity.Result;

import javax.annotation.Resource;
import java.util.List;

##表注释（宏定义）
#tableComment("表控制层")
@Tag(name = "$!{tableName} API")
@RestController
@RequestMapping("/$!tool.firstLowerCase($!tableInfo.name)")
@SuppressWarnings("rawtypes")
public class $!{tableName} {
    /**
     * 服务对象
     */
    @Resource
    private $!{tableInfo.name}Service $!{serviceName};

    /**
     * 分页查询所有数据
     *
     * @param page 当前页
     * @param size 每页数据量
     * @return 所有数据
     */
    @Operation(summary = "分页查询所有数据", tags = "$!{tableName} API")
    @GetMapping(value = "/search/{page}/{size}")
    public Result<PageResult<$!{tableInfo.name}>> findPage(@PathVariable int page, @PathVariable int size) {
        PageResult<$!{tableInfo.name}> pageResult = $!{serviceName}.findPage(page, size);
        return new Result<>(true, HttpStatus.HTTP_OK, "查询成功", pageResult);
    }
    
    /**
     * 按条件分页查询
     *
     * @param page    当前页
     * @param size    每页数据量
     * @param $!entityName 条件
     * @return 分页结果
     */
    @Operation(summary = "按条件分页查询", tags = "$!{tableName} API")
    @PostMapping(value = "/search/{page}/{size}")
    public Result<PageResult<$!{tableInfo.name}>> findPage(@RequestBody(required = false) $!{tableInfo.name} $entityName, @PathVariable int page, @PathVariable int size) {
        PageResult<$!{tableInfo.name}> pageResult = $!{serviceName}.findPage($entityName, page, size);
        return new Result<>(true, HttpStatus.HTTP_OK, "查询成功", pageResult);
    }

    /**
     * 通过主键查询单条数据
     *
     * @param $!pk.name 主键
     * @return 查询结果
     */
    @Operation(summary = "通过主键查询单条数据", tags = "$!{tableName} API")
    @GetMapping("/{$!pk.name}")
    public Result<$!{tableInfo.name}> selectOne(@PathVariable $!pk.shortType $!pk.name) {
        $!{tableInfo.name} $!entityName = $!{serviceName}.selectOne($!pk.name);
        return new Result<>(true, HttpStatus.HTTP_OK, "查询成功", $!entityName);
    }

    /**
     * 新增数据
     *
     * @param $!entityName 实体对象
     * @return 新增结果
     */
    @Operation(summary = "新增数据", tags = "$!{tableName} API")
    @PostMapping
    public Result insert(@RequestBody $!tableInfo.name $!entityName) {
        $!{serviceName}.insert($!entityName);
        return new Result(true, HttpStatus.HTTP_OK, "添加成功");
    }

    /**
     * 修改数据
     *
     * @param $!entityName 实体对象
     * @return 修改结果
     */
    @Operation(summary = "修改数据", tags = "$!{tableName} API")
    @PutMapping(value = "/{$!pk.name}")
    public Result update(@RequestBody $!tableInfo.name $!entityName, @PathVariable $!pk.shortType $!pk.name) {
        // 设置主键值
        $!{entityName}.setId($!pk.name);
        // 调用$!{serviceName}实现修改
        $!{serviceName}.update($!entityName);
        return new Result(true, HttpStatus.HTTP_OK, "修改成功");
    }

    /**
     * 删除数据
     *
     * @param $!pk.name 主键
     * @return 删除结果
     */
    @Operation(summary = "删除数据", tags = "$!{tableName} API")
    @DeleteMapping(value = "/{$!pk.name}" )
    public Result delete(@PathVariable $!pk.shortType $!pk.name) {
        $!{serviceName}.delete($!pk.name);
        return new Result(true, HttpStatus.HTTP_OK, "删除成功");
    }
    
    /**
     * 查询所有
     *
     * @return 所有数据
     */
    @Operation(summary = "查询所有", tags = "$!{tableName} API")
    @GetMapping
    public Result<List<$!tableInfo.name>> selectAll() {
        List<$!tableInfo.name> list = $!{serviceName}.selectAll();
        return new Result<>(true, HttpStatus.HTTP_OK, "查询成功", list);
    }
    
    /**
     * 按条件查询
     *
     * @param $!entityName 条件
     * @return 查询结果
     */
    @Operation(summary = "按条件查询", tags = "$!{tableName} API")
    @PostMapping("/search")
    public Result<List<$!tableInfo.name>> selectList($!tableInfo.name $!entityName) {
        List<$!tableInfo.name> list = $!{serviceName}.selectList($!entityName);
        return new Result<>(true, HttpStatus.HTTP_OK, "查询成功", list);
    }
}