React 表单源码阅读笔记
3.5 Formik
3.5.1 背景
鉴于 Redux-form 强依赖 Redux 所带来的的问题,Formik 抛开了 Redux,自己在内部维护了一个表单状态。大概看了下作者的设计动机,主要是减少模板代码&兼顾表单性能。虽然提供了 FastField 来做一定的性能优化,不过仍然是以表单整体为视角的粗粒度的状态更新,所以本质上并没有逃开全局渲染的,抛开 FastField 来看,它和 rc-field 的设计思路甚至有些类似。
3.5.2 例子
3.5.3 核心思路
所谓的 FastField 性能优化,不过是通过一层 HOC 包裹实际的 Field,然后在这个中间层中用 shouldComponentUpdate 决定当前更新的状态是否为该 HOC 包裹的 Field 状态。
可以看出来就是粗暴地对表单中几个关键的状态 value
, error
, touched
以及传入的 prop 的长度和 isSubmit 几个关键字段进行浅比较,如果碰到类似字段 a 决定字段 b 是一个输入框还是下拉框这种场景,还得自己实现 shouldUpdate 的逻辑。所以整体来看可以认为是这样:
3.5.4 React DevTools Tips
在探究这个表单的时候,碰到这里有个很有意思的结论, 由于只是 FastField 这种外层 connect 接入 context,内层 shouldComponentUpdate 做优化的机制,这时候通过 devtools 中 highlight updates 并不能看出是否是全局渲染,那玩意在这种情况下会给你误导,这时候更好的方法应该是使用插件提供的 profiler,下面这个例子很好地诠释了这一点:
Demo 地址:https://codesandbox.io/s/7vhsw
3.5.5 感想
总的来看,Formik 完成了它最初的设计,从 redux 中解放出来,并一定程度缓解了表单全局渲染导致的性问题,打包体积也很小只有 12.7k,在 redux-form 横行的年代确实给力(怪不得会被官方推荐)。但是由于发布的年代早, 对于后续 react hooks 的支持不是十分全面,且底层设计上还是没有支持到更细的空间更新粒度,所以当表单膨胀或是联动场景较多时,单单靠 FastField 也就力不从心了。
3.6 React-final-form
这是 Redux-form 的作者在维护了多年 Redux-form 之后的又一力作,作者的本意是写一个“无第三方依赖、pure JS、插件式”的表单。在渲染上,final-form 也采取了和 rc-field-form 类似的思路,Form 作为中心订阅器,负责各组件事件的分发,而每个 Field 管理自己的数据,独立地订阅自己感兴趣的其他表单项,并独立地完成渲染。
Final-form 我没有细看,只是大概了解了下,感兴趣的同学可以看看 final-form 作者的演讲: Next Generation Forms with React Final Form [11]
3.7 上述五个表单方案的变迁
其实你会发现历史总是惊人地相似,国内由于饱受 rc-form 全局渲染的困扰而推出了基于订阅的 rc-field-form,国外的发展历程也是类似的: redux-form(v5) => redux-form(v6)
, formik => react-final-form
。总结下,整个变迁大概可以这么理解:
3.8 React-hook-form
3.8.1 背景
上面已经说了几个表单,我们可以发现这些表单都是通过维护了一个 state 来处理表单的状态,无论是集中更新,还是以订阅的方式进行分布式更新,它们都是基于这个表单状态来完成的,这就是 react 的受控表单模式。
现在,我们不妨换个思路,从非受控的角度入手,非受控表单就不是使用 state 那一套了,它是通过 ref 来直接拿到表单组件,从而可以直接拿到表单的值,不需要对表单的值进行状态维护,这就使得非受控表单可以减少很多不必要的渲染。
但是非受控表单也存在着它的问题,在动态校验、动态修改(联动)方面不是很方便,于是在 react hooks 出现以后诞生了一个以非受控思想为基础的表单库 react-hook-form, 这个表单的设计思路很新奇,完全是拥抱原生, 拥抱非受控. 核心思路是各个组件自身维护各自的 ref, 当校验、提交等发生时,便通过这些 ref 来获取表单项的值。
3.8.2 简单例子
3.8.3 核心思路
源码 Commit:1441a0186b8eab5dccb8d85fddb129d6938b994e
Demo 地址: https://codesandbox.io/s/happy-mccarthy-1nxuq?file=/src/App.js
这里其实有一些问题,由于所有的 rerender 都是 field 级别而不是 form 级别的 (表单渲染),即:
-
性能的优化:由于各个字段状态由组件自己托管,并不需要数据回流,除了这一大块以外,代码中也有很多处理很好的细节:
a. 对错误进行浅层比较,例如上一轮渲染已经展示了错误信息 a, 如果这一轮渲染错误信息不变的话, 则不重新渲染.
b. 表单的内部状态(isDirty,touched,submitCount,isSubmitting 等等)统一用过 Proxy 包装, 在初次渲染的时候利用 Proxy 记录用户对于各个状态的订阅情况,不订阅的话变化将被忽略,不引发重新渲染。
c. 虽然 watch 默认会触发全局渲染,不过 useWatch 可以做到不触发全局渲染的情况下通知某个字段的更新,本质上是订阅机制,将 useWatch 调用方的 state hook 维护在了表单的内部对象上,一旦有更新通过这种方式可以做到仅仅通知订阅组件。
-
可惜的是,任何表单下的错误信息变化,都会触发全局的渲染,这一点感觉不是特别好。至少可以 ErrorMessage 里面可以来个浅层比较。
3.8.4 动态校验以及联动
为了支持动态校验,react-hook-form 在进行表单注册的时候还会将 onChange、onBlur 等事件挂载到表单组件上,保证对与用户输入、修改行为的监听,从而可以对表单校验、表单值监听等进行触发。
非受控表单除了动态校验的问题,还存在联动实现的问题。由于 react-hook-form 不会将表单的值维护在 state 中,用户输入不会触发整表层的 JSX 更新,因此 react-hook-form 提供了 watch,以及性能更好的 useWatch,来对于需要进行联动的表单进行注册,当用户进行修改的时候会调用更新。(本质上这两个东西和 rc-field-form 中的 dependences / shouldUpdate 目的类似)。
关于 watch 和 useWatch
其实两者是存在性能差异的,useWatch 可以认为是把更新移到了更局部的位置,所以性能上会更有优势:
3.8.5 兼容三方 UI 库
由于大部分第三方 UI 库是遵照了 react 受控思想设计的,例如 Antd#Input 并没有出 ref,官方也提供了 Controller 组件,用它包装的三方组件只需要遵循默认的受控规范 onChange / value 即可,Controller 会在其构建内部状态,变相模拟出了 Uncontrolled Component。
3.8.6 感想
最终来看 react-hook-form 的其实与其他受控表单库可以说是殊途同归,都是希望状态分布管理,单个表单项的更新不影响其他的表单项,而联动都可以说是使用了订阅来做到的,从某种程度上看,基于非受控实现的 react-hook-form 来看这一切甚至更加自然。可以看到, 非受控也可以做到任何受控表单能做的事情,这也是为什么我个人在 2.3 小节中提到, 受控和非受控从某种层面上看可以互相实现 。
3.9 横向比较
这里再给个横向比较图:
4. Formily (1.x)
4.1 背景
如果不了解之前没有了解过 Formily 可能下面的内容会有些突兀,建议可以先大概了解下。因为这一节我不打算讲 Formily 的基本用法,只是谈谈我对于 Formily 的一些理解。
之所以把 Formily 单独抽出来作为一讲来讲,是因为在我做表单调研工作的这个阶段 (2020.10),毫不夸张地说,Formily 是我当时认知范围内,设计理念最先进 (也可以说是激进),表单领域研究最透彻的一个表单解决方案. 在我写总结的时候,它的断代全新版本 2.x 也已经算是发了 preview 版,据说有挺多改进的, 不过还没来得及仔细看,所以以下内容只针对 1.x。
4.2 场景
在我的认知里,虽然 Formily 初衷是大而全,对于场景的预设考虑比较完备,但是我感觉它还是比较适合高复杂度,表单联动多,有比较极端的性能要求的表单场景, 如果只是简单场景确实没必要,正如我们所说的,antd 4.x 已经拜托了全量渲染,如果能合理地利用 dependencies / shouldUpdate 其实性能表现表现上已经足够好。不过如果你的场景特别复杂,特别是联动逻辑比较多,利用 formily 还是能够有效地帮助你收敛逻辑,降低心智负担的。
4.3 学习成本
虽然我上面说到 Formily 理念先进,但其实业界对于它可以说是褒贬不一的,被诟病最多的问题就是学习成本。我个人也认为这个是阻碍 Formily 火起来的最最核心的问题 (我写文章的时候 Formily 已经有 3000 多个 star 了)。坦率来讲, Formily 的学习成本相较于社区其他表单方案还是偏高的,其实原因主要是两方面的:
-
用户文档:
a. 在 Formily 用户群里面经常能看到有用户反映 Formily 官方文档访问速度慢, 甚至打不开, 这一点我个人也时常碰到.
b. 用户文档不够清晰, 很多地方感觉没有介绍清楚, 诸多细节并没有提到, 需要自己去摸索, 这一点 antd design 简直是业界典范. (这一点也不绝对, 毕竟 Formily 可以算是表单垂直领域的高阶类库,antd 以组件库为核心, 两者本身的认知门槛也是有差距的)
-
整个方案大而全,理念先进,这也导致新的概念比较多,像是 schema 描述结构,coolpath 路径系统,effects 甚至引入 rxjs 来做联动管理,虽然认真看看会发现其实所以概念的引入都有一定的道理,不过对大部分开发者而言,尽可能低的学习成本,尽可能高的开发效率才是他们所追求的,所以 Formily 大量精致的概念对于一些新的用户来说是非常不友好的。
4.4 理念
上面说了 Formily 学习成本如此的高,但是我还是非常希望聊一聊,甚至单独开了一节来聊 Formily。因为它的设计理念确确实实代表了算是业界表单的比较先进的水平。下面讲一些我自己印象深刻的点:
4.4.1 通讯
4.4.1.1 从数据回流到订阅再到 effects
业界的表单一个一个看下来,我自己有个很直观的感觉,就是各个表单方案归根结底,其实是在解决各个表单项之间以及表单项与表单整体的通信问题:
-
我们可以看到最开始的 redux form (< 6), rc-form,他们通过全量 rerender 之后新的 props 层层透传来把信息通知到每个 Field 上,这样信息的通信效率是很低的,表现上就是表单性能比较差。
-
后面 rc-field-form 以及其他一些表单都采取了自己独立更新,依赖项目走订阅更新的路子,这本质上就是带来了更好的通信效率及更优秀的表单性能。
-
此外,无一例外他们也都推崇 onChange + fomrRef 的组合来表达逻辑:
很自然地, Formily 也是订阅式的, 但是它表现上更为独特, 因为它把你的所有的表单相关的逻辑都收敛到了一个叫做 effects 的字段中, 写法非常新颖, 即:
这里的核心在 $('event_type', 'path_rule')
, 意思是搜索所有 path_rule
命中的表单项,订阅他们的 event_type
事件,最后整体的返回是一个 rxjs 流。这里我想说几点:
-
首先用 effects 收敛各种表单行为,联动逻辑这真是一大创举,对比其他方案挂在组件上的各种 onChange 回调散落在整个视图层,这个收敛对于代码的可读性的提高确实有很大帮助。
-
path_rule
必须要遵循作者自己实现的一套 DSL, 即 cool-path [12] ,感觉出发点是好的,目的是既可以精准定位到某个具体的表单项,又有能力根据情况做到批量处理,批量订阅。这其实也可以算是一大创新,它让赋予了 Formily 极强的联动表达能力,一对一,一对多,多对多都能很好的表达。但坏就坏在文档不全,偏偏它的语法还有点四不像,既不是路径系统也不是 glob pattern,其实说实话我用了挺久了有时候还是用不明白。 -
这里引入 rxjs,确实很 geek,不过就我自己而言感觉所有的场景都只是当成简单的事件订阅在用。
4.4.1.2 关于 react-eva
其实这套写法并不是空穴来风,effects + actions + rxjs 这套组合也是作者自创的,为此专门还专门抽象了一个库,叫 react-eva [13] ,想法很明确,即围绕 rxjs 针对 react 组件做的一个内外通讯方案:
这套方案有 2 个核心优势:
-
联动性能好,遵循这个规范很自然而然地就不需要在视图层使用 hooks 了。
-
提高了代码可维护性,所有的逻辑收拢到了 effects 中。
4.4.1.3 从 “Effect 只执行一次” 谈核心理解
之前有同事问我这样一个问题:为什么明明我的某个 react hook 已经更新了但是在最新的 effect 的某个 observer 中还是旧的值?
其实大概多试验几次就会发现,effects 函数本身只会执行一次。这是表面原因,不过我理解更深层次的原因是, 作者不希望让 effects(可以认为是你申明的联动逻辑) 和 当前视图层的 hooks 互相依赖,这里有两方面原因:
-
effects 应该是是比较纯粹的东西,类似 reducer, 甚至可抽离和复用。
-
另一方面,如果 effects 和 视图层 hooks 有耦合,意味着你每次需要 effects 重新执行的话就需要 setState,不知不觉又变成了整表重绘,这可以看做是一种性能倒退,显然是作者不希望看到的。
所以我视角里的 Formily 其实没那么 React, 它更像是一个自动机,你写的 JSX / Schema 不过是在声明这个表单的结构,一旦完成首次渲染,这个表单完全可以通过 用户交互 + 开发者预先定义的 effects 完成表单闭环. 它的生命周期更像是自己独立的而不是属于包裹它的 React 组件容器。这一点在 “Formily 的数据模型是表单 UI 的完全表达”中也得到了了印证。
4.4.2 底层数据模型
4.4.2.1 可订阅模型作为基类
刚在说到表单中所有的事件都可以通过 effects 声明并监听,事实上,这一点在表单内部仍然成立。可以这么说, 整个 Formily 不论内外,都是一个基于一个简单的思想,一切结构可订阅,譬如他的类继承模型如下:
4.4.2.2表单 = 树状结构组织的一堆字段
另一个令我印象深刻的点在于,Formily 底层的数据模型是它整个表单的完整表达。在看其他表单方案的时候,虽然也能看到每个表单的内部用形如 store,state 的状态,里面存的无非是一些 valueinitialValue,rules,dirty,touched 等等之类的一些状态相关的信息。然后对于 Formily:
Formily 不但包括了这些,它甚至把某个字段的输入组件上被传入的 props,当前表单的挂载状态,显示状态都给描述出来了。这里反映出几点:
-
整个表单的状态能完整地表达表单的 UI,这意味我们在 effects 中操作表单时获得了极高的自由度,你甚至通过设置某个字段的 state 来控制这个字段的下拉列表, 单纯地修改数据更新视图,非常纯粹。换作其他表单,你大概率需要在 JSX 中写三元表达式或是有了个 useState 的 hooks 专门用来操作视图层。
-
这里状态的完整表达意味着,Formily 跳脱出了 React 视图框架的禁锢,它是完完整整的内核,你可以通过它完整地驱动任意一个视图框架,例如 Vue。其他有一些表单其实多多少有一些视图层的信息是遗留在 React 的 UI 组件上的。
事实上,不但是具体的 field,如果把视野拉高,你会发现整个表单都可以用一个树状的结构来进行完全表达:
仔细想想,这其实是很自然的,因为在有嵌套数据的场景下,表单的天然结构就是一棵树。可以说,这颗树就是表单的完全表达,结合之前的 effects,表单所有的交互都能在 effects 内部闭环,因为 Formily 的数据层是可以做到 UI 层的完全表达的。
回到我们再 4.4.1.3 小节中说的那个问题,你可以看到,其实 Formily 的状态流转应该是很 Redux 的:
它并不需要依赖任何 React 相关的 hooks/callback 就能实现自己的链路闭环,整体的链路我大概理了下:
4.4.2.3 Immer
不过,刚才说到 effects 的 state 可以非常自由地操作表单/表单项的任意属性。这带来了极高的自由度,确实提高了库的使用者的使用体验,不过工作量并不会凭空消失,对于 Formily 的开发者而言,用户只管设置,那他们就需要对每一种情况进行兜底,比如用户只是简单地在 effects 中通过 state 重新设置了 rules,那 Formily 底层就得考虑重新校验,表单错误状态的更新等等. 那作者如何知道我们在回调中修改了哪个属性呢?
答案是 Immer。第一次看到确实是大呼牛逼,因为在我浅薄的认知里面,Immer 存在的价值仅仅是 “写 redux reducer 的时候便捷地创建不可变对象”,但是作者居然想到了利用 immer 中的 patches 来记录用户的操作记录,用在这里非常自然,整个思路大概如下:
这里确实非常精彩,因为涉及到比较函数前后对比两个对象的变化,第一想法都是 “脏检查”,作者很巧妙地绕开了脏检查。不过我当时的疑问是:里使用了 immer 性能开销真的会更小吗?
为此我专门去研究了下 immer 的原理. 简单来说 Immer 的高性能基于这样的一个事实:
新建/拷贝对象的开销高,引用的开销低。
所以为了更好的性能应该尽可能少地新建对象,这个背景下,immer 实现了 Copy on write 的效果:
当然,对于小表单这点性能优化可有可无,不过确实可以看出来 Formily 对性能是有极度压榨的。
4.4.3 Schema 与 Low / No Code
4.4.3.1 概念
Formily 最顶层还有个叫 Schema 的概念,为什么要有 Schema 呢?为了更好地解释 Schema,先聊聊什么是 Low / No Code。
表单方向的 Low / No Code,通俗来讲就是表单可视化搭建,产品形态就是各种表单生成器。不过对于 Low / No Code,Wiki 上有更准确的定义:
A low-code development platform (LCDP) is software that provides a development environment used to create application software through graphical user interfaces and configuration instead of traditional hand-coded computer programming.
No-code development platform (NCDPs) allows programmers and non-programmers to create application software through graphical user interfaces and configuration instead of traditional computer programming.
它的优势也很明显,那就是降低开发门槛,软件开发的工作不再局限于专业的技术人员。业界所谓的前端赋能,形态之一就是构建 No / Low Code 平台,把需求交给非前端来做.
4.4.3.2 产品与实现
包括 Formily 在内,市面上其实也已经有了一些表单生成器,譬如:
基本上所有的表单 No / Low Code 方案,都离不开一个核心的概念,即 DSL。DSL 可以认为是 UI 视图与用户交互之间的桥梁。通常来说这类产品的流程大概是这样:
-
用户通过在某些非编码的方式(比如在平台上拖拽配置)生产 DSL;
-
DSL 通过映射规则转化为视图。
所以 DSL 是媒介,实际上它是抽象模型的代码表达,譬如:
用户可以不知道啥是 select,input 但是他知道什么是下拉框输入框;
用户可以不知道啥是相对定位绝对定位, 但是他知道自己要让框框再往左边一点;
用户可以不知道啥是 required 但是他会告诉你我希望表单的这一项必填。
下面是 Formily 通过扩充 JSON Schema 定义的 Schema, 也可以认为是一种 DSL:
对于 Formily 而言,其同时存在 3 种等效的表达方式, 见:https://formilyjs.org/#/0yTeT0/8MsesjHa,最贴近配置的 JSON Schema,然后是 JSX Schema,最后是最贴近 React 的纯 JSX。我们之前也说过, Formily 的 JSX 层更像是在声明一堆表单结构而不是视图,其底层逻辑就在这里。它必须保证你使用任何一种表达方式最终呈现出的表单是一致的。
Formily 引入 Schema 是有一个伟大的远景 — 即后续的表单可以由机器生产或者可视化平台配置完成。不过从 react-schema-editor [14] 来看的话,暂时完成度还是比较有限的. 我自己业务中其实 Schema 也接触的比较少,从某种程度来讲,对于不需要考虑配置/机器生成表单的场景,其实这一层反而有点成为了我们的心智负担。我个人感觉 Formily 接地气的部分还是它的 React 层 (core 层) + Antd 桥接层。
4.4.3.3 现状
类似这样希望提供可视化解决方案的类库,Formily 并不是第一个,不过大多数感觉一直接受度不高,我自己的理解有几方面:
-
大部分此类平台是用来赋能非前端同学的,其实配置过程(也就是开发过程)并不难,难得是如何平衡产品灵活性与易用性之间的关系,这里搞不好横容易陷入“研发不想用, 非技术用户不会用”的窘境。
-
另一方面,大部分解决方案只解决了业务需求的第一步,开发,这个往往也是最简单的。但是如何扩充整个链路,把产品的整个生命周期考虑在内,即这种新的开发形态下的后续的 debug 优化改进是否也可以做到研发同学 0 参与?我感觉当前还不是很成熟,这里面还需要更多探索。
4.4.4 其他
其实 Formily 我接触稍微多一些的就是上面一些个概念,其他的譬如样式布局我们业务用得确实会比较少一点,也了解不多就不误人子弟了。虽然是说 Formily 的用户文档不太好,不过 Formily 理念性的介绍文章还是写地非常好的,如果大家想对 Formily 有深入了解的话,这里推荐下官方团队的 Formily 知乎专栏 [15] 。
对于 Formily,客观来讲,他们算是表单领域的探索者, 虽然不尽完美,有这样那样的问题,但是瑕不掩瑜,从中我看到了中国开发者的伟大智慧,也给了我许多的启发。对于想要深入了解表单的同学,我个人认为 Formily 确实是个不错的学习对象。
5. 结尾
关于表单技术的一些想法都已经散落在文章的各个角落里了,到了总结的时候反而感觉没啥可说的。行文仓促,此外文章整体也比较主观,有些说法可能拿捏可能也没那么到位,如果有说的不对的地方,欢迎随时交流指正。
6. 招聘硬广告
急招!我们是字 节跳动游戏前端团队,团队当前业务包括数个 DAU 千万量级 的游戏中 心化平台,覆盖今日 头条、抖音、西瓜视频等等 多个字节跳动宿主端 ;还有 月流水千万级的创作者服务平台 ,是 抖音官方最重要的游戏短视频分发 平台和达人变现 渠道 。团队负责了这些项目产品,以及与之相关的运营后台、广告主服务平台、效率工具 的前端研发,业务技术包括小程序、H5、Node 等多个方向,且在业务快速发展的同时,还在持续丰富技术支持场景。
简历投递欢迎点击 阅读原文 ,检索「 前端开发(高级)工程师-游戏中台 」或者直接邮箱: lupengyu@bytedance.com 。
7. 参考链接
[1] https://github.com/react-component/form
[2] https://3 x.ant.design/components/form-cn/
[3] https://reactjs.org/docs/react-without-es6.html#mixins
[4] https://github.com/mridgway/hoist-non-react-statics
[5] https://reactjs.org/docs/higher-order-components.html#static-methods-must-be-copied-over
[6] https://github.com/react-component/field-form
[7] https://ant.design/components/form-cn/
[8] https://github.com/reduxjs/redux/issues/1287#issuecomment-175351978
[9] https://redux.js.org/faq/organizing-state#should-i-put-form-state-or-other-ui-state-in-my-store
[10] https://github.com/redux-form/redux-form#%EF%B8%8F-attention-%EF%B8%8F
[11]
rm:
https://www.youtube.com/watch?v=WoSzy-4mviQ&feature=emb_logo
[12] https://github.com/janryWang/cool-path
[13] https://github.com/janryWang/react-eva
[14] https://github.com/alibaba/formily/tree/master/packages/react-schema-editor
[15]
https://www.zhihu.com/column/uform