Skip to content

Commit 0e991b4

Browse files
committed
docs(decorator): 修饰器补充内容
1 parent 8c4187a commit 0e991b4

File tree

1 file changed

+74
-14
lines changed

1 file changed

+74
-14
lines changed

docs/decorator.md

Lines changed: 74 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 类的修饰
44

5-
修饰器(Decorator)是一个表达式,用来修改类的行为。这是ES7的一个[提案](https://github.com/wycats/javascript-decorators),目前Babel转码器已经支持。
5+
修饰器(Decorator)是一个函数,用来修改类的行为。这是ES7的一个[提案](https://github.com/wycats/javascript-decorators),目前Babel转码器已经支持。
66

77
修饰器对类的行为的改变,是代码编译时发生的,而不是在运行时。这意味着,修饰器能在编译阶段运行代码。
88

@@ -17,7 +17,7 @@ class MyTestableClass {}
1717
console.log(MyTestableClass.isTestable) // true
1818
```
1919

20-
上面代码中,`@testable`就是一个修饰器。它修改了MyTestableClass这个类的行为,为它加上了静态属性`isTestable`
20+
上面代码中,`@testable`就是一个修饰器。它修改了`MyTestableClass`这个类的行为,为它加上了静态属性`isTestable`
2121

2222
基本上,修饰器的行为就是下面这样。
2323

@@ -31,9 +31,19 @@ class A {}
3131
A = decorator(A) || A;
3232
```
3333

34-
也就是说,修饰器本质上就是能在编译时执行的函数
34+
也就是说,修饰器本质就是编译时执行的函数
3535

36-
修饰器函数可以接受三个参数,依次是目标函数、属性名和该属性的描述对象。后两个参数可省略。上面代码中,testable函数的参数target,就是所要修饰的对象。如果希望修饰器的行为,能够根据目标对象的不同而不同,就要在外面再封装一层函数。
36+
修饰器函数的第一个参数,就是所要修饰的目标类。
37+
38+
```javascript
39+
function testable(target) {
40+
// ...
41+
}
42+
```
43+
44+
上面代码中,`testable`函数的参数`target`,就是会被修饰的类。
45+
46+
如果觉得一个参数不够用,可以在修饰器外面再封装一层函数。
3747

3848
```javascript
3949
function testable(isTestable) {
@@ -53,7 +63,7 @@ MyClass.isTestable // false
5363

5464
上面代码中,修饰器`testable`可以接受参数,这就等于可以修改修饰器的行为。
5565

56-
如果想要为类的实例添加方法,可以在修饰器函数中,为目标类的prototype属性添加方法
66+
前面的例子是为类添加一个静态属性,如果想添加实例属性,可以通过目标类的`prototype`对象操作
5767

5868
```javascript
5969
function testable(target) {
@@ -67,7 +77,7 @@ let obj = new MyTestableClass();
6777
obj.isTestable // true
6878
```
6979

70-
上面代码中,修饰器函数`testable`是在目标类的`prototype`属性添加属性,因此就可以在类的实例上调用添加的属性
80+
上面代码中,修饰器函数`testable`是在目标类的`prototype`对象上添加属性,因此就可以在实例上调用
7181

7282
下面是另外一个例子。
7383

@@ -93,9 +103,7 @@ let obj = new MyClass()
93103
obj.foo() // 'foo'
94104
```
95105

96-
上面代码通过修饰器`mixins`,可以为类添加指定的方法。
97-
98-
修饰器可以用`Object.assign()`模拟。
106+
上面代码通过修饰器`mixins`,把`Foo`类的方法添加到了`MyClass`的实例上面。可以用`Object.assign()`模拟这个功能。
99107

100108
```javascript
101109
const Foo = {
@@ -121,13 +129,11 @@ class Person {
121129
}
122130
```
123131

124-
上面代码中,修饰器readonly用来修饰“类”的name方法
132+
上面代码中,修饰器`readonly`用来修饰“类”`name`方法
125133

126134
此时,修饰器函数一共可以接受三个参数,第一个参数是所要修饰的目标对象,第二个参数是所要修饰的属性名,第三个参数是该属性的描述对象。
127135

128136
```javascript
129-
readonly(Person.prototype, 'name', descriptor);
130-
131137
function readonly(target, name, descriptor){
132138
// descriptor对象原来的值如下
133139
// {
@@ -140,10 +146,14 @@ function readonly(target, name, descriptor){
140146
return descriptor;
141147
}
142148

149+
readonly(Person.prototype, 'name', descriptor);
150+
// 类似于
143151
Object.defineProperty(Person.prototype, 'name', descriptor);
144152
```
145153

146-
上面代码说明,修饰器(readonly)会修改属性的描述对象(descriptor),然后被修改的描述对象再用来定义属性。下面是另一个例子。
154+
上面代码说明,修饰器(readonly)会修改属性的描述对象(descriptor),然后被修改的描述对象再用来定义属性。
155+
156+
下面是另一个例子,修改属性描述对象的`enumerable`属性,使得该属性不可遍历。
147157

148158
```javascript
149159
class Person {
@@ -157,6 +167,35 @@ function nonenumerable(target, name, descriptor) {
157167
}
158168
```
159169

170+
下面的`@log`修饰器,可以起到输出日志的作用。
171+
172+
```bash
173+
class Math {
174+
@log
175+
add(a, b) {
176+
return a + b;
177+
}
178+
}
179+
180+
function log(target, name, descriptor) {
181+
var oldValue = descriptor.value;
182+
183+
descriptor.value = function() {
184+
console.log(`Calling "${name}" with`, arguments);
185+
return oldValue.apply(null, arguments);
186+
};
187+
188+
return descriptor;
189+
}
190+
191+
const math = new Math();
192+
193+
// passed parameters should get logged now
194+
math.add(2, 4);
195+
```
196+
197+
上面代码中,`@log`修饰器的作用就是在执行原始的操作之前,执行一次`console.log`,从而达到输出日志的目的。
198+
160199
修饰器有注释的作用。
161200

162201
```javascript
@@ -170,6 +209,27 @@ class Person {
170209

171210
从上面代码中,我们一眼就能看出,`Person`类是可测试的,而`name`方法是只读和不可枚举的。
172211

212+
如果同一个方法有多个修饰器,会像剥洋葱一样,先从外到内进入,然后由内向外执行。
213+
214+
```javascript
215+
function dec(id){
216+
console.log('evaluated', id);
217+
return (target, property, descriptor) => console.log('executed', id);
218+
}
219+
220+
class Example {
221+
@dec(1)
222+
@dec(2)
223+
method(){}
224+
}
225+
// evaluated 1
226+
// evaluated 2
227+
// executed 2
228+
// executed 1
229+
```
230+
231+
上面代码中,外层修饰器`@dec(1)`先进入,但是内层修饰器`@dec(2)`先执行。
232+
173233
除了注释,修饰器还能用来类型检查。所以,对于类来说,这项功能相当有用。从长期来看,它将是JavaScript代码静态分析的重要工具。
174234

175235
## 为什么修饰器不能用于函数?
@@ -188,7 +248,7 @@ function foo() {
188248
}
189249
```
190250

191-
上面的代码,意图是执行后,counter等于1,但是实际上结果是couter等于0。因为函数提升,使得实际执行的代码是下面这样。
251+
上面的代码,意图是执行后`counter`等于1,但是实际上结果是`counter`等于0。因为函数提升,使得实际执行的代码是下面这样。
192252

193253
```javascript
194254
var counter;

0 commit comments

Comments
 (0)