uni-app 微信小程序中使用 uni://form-field 的注意事项与解决方案

问题背景

在 uni-app 开发微信小程序时，开发者可能会遇到使用 uni://form-field 行为(behavior)时出现的两个主要问题：

1. 控制台报错："Behaviors should be constructed with Behavior()"
2. 嵌套组件时无法在表单提交(submit)事件中获取输入框的值

这些问题主要出现在 Vue3 版本的 uni-app 项目中，而 Vue2 版本则表现正常。

问题分析

行为(Behavior)机制

微信小程序原生提供了表单相关的内置 behaviors，如 wx://form-field，用于将自定义组件与表单组件关联。uni-app 为了保持跨平台一致性，提供了对应的 uni://form-field 实现。

问题根源

在 uni-app 的编译过程中，对于微信小程序平台，uni://form-field 会被转换为 __GLOBAL__://form-field，而微信小程序原生只识别 wx://form-field，这导致了运行时错误。

解决方案

临时解决方案

在等待官方修复期间，开发者可以采用以下临时解决方案：

1. 直接使用 wx://form-field 替代 uni://form-field

   export default {
     behaviors: ['wx://form-field'],
     // 其他组件选项
   }
   

2. 手动修改编译产物：

   • 找到 uni.mp.esm.js 文件
   • 搜索 __GLOBAL__:// 并替换为 wx://

官方修复

uni-app 4.21.2024061818-alpha 版本已修复此问题，建议开发者升级到该版本或更高版本。

最佳实践

表单组件实现

<template>
  <div>
    <input 
      type="text" 
      :value="modelValue" 
      @input="onInput"
      style="border: solid 1px #999999;height: 80px;"
    />
  </div>
</template>

<script>
export default {
  behaviors: ['uni://form-field'],
  props: {
    modelValue: {
      type: String,
      default: ''
    },
  },
  methods: {
    onInput(e) {
      this.$emit('update:modelValue', e.detail.value)
    }
  },
};
</script>

表单页面使用

<template>
  <view class="content">
    <form @submit="onSumbit">
      <div>当前值: {{ formData.userName }}</div>
      <CustomInput name='userName' v-model="formData.userName" />
      <button form-type="submit">提交</button>
    </form>
  </view>
</template>

<script>
import CustomInput from '../../components/CustomInput.vue';

export default {
  components: {
    CustomInput
  },
  data() {
    return {
      formData: {
        userName: '初始值'
      }
    }
  },
  methods: {
    onSumbit(e) {
      console.log('表单提交数据:', e.detail.value);
    }
  }
};
</script>

注意事项

1. 确保自定义组件中设置了 name 属性，这是表单收集数据的键名
2. 使用 v-model 实现双向绑定，同时保持与表单行为的兼容
3. 提交按钮必须设置 form-type="submit" 属性
4. 在 Vue3 环境中，确保使用修复后的 uni-app 版本

扩展知识

微信小程序还提供了其他表单相关的 behaviors：

• wx://form-field-group：用于表单组件分组
• wx://form-field-button：用于表单按钮组件

这些 behaviors 在 uni-app 中的使用方式与 wx://form-field 类似，开发者可以根据实际需求选择使用。

通过以上解决方案和实践建议，开发者可以顺利在 uni-app 的微信小程序项目中实现表单功能，避免常见的表单行为相关问题。