idea：利用EasyCode插件生成自定义增删改查接口

2020-04-11

背景

个人方面

作为程序员，多年工作以来总是会有繁琐的增删改查需求在耗尽人的精力和时间，一直在思考如何能把人从这里解放出来，终于在这次的新项目中找到了EasyCode插件来帮我从重复劳动中解放了出来，通过编写自定义的模版代码就能连接数据库后自动生成定制化并且复杂的增删改查代码。

项目方面

新项目成立，需要新建10个表每个表都有增删改查的繁琐功能，每个crud大概估工时为0.5天时间，一天能完成2个，并且不包括自我测试时间。即使是两个人分5个模块开发也需要很长时间，并且代码风格不一致。参照一下。

一级功能	二级功能	三级功能	工时	开发人员
XYZ管理	x模块	增	0.5天	张三
	x模块	删	0.5天	张三
	x模块	改	0.5天	张三
	x模块	查（详情、分页）	0.5天	张三
	y模块	增	0.5天	李四
	y模块	删	0.5天	李四
	y模块	改	0.5天	李四
…省略	…省略	…省略	…省略	…省略

初识EasyCode插件

最初的时候还不知道idea有该神器，当时还花了周末的一天时间去折腾利用反射和javassist修改字节码进行通用化能力，但是门槛比较高、并且不易维护、有内存溢出的风险，不如一个真实存在并且可修改的java文件实在。

偶然的机会通过公众号知道了该组件，但是生成的代码风格非常的糟糕，而且漏洞百出。后来发现原来可以定制化自己的模版。于是花了大概2小时定制了我想要的东西。

生成代码演示

配置模版演示

优点

统一代码风格
减少测试时间
解放重复人力
可定制化模版

缺点

多个maven模块的项目里，选择多个表生成会出现路径错误

建议和mybatis-generator配合使用

mybatis-generator提供了丰富的增删改查的方法，没必要再花时间重复造轮子，所以可以利用mybatis-generator生成dao、dao.xml、entity然后使用EasyCode生成service的增删改查。

其他

下载地址 https://gitee.com/makejava/EasyCode

个人代码模版

facade.java

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "Facade"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/facade"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end
#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}facade;
import $!{tableInfo.savePackageName}.dto.CommonDTO;
import $!{tableInfo.savePackageName}.orm.entity.$!{tableInfo.name};
import javax.ws.rs.*;
import me.ele.stargate.mapping.ProducesRawJson;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表对外暴露接口
 *
 * @author $!author
 * @since $!time.currTime()
 */
@Path("/$!tool.firstLowerCase($!{tableInfo.name})")
@ProducesRawJson
public interface $!{tableName} {
    /**
     * 新建
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 添加参数
     */
    @Path("insert")
    @POST
    CommonDTO insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
    /**
     * 删除
     * @param id 主键
     */
    @Path("/delete/{id}")
    @DELETE
    CommonDTO delete(@PathParam("id")$!pk.shortType id);
    
    /**
     * 改
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 添加参数
     */
    @Path("/update/{id}")
    @PUT
    CommonDTO update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
    /**
     * 通过主键查询单条数据
     * @param id 主键
     * @return 单条数据
     */
    @Path("/{id}")
    @GET
    CommonDTO getOne(@PathParam("id")$!pk.shortType id);
    
   
    /**
     * 分页查询
     * @param pageNum 当前页码 必须大于1
     * @param pageSize 查询条数
     * @return list和count
     */
    @Path("/list")
    @GET
    CommonDTO list($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}),int pageNum,int pageSize);
    
}

facadeImpl.java

##定义初始变量
#set($tableName = $tool.append($tableInfo.name, "FacadeImpl"))
##设置回调
$!callback.setFileName($tool.append($tableName, ".java"))
$!callback.setSavePath($tool.append($tableInfo.savePath, "/facade/impl"))
##拿到主键
#if(!$tableInfo.pkColumn.isEmpty())
    #set($pk = $tableInfo.pkColumn.get(0))
