动态表单设计

一、选型分析

动态表单是一种要求比较灵活的使用场景，根据动态的模型来生成对应的表单，并且能够很方便的随时修改结构。

通过分析，整理了三种可能符合的方案。

1.MySQL物理表方案

每个模型对应生成一张MySQL物理表，并生成对应代码，动态装载到Spring。

此方案的优点是：

a. 做到了代码和数据的隔离，并且能很好的适应传统框架。

b. 查询统计比较方便

也有很多弊端：

a. 实现成本高，且需要解决运行时不停服新增表单对应的功能。

b. 变更不方便，每次结构变更需要修改物理表，并且重新生成对应的代码。

2.MySQL逻辑表方案

一张基础属性表+一张表单结构表+一张数据大表

image.png

a. 通过基础属性表创建结构映射表。

b. 实际的数据存储在大表中，字段对应到映射中的模型。

此方案的优点：

a. 实现成本低，逻辑控制数据关系。

b. 非常轻松的随时变更结构，只需要修改、删除或新增记录就可以实现效果。

缺点：

a. 不适合大量数据的操作，数据大表会极度膨胀。

b. 数据隔离性较差，做数据查询和统计比较麻烦。

3.NoSQL物理表方案

结合前2种方案，我们试图寻找一种既能做到数据隔离，也能方便后期随时修改结构的方案。

通过NoSQL文档类型数据库来解决灵活变更结构且能保证数据表的隔离。

在这里，我们选择的是MongoDB。下面，就按照这个思路展开详细设计。

二、MongoDB物理表方案设计

1. 逻辑设计

结构采用MySQL来存储维护，实际的数据采用MongoDB来存储。

表单结构关系设计

image.png

组件元素表的每条记录cell对应的是系统中支持的组件，包含了组件的类型、组件名称等属性。

字段对应到的是组件元素，这里可能是一个字段对应一个组件元素，也有可能是多个字段对应一个组件元素，因为组件元素有可能是复合组件，如身份信息组件等。

字段对应好后组合成字段集合，也就是实际的表单结构。

image.png

2.MongoDB表设计

公共字段设计

字段名	字段类型	备注
_id	string	默认字段，值根据uid生成，方便查询和去重
uid	string	业务uid

3.MongoDB操作API设计

因为表都是动态的，所以不适合用spring自带的mongoDb cruid框架，对于输入和输出数据需要用json来表现。

项目中定义了 MongoDbTemplate操作类来对动态表操作数据，具体方法如下：

/**
 * 查询记录
 * @param queryDTO
 * @return
 */
public JSONArray queryData(DocumentQueryDTO queryDTO)

/**
 * 查询单条记录
 * @param collectionName
 * @param uid
 * @return
 */
public JSONObject selectOne(String collectionName, String uid)

/**
 * 分页查询
 * @param queryPageDTO
 * @return
 */
public PageResult selectPage(DocumentQueryPageDTO queryPageDTO) 

/**
 * 单条记录插入
 * @param collectionName
 * @param jsonObject
 * @return
 */
public boolean insertOrUpdate(String collectionName, JSONObject jsonObject)

/**
 * 批量插入
 * @param collectionName
 * @param jsonArray
 * @return
 */
public boolean insertOrUpdateMany(String collectionName, JSONArray jsonArray)

/**
 * 删除文档
 * @param collectionName
 * @param uid
 * @return
 */
public boolean removeDocument(String collectionName, String uid)

/**
 * 根据条件删除
 * @param collectionName
 * @param filter
 * @return
 */
public boolean removeDocumentByFilter(String collectionName, Bson filter)

查询入参DocumentQueryDTO类字段信息如下

@Data
public class DocumentQueryDTO implements Serializable {

    private String collectionName;

    /**
     * 过滤条件
     * com.mongodb.client.model.Filters类来构建条件
     */
    private Bson filter;

    /**
     * 排序字段
     */
    private SortParam sortParam;

}

SortParam类字段信息

@Data
public class SortParam {

    /**
     * 排序字段名
     */
    private String sortKey;

    /**
     * 排序类型
     * ASC 升序
     * DESC 降序
     */
    private SortEnum sort;

}

Filters使用

//单条件查询
Bson filter = Filters.eq("uid", "123");

//多条件查询
Bson filter = Filters.and(Filters.eq("uid", "123"), Filters.eq("age", 12));

//也可支持or、in等操作符。