在ngx-formly中自定义JSON Schema验证消息路径的最佳实践

背景介绍

ngx-formly是一个强大的Angular表单生成库，它允许开发者通过JSON Schema来定义表单结构和验证规则。在实际项目中，我们经常需要在Schema中定义验证失败时的提示信息，但默认情况下这些信息需要放在特定路径下（如widget.formlyConfig.validation.messages），这会导致Schema与特定工具耦合。

问题分析

从示例中可以看到，当前ngx-formly支持在JSON Schema中通过widget.formlyConfig.validation.messages路径定义验证消息。然而，这种写法存在两个主要问题：

1. 工具耦合性：Schema中直接引用了formlyConfig这样的特定工具配置，使得Schema无法在其他不依赖ngx-formly的环境中复用。

2. 路径冗长：验证消息需要嵌套在多层级路径下，不够简洁直观。

理想情况下，我们希望验证消息能够定义在更通用的路径下，如validationMessages，这样既保持了Schema的通用性，又提高了可读性。

解决方案

ngx-formly提供了map回调函数，允许开发者在解析JSON Schema时自定义字段映射逻辑。我们可以利用这个特性来实现验证消息路径的自定义。

实现步骤

1. 定义自定义映射函数：

export function customValidationMessagesMap(schema: any, field: FormlyFieldConfig) {
  if (schema.validationMessages) {
    field.validation = field.validation || {};
    field.validation.messages = {
      ...(field.validation.messages || {}),
      ...schema.validationMessages,
    };
  }
  return field;
}

2. 在FormlyModule配置中使用映射函数：

@NgModule({
  imports: [
    FormlyModule.forRoot({
      extras: {
        map: customValidationMessagesMap,
      },
    }),
  ],
})
export class AppModule {}

使用示例

现在，我们可以使用更简洁的Schema格式：

{
  "zipcode": {
    "pattern": "^[0-9]+$",
    "type": "string",
    "validationMessages": {
      "pattern": "邮政编码必须由5位数字组成"
    }
  }
}

优势分析

1. 解耦设计：Schema不再包含任何ngx-formly特定的配置，可以在不同平台和工具间共享。

2. 可维护性：验证消息定义在更直观的路径下，提高了Schema的可读性和可维护性。

3. 灵活性：通过映射函数可以灵活处理各种自定义Schema结构，满足不同项目的需求。

扩展建议

1. 多语言支持：可以在映射函数中根据当前语言环境选择不同的验证消息。

2. 默认消息：结合Schema中的验证规则自动生成默认验证消息，减少重复定义。

3. 消息模板：支持在消息中使用变量，如{{minLength}}，实现更动态的提示信息。

总结

通过ngx-formly的map回调功能，我们可以优雅地实现JSON Schema验证消息路径的自定义，既保持了Schema的通用性，又满足了项目特定的需求。这种方法适用于需要跨平台共享Schema或追求更高可维护性的项目场景。