IDEA 集成 EasyCode 插件，快速生成自定义 mybatisplus 代码

标签：tableInfo 插件 mybatisplus name 自定义 java ## import com

IDEA 集成 easyCode 插件

在 idea 插件市场中，搜索 EasyCode 插件，下载并进行安装

EasyCode 插件介绍

1. 修改作者名称

EasyCode 插件可以修改作者名称，即生成代码后，注释中自动添加相应作者的姓名。

2. Type Mapper

Type Mapper 指的是生成 mapper.xml 文件中数据库中的字段和 java 中代码的字段以及生成 mybatis 数据之间的类型转换。最常见的形式如下,也就是 java 中的属性 property、数据库中的列名 column 数据类型之间的转换 jdbcType

举例如下：

<resultMap type="com.school.infomation.entity.SysRoleEntity" id="SysRoleMap">
    <result property="id" column="id" jdbcType="INTEGER"/>
    <result property="name" column="name" jdbcType="VARCHAR"/>
    <result property="code" column="code" jdbcType="VARCHAR"/>
    <result property="isEnabled" column="is_enabled" jdbcType="INTEGER"/>
    <result property="isDeleted" column="is_deleted" jdbcType="INTEGER"/>
    <result property="remark" column="remark" jdbcType="VARCHAR"/>
    <result property="createUser" column="create_user" jdbcType="INTEGER"/>
    <result property="createTime" column="create_time" jdbcType="TIMESTAMP"/>
    <result property="updateUser" column="update_user" jdbcType="INTEGER"/>
    <result property="updateTime" column="update_time" jdbcType="TIMESTAMP"/>
</resultMap>

3. Template

template 是最核心的内容，可以生成相应的代码。同时，可以进行相应插件的选择，Default 默认形式是 mybatis，如果使用 mybatisPlus可以选择 MybatisPlus 自动生成相应代码。

4. Column Config

Column Config 主要用来对列进行相关的额外配置，基本上用不到。默认就行。

5. Global Config

Global Config 全局配置，主要配置相关包的导入、代码的注释及相关生成。

6. 自定义配置 mybatisplus

首先来看一个实体类，从该实体类中，可以发现，该类继承了 BaseEntity。

SysRoleEntity实体类

package com.school.infomation.entity;
import com.baomidou.mybatisplus.annotation.TableName;
import com.school.infomation.core.security.entity.BaseEntity;
import com.school.infomation.enums.status.EnabledEnum;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
import java.io.Serializable;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
@TableName("sys_role")
public class SysRoleEntity extends BaseEntity implements Serializable {
 
    private static final long serialVersionUID = 1L;
 
    /**
     * 角色名称
     */
    private String name;
 
    /**
     * 角色编码
     */
    private String code;
 
    /**
     * 是否启用 0启用 1禁用
     */
    private EnabledEnum isEnabled;
 
    /**
     * 备注
     */
    private String remark;
}

BaseEntity实体类

package com.school.infomation.core.security.entity;
import com.alibaba.fastjson.annotation.JSONField;
import com.alibaba.fastjson.serializer.ToStringSerializer;
import com.baomidou.mybatisplus.annotation.*;
import com.school.infomation.enums.status.DeletedEnum;
import com.school.infomation.utils.DateUtil;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.io.Serializable;
import java.time.LocalDateTime;
 
/**
 * 基础实体类
 */
@Data
public class BaseEntity implements Serializable {
    /**
     * 主键id
     */
    @JSONField(serializeUsing = ToStringSerializer.class)
    @TableId(value = "id", type = IdType.ASSIGN_ID)
    private Long id;
 
    /**
     * 创建人
     */
    @TableField(fill = FieldFill.INSERT)
    @JSONField(serializeUsing = ToStringSerializer.class)
    private Long createUser;
 
    /**
     * 创建时间
     */
    @TableField(fill = FieldFill.INSERT)
    @DateTimeFormat(pattern = DateUtil.PATTERN_DATETIME)
    @JSONField(format = DateUtil.PATTERN_DATETIME)
    private LocalDateTime createTime;
 
