Formily基础

Formily基础

formily

  • formily是一款面向中后台复杂场景的数据+协议驱动的表单框架,也是阿里巴巴集团统一表单解决方案,可以完成复杂表单需求,而且提供了表单设计器让我们快速设计表单

核心优势

  • 高性能 字段数据极多的情况下保持快速响应,可以实现高效联动逻辑
  • 跨端能力 与框架无关,可以兼容reactvue等框架
  • 生态完备 支持了业界主流的antdelement等组件库
  • 协议驱动 可以通过JSON驱动表单渲染,可以成为领域视图模型驱动的低代码渲染引擎

分层架构

  • @formily/core负责管理表单的状态、校验和联动等
  • @formily/react是UI桥接库,用来接入内核数据实现最终的表单交互效果,不同框架有不同的桥接库
  • @formily/antd封装了场景化的组件

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

  • 这张图主要将 Formily 分为了内核协议层,UI胶水桥接层,扩展组件层,和配置应用层
  • 内核层是 UI 无关的,它保证了用户管理的逻辑和状态是不耦合任何一个框架
  • JSON Schema 独立存在,给 UI 桥接层消费,保证了协议驱动在不同 UI 框架下的绝对一致性,不需要重复实现协议解析逻辑
  • 扩展组件层,提供一系列表单场景化组件,保证用户开箱即用。无需花大量时间做二次开发

竞品对比

formcompare

安装

npm init vite@latest
npm install @formily/reactive @formily/core @formily/reactive-react @formily/react @formily/antd ajv less --save

配置

  • jsxRuntime
  • less`` 文件中引入 antdless 文件会有一个~`前置符,这种写法对于 ESM 构建工具是不兼容的
  • javascriptEnabled这个参数在less3.0之后是默认为false

vite.config.ts

import { defineConfig } from 'vite'
import react from '@vitejs/plugin-react'

// https://vitejs.dev/config/
export default defineConfig({
+ plugins: [react({
+   jsxRuntime: 'classic'
+ })],
+ resolve: {
+   alias: [
+     { find: /^~/, replacement: '' }
+   ]
+ },
+ css: {
+   preprocessorOptions: {
+     less: {
+       // 支持内联 JavaScript
+       javascriptEnabled: true,
+     }
+   }
+ }
})

tsconfig.json

{
  "compilerOptions": {
    "target": "ESNext",
    "useDefineForClassFields": true,
    "lib": ["DOM", "DOM.Iterable", "ESNext"],
    "allowJs": false,
    "skipLibCheck": true,
    "esModuleInterop": false,
    "allowSyntheticDefaultImports": true,
+   "strict": false,
+   "noImplicitAny": false,
    "forceConsistentCasingInFileNames": true,
    "module": "ESNext",
    "moduleResolution": "Node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "react-jsx"
  },
  "include": ["src"],
  "references": [{ "path": "./tsconfig.node.json" }]
}

字段数量多

问题

  • 字段数量多,如何让性能不随字段数量增加而变差?

解决方案

  • 依赖@formily/reactive响应式解决方案,构建响应式表单的领域模型实现精确渲染

Reaction

MVVM
  • MVVM(Model–view–viewmodel)是一种 OOP 软件架构模式,它的核心是将我们的应用程序的逻辑与视图做分离,提升代码可维护性与应用健壮性
  • View(视图层)负责维护 UI 结构与样式,同时负责与 ViewModel(视图模型)做数据绑定
  • 这里的数据绑定关系是双向的,也就是,ViewModel(视图模型)的数据发生变化,会触发 View(视图层)的更新,同时视图层的数据变化又会触发 ViewModel(视图模型)的变化,Model 则更偏实际业务数据处理模型
  • ViewModel 和 Model 都是充血模型,两者都注入了不同领域的业务逻辑,比如 ViewModel 的业务逻辑更偏视图交互层的领域逻辑,而 Model 的业务逻辑则更偏业务数据的处理逻辑
  • Formily 它提供了 ViewViewModel 两层能力,View 则是@formily/react,专门用来与@formily/core 做桥接通讯的,所以,@formily/core 的定位就是 ViewModel

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>MVVM</title>
</head>
<body>
    <input id="bookTitle" value="红楼梦"/>
    <script>
        class Book{
            constructor(title){
                this.title=title;
            }
        }
        //Model
        let book = new Book('红楼梦');
        //ViewModel
        let viewModel = {display:'block'};
        Object.defineProperty(viewModel,'title',{
                get(){
                    return book.title;
                },
                set(newTitle){
                    bookTitle.value = book.title = newTitle;
                }
        });
        Object.defineProperty(viewModel,'display',{
                get(){
                    return bookTitle.style.display;
                },
                set(display){
                    bookTitle.style.display = display;
                }
        });
        //View(视图层)负责维护 UI 结构与样式
        //同时负责与 ViewModel(视图模型)做数据绑定
        //这里的数据绑定关系是双向的,也就是,ViewModel(视图模型)的数据发生变化,会触发 View(视图层)的更新
        viewModel.title='新红楼梦';
        setTimeout(()=>{
            viewModel.display= 'none';
        },3000);
        //同时视图层的数据变化又会触发 ViewModel(视图模型)的变化
        bookTitle.onchange = (event)=>{
            viewModel.title = event.target.value;
        }
    </script>
</body>
</html>
observable
  • observable主要用于创建不同响应式行为的 observable 对象
  • 一个observable对象,字面意思是可订阅对象,我们通过创建一个可订阅对象,在每次操作该对象的属性数据的过程中,会自动通知订阅者
  • @formily/reactive 创建 observable 对象主要是通过 ES Proxy 来创建的,它可以做到完美劫持数据操作
Reaction
  • `reaction在响应式编程模型中,它就相当于是可订阅对象的订阅者
  • 它接收一个 tracker 函数,这个函数在执行的时候,如果函数内部有对 observable 对象中的某个属性进行读操作会进行依赖收集,那当前 reaction 就会与该属性进行一个绑定(依赖追踪),该属性在其它地方发生了写操作,就会触发 tracker 函数重复执行
  • 从订阅到派发订阅,其实是一个封闭的循环状态机,每次 tracker 函数执行的时候都会重新收集依赖,依赖变化时又会重新触发tracker执行
