Java自定义字段

小黄最近在工作中遇到一个比较有意思的需求，在此跟大家分享一下

需求

这个需求是这样的，用户在添加表单时，除了一些固定信息填入之外，还可以自定义一些字段填入，例如一个用户表，默认情况下姓名和年龄是所有人都要填入的，除此之外，比如小红想多添加一个字段身高，小白想多添加一个字段体重…所以在用户填入表单时，就需要可拓展的自定义字段。

小红存在数据库中的字段如下:

{
    "name":"小红",
    "age":18,
    "height":180
}

小白存在数据库中的字段如下:

{
    "name":"小红",
    "age":18,
    "weight":65
}

分析

其实接口是非常简单的，就是一套CRUD接口，所以我们来分析一下如何解决这个问题。

首先我们先和前端约定好，如何传一个表单格式，关于自定义字段，小黄是这样定义的

en：表示字段名
cn：表示字段中文名
type：表示字段类型，因为前端需要靠这个渲染页面，和前端约定
required：表示是否必填项
value：表示字段值

[       
    {
        "en": "name",
        "cn": "用户名",
        "type": 1,
        "required":1,
        "value": "小红"
    }
]

思路一

使用MySQL，创建一张User表，表结构如下设计

ext：表示用户自定义字段内容，使用json格式存储

使用这个方法可以将用户填入的多个自定义字段都存入在ext中，但是由于所有字段都挤在了一起，对于后续的可拓展性不是很高。

思路二

使用Mongo存储，Mongo是一个文档型数据库，每一条数据可以使用不同的字段存储，这对于我们这个需求来说就再适合不过了。

我们需要花两张表来存储信息，status用于表示逻辑删除

user表：用于存储字段对应的值，存储格式如下

{
    "_id": "98c6db9985c8481a8d80f3555b6db326",
    "status": NumberInt("0"),
    "name": "yellowstar459",
    "age": NumberInt("18"),
    "height": 180.5,
    "happy": "唱跳rap"
}

user_ext表：用于存储字段信息，存储格式如下，每个值分别对应cn,type,required

{
    "_id": "98c6db9985c8481a8d80f3555b6db326",
    "status": NumberInt("0"),
    "name": "用户名,1,1",
    "age": "年龄,2,1",
    "height": "身高,3,1",
    "happy": "爱好,1,1"
}

实现

这篇文章仅仅分享一下思路，代码写的都不是非常规范，见谅。

新增

定义一个接收前端参数的对象

@Data
public class Custom implements Serializable {
    private static final long serialVersionUID = 1L;

    private String en;

    private String cn;

    private Integer type;

    //1:必填,0:非必填
    private Integer required;

    private Object value;
}

编写业务类

/**
 * userExt对应
 * cn,type,required
 * status : 作为逻辑删除
 * @param list
 */
@PostMapping
public void add(@RequestBody List<Custom> list) {
    Document user = new Document();
    Document userExt = new Document();
    String id = UUID.randomUUID().toString().replaceAll("-", "");
    user.append("_id", id);
    user.append("status", 0);
    userExt.append("_id", id);
    userExt.append("status", 0);
    for (Custom custom : list) {
        user.append(custom.getEn(), custom.getValue());
        userExt.append(custom.getEn(), custom.getCn() + "," + custom.getType() + "," + custom.getRequired());
    }
    mongoTemplate.save(user, "user");
    mongoTemplate.save(userExt, "user_ext");
}

测试

我这边和前端约定type值

1：字符串
2：整型
3：浮点型

通过postman发送如下请求

[       
    {
        "en": "name",
        "cn": "用户名",
        "type": 1,
        "required":1,
        "value": "yellowstar"
    },
    {
        "en": "age",
        "cn": "年龄",
        "type": 2,
        "required":1,
        "value": 18
    },
    {
        "en": "height",
        "cn": "身高",
        "type": 3,
        "required":1,
        "value": 180.5
    },
    {
        "en": "happy",
        "cn": "爱好",
        "type": 1,
        "required":1,
        "value": "唱跳rap"
    }
]

存入Mongo的数据分别为

根据id查询

返回类

返回类需要一个id，在添加时将两张表的id设为相同

@Data
public class CustomVo implements Serializable {
    private static final long serialVersionUID = 1L;

    private String _id;

    private List<Custom> list;
}

业务类

@GetMapping("/{id}")
public CustomVo getById(@PathVariable(value = "id") String id) {
    Document user = mongoTemplate.findOne(Query.query(Criteria.where("_id").is(id).and("status").is(0)), Document.class, "user");
    Document userExt = mongoTemplate.findOne(Query.query(Criteria.where("_id").is(id).and("status").is(0)), Document.class, "user_ext");
    if (Objects.isNull(user) || Objects.isNull(userExt)) {
        throw new RuntimeException("数据不存在");
    }
    CustomVo customVo = new CustomVo();
    customVo.set_id(user.getString("_id"));
    List<Custom> list = new ArrayList<>();
    for (Map.Entry<String, Object> entry : user.entrySet()) {
        if ("_id".equals(entry.getKey()) || "status".equals(entry.getKey())) {
            continue;
        }
        Custom custom = new Custom();
        custom.setEn(entry.getKey());
        custom.setValue(entry.getValue());
        String ext = userExt.getString(entry.getKey());
        String[] split = ext.split(",");
        custom.setCn(split[0]);
        custom.setType(Integer.valueOf(split[1]));
        custom.setRequired(Integer.valueOf(split[2]));
        list.add(custom);
    }
    customVo.setList(list);
    return customVo;
}

更新

@PutMapping
public void update(@RequestBody CustomVo vo) {
    Document user = new Document();
    Document userExt = new Document();
    user.append("_id", vo.get_id());
    user.append("status", 0);
    userExt.append("_id", vo.get_id());
    userExt.append("status", 0);
    for (Custom custom : vo.getList()) {
        user.append(custom.getEn(), custom.getValue());
        userExt.append(custom.getEn(), custom.getCn() + "," + custom.getType() + "," + custom.getRequired());
    }
    Update userUpdate = Update.fromDocument(user);
    Update userExtUpdate = Update.fromDocument(userExt);
    mongoTemplate.updateFirst(Query.query(Criteria.where("_id").is(vo.get_id()).and("status").is(0)), userUpdate, "user");
    mongoTemplate.updateFirst(Query.query(Criteria.where("_id").is(vo.get_id()).and("status").is(0)), userExtUpdate, "user_ext");
}

删除

只需要修改status状态即可

@DeleteMapping("/{id}")
public void delete(@PathVariable(value = "id") String id) {
    Update update = Update.update("status", 1);
    mongoTemplate.updateFirst(Query.query(Criteria.where("_id").is(id).and("status").is(0)), update, "user");
    mongoTemplate.updateFirst(Query.query(Criteria.where("_id").is(id).and("status").is(0)), update, "user_ext");
}

列表

一般情况下，列表中肯定只显示一些通用的字段，目前只需要返回name，age即可

实体类

@Data
public class User {
    private String name;
    private Integer age;
}

业务逻辑

@GetMapping
public List<User> list(){
    Criteria criteria = Criteria.where("status").is(0);
    List<User> users = mongoTemplate.find(Query.query(criteria), User.class, "user");
    return users;
}