头图

一次说清,为什么在Antd Modal中调resetFields调了个寂寞

背景

在干了大半年增删查改后(node,mysql,serverless),业务端人手短缺,老板开恩让我支持其他团队写几个页面。

久了不摸手生,除了react依稀记得,antd基本只能看着官方demo一行一行写,感觉一天能写完的,结果两天了还没联调完。中间还遇到一些似曾相识的问题,可惜以前的经验已经不管用了。

demo地址: https://codesandbox.io/s/antd...

这些问题在antd的仓库issue都反复被提及,看了下文,包括但不限于以下问题都将得到答案:
20211221224910

概括一下:

  • Form表单,React hooks 组件,initialValues初始化数据时候,第二次、第三次……传递新值,表单没有更新,永远显示第一次数据?
  • 弹出层新建表单重新设置值不起作用?

    • Modal 用了destroyOnClose,里面有 Form,并使用 form.resetFields,为什么会失效?
    • Modal中initialValues更新了,使用了form.resetFields,要连续打开两次才生效?

有事说事

语言描述显得太苍白,所以直接看动图吧:
reset-small

这是一个简单的增删查改页面,新增和编辑共享了同一个组件,期望在打开弹窗编辑表单关闭后,重新打开时,能根据initialValues重新渲染表单, 但得到的结果是,第二次打开,编辑框没有刷新.

实现的伪代码大致是这样:

import React, { useEffect } from "react";
import { Modal, Form, Input, Button, Checkbox } from "antd";

export function EditModal(props) {
  const { visible, onOk, onCancel, content = {} } = props;
  const [form] = Form.useForm();
  const isEdit = !!content.sort;
  const handlSubmit = (close) => {
    // 一些提交逻辑
  };
  useEffect(() => {
    // setTimeout(() => {
    form.resetFields();
    // });
  }, [content]);

  return (
    <Modal
      title={`${isEdit ? "编辑" : "新建"}备注`}
      visible={visible}
      destroyOnClose
      onOk={onOk}
      onCancel={onCancel}
    >
      <Form
        name="basic"
        labelCol={{ span: 7 }}
        wrapperCol={{ span: 14 }}
        form={form}
        initialValues={content}
        autoComplete="off"
      >
        {...一些表单}
      </Form>
    </Modal>
  );
}

相信出现问题的盆友们,大多都是和我一样,如上面这样的代码这样实现。

具体问题,具体分析

先给结论,之所以会出现上面的那些问题,主要是三个问题导致:

  • react hooks使用姿势不正确,antd4 form引入了hooks, 和antd3使用有所区别;
  • 对form表单initialValues的认识不清;
  • Modal子元素的渲染是异步的,destroyOnClose 错误使用;

initialValues初始化数据时候,第二次、第三次……传递新值,表单没有更新?

因为initialValues只在表单首次初始化时有效,只要表单没有卸载并重新挂载,改变initialValues都不会刷新表单的值,form最初的设计就如此;以下是initialValues初始化存到store的完整实现:

  this.setInitialValues = function (initialValues, init) {
    _this.initialValues = initialValues || {};
    if (init) {
      // setValues 作用类似于Object.assign();
      _this.store = setValues({}, initialValues, _this.store);
    }
  };

this.store 是存放在form实例中的,只要实例不销毁,store的值就不会变化。

destroyOnClose,弹出层新建表单重新设置值不起作用?

首先这里有个概念,initialValues 在Form表单实例挂载时,这个值是被存在了用hooks生成的form实例中。

所以当我们使用了destroyOnClose,虽然销毁了Modal 以及Modal框中的Form,但这个form实例仍然存在,这个hook实例是挂载在EditModal元素上的,并没有被一起销毁,所以当弹窗再次打开,Form表单又会根据这个form的store再次渲染(原因见上)。

Modal 用了destroyOnClose,里面有 Form,并使用 form.resetFields,为什么会失效?

当我们意识到form实例没有被销毁,可能保存了上一个表单编辑状态时,我们会想到使用useEffect钩子,去观察初始值,采用form.resetFields去重置实例,但最后发现这并没有起作用(我也踩到了这个坑上)。

当我去掉destroyOnClose,我发现生效了,后面我去看了一下form.resetFields的实现源码:

this.resetFields = function (nameList) {
  var prevStore = _this.store;

  if (!nameList) {
    // console.log(JSON.stringify(prevStore), JSON.stringify(_this.initialValues));
    _this.store = setValues({}, _this.initialValues);
    _this.resetWithFieldInitialValue();
    _this.notifyObservers(prevStore, null, {
      type: 'reset'
    });
    return;
  }
}