autorun
  • autorun可以创建一个自动执行的响应器
  • 接收一个 tracker 函数,如果函数内部有消费 observable 数据,数据发生变化时,tracker 函数会重复执行
实现observable
src\main.tsx

src\main.tsx

import { observable, autorun } from './@formily/reactive'
// observable用来创建不同的响应式行为的可观察对象
const obs = observable({
  name: 'hs',
})
const tracker = () => {
  console.log(obs.name);
}
// 创建一个自动执行的响应器
autorun(tracker)
obs.name = 'ha';
/**
hs
ha
 */
import { observable, autorun } from '@formily/reactive'
const obs = observable({
  name: 'hs',
+ age: 12
})
+let counter = 0;
// 当tracker函数执行的时候,如果函数内部对observable对象的某个属性进行读写操作,则会进行依赖收集
// 那么当前的reaction就会与属性进行一个绑定,当属性发生了写操作,就会触发tracker重新执行
const tracker = () => {
  console.log(obs.name);
+ if (counter++) {
+   console.log(obs.age);
+ }
}
autorun(tracker)
+obs.age = 13;
obs.name = 'ha';
+obs.age = 14;
/**
tracker第1次执行
hs
tracker第2次执行
ha
13
tracker第3次执行
ha
14
 */
reactive\index.ts

src@formily\reactive\index.ts