    /**
     * 更新人
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @JSONField(serializeUsing = ToStringSerializer.class)
    private Long updateUser;
 
    /**
     * 更新时间
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    @DateTimeFormat(pattern = DateUtil.PATTERN_DATETIME)
    @JSONField(format = DateUtil.PATTERN_DATETIME)
    private LocalDateTime updateTime;
 
    /**
     * 状态[0:未删除,1:删除]
     */
    @TableLogic
    @TableField(fill = FieldFill.INSERT)
    private DeletedEnum isDeleted;
}

如果使用easyCode默认配置的话，生成实体类的时候，则无法自动导入com.school.infomation.core.security.entity.BaseEntity包。这时，需要添加一个全局配置

另外一个问题就是，如果选择继承了BaseEntity，则表明生成的SysRole实体类不能在有id，createUser等公共字段。这时需要排除。

#set($temp = $tool.newHashSet("id", "createUser", "updateUser", "createTime", "updateTime", "isDeleted"))
#foreach($item in $temp)
    #set($newList = $tool.newArrayList())
    #foreach($column in $tableInfo.fullColumn)
        #if($column.name!=$item)
            $tool.call($newList.add($column))
        #end
    #end
    $tableInfo.setFullColumn($newList)
#end

生成实体类的文件后面都有Entity后缀，这是，得需要修改 Template 中的 entity.java.vm 文件。

建议修改这些文件的时候，我们可以自定义一个分组，将其他分组文件复制过来，在进行修改。

我们也可以增加lombok插件，将自动生成set、get方法删除。

具体修改后文件如下：

entity.java.vm文件

##导入宏定义
$!{define.vm}
##保存文件（宏定义）
#save("/entity", "Entity.java")
#set($temp = $tool.newHashSet("id", "createUser", "updateUser", "createTime", "updateTime", "isDeleted"))
#foreach($item in $temp)
    #set($newList = $tool.newArrayList())
    #foreach($column in $tableInfo.fullColumn)
        #if($column.name!=$item)
            $tool.call($newList.add($column))
        #end
    #end
    $tableInfo.setFullColumn($newList)
#end
 
#setPackageSuffix("entity")
##自动导入包（全局变量）
$!{customExtendBaseEntity.vm}
$!{autoImport.vm}
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import lombok.Data;
import lombok.AllArgsConstructor;
import lombok.NoArgsConstructor;
 
##表注释（宏定义）
#tableComment("表实体类")
@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("$!{tableInfo.obj.name}")
public class $!{tableInfo.name}Entity extends BaseEntity implements Serializable {
 
    private static final long serialVersionUID = 1L;
 
#foreach($column in $tableInfo.fullColumn)
    #if(${column.comment})//${column.comment}#end
    
    private $!{tool.getClsNameByFullName($column.type)} $!{column.name};
#end
}

因为 EasyCode 自动生成的是 dao 文件，同样可以修改为 mapper 文件。

mapper.java.vm文件

##导入宏定义
$!{define.vm}
 
##设置表后缀（宏定义）
#setTableSuffix("Mapper")
 
##保存文件（宏定义）
#save("/mapper", "Mapper.java")
 
##包路径（宏定义）
#setPackageSuffix("mapper")
 
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name}Entity;
 
##表注释（宏定义）
#tableComment("表数据库访问层")
@Mapper
public interface $!{tableName} extends BaseMapper<$!{tableInfo.name}Entity> {
 
}

mapper.xml.vm文件

##引入mybatis支持
$!{mybatisSupport.vm}
 
##设置保存名称与保存位置
$!callback.setFileName($tool.append($!{tableInfo.name}, "Mapper.xml"))
$!callback.setSavePath($tool.append($modulePath, "/src/main/resources/mapper"))
 
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="$!{tableInfo.savePackageName}.mapper.$!{tableInfo.name}Mapper">
 
    <resultMap type="$!{tableInfo.savePackageName}.entity.$!{tableInfo.name}Entity" id="$!{tableInfo.name}Map">
#foreach($column in $tableInfo.fullColumn)
        <result property="$!column.name" column="$!column.obj.name" jdbcType="$!column.ext.jdbcType"/>
