Vue Vben Admin 中自定义表单组件的正确使用方式

在 Vue Vben Admin 项目中，开发者经常需要在表格搜索表单中使用自定义组件。然而，一些开发者在使用 h 函数渲染自定义组件时遇到了表单值无法正确获取的问题。本文将深入分析这一问题的根源，并提供几种正确的解决方案。

问题分析

当开发者尝试在表单 schema 中使用 h 函数直接包裹组件时，如以下代码所示：

component: (props) => {
  return h(Cascader, {
    ...props,
    onChange: (value) => {
      data.value = value;
    },
  });
}

这种写法会导致表单值无法正确传递到 query 方法的 formValues 参数中。问题的核心在于这种写法破坏了 Vue Vben Admin 表单系统的双向绑定机制。

正确解决方案

方案一：直接使用组件引用

最简单的方式是直接引用组件，而不是使用 h 函数包裹：

{
  component: Cascader,
  componentProps: {
    allowClear: true,
    changeOnSelect: true,
    options: cascaderOptions,
    placeholder: '请选择省市区',
  },
  fieldName: 'Ids',
  label: '省市区',
}

这种方式保持了表单的原生绑定机制，是最推荐的做法。

方案二：使用 markRaw 处理组件

如果需要动态决定使用哪个组件，可以使用 markRaw：

{
  component: markRaw(Cascader),
  componentProps: {
    // 同上
  },
  // 其他配置
}

方案三：正确处理 h 函数返回值

如果确实需要使用 h 函数，必须正确处理 props 和 attrs：

component: (props, { attrs }) => {
  return h(Cascader, {
    ...props,
    ...attrs,
    onChange: (value) => {
      props.onChange(value); // 必须调用原始 onChange
    },
  });
}

最佳实践建议

1. 优先使用直接组件引用的方式
2. 避免在表单 schema 中直接使用 h 函数
3. 如果必须自定义渲染逻辑，确保正确处理所有 props 和事件
4. 对于复杂表单场景，考虑使用插槽方式

总结

Vue Vben Admin 的表单系统提供了多种自定义组件的方式，但开发者需要理解其内部绑定机制。通过遵循本文提供的解决方案，可以避免表单值无法获取的问题，同时保持代码的简洁性和可维护性。记住，最简单的解决方案往往是最可靠的。