const RawReactionsMap = new WeakMap()
let currentReaction;
export function observable(value) {
    return new Proxy(value, baseHandlers)
}
export const autorun = (tracker) => {
    const reaction = () => {
        currentReaction = reaction;
        tracker()
        currentReaction = null;
    }
    reaction()
}
const baseHandlers = {
    get(target, key) {
        const result = target[key]
        // 当前存在一个响应器,则把此响应器和对象以及属性进行绑定,以后当此对象的这个属性发生改变后会重新执行此响应器
        if (currentReaction) {
            addRawReactionsMap(target, key, currentReaction)
        }
        return result
    },
    set(target, key, value) {
        target[key] = value
        RawReactionsMap.get(target)?.get(key)?.forEach((reaction) => reaction())
        return true;
    }
}
/**
 * 则把此响应器和对象以及属性进行绑定
 * @param target 目标对象
 * @param key 目标属性
 * @param reaction 响应器 
 */
const addRawReactionsMap = (target, key, reaction) => {
    const reactionsMap = RawReactionsMap.get(target)
    if (reactionsMap) {
        const reactions = reactionsMap.get(key)
        if (reactions) {
            reactions.push(reaction)
        } else {
            reactionsMap.set(key, [reaction])
        }
        return reactionsMap
    } else {
        const reactionsMap = new Map()
        reactionsMap.set(key, [reaction]);
        RawReactionsMap.set(target, reactionsMap)
        return reactionsMap
    }
}
Observer
  • Observer接收一个 Function RenderProps,只要在 Function 内部消费到的任何响应式数据,都会随数据变化而自动重新渲染,也更容易实现局部精确渲染
src\main.tsx

src\main.tsx

import React from 'react'
import ReactDOM from 'react-dom'
import App from './App';
ReactDOM.render(<App />, document.getElementById('root')!);
src\App.tsx

src\App.tsx

import { observable } from './@formily/reactive'
import { Observer } from './@formily/reactive-react'
const username = observable({ value: 'zhangsan' })
const age = observable({ value: 14 })
export default () => {
  return (
    <>
      <Observer>
        {() => (
          <input
            value={username.value}
            onChange={(event) => {
              username.value = event.target.value
            }}
          />
        )}
      </Observer>
      <Observer>{() => {
        console.log('username render');
        return <div>{username.value}</div>;
      }}</Observer>
      <Observer>
        {() => (
          <input
            value={age.value}
            onChange={(event) => {
              age.value = +event.target.value
            }}
          />
        )}
      </Observer>
      <Observer>{() => {
        console.log('age render');
        return <div>{age.value}</div>;
      }}</Observer>
    </>
  )
}
reactive-react\index.tsx

src@formily\reactive-react\index.tsx

import React, { useReducer } from 'react';
import { Tracker } from '../../@formily/reactive'
export const Observer = (props) => {
    const [, forceUpdate] = useReducer(x => x + 1, 0)
    const trackerRef = React.useRef(null)
    if (!trackerRef.current)
        trackerRef.current = new Tracker(forceUpdate)
    return trackerRef.current.track(props.children)
}
reactive\index.ts

src@formily\reactive\index.ts

const RawReactionsMap = new WeakMap()
let currentReaction;
export function observable(value) {
    return new Proxy(value, baseHandlers)
}
export const autorun = (tracker) => {
    const reaction = () => {
        currentReaction = reaction;
        tracker()
        currentReaction = null;
    }
    reaction()
}
const baseHandlers = {
    get(target, key) {
        const result = target[key]
        if (currentReaction) {
            addRawReactionsMap(target, key, currentReaction)
        }
        return result
    },
    set(target, key, value) {
        target[key] = value
        RawReactionsMap.get(target)?.get(key)?.forEach((reaction) => {
+           if (typeof reaction._scheduler === 'function') {
+               reaction._scheduler()
+           } else {
+               reaction()
+           }
        })
        return true;
    }
}
const addRawReactionsMap = (target, key, reaction) => {
    const reactionsMap = RawReactionsMap.get(target)
    if (reactionsMap) {
        const reactions = reactionsMap.get(key)
        if (reactions) {
            reactions.push(reaction)
        } else {
            reactionsMap.set(key, [reaction])
        }
        return reactionsMap
    } else {
        const reactionsMap = new Map()
        reactionsMap.set(key, [reaction]);
        RawReactionsMap.set(target, reactionsMap)
        return reactionsMap
    }
}

