schema/validator优化

[zhennann]

背景

CabloyJS采用ajv进行数据的前端渲染和后端验证

1. 通过schema来定义json数据规则
2. 定义一个validator用于实际的验证工作
3. 一个validator可以包含1个或者多个schema

目标

在大多数场景下，一个validator只需要包含一个schema。因此，可以依据schema自动定义validator，从而简化配置，减少代码量

方案

1. 依据schema自动定义validator
2. 如果存在一个validator包含多个schema的情况，只需按旧方案配置，从而覆盖缺省行为。也顺带实现了对旧方案的兼容处理

举例

原配置

src/module-system/a-baseadmin/backend/src/meta.js

module.exports = app => {
  // schemas
  const schemas = require('./config/validation/schemas.js')(app);
  ...
  // meta
  const meta = {
    ...
    validation: {
      validators: {
        roleRight: {
          schemas: 'roleRight',
        },
        roleRightSearch: {
          schemas: 'roleRightSearch',
        },
        roleResourceRight: {
          schemas: 'roleResourceRight',
        },
        roleResourceRightSearch: {
          schemas: 'roleResourceRightSearch',
        },
      },
      keywords: {},
      schemas,
    },
  };

  return meta;
};

优化后配置

module.exports = app => {
  // schemas
  const schemas = require('./config/validation/schemas.js')(app);
  ...
  // meta
  const meta = {
    ...
    validation: {
      validators: {},
      keywords: {},
      schemas,
    },
  };

  return meta;
};