JavaScript 中的 structuredClone():详尽解析

简介: 您是否知道,现在 JavaScript 中有一种原生的方式可以深拷贝对象?

您是否知道,现在 JavaScript 中有一种原生的方式可以深拷贝对象?

没错,这个内置于 JavaScript 运行时的structuredClone函数就是这样:

const calendarEvent = {
  title: "Builder.io大会",
  date: new Date(123),
  attendees: ["Steve"]
}
// 😍
const copied = structuredClone(calendarEvent)

您是否注意到在上面的例子中,我们不仅复制了对象,还复制了嵌套数组,甚至还包括 Date 对象?

一切正如预期工作:

copied.attendees // ["Steve"]
copied.date // Date: 1969年12月31日16:00:00
cocalendarEvent.attendees === copied.attendees // false

没错,structuredClone不仅能做到上述功能,还能够:

  • 克隆无限嵌套的对象和数组
  • 克隆循环引用
  • 克隆广泛的 JavaScript 类型,例如DateSetMapErrorRegExpArrayBufferBlobFileImageData,以及许多其他类型
  • 转移任何可转移对象

例如,甚至以下这种疯狂的情况也能如期工作:

const kitchenSink = {
  set: new Set([1, 3, 3]),
  map: new Map([[1, 2]]),
  regex: /foo/,
  deep: { array: [ new File(someBlobData, 'file.txt') ] },
  error: new Error('Hello!')
}
kitchenSink.circular = kitchenSink
// ✅ 全部良好,完全而深入地复制!
const clonedSink = structuredClone(kitchenSink)

为什么不仅使用对象扩展?

重要的是要注意我们在谈论深度拷贝。如果您只需要进行浅拷贝,也就是不复制嵌套对象或数组的拷贝,那么我们可以简单地使用对象扩展:

const simpleEvent = {
  title: "Builder.io大会",
}
// ✅ 没问题,没有嵌套对象或数组
const shallowCopy = {...calendarEvent}

甚至如果您更喜欢,可以使用以下方式之一:

const shallowCopy = Object.assign({}, simpleEvent)
const shallowCopy = Object.create(simpleEvent)

但是一旦我们有了嵌套项,就会遇到麻烦:

const calendarEvent = {
  title: "Builder.io大会",
  date: new Date(123),
  attendees: ["Steve"]
}
const shallowCopy = {...calendarEvent}
// 🚩 哎呀 - 我们刚刚将“Bob”添加到了复制品*和*原始事件中
shallowCopy.attendees.push("Bob")
// 🚩 哎呀 - 我们刚刚更新了复制品*和*原始事件的日期
shallowCopy.date.setTime(456)

如您所见,我们并没有完全复制这个对象。

嵌套的日期和数组仍然是两者之间的共享引用,如果我们想要编辑这些,认为我们只是在更新复制的日历事件对象,这可能会导致我们遇到重大问题。

为什么不用JSON.parse(JSON.stringify(x))?

啊,是的,这个技巧。实际上这是一个很好的方法,而且出人意料地高效,但structuredClone解决了它的一些缺点。

以此为例:

const calendarEvent = {
  title: "Builder.io大会",
  date: new Date(123),
  attendees: ["Steve"]
}
// 🚩 JSON.stringify 将`date`转换为了字符串
const problematicCopy = JSON.parse(JSON.stringify(calendarEvent))

如果我们记录problematicCopy,我们会得到:

{
  title: "Builder.io大会",
  date: "1970-01-01T00:00:00.123Z"
  attendees: ["Steve"]
}

这不是我们想要的!date应该是一个Date对象,而不是一个字符串。

这是因为JSON.stringify只能处理基本的对象、数组和原始类型。任何其他类型都以难以预测的方式处理。例如,日期被转换为字符串。但是Set简单地转换为{}

JSON.stringify甚至完全忽略某些东西,如undefined函数

例如,如果我们用这种方法复制我们的kitchenSink示例:

const kitchenSink = {
  set: new Set([1, 3, 3]),
  map: new Map([[1, 2]]),
  regex: /foo/,
  deep: { array: [ new File(someBlobData, 'file.txt') ] },
  error: new Error('Hello!')
}
const veryProblematicCopy = JSON.parse(JSON.stringify(kitchenSink))

我们会得到:

{
  "set": {},
  "map": {},
  "regex": {},
  "deep": {
    "array": [
      {}
    ]
  },
  "error": {},
}

呃!

哦,是的,我们不得不移除我们最初拥有的循环引用,因为JSON.stringify如果遇到其中的一个,就会简单地抛出错误。

因此,虽然如果我们的需求适合它能做的事情,这种方法可能很好,但structuredClone(也就是上面我们未能做到的所有事情)能做许多这种方法不能做的事情。

为什么不用_.cloneDeep?

到目前为止,Lodash 的cloneDeep函数一直是这个问题的一个非常常见的解决方案。

