aboutsummaryrefslogtreecommitdiff
path: root/files/zh-cn/web/javascript/reference/functions/get/index.html
blob: 5264abb7a5e4acf80adcf2d1427d8ef69b243287 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
---
title: getter
slug: Web/JavaScript/Reference/Functions/get
tags:
  - ECMAScript 2015
  - Functions
  - JavaScript
translation_of: Web/JavaScript/Reference/Functions/get
---
<div>{{jsSidebar("Functions")}}</div>

<p><strong><code>get</code></strong>语法将对象属性绑定到查询该属性时将被调用的函数。</p>

<div>{{EmbedInteractiveExample("pages/js/functions-getter.html")}}</div>



<h2 id="语法">语法</h2>

<pre class="syntaxbox">{get <em>prop</em>() { ... } }

{get <em>[expression]</em>() { ... } }</pre>

<h3 id="参数">参数</h3>

<dl>
 <dt><code>prop</code></dt>
 <dd>要绑定到给定函数的属性名。</dd>
 <dt>expression</dt>
 <dd>从 ECMAScript 2015 开始,还可以使用一个计算属性名的表达式绑定到给定的函数。</dd>
</dl>

<h2 id="描述">描述</h2>

<p>有时需要允许访问返回动态计算值的属性,或者你可能需要反映内部变量的状态,而不需要使用显式方法调用。在JavaScript中,可以使用 <em>getter </em>来实现。</p>

<p>尽管可以结合使用getter和setter来创建一个伪属性,但是不可能同时将一个 getter 绑定到一个属性并且该属性实际上具有一个值。</p>

<p>使用<code>get</code>语法时应注意以下问题:</p>

<div>
<ul>
 <li>可以使用数值或字符串作为标识;</li>
 <li>必须不带参数(请参考<a class="external" href="http://whereswalden.com/2010/08/22/incompatible-es5-change-literal-getter-and-setter-functions-must-now-have-exactly-zero-or-one-arguments/" rel="external nofollow">Incompatible <abbr title="ECMAScript 5th edition">ES5</abbr> change: literal getter and setter functions must now have exactly zero or one arguments</a>);</li>
 <li>它不能与另一个 <code>get </code>或具有相同属性的数据条目同时出现在一个对象字面量中(不允许使用 <code>{ get x() { }, get x() { } }</code><code>{ x: ..., get x() { } }</code>)。</li>
</ul>
</div>

<h2 id="示例">示例</h2>

<h3 id="Example_Defining_a_getter_with_the_get_operator" name="Example:_Defining_a_getter_with_the_get_operator">在新对象初始化时定义一个getter</h3>

<p>这会为<code>obj</code>创建一个伪属性<code>latest</code>,它会返回<code>log</code>数组的最后一个元素。</p>

<pre class="brush: js">const obj = {
  log: ['example','test'],
  get latest() {
    if (this.log.length == 0) return undefined;
    return this.log[this.log.length - 1];
  }
}
console.log(obj.latest); // "test".</pre>

<p>注意,尝试为<code>latest</code>分配一个值不会改变它。</p>

<h3 id="Example_Deleting_a_getter_using_the_delete_operator" name="Example:_Deleting_a_getter_using_the_delete_operator">使用<code>delete</code>操作符删除 getter</h3>

<p>只需使用 <code><a href="/zh-CN/docs/Web/JavaScript/Reference/Operators/delete">delete</a></code>,就可删除 getter:</p>

<pre class="brush: js">delete obj.latest;
</pre>

<h3 id="使用defineProperty在现有对象上定义_getter">使用<code>defineProperty</code>在现有对象上定义 getter</h3>

<p>要随时将 getter 添加到现有对象,使用 {{jsxref("Object.defineProperty()")}}.</p>

<pre class="brush: js">var o = { a:0 }

Object.defineProperty(o, "b", { get: function () { return this.a + 1; } });

console.log(o.b) // Runs the getter, which yields a + 1 (which is 1)</pre>

<h3 id="使用计算出的属性名">使用计算出的属性名</h3>

