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

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

问题分析

当开发者尝试在表单 schema 中使用 h 函数直接包裹组件时，例如：

component: (props) => {
  return h(Input, {
    ...props,
  });
}

这种写法会导致表单值无法正确绑定到 formValues 中。核心原因在于：

1. 这种写法创建了一个新的函数组件，破坏了 Vben Admin 表单系统的内部绑定机制
2. 直接使用 h 函数时，如果没有正确处理 attrs 和 props，会导致表单的双向绑定失效

正确解决方案

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

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

{
  component: Input,
  componentProps: {
    allowClear: true,
    placeholder: '请输入地点关键词'
  },
  fieldName: 'keyword',
  label: '关键词'
}

方案二：使用 markRaw 处理组件

如果需要自定义组件逻辑，可以使用 markRaw：

import { markRaw } from 'vue';

const CustomInput = markRaw({
  setup(props) {
    // 自定义逻辑
    return () => h(Input, props);
  }
});

// 在 schema 中使用
{
  component: CustomInput,
  // ...其他配置
}

方案三：正确处理 attrs 和 props

如果必须使用 h 函数，确保正确处理所有属性：

component: (props, { attrs }) => {
  return h(Input, {
    ...props,
    ...attrs
  });
}

最佳实践建议

1. 优先使用直接引用组件的方式，这是最简单可靠的方法
2. 对于需要自定义行为的组件，考虑使用组合式 API 创建可复用组件
3. 避免在 schema 中直接创建匿名函数组件，这会破坏响应性
4. 对于复杂表单控件，建议单独封装成组件后再引用

总结

Vue Vben Admin 的表单系统提供了多种方式来使用自定义组件，但需要遵循正确的模式。理解 Vue 的组件渲染机制和 Vben Admin 的表单工作原理，可以帮助开发者避免这类表单值绑定问题。通过本文介绍的几种方法，开发者可以灵活地在表单中使用各种自定义组件，同时确保表单数据的正确绑定和获取。