Easy Code插件使用（附Spring Data JPA生成模板）

一、概述

EasyCode可以自动根据表格生成：entity，dao，service，serviceImpl，controller等等

官方文档：https://gitee.com/makejava/EasyCode/wikis/pages

二、安装

1. 安装插件

在File --> setting --> Plugins --> Marketplace 中，搜索 easy code，点击Install进行安装，安装之后需要重启IDEA

2. 连接数据库

（a）打开Database，如果IDEA右侧边栏有的话可以直接点开，如果没有则通过如下方式点开：

（b）点击加号，选择数据源，这里选择MySql，其它数据库配置类似

（c）添加JDBC驱动，选择驱动jar包的位置

（d）配置数据库

三、生成代码

连接成功数据库后，选择要生成的表，鼠标右击，选择EasyCode --> Generate Code用来生成代码，Config Table用来配置表

点击Generate Code后，会弹出如下的窗口：

四、配置EasyCode

在 File --> Settings --> Other Settings --> Easy Code 中对EasyCode进行配置

• Type Mapper：类型映射，配置数据库中字段类型（支持正则表达式）与java对象的属性类型的映射
• Template Setting：配置模板信息，默认在安装了EasyCode后，自动带有两套模板，一套是默认，一套是MybatisPuls（后面会稍做修改），下一章提供了Spring Data JPA模板
• Global Config：全局配置，可以在模板中引用全局变量

五、Spring Data JPA模板

生成实体类请参考：Spring Data JPA详细入门

1. controller类

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Controller"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/controller"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end

#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}controller;

import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;

/**
 * $!{tableInfo.comment}($!{tableInfo.name})表控制层
 *
 * @author $!author
 * @since $!time.currTime()
 */
@RestController
@RequestMapping("$!tool.firstLowerCase($tableInfo.name)")
public class $!{tableName} {
    /**
     * 服务对象
     */
    @Resource
    private $!{tableInfo.name}Service $!tool.firstLowerCase($tableInfo.name)Service;

    /**
     * 通过主键查询单条数据
     *
     * @param id 主键
     * @return 单条数据
     */
    @GetMapping("selectOne")
    public $!{tableInfo.name} selectOne($!pk.shortType id) {
        return this.$!{tool.firstLowerCase($tableInfo.name)}Service.queryById(id);
    }

}

2. service接口

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Service"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/service"))

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

#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}service;

import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import java.util.List;
import org.springframework.data.domain.Page;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表服务接口
 *
 * @author zry
 * @since $!time.currTime()
 */
public interface $!{tableName} {
    $!{tableInfo.name} queryById($!pk.shortType $!pk.name);
    Page<$!{tableInfo.name}> queryAllByLimit(int offset, int limit);
    $!{tableInfo.name} insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
    $!{tableInfo.name} update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
    boolean deleteById($!pk.shortType $!pk.name);
     List<$!{tableInfo.name}> getall();
}

3. serviceImpl实现类

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "ServiceImpl"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/service/impl"))

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

#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}service.impl;

import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.dao.$!{tableInfo.name}Dao;
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.stereotype.Service;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import javax.annotation.Resource;
import java.util.List;
import org.springframework.data.domain.Page;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表服务实现类
 *
 * @author $!author
 * @since $!time.currTime()
 */
@Service("$!tool.firstLowerCase($!{tableInfo.name})Service")
public class $!{tableName} implements $!{tableInfo.name}Service {
    @Resource
    private $!{tableInfo.name}Dao $!tool.firstLowerCase($!{tableInfo.name})Dao;

    @Override
    public $!{tableInfo.name} queryById($!pk.shortType $!pk.name) {
        return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.getOne($!pk.name);
    }

    @Override
    public List<$!{tableInfo.name}> getall() {
        return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.findAll();

    }
    
     @Override
    public Page<$!{tableInfo.name}> queryAllByLimit(int offset, int limit) {
        return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.findAll(PageRequest.of((offset-1)
*limit,limit));
    }

    @Override
    public $!{tableInfo.name} insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
       
        return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.save($!tool.firstLowerCase($!{tableInfo.name}));
    }


    @Override
    public $!{tableInfo.name} update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
       
        return this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.save($!tool.firstLowerCase($!{tableInfo.name}));
    }

  
    @Override
    public boolean deleteById($!pk.shortType $!pk.name) {
    
     try{
             this.$!{tool.firstLowerCase($!{tableInfo.name})}Dao.deleteById($!pk.name) ;
        }catch (Exception ex){
            return false;
        }
        return true;
      
    }
}

4. dao接口

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Dao"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/dao"))

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

#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}dao;

import $!{tableInfo.savePackageName}.entity.$!{tableInfo.name};

import java.util.List;
import org.springframework.data.jpa.repository.JpaRepository;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表数据库访问层
 *
 * @author zry
 * @since $!time.currTime()
 */
public interface $!{tableName} extends JpaRepository<$!{tableInfo.name} ,$!pk.shortType>{

  
}

六、MyBatisPlus模板修改

修改时，建议先把原来的模板复制一份做备份。

1. entity实体类

原来的entity会生成大量的getter和setter，这里使用lombok来简化代码

##导入宏定义
$!define

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

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


##自动导入包（全局变量）
$!autoImport
##import com.baomidou.mybatisplus.extension.activerecord.Model;
import java.io.Serializable;
import lombok.Data;
##import com.baomidou.mybatisplus.annotation.IdType;
##import com.baomidou.mybatisplus.annotation.TableId;

##表注释（宏定义）
#tableComment("表实体类")
@Data
@SuppressWarnings("serial")
public class $!{tableInfo.name} implements Serializable {
  
#foreach($column in $tableInfo.fullColumn)
    #if(${column.comment})/**${column.comment}*/#end

    private $!{tool.getClsNameByFullName($column.type)} $!{column.name};
#end

###foreach($column in $tableInfo.fullColumn)
##    #getSetMethod($column)
###end

###foreach($column in $tableInfo.pkColumn)
##    /**
##     * 获取主键值
##     *
##     * @return 主键值
##     */
##    @Override
##    protected Serializable pkVal() {
##        return this.$!column.name;
##    }
##    #break
###end
}

2. 表以"t_"开头

原来的模板：当表以"t_"开头时，生成的所有类和接口，都会以T开头。例如表 t_user 生成的实体类为 TUser
修改：找到全局配置 Easy Code --> Global Config --> define 文件，将下面的代码添加到文件开头即可（代码也比较好懂，若是其它前缀，稍微修改一下即可）：

##去掉表的t_前缀
#if($tableInfo.obj.name.startsWith("t_"))
    $!tableInfo.setName($tool.getClassName($tableInfo.obj.name.substring(2)))
#end