+export class Tracker {
+    constructor(scheduler) {
+        this.track._scheduler = scheduler // 调度更新器
+    }
+    track: any = (tracker) => {
+        currentReaction = this.track;
+        return tracker()
+    }
+}

字段关联逻辑复杂

问题

  • 字段关联逻辑复杂,如何更简单的实现复杂的联动逻辑?字段与字段关联时,如何保证不影响表单性能?
    • 一对多(异步)
    • 多对一(异步)
    • 多对多(异步)

领域模型

  • 字段值的改变和应用状态、服务器返回数据等都可能会引发字段的联动
  • 联动关系核心是将字段的某些状态属性与某些数据关联起来
  • 可以定义针对表单领域的领域模型
  • Form是调用createForm所返回的核心表单模型
  • Field是调用createField所返回的字段模型
  • createForm用来创建表单核心领域模型,它是作为MVVM设计模式的标准 ViewModel

外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传

src\main.tsx

import { createForm } from '@formily/core'
const form = createForm()
const field = form.createField({ name: 'target' })

DDD(领域驱动)

  • DDD(Domain-Driven Design)即领域驱动设计是思考问题的方法论,用于对实际问题建模
  • 它以一种领域专家、设计人员、开发人员都能理解的通用语言作为相互交流的工具,然后将这些概念设计成一个领域模型。由领域模型驱动软件设计,用代码来实现该领域模型
表单
interface Form {
   values,//值
   visible, //是否可见
   submit() //提交
}
字段
interface Field {
   value,     //值
   visible,   //是否可见
   setValue() //设置值
}

路径系统

  • 表单模型作为顶层模型管理着所有字段模型,每个字段都有着自己的路径
  • 如何优雅的查找某个字段?
  • Formily 独创的路径系统@formily/path让字段查找变得优雅
  • FormPath 在 Formily 中核心是解决路径匹配问题和数据操作问题

src\main.tsx

import { FormPath } from '@formily/core'
const target = { array: [] }
//点路径 就是我们最常用的a.b.c格式,用点符号来分割每个路径节点,主要用来读写数据
FormPath.setIn(target, 'a.b.c', 'dotValue')
console.log(FormPath.getIn(target, 'a.b.c')) //'dotValue'

//下标路径 对于数组路径,都会有下标,我们的下标可以用点语法,也可以用中括号
FormPath.setIn(target, 'array.0.d', 'arrayValue')
console.log(FormPath.getIn(target, 'array.0.d')) //arrayValue

//解构表达式 解构表达式类似于 ES6 的解构语法,在前后端数据不一致的场景非常适用,解构表达式会作为点路径的某个节点
FormPath.setIn(target, 'parent.[f,g]', [1, 2])

console.log(JSON.stringify(target))
//{"array":[{"d":"arrayValue"}],"a":{"b":{"c":"dotValue"}},"parent":{"f":1,"g":2}}

生命周期

问题

  • 响应式和路径系统组成一个较为完备的表单方案,但是一个黑盒
  • 想要在某个过程阶段内实现一些自定义逻辑如何实现?

解决方案

  • Form Effect Hooks可以将整个表单生命周期作为事件钩子暴露给外界,这样就能做到了既有抽象,但又灵活的表单方案
  • onFormInit用于监听某个表单初始化的副作用钩子,我们在调用 createForm 的时候就会触发初始化事件
  • onFormReact用于实现表单响应式逻辑的副作用钩子,它的核心原理就是表单初始化的时候会执行回调函数,同时自动追踪依赖,依赖数据发生变化时回调函数会重复执行