#end
#if($tableInfo.savePackageName)package $!{tableInfo.savePackageName}.#{end}facade.impl;
import $!{tableInfo.savePackageName}.orm.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.beans.factory.annotation.Autowired;
import $!{tableInfo.savePackageName}.dto.CommonDTO;
import org.springframework.stereotype.Component;
import $!{tableInfo.savePackageName}.facade.$!{tableInfo.name}Facade;
import static $!{tableInfo.savePackageName}.constant.Constant.HttpResponseConstants.SUCCESS;
import static $!{tableInfo.savePackageName}.constant.Constant.HttpResponseMsgConstants.MSG_SUCCESS;
import lombok.extern.slf4j.Slf4j;
import com.alibaba.fastjson.JSON;
import java.util.Map;
import javax.ws.rs.*;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表facade
 *
 * @author $!author
 * @since $!time.currTime()
 */
@Slf4j
@Component
public class $!{tableName} implements $!{tableInfo.name}Facade {
    /**
     * 服务对象
     */
    @Autowired
    private $!{tableInfo.name}Service $!tool.firstLowerCase($tableInfo.name)Service;
    /**
     * 新建
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 添加参数
     */
    @Override
    public CommonDTO insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
        log.info("$!{tableName} insert query={}",JSON.toJSONString($!tool.firstLowerCase($!{tableInfo.name})));
        return new CommonDTO(SUCCESS,MSG_SUCCESS,$!{tool.firstLowerCase($!{tableInfo.name})}Service.insert($!tool.firstLowerCase($!{tableInfo.name})));
    }
    /**
     * 删除
     * @param id 主键
     */
    @Override
    public CommonDTO delete(@PathParam("id")$!pk.shortType id) {
        log.info("$!{tableName} delete id={}",id);
        return new CommonDTO(SUCCESS,MSG_SUCCESS,$!{tool.firstLowerCase($!{tableInfo.name})}Service.delete(id));
    }
    
    /**
     * 改
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 添加参数
     */
    @Override
    public CommonDTO update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
        log.info("$!{tableName} update query={}",JSON.toJSONString($!tool.firstLowerCase($!{tableInfo.name})));
        return new CommonDTO(SUCCESS,MSG_SUCCESS,$!{tool.firstLowerCase($!{tableInfo.name})}Service.update($!tool.firstLowerCase($!{tableInfo.name})));
    }
    /**
     * 通过主键查询单条数据
     *
     * @param id 主键
     * @return 单条数据
     */
    @Override
    public CommonDTO getOne($!pk.shortType id) {
        log.info("$!{tableName} getOne id={}",id);
        return new CommonDTO(SUCCESS,MSG_SUCCESS,$!{tool.firstLowerCase($!{tableInfo.name})}Service.getOne(id));
    }
    
   
    /**
     * 分页查询
     * @param pageNum 当前页码 必须大于1
     * @param pageSize 查询条数
     * @return list
     */
    @Override
    public CommonDTO list($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}),int pageNum,int pageSize) {
        log.info("$!{tableName} list query={},pageNum={},pageSize={}",JSON.toJSONString($!tool.firstLowerCase($!{tableInfo.name})),pageNum,pageSize);
        Map<String,Object> map = $!{tool.firstLowerCase($!{tableInfo.name})}Service.list($!tool.firstLowerCase($!{tableInfo.name}),pageNum,pageSize);
        return new CommonDTO(SUCCESS,MSG_SUCCESS,map);
    }
}

service.java

##定义初始变量
#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}.orm.entity.$!{tableInfo.name};
import java.util.Map;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表服务接口
 *
 * @author $!author
 * @since $!time.currTime()
 */
public interface $!{tableName} {
    /**
     * 新增数据
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
     * @return 实例对象
     */
    $!{tableInfo.name} insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
    
    /**
     * 通过主键删除数据
     *
     * @param $!pk.name 主键
     * @return 是否成功
     */
    boolean delete($!pk.shortType $!pk.name);
    /**
     * 修改数据
     *
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
     * @return 实例对象
     */
    $!{tableInfo.name} update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}));
    /**
     * 通过ID查询单条数据
     *
     * @param $!pk.name 主键
     * @return 实例对象
     */
    $!{tableInfo.name} getOne($!pk.shortType $!pk.name);
    /**
     * 查询多条数据
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 查询条件
     * @param pageNum 查询起始位置
     * @param pageSize 查询条数
     * @return 对象列表和数量 total，list
     */
    Map<String,Object> list($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name}),int pageNum, int pageSize);
}

serviceImpl.java