实际上,这确实如预期工作:

import cloneDeep from 'lodash/cloneDeep'
const calendarEvent = {
  title: "Builder.io大会",
  date: new Date(123),
  attendees: ["Steve"]
}
const clonedEvent = cloneDeep(calendarEvent)

但是,这里只有一个警告。根据我的 IDE 中的 Import Cost 扩展,它打印了我导入的任何东西的 kb 成本,这一个功能的成本为整整 17.4kb压缩后的大小(5.3kb gzip 压缩后):

而这是假设您仅导入了那个功能。如果您以更常见的方式导入,没有意识到 tree shaking 并不总是按照您希望的方式工作,您可能意外地仅为这一个功能导入多达 25kb😱

虽然这对任何人来说都不会是世界末日,但在我们的案例中,这根本不是必要的,不是在浏览器中已经内置了structuredClone的情况下。

什么是structuredClone不能克隆

函数不能被克隆

它们会抛出一个DataCloneError异常:

// 🚩 错误!
structuredClone({ fn: () => { } })

DOM 节点

也会抛出一个DataCloneError异常:

// 🚩 错误!
structuredClone({ el: document.body })

属性描述符、设置器和获取器

以及类似的元数据特性都不会被克隆。

例如,对于一个获取器,克隆的是结果值,而不是获取器函数本身(或任何其他属性元数据):

structuredClone({ get foo() { return 'bar' } })
// 变成了:{ foo: 'bar' }

对象原型

不会遍历或复制原型链。因此,如果您克隆了MyClass的一个实例,克隆的对象将不再被识别为这个类的实例(但这个类的所有有效属性将被克隆):

class MyClass { 
  foo = 'bar' 
  myMethod() { /* ... */ }
}
const myClass = new MyClass()
const cloned = structuredClone(myClass)
// 变成了:{ foo: 'bar' }
cloned instanceof myClass // false

支持的类型全列表

更简单地说,下面列表中未提到的任何东西都不能被克隆:

JS 内建类型

ArrayArrayBufferBooleanDataViewDateError类型(下面具体列出的那些)、MapObject但仅限于普通对象(例如,来自对象字面量)、原始类型,除了symbol(即numberstringnullundefinedbooleanBigInt)、RegExpSetTypedArray

错误类型

ErrorEvalErrorRangeErrorReferenceErrorSyntaxErrorTypeErrorURIError

Web/API 类型

AudioDataBlobCryptoKeyDOMExceptionDOMMatrixDOMMatrixReadOnlyDOMPointDomQuadDomRectFileFileListFileSystemDirectoryHandleFileSystemFileHandleFileSystemHandleImageBitmapImageDataRTCCertificateVideoFrame

浏览器和运行时支持

这里是最好的部分 - structuredClone在所有主要浏览器中都得到支持,甚至包括 Node.js 和 Deno。

只需注意 Web Workers 的支持较为有限的警告:

来源:MDN

结论

经过漫长的等待,我们终于现在有了structuredClone,使得在 JavaScript 中深度克隆对象变得轻而易举。

相关文章
|
1月前
|
Linux iOS开发 UED
探索Qt折线图之美:一次详尽的多角度解析
探索Qt折线图之美:一次详尽的多角度解析
111 0
|
2月前
|
JavaScript 前端开发
Vue 应用 main.js 里的源代码解析
Vue 应用 main.js 里的源代码解析
26 0
|
1月前
|
自然语言处理 JavaScript 前端开发
Vue.js 深度解析:模板编译原理与过程
Vue.js 深度解析:模板编译原理与过程
|
1月前
|
缓存 JavaScript 网络架构
Vue.js 进阶技巧:keep-alive 缓存组件解析
Vue.js 进阶技巧:keep-alive 缓存组件解析
|
1月前
|
JavaScript 前端开发 API
Vue.js 深度解析:nextTick 原理与应用
Vue.js 深度解析:nextTick 原理与应用
|
2月前
|
前端开发 JavaScript BI
JavaScript的过滤大师:深度解析Filter用法
JavaScript的过滤大师:深度解析Filter用法
63 0
|
2月前
|
JSON 前端开发 JavaScript
掌握现代JavaScript:ES7到ES12的新特性全解析!
ES2016(ES7)中新增了如下特性👇 Array.prototype.includes Exponentiation Operator
|
3月前
|
JavaScript
js生成二维码和解析二维码
js生成二维码和解析二维码
25 0
|
3月前
|
存储 JavaScript 前端开发
JavaScript中的类型、面向对象编程 深度解析
JavaScript中的类型、面向对象编程 深度解析
13 0
|
3月前
|
前端开发 JavaScript 算法
深入探究 JavaScript 中的 String:常用方法和属性全解析(下)
深入探究 JavaScript 中的 String:常用方法和属性全解析(下)

推荐镜像

更多