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

置顶 已于 2023-08-12 09:41:44 修改
阅读量8.1k 收藏 43
点赞数 24
文章标签： intellij-idea java ide
于 2023-05-29 12:11:18 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yu1431/article/details/130924049
版权
本文介绍了如何在Idea中集成EasyCode插件，用于自动化代码生成，并详细解释了EasyCode的各个配置项，如TypeMapper、Template、ColumnConfig和GlobalConfig。同时，针对使用MybatisPlus时的自定义配置进行了说明，包括如何处理继承BaseEntity的情况以及修改模板文件以适应项目需求。此外，还提到了Lombok的使用来简化实体类的编写。
摘要由CSDN通过智能技术生成

1、idea集成easyCode插件

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

2、easyCode插件介绍

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

2.1 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>

2.2 Template

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

 2.3 Column Config

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

2.4 Global Config

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

2.5 自定义配置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));
    }
}

3、生成代码

3、1 在idea中链接数据库

 输入自己数据库的账号密码、数据库名称即可。

 3.2 选择相应的表，进行生成代码操作

 选择包路径、代码生成后保存的路径及选择自定义分组规则进行代码生成。

 生成后的代码结构如下：

菜鸟码神
关注
懒人 IDEA 插件推荐: EasyCode 一键帮你生成所需代码(Easycode用法)
09-07
主要介绍了懒人 IDEA 插件推荐: EasyCode 一键帮你生成所需代码,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
EasyCode 生成代码
12-03
快速生成.net代码 EasyCode 生成代码 去官方看看效果
easycode 自定义模板
最新发布
bareape的博客
09-29 272
#自动导入包（仅导入实体属性需要的包，通常用于实体类）import $!import;#end。
EasyCode实现完整CRUD + 分页封装
Sun的个人博客
08-30 1067
【代码】EasyCode实现完整CRUD + 分页封装。
EasyCode代码生成模板
04-20
代码非常齐全
IntelliJ IDEA生成Mybatis代码插件
01-24
2022.8优化一版，Spring&MyBatis;框架，可生成service、mapper等。有图形用户界面，自由选择文件保存路径，基于窗口(项目)级别，提供参数记忆、路径选择界面、自动匹配路径和包，简化了操作流程，方便随时打开使用，符合大部分公司开发规范。 使用说明:https://blog.csdn.net/qq_21370913/article/details/86627484
Spring boot 之 EasyCode 代码生成工具
GIS摆渡人
02-04 3181
Easycode是idea的一个插件，可以直接对数据的表生成entity,controller,service,dao,mapper,无需任何编码，简单而强大。 1、安装(EasyCode) image.png 我这里的话是已经那装好了。 建议大家在安装一个插件，叫做Lombok。 Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equal...
Idea EasyCode插件
wan9x1nzZZ的博客
11-16 542
在指定区域修改好自己的模板后，就可以在实时调试的位置点击右侧>按钮预览效果，看不懂也没关系，多试试总能调出想要的效果，在底下另附一份删除GETSET方法和序列化相关内容，添加Lombok注释的实体类模板供大家直接使用。##引入宏定义##使用宏定义设置回调（保存位置与文件后缀）##使用宏定义设置包后缀##使用全局变量实现默认包导入##使用宏定义实现类注释信息#tableComment("实体类")@Data*/#endprivate $!#end。
MybatisPlus----- 扩展功能 代码生成
m0_59281987的博客
05-09 506
刚好数据库中还有一张address表尚未生成对应的实体和mapper等基础代码。首先需要配置数据库地址，在Idea顶部菜单中，找到。代码相对固定，重复编写也比较麻烦。因此MybatisPlus官方提供了代码生成器根据数据库表结构生成。只不过代码生成器同样要编码使用，也很麻烦。然后再次点击Idea顶部菜单中的other，然后选择。在使用MybatisPlus以后，基础的。的插件，它可以基于图形化界面完成。最终，代码自动生成到指定的位置了。然后重启你的Idea即可使用。的代码生成，非常简单。
【idea系列】插件之EasyCode
热门推荐
檀越的博客
12-22 3万+
EasyCode是idea的一个插件,主要功能是代码生成,类似的插件还有jpa supportEasyCode是idea的一个插件，可以采用图形化的方式对数据的表生成entity,controller,service,dao,mapper……无需任何编码，简单而强大。可以大幅度的提高开发效率.下面来给大家介绍下如何使用easycode这款插件。
SpringBoot整合Mybatis与EasyCode(快速开发神器)
qq_44784185的博客
03-29 1532
1. SpringBoot整合Mybatis 此处SpringBoot整合Mybatis是xml形式的整合，注解整合点我 1.1 新建boot项目并导入依赖，依赖如下 <dependency> <groupId>org.springframework.boot</groupId> <artifactId&g...
基于idea插件easycode编写java springboot mybatis代码生成模板
03-14
基于idea插件easycode编写java springboot mybatis代码生成模板,生成内容Controller,service,dao,mapper,生成接口是基于rest访问方式,add,update,delete,selectOne,selectAll
IDEA开源自动代码生成插件EasyCode v1.2.2
01-30
EasyCode是基于IntelliJ IDEA开发的代码生成插件，支持自定义任意模板（Java，html，js，xml）。只要是与数据库相关的代码都可以通过自定义模板来生成。支持数据库类型与java类型映射关系配置。支持同时生成生成多张表的代码。每张表有独立的配置信息。完全的个性化定义，规则由你设置。配置说明:https://gitee.com/makejava/EasyCode/wikis/pages?sort_id=729664&doc_id=166248
MybatisPlus笔记
小谭秃秃
10-13 873
MybatisPlus笔记 一、简介 1.MyBatisPlus介绍 MyBatis-Plus( 简称 MP),是一个 MyBatis 的增强工具包，只做增强不做改变. 为简化开 发工作、提高生产率而生，我们的愿景是成为 Mybatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。 2.代码及文档发布地址 官方地址: 代码发布地址: Github: Gitee: 文档发布地址: 代码地址： 学习地址： 二、集成MP 1.创建数据库表 -- 创建库 CREATE DATABAS
MyBatis Plus详细教程
m0_59092234的博客
09-08 2712
为什么要学MybatisPlus？MybatisPlus可以节省大量时间，所有的CRUD代码都可以自动化完成MyBatis-Plus是一个MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。特性：无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作强大的 CRUD 操作。
idea整合easycode插件 (代码神器)
java技术博客
03-03 471
IDEA 整合EasyCode插件 (代码神器) 参考网址: https://mp.weixin.qq.com/s/WLn7oS8XCGspwAfM2gHoAA Easycode是idea的一个插件，可以直接对数据的表生成entity,controller,service,dao,mapper,无需任何编码，简单而强大。 1、安装(EasyCode) 2、建立数据库 -- ---------------------------- -- Table structure for user -- -----
mybatis-plus自动生成代码
weixin_51304175的博客
04-04 4432
第一步：引入依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-generator</artifactId> <version>3.2.0</version> </dependency> <dependen
EasyCode代码生成器插件
m0_53951384的博客
01-02 446
在setting-> other settings -> Template -> Group Name【选择对应的组模板】-> 修改Group Name：MyBatis-Plus修改的内容不会在Default中生效， 各个组之间是独立的。
Idea插件推荐-EasyCode插件配置
cwz1028的博客
07-09 878
Idea插件：EasyCode快速生成entity,controller,service,dao,mapper
评论 4
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

菜鸟码神

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值