你用过不写代码就能完成一个简单模块的组件么?

Posted by 石玉军 on 2018-10-14

开篇四连问

  1. 你是否懒得写普通的增删改查方法?
  2. 你是否不喜欢代码生成插件的重复代码?
  3. 你是否渴望一个没有冗余代码的项目?
  4. 你是否渴望一行代码都不用写就能完成一个简单的模块?

组件由来

作为后端程序员,相信大家都写过以下几种代码:

  1. 根据主键查询
  2. 多条件分页查询
  3. 插入
  4. 根据主键修改
  5. 根据主键删除(单个或批量)

抛开业务来说,这几种代码是我们项目中最最基本的代码了,每一个项目中都会出现大量的这种代码。那么你的项目中这种代码你是怎么写的呢?

  1. 按照dao-service-controller的流程写?
  2. copy一个现有的模块然后修修改改?
  3. 使用代码生成插件?
  4. 自己封装一个组件?



    对于我个人来说,就是从上方四个步骤走过来的。刚刚开始学习Java的时候跟着老师的步骤从dao到service接口到实现类再到controller。等到参加工作的时候就觉得没什么大不了的了,直接copy后进行修改。工作一段时间以后觉得自己写太累了然后就开始使用代码生成插件。


    但是使用插件一段时间以后我觉得每个项目中存在的太多太多的冗余代码了,单单进行全局搜索时一个方法名出现了几十次,如果有一个插件的代码需要修改那么就要修改几十次,稍不注意就给自己挖了个坑等等。然后呢我就在想,既然这些都是冗余方法那么我何不自己封装一个组件把这些东西都抽象出来做一个组件。以后开发时我只维护这一个组件,把剩余的精力放到业务代码上呢?

我封装的什么组件?

组件名称:syj-minicode

当一些单表的增删改查时你只需要告诉前端来调用这几个接口就行了

下方出现的entityName为当前操作的对象名称或者数据库表名称(注意命名规范要符合驼峰命名法,例如:UserOrder或者user_order都可以) 删除接口为物理删除,逻辑删除请使用update接口

  1. 根据主键查询对象
1
@RequestMapping(value = "/syj-api/{entityName}/{id}", method = RequestMethod.GET)
  1. 分页查询
1
2
@RequestMapping(value = "/syj-api/{entityName}/page", method = RequestMethod.POST)
@RequestBody: GridPageRequest

这里的GridPageRequest为分页查询的条件,看一下它的组成元素

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
/**
* 查询关键字Map
*/
private Map<String, String> searchMap;
/**
* 模糊查询关键字Map
*/
private Map<String, String> likeSearchMap;
/**
* 排序关键字Map
*/
private Map<String, String> orderMap;
/**
* 分组关键字数组
*/
private String[] groupArray;

private int pageNum;
private int pageSize;

前端查询时只需要按照查询条件组装GridPageRequest对象就可以了

  1. 插入
1
2
@RequestMapping(value = "/syj-api/{entityName}/insert", method = RequestMethod.POST)
@RequestBody: Object(待插入对象)
  1. 根据主键进行更新
1
2
@RequestMapping(value = "/syj-api/{entityName}/update", method = RequestMethod.PUT)
@RequestBody: Object(待更新对象)
  1. 根据主键进行删除
1
@RequestMapping(value = "/syj-api/{entityName}/{id}", method = RequestMethod.DELETE)
  1. 批量删除
1
2
@RequestMapping(value = "/syj-api/{entityName}/deleteByIds", method = RequestMethod.DELETE)
@RequestBody: List<String> ids(待删除主键列表)

扩展接口

  1. 因为默认情况下单个对象查询、修改、删除所依据的主键的字段名使用的都是"id",但是很可能有的项目使用的是userId、orderId、roleId等主键,如果你的项目符合这个条件注入下方这个bean。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    @Bean
    public IdField idField() {
    Map<String,String> map=new ConcurrentHashMap<>();
    map.put("user","userId");//key的名称为实体名称或数据库表名称,value为主键属性名
    map.put("order","orderId");
    map.put("role","roleId");
    IdField idField=new IdField();
    idField.setMap(map);
    return idField;
    }
  2. 有的项目在进行插入和更新时会加入创建人和修改人等信息。如果有此需求请按照如下方式调用

    1. 插入扩展

    创建一个名为InsertExtend的bean并实现DefaultExtend接口

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @Component
    public class InsertExtend implements ExtendInterface{
    @Override
    public Map<String, String> exectue() {
    Map<String, String> map=new HashMap<>();
    map.put("createTime", System.currentTimeMillis());
    map.put("createBy", "创建人id");
    map.put("createUserName", "创建人名称");
    return map;
    }
    }
    1. 更新扩展

    创建一个名为UpdateExtend的bean并实现DefaultExtend接口

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @Component
    public class UpdateExtend implements ExtendInterface{
    @Override
    public Map<String, String> exectue() {
    Map<String, String> map=new HashMap<>();
    map.put("updateTime", System.currentTimeMillis());
    map.put("updateBy", "修改人id");
    map.put("updateUserName", "修改人名称");
    return map;
    }
    }

还有没有更灵活的使用方式?

上方使用方式其实是直接抽象到了controller层,解决一般的需要是没问题的,但是我们是有业务逻辑的,那么存在业务逻辑的情况下如何使用呢?
你可以在处理完业务逻辑后在service中调用

  1. 初始化

    1
    2
    3
    private BaseService getUserBaseService(){
    return ServiceBeanFactory.getBean("User");
    }
  2. 根据id查询

    1
    2
    Map<String,Object> userMap=getUserBaseService().selectOneById("115");
    User user=(User) BeanMapUtil.mapToBean(map,User.class);
  3. 根据条件查询列表(相信你已经知道了gridPageRequest对象如何组装)

    1
    2
    3
    4
    List<Map<String, Object>> userMaps=getUserBaseService().selectBySelective(gridPageRequest);
    for (Map<String, Object> map:userMaps){
    User user=(User) BeanMapUtil.mapToBean(map,User.class);
    }
  4. 插入

    1
    getUserBaseService().insertSelective(user);
  5. 更新

    1
    getUserBaseService().updateByIdSelective(user);
  6. 删除

    1
    getUserBaseService().deleteById("115");
  7. 批量删除

    1
    2
    3
    4
    5
    List<String> list=new ArrayList<>();
    list.add("115");
    list.add("116");
    list.add("117");
    getUserBaseService().deleteByIds(list);

组件好用么?

看完我的介绍你觉得这个组件能满足你的基本需要么,如果可以话请移步下方的GitHub链接看一下这个组件的源码写的如何以及如何使用吧。

GitHub

本文出自http://zhixiang.org.cn,转载请保留。