在ngx-formly中实现基于对象属性的数组唯一性校验

背景介绍

ngx-formly是一个强大的Angular表单生成库，它允许开发者通过JSON Schema来定义表单结构和验证规则。在实际开发中，我们经常需要确保数组中的元素具有唯一性，特别是当数组元素是复杂对象时。

JSON Schema中的uniqueItems属性

JSON Schema规范提供了uniqueItems属性来确保数组元素的唯一性。对于基本类型数组，直接设置uniqueItems: true即可：

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "uniqueItems": true
}

复杂对象数组的唯一性校验问题

当数组元素是对象时，uniqueItems会检查整个对象是否完全相同。但在实际业务中，我们往往只需要基于对象的某个属性来确保唯一性。例如：

{
  "type": "array",
  "items": {
    "$ref": "#/definitions/CustomTypes"
  },
  "uniqueItems": true
}

这种情况下，只有当两个对象的所有属性都完全相同时才会被视为重复，这通常不符合业务需求。

解决方案

1. 自定义验证器

ngx-formly允许我们创建自定义验证器来实现基于特定属性的唯一性检查：

export function uniqueItemsByProperty(propertyName: string): ValidatorFn {
  return (control: AbstractControl): ValidationErrors | null => {
    if (!Array.isArray(control.value)) return null;
    
    const seen = new Set();
    const hasDuplicate = control.value.some(item => {
      const key = item[propertyName];
      if (seen.has(key)) return true;
      seen.add(key);
      return false;
    });
    
    return hasDuplicate ? { uniqueItems: true } : null;
  };
}

2. 在表单配置中使用

在表单配置中，我们可以这样使用自定义验证器：

{
  "key": "CustomTypes",
  "type": "array",
  "validators": {
    "uniqueItems": {
      "expression": "$field.formControl | uniqueItemsByProperty:'CustomType'"
    }
  }
}

3. 扩展JSON Schema

为了保持JSON Schema的规范性，我们可以扩展Schema定义：

{
  "type": "array",
  "items": {
    "$ref": "#/definitions/CustomTypes"
  },
  "x-uniqueItemsBy": "CustomType"
}

然后创建一个Formly扩展来处理这个自定义属性：

export class UniqueItemsByExtension extends FieldExtension {
  prePopulate(field: FormlyFieldConfig): void {
    if (field.props?.uniqueItemsBy) {
      field.validators = field.validators || {};
      field.validators['uniqueItems'] = {
        expression: (c: AbstractControl) => {
          const property = field.props.uniqueItemsBy;
          // 实现验证逻辑
        }
      };
    }
  }
}

最佳实践建议

1. 明确业务需求：确定是基于整个对象还是特定属性进行唯一性校验

2. 性能考虑：对于大型数组，自定义验证器可能比原生uniqueItems更高效

3. 用户体验：提供清晰的错误提示，告知用户哪个属性值重复了

4. 前后端一致性：即使前端做了校验，后端也应进行相同的验证

5. 可维护性：将常用的验证逻辑封装为可复用的验证器或扩展

总结

在ngx-formly中实现基于对象属性的数组唯一性校验需要结合JSON Schema和自定义验证逻辑。虽然JSON Schema的uniqueItems属性对简单场景有效，但对于复杂对象数组，我们需要通过自定义验证器或扩展来实现更灵活的校验规则。这种方法既保持了JSON Schema的规范性，又能满足实际业务需求。