##定义初始变量
#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}.orm.entity.$!{tableInfo.name};
import $!{tableInfo.savePackageName}.orm.entity.$!{tableInfo.name}Example;
import $!{tableInfo.savePackageName}.orm.mapper.$!{tableInfo.name}Mapper;
import $!{tableInfo.savePackageName}.service.$!{tableInfo.name}Service;
import org.springframework.stereotype.Service;
import org.springframework.beans.factory.annotation.Autowired;
import java.util.List;
import static $!{tableInfo.savePackageName}.constant.Constant.DeletedCosntants.NO_DELETED;
import static $!{tableInfo.savePackageName}.constant.Constant.DeletedCosntants.DELETED;
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;
/**
 * $!{tableInfo.comment}($!{tableInfo.name})表服务实现类
 *
 * @author $!author
 * @since $!time.currTime()
 */
@Slf4j
@Service
public class $!{tableName} implements $!{tableInfo.name}Service {
    @Autowired
    private $!{tableInfo.name}Mapper $!tool.firstLowerCase($!{tableInfo.name})Mapper;
    
    
    /**
     * 新增数据
     *
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
     * @return 实例对象
     */
    @Override
    public $!{tableInfo.name} insert($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
    
        $!{tool.firstLowerCase($!{tableInfo.name})}Mapper.insertSelective($!tool.firstLowerCase($!{tableInfo.name}));
    
        return $!tool.firstLowerCase($!{tableInfo.name});
    }
    
    /**
     * 通过主键删除数据
     *
     * @param $!pk.name 主键
     * @return 是否成功
     */
    @Override
    public boolean delete($!pk.shortType $!pk.name) {
        $!{tableInfo.name} record=new $!{tableInfo.name}();
        record.setId($!pk.name);
        record.setIsDelete(DELETED);
        return $!{tool.firstLowerCase($!{tableInfo.name})}Mapper.updateByPrimaryKeySelective(record) > 0;
    }
    /**
     * 修改数据
     *
     * @param $!tool.firstLowerCase($!{tableInfo.name}) 实例对象
     * @return 实例对象
     */
    @Override
    public $!{tableInfo.name} update($!{tableInfo.name} $!tool.firstLowerCase($!{tableInfo.name})) {
        $!{tool.firstLowerCase($!{tableInfo.name})}Mapper.updateByPrimaryKeySelective($!tool.firstLowerCase($!{tableInfo.name}));
        return getOne($!{tool.firstLowerCase($!{tableInfo.name})}.get$!tool.firstUpperCase($pk.name)());
    }
    /**
     * 通过ID查询单条数据
     *
     * @param $!pk.name 主键
     * @return 实例对象
     */
    @Override
    public $!{tableInfo.name} getOne($!pk.shortType $!pk.name) {
        return $!{tool.firstLowerCase($!{tableInfo.name})}Mapper.selectByPrimaryKey($!pk.name);
    }
    /**
     * 查询多条数据
     *
     * @param pageNum 查询起始位置
     * @param pageSize 查询条数
     * @return 对象列表
     */
    @Override
    public Map<String,Object> list($!{tableInfo.name} $!{tool.firstLowerCase($!{tableInfo.name})},int pageNum, int pageSize) {
        Map<String,Object> map = new HashMap<>();
        if(pageNum==0){
            pageNum=1;
        }
        if(pageSize==0){
           pageSize=10; 
        }
        int startNo=(pageNum-1)*pageSize;
        
        $!{tableInfo.name}Example example = new $!{tableInfo.name}Example();
        $!{tableInfo.name}Example.Criteria criteria=example.createCriteria();
        criteria.andIsDeleteEqualTo(NO_DELETED);
        //判断有无值
#foreach($temp in $tableInfo.fullColumn)
#if($!{temp.name}=='drcCheckTime')#elseif($!{temp.name}=='ezoneShardInfo')#else 
        if($!{tool.firstLowerCase($!{tableInfo.name})}.get$!tool.firstUpperCase($!{temp.name})()!=null){
            criteria.and$!tool.firstUpperCase($!{temp.name})EqualTo($!{tool.firstLowerCase($!{tableInfo.name})}.get$!tool.firstUpperCase($!{temp.name})());
        }
#end
#end
        
        example.setOrderByClause(" id DESC LIMIT "+startNo+","+pageSize);
        //查询数据库
        long count = $!{tool.firstLowerCase($!{tableInfo.name})}Mapper.countByExample(example);
        List<$!{tableInfo.name}> list = new ArrayList<>();
        if(count>0){
            list = $!{tool.firstLowerCase($!{tableInfo.name})}Mapper.selectByExample(example);
        }
        map.put("count",count);
        map.put("list",list);
        return map;
    }
}