diff options
| -rw-r--r-- | files/zh-cn/web/javascript/reference/global_objects/weakmap/index.md | 161 | ||||
| -rw-r--r-- | files/zh-cn/web/javascript/reference/global_objects/weakmap/weakmap/index.md | 81 |
2 files changed, 144 insertions, 98 deletions
diff --git a/files/zh-cn/web/javascript/reference/global_objects/weakmap/index.md b/files/zh-cn/web/javascript/reference/global_objects/weakmap/index.md index 24739f460d..bd861156ba 100644 --- a/files/zh-cn/web/javascript/reference/global_objects/weakmap/index.md +++ b/files/zh-cn/web/javascript/reference/global_objects/weakmap/index.md @@ -7,151 +7,116 @@ tags: - WeakMap translation_of: Web/JavaScript/Reference/Global_Objects/WeakMap --- -<div>{{JSRef}}</div> +{{JSRef}} -<p><strong><code>WeakMap</code></strong> 对象是一组键/值对的集合，其中的键是弱引用的。其键必须是对象，而值可以是任意的。</p> +**`WeakMap`** 对象是一组键/值对的集合，其中的键是弱引用的。其键必须是对象，而值可以是任意的。 -<p>你可以从这里了解更多关于<code>WeakMap</code>的内容:{{SectionOnPage("/zh-CN/docs/Web/JavaScript/Guide/Keyed_collections", "WeakMap对象")}}.</p> +你可以从这里了解更多关于 `WeakMap` 的内容：[WeakMap对象](/zh-CN/docs/Web/JavaScript/Guide/Keyed_collections#WeakMap_object)。 -<h2 id="语法">语法</h2> -<pre>new WeakMap([iterable])</pre> +## 描述 -<h3 id="参数">参数</h3> +WeakMap 的 key 只能是 `Object` 类型。 {{Glossary("Primitive", "原始数据类型")}} 是不能作为 key 的（比如 {{jsxref("Symbol")}}）。 -<dl> - <dt><code>iterable</code></dt> - <dd>Iterable 是一个数组（二元数组）或者其他可迭代的且其元素是键值对的对象。每个键值对会被加到新的 WeakMap 里。null 会被当做 undefined。</dd> -</dl> +### Why *Weak*Map ？ -<h2 id="描述">描述</h2> +在 JavaScript 里，map API _可以_ 通过使其四个 API 方法共用两个数组(一个存放键,一个存放值)来实现。给这种 map 设置值时会同时将键和值添加到这两个数组的末尾。从而使得键和值的索引在两个数组中相对应。当从该 map 取值的时候，需要遍历所有的键，然后使用索引从存储值的数组中检索出相应的值。 -<p>WeakMap 的 key 只能是 <code>Object</code> 类型。 {{Glossary("Primitive", "原始数据类型")}} 是不能作为 key 的（比如 {{jsxref("Symbol")}}）。</p> +但这样的实现会有两个很大的缺点： -<h3 id="Why_WeakMap">Why <em>WeakMap</em>?</h3> +1. 首先赋值和搜索操作都是 *O(*n*)* 的时间复杂度（_n_ 是键值对的个数），因为这两个操作都需要遍历全部整个数组来进行匹配。 -<p>在 JavaScript 里，map API 可以通过使其四个 API 方法共用两个数组(一个存放键,一个存放值)来实现。给这种 map 设置值时会同时将键和值添加到这两个数组的末尾。从而使得键和值的索引在两个数组中相对应。当从该 map 取值的时候，需要遍历所有的键，然后使用索引从存储值的数组中检索出相应的值。</p> +2. 另外一个缺点是可能会导致内存泄漏，因为数组会一直引用着每个键和值。这种引用使得垃圾回收算法不能回收处理他们，即使没有其他任何引用存在了。 -<p>但这样的实现会有两个很大的缺点，首先赋值和搜索操作都是 O(n) 的时间复杂度( n 是键值对的个数)，因为这两个操作都需要遍历全部整个数组来进行匹配。另外一个缺点是可能会导致内存泄漏，因为数组会一直引用着每个键和值。这种引用使得垃圾回收算法不能回收处理他们，即使没有其他任何引用存在了。</p> +相比之下，原生的 `WeakMap` 持有的是每个键对象的“弱引用”，这意味着在没有其他引用存在时垃圾回收能正确进行。原生 `WeakMap` 的结构是特殊且有效的，其用于映射的 key _只有_在其没有被回收时才是有效的。 -<p>相比之下，原生的 WeakMap 持有的是每个键对象的“弱引用”，这意味着在没有其他引用存在时垃圾回收能正确进行。原生 WeakMap 的结构是特殊且有效的，其用于映射的 key 只有在其没有被回收时才是有效的。</p> +**正由于这样的弱引用，`WeakMap` 的 key 是不可枚举的**（没有方法能给出所有的 key）。如果key 是可枚举的话，其列表将会受垃圾回收机制的影响，从而得到不确定的结果。因此，如果你想要这种类型对象的 key 值的列表，你应该使用 {{jsxref("Map")}}。 -<p>正由于这样的弱引用，<code>WeakMap</code> 的 key 是不可枚举的 (没有方法能给出所有的 key)。如果key 是可枚举的话，其列表将会受垃圾回收机制的影响，从而得到不确定的结果。因此，如果你想要这种类型对象的 key 值的列表，你应该使用 {{jsxref("Map")}}。</p> +## 构造函数 -<p>基本上，如果你要往对象上添加数据，又不想干扰垃圾回收机制，就可以使用 WeakMap。</p> +- {{jsxref("WeakMap/WeakMap", "WeakMap()")}} + - : 创建一个新的 `WeakMap` 对象。 -<h2 id="属性">属性</h2> +## 实例方法 -<dl> - <dt><code>WeakMap.length</code></dt> - <dd><code>length</code> 属性的值为 0。</dd> - <dt>{{jsxref("WeakMap.prototype")}}</dt> - <dd><code>WeakMap</code> 构造器的原型。 允许添加属性到所有的 WeakMap 对象。</dd> -</dl> +- {{jsxref("WeakMap.delete", "WeakMap.prototype.delete(<var>key</var>)")}} + - : 删除 WeakMap 中与 `key` 相关联的值。删除之后， `WeakMap.prototype.has(key)` 将会返回 `false`。 +- {{jsxref("WeakMap.get", "WeakMap.prototype.get(<var>key</var>)")}} + - : 返回 WeakMap 中与 `key` 相关联的值，如果 `key` 不存在则返回 `undefined`。 +- {{jsxref("WeakMap.has", "WeakMap.prototype.has(<var>key</var>)")}} + - : 返回一个布尔值，断言一个值是否已经与 `WeakMap` 对象中的 `key` 关联。 +- {{jsxref("WeakMap.set", "WeakMap.prototype.set(<var>key</var>, <var>value</var>)")}} + - : 给 `WeakMap` 中的 `key` 设置一个 `value`。该方法返回一个 `WeakMap` 对象。 -<h2 id="WeakMap_实例"><code>WeakMap</code> 实例</h2> +## 示例 -<p>所有 <code>WeakMap</code> 实例继承自 {{jsxref("WeakMap.prototype")}}.</p> +### 使用 WeakMap -<h3 id="属性_2">属性</h3> - -<p>{{page('zh-CN/Web/JavaScript/Reference/Global_Objects/WeakMap/prototype','属性')}}</p> - -<h3 id="方法">方法</h3> - -<p>{{page('zh-CN/Web/JavaScript/Reference/Global_Objects/WeakMap/prototype','方法')}}</p> - -<h2 id="示例">示例</h2> - -<h3 id="使用_WeakMap">使用 <code>WeakMap</code></h3> - -<pre class="brush: js">const wm1 = new WeakMap(), +```js +const wm1 = new WeakMap(), wm2 = new WeakMap(), wm3 = new WeakMap(); const o1 = {}, - o2 = function(){}, + o2 = function() {}, o3 = window; - wm1.set(o1, 37); -wm1.set(o2, "azerty"); +wm1.set(o2, 'azerty'); wm2.set(o1, o2); // value可以是任意值,包括一个对象或一个函数 wm2.set(o3, undefined); wm2.set(wm1, wm2); // 键和值可以是任意对象,甚至另外一个WeakMap对象 - wm1.get(o2); // "azerty" wm2.get(o2); // undefined,wm2中没有o2这个键 wm2.get(o3); // undefined,值就是undefined - wm1.has(o2); // true wm2.has(o2); // false wm2.has(o3); // true (即使值是undefined) - wm3.set(o1, 37); wm3.get(o1); // 37 - -wm1.has(o1); // true +wm1.has(o1); // true wm1.delete(o1); -wm1.has(o1); // false -</pre> +wm1.has(o1); // false +``` -<h3 id="实现一_个带有_.clear_方法的类_WeakMap_类">实现一 个带有 .clear() 方法的类 <code>WeakMap</code> 类</h3> +### 实现一 个带有 .clear() 方法的类 WeakMap 类 -<pre class="brush: js">class ClearableWeakMap { +```js +class ClearableWeakMap { constructor(init) { - this._wm = new WeakMap(init) + this._wm = new WeakMap(init); } clear() { - this._wm = new WeakMap() + this._wm = new WeakMap(); } delete(k) { - return this._wm.delete(k) + return this._wm.delete(k); } get(k) { - return this._wm.get(k) + return this._wm.get(k); } has(k) { - return this._wm.has(k) + return this._wm.has(k); } set(k, v) { - this._wm.set(k, v) - return this + this._wm.set(k, v); + return this; } -}</pre> - -<h2 id="Specifications" name="Specifications">规范</h2> - -<table class="standard-table"> - <thead> - <tr> - <th scope="col">Specification</th> - <th scope="col">Status</th> - <th scope="col">Comment</th> - </tr> - </thead> - <tbody> - <tr> - <td>{{SpecName('ES6', '#sec-weakmap-objects', 'WeakMap')}}</td> - <td>{{Spec2('ES6')}}</td> - <td>Initial definition.</td> - </tr> - <tr> - <td>{{SpecName('ESDraft', '#sec-weakmap-objects', 'WeakMap')}}</td> - <td>{{Spec2('ESDraft')}}</td> - <td></td> - </tr> - </tbody> -</table> - -<h2 id="浏览器兼容性">浏览器兼容性</h2> - -<div>{{Compat("javascript.builtins.WeakMap")}}</div> - -<h2 id="相关链接">相关链接</h2> - -<ul> - <li><a class="link-https" href="https://bugzilla.mozilla.org/show_bug.cgi?id=547941">WeakMap bug at Mozilla</a></li> - <li><a href="http://fitzgeraldnick.com/weblog/53/">Hiding Implementation Details with ECMAScript 6 WeakMaps</a></li> - <li>{{jsxref("Map")}}</li> - <li>{{jsxref("Set")}}</li> - <li>{{jsxref("WeakSet")}}</li> -</ul> +} +``` + + +## 规范 + +{{Specifications}} + +## 浏览器兼容性 + +{{Compat}} + +## 相关链接 + +- A polyfill of `WeakMap` is available in [`core-js`](https://github.com/zloirock/core-js#weakmap) +- [`WeakMap` in the JavaScript guide](/en-US/docs/Web/JavaScript/Guide/Keyed_collections#WeakMap_object) +- [Hiding Implementation Details with ECMAScript 6 WeakMaps](http://fitzgeraldnick.com/weblog/53/) +- {{jsxref("Map")}} +- {{jsxref("Set")}} +- {{jsxref("WeakSet")}} diff --git a/files/zh-cn/web/javascript/reference/global_objects/weakmap/weakmap/index.md b/files/zh-cn/web/javascript/reference/global_objects/weakmap/weakmap/index.md new file mode 100644 index 0000000000..68695fdef1 --- /dev/null +++ b/files/zh-cn/web/javascript/reference/global_objects/weakmap/weakmap/index.md @@ -0,0 +1,81 @@ +--- +title: WeakMap() constructor +slug: Web/JavaScript/Reference/Global_Objects/WeakMap/WeakMap +tags: + - Constructor + - JavaScript + - Reference + - WeakMap + - Polyfill +browser-compat: javascript.builtins.WeakMap.WeakMap +translation_of: Web/JavaScript/Reference/Global_Objects/WeakMap/WeakMap +--- + +{{JSRef}} + +**`WeakMap()`** 会创建一个 `WeakMap` 对象，该对象是一组键/值对的集合，其中的键是弱引用的。其键必须是对象，而值可以是任意的。 + +你可以从这里了解更多关于 `WeakMap` 的内容 [WeakMap 对象](/zh-CN/docs/Web/JavaScript/Guide/Keyed_collections) + +## 语法 + +```js +new WeakMap(); +new WeakMap([iterable]); +``` + +## 参数 + +- `iterable` + - Iterable 是一个数组（二元数组）或者其他可迭代的且其元素是键值对的对象。每个键值对会被加到新的 WeakMap 里。null 会被当做 undefined。 + +## 示例 + +### 使用 `WeakMap` + +```JavaScript +const wm1 = new WeakMap(), + wm2 = new WeakMap(), + wm3 = new WeakMap(); +const o1 = {}, + o2 = function(){}, + o3 = window; + +wm1.set(o1, 37); +wm1.set(o2, "azerty"); +wm2.set(o1, o2); // value可以是任意值,包括一个对象或一个函数 +wm2.set(o3, undefined); +wm2.set(wm1, wm2); // 键和值可以是任意对象,甚至另外一个WeakMap对象 + +wm1.get(o2); // "azerty" +wm2.get(o2); // undefined,wm2中没有o2这个键 +wm2.get(o3); // undefined,值就是undefined + +wm1.has(o2); // true +wm2.has(o2); // false +wm2.has(o3); // true (即使值是undefined) + +wm3.set(o1, 37); +wm3.get(o1); // 37 + +wm1.has(o1); // true +wm1.delete(o1); +wm1.has(o1); // false +``` + +## 规范 + +{{Specifications}} + +## 浏览器兼容性 + +{{Compat("javascript.builtins.WeakMap")}} + +## 相关链接 + +- A polyfill of `WeakMap` is available in [`core-js`](https://github.com/zloirock/core-js#weakmap) +- [`WeakMap` in the JavaScript guide](/zh-CN/docs/Web/JavaScript/Guide/Keyed_collections#weakmap对象) +- [Hiding Implementation Details with ECMAScript 6 WeakMaps](https://fitzgeraldnick.com/weblog/53/) +- {{jsxref("Map")}} +- {{jsxref("Set")}} +- {{jsxref("WeakSet")}} |