import { useMemo, useState } from 'react'
import { createForm, onFormInit, onFormReact } from '@formily/core'
export default () => {
  const [state, setState] = useState('init')
  const form = useMemo(
    () =>
      createForm({
        effects() {
          onFormInit(() => {
            setState('表单已初始化')
          })
          onFormReact((form) => {
            if (form.values.input == 'Hello') {
              setState('响应Hello')
            } else if (form.values.input == 'World') {
              setState('响应World')
            }
          })
        },

      }),
    []
  )
  return (
    <div>
      <p>{state}</p>
      <button
        onClick={() => {
          form.setValuesIn('input', 'Hello')
        }}
      >
        Hello
      </button>
      <button
        onClick={() => {
          form.setValuesIn('input', 'World')
        }}
      >
        World
      </button>
    </div>
  )
}

协议驱动

问题

  • 动态渲染述求很强烈
    • 字段配置化,让非专业前端也能快速搭建复杂表单
    • 跨端渲染,一份 JSON Schema,多端适配
    • 如何在表单协议中描述布局?
      • 纵向布局
      • 横向布局
      • 网格布局
      • 弹性布局
      • 自由布局
    • 如何在表单协议中描述逻辑?

解决方案

  • 表单场景的数据协议最流行就是JSON-Schema
  • 定义一套通用协议,简单高效的描述表单逻辑,适合开发低代码

JSON-Schema

  • JSON-Schema以数据描述视角驱动UI渲染,不好描述UI
  • ajv是一个JSON Schema验证器 -
import Ajv from 'ajv';
const ajv = new Ajv()

const schema = {
  type: "object",
  properties: {
    foo: { type: "integer" },
    bar: { type: "string" }
  },
  required: ["foo"],
  additionalProperties: false
}

const validate = ajv.compile(schema)

const data = {
  foo: 1,
  bar: "abc",
  age: 1
}

const valid = validate(data)
if (!valid)
  console.log(validate.errors)

扩展的JSON-Schema

  • Formily扩展了JSON-Schema 属性,统一以x-*格式来表达扩展属性以描述数据无关的布局容器和控件,实现UI协议与数据协议混合在一起
  • JSON Schema 引入 void,代表一个虚数据节点,表示该节点并不占用实际数据结构
  • DSL(领域特定语言)(Domain Specific Language)是针对某一领域,具有受限表达性的一种计算机程序设计语言
{
  "type": "string",
  "title": "字符串",
  "description": "这是一个字符串",
  "x-component": "Input",//字段 UI 组件属性
  "x-component-props": {//字段 UI 组件属性
    "placeholder": "请输入"
  }
}
{
  "type": "void",
  "title": "卡片",
  "description": "这是一个卡片",
  "x-component": "Card",//字段 UI 组件属性
  "properties": {
    "name": {
      "type": "string",
      "title": "字符串",
      "description": "这是一个字符串",
      "x-component": "Input",//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      }
    }
  }
}

