在ngx-formly中基于自定义字段动态显示/隐藏表单字段

ngx-formly是一个强大的Angular表单生成库，它允许开发者通过JSON Schema动态生成表单。在实际开发中，我们经常需要根据用户的选择动态显示或隐藏某些表单字段。本文将详细介绍如何在ngx-formly中实现这一功能。

需求分析

假设我们有一个表单，其中包含一个"用户类型"选择字段（standard/advanced/dev），根据用户选择的不同类型，需要显示不同的表单字段。例如：

• 标准用户只能看到基础字段
• 高级用户可以看到更多选项
• 开发者可以看到所有技术参数

实现方案

1. 定义JSON Schema

首先，我们需要在JSON Schema中为每个字段添加自定义属性props.visibility，用于标识该字段应该对哪种用户类型可见：

{
  "properties": {
    "user_type": {
      "title": "User type",
      "type": "string",
      "enum": ["standard", "advanced", "dev"]
    },
    "start_timestamp": {
      "title": "Start Timestamp",
      "type": "number",
      "props": {
        "visibility": "standard"
      }
    },
    "stop_timestamp": {
      "title": "Stop Timestamp",
      "type": "number",
      "props": {
        "visibility": "advanced"
      }
    },
    "multithread": {
      "title": "Multithread",
      "type": "integer",
      "props": {
        "visibility": "dev"
      }
    }
  }
}

2. 转换Schema并添加动态显示逻辑

使用ngx-formly的toFieldConfig方法转换Schema时，我们需要为每个字段添加hide表达式：

import { FormGroup } from '@angular/forms';
import { FormlyFieldConfig } from '@ngx-formly/core';

export class MyFormComponent {
  form = new FormGroup({});
  fields: FormlyFieldConfig[];
  model = { user_type: 'standard' };

  constructor() {
    // 转换JSON Schema为Formly配置
    this.fields = [jsonSchemaToFormlyFieldConfig(mySchema)];
    
    // 递归处理所有字段，添加动态显示逻辑
    this.applyVisibilityExpressions(this.fields);
  }

  applyVisibilityExpressions(fields: FormlyFieldConfig[]) {
    fields.forEach(field => {
      // 如果字段有visibility属性，则添加hide表达式
      if (field.props?.visibility) {
        field.expressions = {
          hide: (model) => {
            const userType = model['user_type'] || 'standard';
            return field.props.visibility !== userType;
          }
        };
      }

      // 递归处理嵌套字段组
      if (field.fieldGroup) {
        this.applyVisibilityExpressions(field.fieldGroup);
      }
    });
  }
}

3. 工作原理

1. 表达式绑定：ngx-formly的expressions.hide属性允许我们根据模型数据动态决定是否隐藏字段
2. 响应式更新：当user_type字段值变化时，ngx-formly会自动重新计算所有相关字段的hide表达式
3. 递归处理：applyVisibilityExpressions方法会递归遍历所有字段及其嵌套字段组，确保整个表单结构都能正确应用显示逻辑

高级用法

1. 组合条件显示

如果需要基于多个字段组合条件显示，可以扩展表达式逻辑：

field.expressions = {
  hide: (model) => {
    return !(model.user_type === 'dev' || 
            (model.user_type === 'advanced' && field.props.visibility !== 'dev'));
  }
};

2. 性能优化

对于大型表单，可以考虑以下优化：

• 使用field.hide代替expressions.hide直接设置布尔值
• 在user_type变更时手动触发更新，而不是依赖自动检测

3. 自定义扩展

可以创建一个自定义扩展来封装这一功能：

export function visibilityExtension(): FormlyExtension {
  return {
    prePopulate(field: FormlyFieldConfig) {
      if (field.props?.visibility) {
        field.expressions = {
          ...field.expressions,
          hide: (model) => model.user_type !== field.props.visibility
        };
      }
    }
  };
}

// 在模块中注册
@NgModule({
  imports: [
    FormlyModule.forRoot({
      extensions: [{ name: 'visibility', extension: visibilityExtension }]
    })
  ]
})

总结

通过ngx-formly的表达式系统和自定义属性，我们可以轻松实现基于用户选择的动态表单显示逻辑。这种方法不仅灵活，而且维护简单，只需在JSON Schema中添加少量元数据即可控制整个表单的显示行为。对于更复杂的需求，还可以通过自定义扩展来封装通用逻辑，提高代码复用性。