<pre class="brush: js">var expr = 'foo';

var obj = {
  get [expr]() { return 'bar'; }
};

console.log(obj.foo); // "bar"</pre>

<h3 id="智能_自我复写_懒加载_getters">智能 / 自我复写/ 懒加载 getters</h3>

<p>Getters 给你一种方法来定义一个对象的属性,但是在访问它们之前不会计算属性的值。 getter 延迟计算值的成本,直到需要此值,如果不需要,您就不用支付成本。</p>

<p>一种额外的优化技术是用<strong>智能(或称<a href="https://en.wikipedia.org/wiki/Memoization">记忆化</a>)getters </strong>延迟属性值的计算并将其缓存以备以后访问。该值是在第一次调用getter 时计算的,然后被缓存,因此后续访问返回缓存值而不重新计算它。这在以下情况下很有用:</p>

<ul>
 <li>如果属性值的计算是昂贵的(占用大量RAM或CPU时间,产生工作线程,检索远程文件等)。</li>
 <li>如果现在不需要该值。它将在稍后使用,或在某些情况下它根本不使用。</li>
 <li>如果被使用,它将被访问几次,并且不需要重新计算,该值将永远不会被改变,或者不应该被重新计算。</li>
</ul>

<div class="blockIndicator note">
<p>这意味着你不应该为你希望更改其值的属性使用懒 getter,因为 getter 不会重新计算该值。</p>
</div>

<p>在以下示例中,对象具有一个 getter 属性。在获取属性时,该属性将从对象中删除并重新添加,但此时将隐式显示为数据属性。最后返回得到值。</p>

<pre class="brush: js">get notifier() {
  delete this.notifier;
  return this.notifier = document.getElementById('bookmarked-notification-anchor');
},
</pre>

<p>对于Firefox代码,另请参阅定义<code><a href="https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/XPCOMUtils.jsm#defineLazyGetter()">defineLazyGetter()</a></code>函数的<code>XPCOMUtils.jsm</code>代码模块。</p>

<h3 id="get_vs._defineProperty"><code>get</code> vs. <code>defineProperty</code></h3>

<p>当使用 <code>get</code> 关键字时,它和{{jsxref("Object.defineProperty()")}} 有类似的效果,在{{jsxref("classes")}}中使用时,二者有细微的差别。</p>

<p>当使用 <code>get</code> 关键字时,属性将被定义在实例的原型上,当使用{{jsxref("Object.defineProperty()")}}时,属性将被定义在实例自身上。</p>

<pre class="brush: js">class Example {
  get hello() {
    return 'world';
  }
}

const obj = new Example();
console.log(obj.hello);
// "world"

console.log(Object.getOwnPropertyDescriptor(obj, 'hello'));
// undefined

console.log(
  Object.getOwnPropertyDescriptor(
    Object.getPrototypeOf(obj), 'hello'
  )
);
// { configurable: true, enumerable: false, get: function get hello() { return 'world'; }, set: undefined }</pre>

<h2 id="规范">规范</h2>

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Specification</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{SpecName('ESDraft', '#sec-method-definitions', 'Method definitions')}}</td>
  </tr>
 </tbody>
</table>

<h2 id="浏览器兼容">浏览器兼容</h2>

<p>{{Compat("javascript.functions.get")}}</p>

<h2 id="See_also" name="See_also">相关链接</h2>

<ul>
 <li><a href="/en-US/docs/Web/JavaScript/Reference/Functions/set">setter</a></li>
 <li>{{jsxref("Operators/delete", "delete")}}</li>
 <li>{{jsxref("Object.defineProperty()")}}</li>
 <li>{{jsxref("Object.defineGetter", "__defineGetter__")}}</li>
 <li>{{jsxref("Object.defineSetter", "__defineSetter__")}}</li>
 <li>在Javascript指南中 <a href="/en-US/docs/Web/JavaScript/Guide/Working_with_Objects#Defining_getters_and_setters">定义Getters和Setters</a></li>
</ul>