这个实现和initialValues 一样简单明了,所以问题不在resetFields。问题是出在Modal身上,简单来讲Moda的创建有一个异步过程,所以子组件的渲染并不是同步的。正常的组件渲染是下面这样的:

20211223222510

只需和我上面一样,在resetFields加一句console, 就会发现_this.initialValues是上一次的初始值,而不是新传入的(因为Form元素还未挂载),所以这里resetFields调了个寂寞。

还有一种简单的方法证明Modal组件的子组件挂载是异步的,就是如下面这样去玩:

useEffect(() => {
  setTimeout(() => {
    form.resetFields();
  });
}, [content]);

这个实现,你会发现resetFields居然生效了,因为一个宏任务后,Form元素已经挂载上。

所以这里告诉我们,要尽量少用destroyOnClose,因为Modal的渲染是耗时的且费力的。

Modal使用了form.resetFields初始化,要连续打开两次才生效?

相信经过上面的一系列解释,你的心中已经有了答案;destroyOnClose 确实不适合在Modal中写表单时用。

所以,Modal中重置Form initalValues的正确姿势了吗?

慎点

吃一堑,长一智

这一次经历后,我记住了:

  • destroyOnClose要慎用,因为Modal的渲染是昂贵的;
  • hooks 是个好东西,但你得用对;
  • antd是个好东西,前提是你会用;
  • 我还是太菜了;

欢迎关注我的前端公众号:前端黑洞


前端黑洞
生命不息,奋斗不止

不要假装很努力,因为结果不会陪你演戏

3.4k 声望
4.7k 粉丝
0 条评论
推荐阅读
6s到1s: 双端应用的秒开优化之路
近来,我们团队开始尝试用新的解决方案(双端开发,同时投放PC端和移动端)解决前端资源短缺问题。但提测后,测试提出我们移动端页面首屏太慢(6s+),体验极差。

前端黑洞2阅读 776

封面图
安全地在前后端之间传输数据 - 「3」真的安全吗?
在「2」注册和登录示例中,我们通过非对称加密算法实现了浏览器和 Web 服务器之间的安全传输。看起来一切都很美好,但是危险就在哪里,有些人发现了,有些人嗅到了,更多人却浑然不知。就像是给门上了把好锁,还...

边城31阅读 7.2k评论 5

封面图
涨姿势了,有意思的气泡 Loading 效果
今日,群友提问,如何实现这么一个 Loading 效果:这个确实有点意思,但是这是 CSS 能够完成的?没错,这个效果中的核心气泡效果,其实借助 CSS 中的滤镜,能够比较轻松的实现,就是所需的元素可能多点。参考我们...

chokcoco20阅读 2.1k评论 2

在前端使用 JS 进行分类汇总
最近遇到一些同学在问 JS 中进行数据统计的问题。虽然数据统计一般会在数据库中进行,但是后端遇到需要使用程序来进行统计的情况也非常多。.NET 就为了对内存数据和数据库数据进行统一地数据处理,发明了 LINQ (L...

边城17阅读 1.9k

封面图
【已结束】SegmentFault 思否写作挑战赛!
SegmentFault 思否写作挑战赛 是思否社区新上线的系列社区活动在 2 月 8 日 正式面向社区所有用户开启;挑战赛中包含多个可供作者选择的热门技术方向,根据挑战难度分为多个等级,快来参与挑战,向更好的自己前进!

SegmentFault思否20阅读 5.6k评论 10

封面图
过滤/筛选树节点
又是树,是我跟树杠上了吗?—— 不,是树的问题太多了!🔗 相关文章推荐:使用递归遍历并转换树形数据(以 TypeScript 为例)从列表生成树 (JavaScript/TypeScript) 过滤和筛选是一个意思,都是 filter。对于列表来...

边城18阅读 7.7k评论 3

封面图
Vue2 导出excel
2020-07-15更新 excel导出安装 {代码...} src文件夹下新建一个libs文件夹,新建一个excel.js {代码...} vue页面中使用 {代码...} ===========================以下为早期的文章今天在开发的过程中需要做一个Vue的...

原谅我一生不羁放歌搞文艺14阅读 20k评论 9

不要假装很努力,因为结果不会陪你演戏

3.4k 声望
4.7k 粉丝
宣传栏