#end
    </resultMap>
 
</mapper>

service.java.xml文件

##导入宏定义
$!{define.vm}
 
##设置表后缀（宏定义）
#setTableSuffix("Service")
 
##保存文件（宏定义）
#save("/service", "Service.java")
 
##包路径（宏定义）
#setPackageSuffix("service")
 
import com.baomidou.mybatisplus.extension.service.IService;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name}Entity;
 
##表注释（宏定义）
#tableComment("表服务接口")
public interface $!{tableName} extends IService<$!{tableInfo.name}Entity>{
 
}

serviceImpl.java.vm文件

##导入宏定义
$!{define.vm}
 
##设置表后缀（宏定义）
#setTableSuffix("ServiceImpl")
 
##保存文件（宏定义）
#save("/service/impl", "ServiceImpl.java")
 
##包路径（宏定义）
#setPackageSuffix("service.impl")
 
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import $!{tableInfo.savePackageName}.mapper.$!{tableInfo.name}Mapper;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name}Entity;
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.stereotype.Service;
 
##表注释（宏定义）
#tableComment("表服务实现类")
@Service
public class $!{tableName} extends ServiceImpl<$!{tableInfo.name}Mapper, $!{tableInfo.name}Entity> implements $!{tableInfo.name}Service{
 
}

controller.java.vm文件

这个文件可以自定义返回的工具类。如果自定义返回的类 ResultUtil.java; 导入自定义的包时，需要在全局中进行配置相关包名，然后进行引入。

$!{resultUtil.vm}

##导入宏定义
$!{define.vm}
 
##设置表后缀（宏定义）
#setTableSuffix("Controller")
##保存文件（宏定义）
#save("/controller", "Controller.java")
##包路径（宏定义）
#setPackageSuffix("controller")
 
##定义服务名
#set($serviceName = $!tool.append($!tool.firstLowerCase($!tableInfo.name), "Service"))
##定义实体对象名
#set($entityName = $!tool.firstLowerCase($!tableInfo.name))
$!{resultUtil.vm}
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name}Entity;
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;
import java.io.Serializable;
import java.util.List;
 
##表注释（宏定义）
#tableComment("表控制层")
@RestController
@RequestMapping("$!tool.firstLowerCase($!tableInfo.name)")
public class $!{tableName} {
    /**
     * 服务对象
     */
    @Resource
    private $!{tableInfo.name}Service $!{serviceName};
 
    /**
     * 分页查询所有数据
     *
     * @param page 分页对象
     * @param $!entityName 查询实体
     * @return 所有数据
     */
    @GetMapping
    public ResultUtil selectAll(Page<$!{tableInfo.name}Entity> page, $!{tableInfo.name}Entity $!entityName) {
        return ResultUtil.success(this.$!{serviceName}.page(page, new QueryWrapper<>($!entityName)));
    }
 
    /**
     * 通过主键查询单条数据
     *
     * @param id 主键
     * @return 单条数据
     */
    @GetMapping("{id}")
    public ResultUtil selectOne(@PathVariable Serializable id) {
        return ResultUtil.success(this.$!{serviceName}.getById(id));
    }
 
    /**
     * 新增数据
     *
     * @param $!entityName 实体对象
     * @return 新增结果
     */
    @PostMapping
    public ResultUtil insert(@RequestBody $!{tableInfo.name}Entity $!entityName) {
        return ResultUtil.success(this.$!{serviceName}.save($!entityName));
    }
 
    /**
     * 修改数据
     *
     * @param $!entityName 实体对象
     * @return 修改结果
     */
    @PutMapping
    public ResultUtil update(@RequestBody $!{tableInfo.name}Entity $!entityName) {
        return ResultUtil.success(this.$!{serviceName}.updateById($!entityName));
    }
 
    /**
     * 删除数据
     *
     * @param idList 主键结合
     * @return 删除结果
     */
    @DeleteMapping
    public ResultUtil delete(@RequestParam("idList") List<Long> idList) {
        return ResultUtil.success(this.$!{serviceName}.removeByIds(idList));
    }
}