API

  • createForm

    创建一个 Form 实例,作为 ViewModel 给 UI 框架层消费

    • effects 副作用逻辑,用于实现各种联动逻辑
    • onFieldMount用于监听某个字段已挂载的副作用钩子
    • onFieldValueChange用于监听某个字段值变化的副作用钩子
    • setFieldState可以设置字段状态
  • core/Field组件是用来承接普通字段的组件

  • react/Field作为@formily/corecreateField

    React 实现,它是专门用于将

    ViewModel
    

    与输入控件做绑定的桥接组件

    • title字段标题
    • required字段是否必填,如果 decorator 指定为 FormItem,那么会自动出现星号提示
    • component字段组件,注意 component 属性传递的是数组形式,第一个参数代表指定组件类型,第二个参数代表指定组件属性
    • decorator字段装饰器,通常我们都会指定为 FormItem,注意 decorator 属性传递的是数组形式,第一个参数代表指定组件类型,第二个参数代表指定组件属性
  • SchemaField组件是专门用于解析JSON-Schema动态渲染表单的组件。 在使用SchemaField组件的时候,需要通过 createSchemaField 工厂函数创建一个 `SchemaField`` 组件

  • Schema

    @formily/react
    

    协议驱动最核心的部分

    • 解析 json-schema 的能力
    • json-schema 转换成 Field Model 的能力
    • 编译 json-schema 表达式的能力
    • x-component 的组件标识与createSchemaField传入的组件集合的 Key 匹配
    • x-decorator 的组件标识与createSchemaField传入的组件集合的 Key 匹配
    • Schema 的每个属性都能使用字符串表达式{{expression}},表达式变量可以从 createSchemaField 中传入,也可以从 SchemaField 组件中传入
  • Schema

    属性

表单渲染

  • Formily 的表单校验使用了极其强大且灵活的

    FieldValidator

    校验引擎,校验主要分两种场景:

    • JSX 场景校验属性,使用 validator 属性实现校验
    • Markup(JSON) Schema场景协议校验属性校验,使用 JSON Schema 本身的校验属性与 x-validator 属性实现校验
JSX 案例

src\App.tsx

import { createForm } from '@formily/core'
import { Field } from '@formily/react'
import 'antd/dist/antd.css'
import { Form, FormItem, Input, NumberPicker } from '@formily/antd'
//createForm创建一个 Form 实例,作为 ViewModel 给 UI 框架层消费
const form = createForm()
function App() {
  return (
    <Form form={form} labelCol={6} wrapperCol={10}>
      <Field
        name="name"
        title="姓名"
        required
        component={[Input]}
        decorator={[FormItem]}
      />
      <Field
        name="age"
        title="年龄"
        validator={{ maximum: 5 }}
        component={[NumberPicker]}
        decorator={[FormItem]}
      />
    </Form>
  )
}
export default App;
JSON Schema案例
  • schema是@formily/react协议驱动最核心的部分
    • 解析 json-schema 的能力
    • json-schema 转换成 Field Model 的能力
    • 编译 json-schema 表达式的能力

src\App.tsx

import { createForm } from '@formily/core'
import { createSchemaField } from '@formily/react'
import 'antd/dist/antd.css'
import { Form, FormItem, Input } from '@formily/antd'
const form = createForm()
const SchemaField = createSchemaField({
  components: {
    FormItem,
    Input
  },
})
const schema = {
  type: 'object',
  properties: {
    name: {
      title: `姓名`,
      type: 'string',
      required: true,
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      'x-component': 'Input',//字段 UI 组件属性
    },
    age: {
      title: `邮箱`,
      type: 'string',
      required: true,
      'x-validator': 'email',
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      'x-component': 'Input',//字段 UI 组件属性
    },
  },
}
function App() {
  return (
    <Form form={form} labelCol={6} wrapperCol={10}>
      <SchemaField schema={schema} />
    </Form>
  )
}
export default App;
Markup Schema 案例

给SchemaField传儿子

src\App.tsx

import { createForm } from '@formily/core'
import { createSchemaField } from '@formily/react'
import 'antd/dist/antd.css'
import { Form, FormItem, Input, NumberPicker } from '@formily/antd'
const form = createForm()
const SchemaField = createSchemaField({
  components: {
    Input,
    FormItem,
    NumberPicker
  },
})

function App() {
  return (
    <Form form={form} labelCol={6} wrapperCol={10}>
      <SchemaField>
        <SchemaField.String
          name="name"
          title="姓名"
          required
          x-component="Input"//字段 UI 组件属性
          x-decorator="FormItem"//字段 UI 包装器组件
        />
        <SchemaField.Number
          name="age"
          title="年龄"
          maximum={120}
          x-component="NumberPicker"//字段 UI 组件属性
          x-decorator="FormItem"//字段 UI 包装器组件
        />
      </SchemaField>
    </Form>
  )
}
export default App;

联动校验

  • 同时我们还能在 effects 或者 x-reactions 中实现联动校验
主动联动
  • Schema 联动协议,如果reaction对象里包含target,则代表主动联动模式,否则代表被动联动模式

src\App.tsx

import { createForm } from '@formily/core'
import { createSchemaField } from '@formily/react'
import 'antd/dist/antd.css'
import { Form, FormItem, Input } from '@formily/antd'
const form = createForm()
const SchemaField = createSchemaField({
  components: {
    FormItem,
    Input
  },
})
const schema = {
  type: 'object',
  properties: {
    source: {
      title: `来源`,
      type: 'string',
      required: true,
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      'x-component': 'Input',//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      },
      "x-reactions": [//字段联动协议
        {
          "target": "target",///要操作的字段路径,支持FormPathPattern路径语法
          //代表当前字段实例,可以在普通属性表达式中使用,也能在 x-reactions 中使用
          "when": "{{$self.value == '123'}}",//联动条件
          "fulfill": { //满足条件
            "state": {//更新状态
              "visible": true
            }
          },
          "otherwise": { //不满足条件
            "state": {//更新状态
              "visible": false
            }
          }
        }
      ]
    },
    target: {
      "title": "目标",
      "type": "string",
      "x-component": "Input",//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      },
      'x-decorator': 'FormItem'//字段 UI 包装器组件
    }
  },
}
function App() {
  return (
    <Form form={form} labelCol={6} wrapperCol={10}>
      <SchemaField schema={schema} />
    </Form>
  )
}
export default App;
被动联动

src\App.tsx

import { createForm } from '@formily/core'
import { createSchemaField } from '@formily/react'
import 'antd/dist/antd.css'
import { Form, FormItem, Input } from '@formily/antd'
const form = createForm()
const SchemaField = createSchemaField({
  components: {
    FormItem,
    Input
  },
})
const schema = {
  type: 'object',
  properties: {
    source: {
      title: `来源`,
      type: 'string',
      required: true,
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      'x-component': 'Input',//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      }
    },
    target: {
      "title": "目标",
      "type": "string",
      "x-component": "Input",//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      },
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      "x-reactions": [//字段联动协议
        {
          "dependencies": ["source"],
          //只能在x-reactions中的表达式消费,与 x-reactions 定义的 dependencies 对应,数组顺序一致
          "when": "{{$deps[0] == '123'}}",
          "fulfill": {
            "state": {
              "visible": true
            }
          },
          "otherwise": {
            "state": {
              "visible": false
            }
          }
        }
      ]
    }
  },
}
function App() {
  return (
    <Form form={form} labelCol={6} wrapperCol={10}>
      <SchemaField schema={schema} />
    </Form>
  )
}
export default App;
effects

src\App.tsx

import { createForm, onFieldMount, onFieldValueChange } from '@formily/core'
import { createSchemaField } from '@formily/react'
import 'antd/dist/antd.css'
import { Form, FormItem, Input } from '@formily/antd'
const form = createForm({
  effects() {//effects 副作用逻辑,用于实现各种联动逻辑
    //用于监听某个字段已挂载的副作用钩子
    onFieldMount('target', (field: any) => {
      //可以设置字段状态
      form.setFieldState(field.query('target'), (state) => {
        if (field.value === '123') {
          state.visible = true;
        } else {
          state.visible = false;
        }
      })
    })
    //用于监听某个字段值变化的副作用钩子
    onFieldValueChange('source', (field: any) => {
      form.setFieldState(field.query('target'), (state) => {
        if (field.value === '123') {
          state.visible = true;
        } else {
          state.visible = false;
        }
      })
    })
  },
})
const SchemaField = createSchemaField({
  components: {
    FormItem,
    Input
  },
})
const schema = {
  type: 'object',
  properties: {
    source: {
      title: `来源`,
      type: 'string',
      required: true,
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      'x-component': 'Input',//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      }
    },
    target: {
      "title": "目标",
      "type": "string",
      'x-decorator': 'FormItem',//字段 UI 包装器组件
      "x-component": "Input",//字段 UI 组件属性
      "x-component-props": {//字段 UI 组件属性
        "placeholder": "请输入"
      }
    }
  }
}
function App() {
  return (
    <Form form={form} labelCol={6} wrapperCol={10}>
      <SchemaField schema={schema} />
    </Form>
  )
}
export default App;
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值