淺談ES6中的裝飾器
- 不言轉載
- 2018-11-15 17:35:142483瀏覽
這篇文章帶給大家的內容是關於淺談ES6中的裝飾器，有一定的參考價值，有需要的朋友可以參考一下，希望對你有所幫助。
Decorator
裝飾器主要用於：
#裝飾類別
裝飾方法或屬性
裝飾類別
@annotation
class MyClass { }
function annotation(target) {
target.annotated = true;
}
裝飾方法或屬性
class MyClass {
@readonly
method() { }
}
function readonly(target, name, descriptor) {
descriptor.writable = false;
return descriptor;
}
Babel
安裝編譯
我們可以在Babel官網的Try it out，查看Babel 編譯後的程式碼。
不過我們也可以選擇本地編譯：
npm init npm install --save-dev @babel/core @babel/cli npm install --save-dev @babel/plugin-proposal-decorators @babel/plugin-proposal-class-properties
新建.babelrc 檔案
{
"plugins": [
["@babel/plugin-proposal-decorators", { "legacy": true }],
["@babel/plugin-proposal-class-properties", {"loose": true}]
]
}
再編譯指定的檔案
babel decorator.js --out-file decorator-compiled.js
裝飾類別的編譯
編譯前：
@annotation
class MyClass { }
function annotation(target) {
target.annotated = true;
}
編譯後：
var _class;
let MyClass = annotation(_class = class MyClass {}) || _class;
function annotation(target) {
target.annotated = true;
}
我們可以看到對於類別的裝飾，其原理就是：
@decorator
class A {}
// 等同于
class A {}
A = decorator(A) || A;
裝飾方法的編譯
編譯前：
class MyClass {
@unenumerable
@readonly
method() { }
}
function readonly(target, name, descriptor) {
descriptor.writable = false;
return descriptor;
}
function unenumerable(target, name, descriptor) {
descriptor.enumerable = false;
return descriptor;
}
編譯後：
var _class;
function _applyDecoratedDescriptor(target, property, decorators, descriptor, context ) {
/**
* 第一部分
* 拷贝属性
*/
var desc = {};
Object["ke" + "ys"](descriptor).forEach(function(key) {
desc[key] = descriptor[key];
});
desc.enumerable = !!desc.enumerable;
desc.configurable = !!desc.configurable;
if ("value" in desc || desc.initializer) {
desc.writable = true;
}
/**
* 第二部分
* 应用多个 decorators
*/
desc = decorators
.slice()
.reverse()
.reduce(function(desc, decorator) {
return decorator(target, property, desc) || desc;
}, desc);
/**
* 第三部分
* 设置要 decorators 的属性
*/
if (context && desc.initializer !== void 0) {
desc.value = desc.initializer ? desc.initializer.call(context) : void 0;
desc.initializer = undefined;
}
if (desc.initializer === void 0) {
Object["define" + "Property"](target, property, desc);
desc = null;
}
return desc;
}
let MyClass = ((_class = class MyClass {
method() {}
}),
_applyDecoratedDescriptor(
_class.prototype,
"method",
[readonly],
Object.getOwnPropertyDescriptor(_class.prototype, "method"),
_class.prototype
),
_class);
function readonly(target, name, descriptor) {
descriptor.writable = false;
return descriptor;
}
裝飾方法的編譯原始碼解析
#我們可以看到Babel 建構了一個_applyDecoratedDescriptor 函數，用於給方法裝飾。
Object.getOwnPropertyDescriptor()
在傳入參數的時候，我們用了一個Object.getOwnPropertyDescriptor() 方法，我們來看這個方法：
Object. getOwnPropertyDescriptor() 方法傳回指定物件上的一個自有屬性對應的屬性描述符。 （自有屬性指的是直接賦予該物件的屬性，不需要從原型鏈上進行尋找的屬性）
順便注意這是一個 ES5 的方法。
舉例：
const foo = { value: 1 };
const bar = Object.getOwnPropertyDescriptor(foo, "value");
// bar {
// value: 1,
// writable: true
// enumerable: true,
// configurable: true,
// }
const foo = { get value() { return 1; } };
const bar = Object.getOwnPropertyDescriptor(foo, "value");
// bar {
// get: /*the getter function*/,
// set: undefined
// enumerable: true,
// configurable: true,
// }
第一部分原始碼解析
在_applyDecoratedDescriptor 函數內部，我們先將Object.getOwnPropertyDescriptor() 傳回的屬性描述子物件做了一份拷貝：
// 拷贝一份 descriptor
var desc = {};
Object["ke" + "ys"](descriptor).forEach(function(key) {
desc[key] = descriptor[key];
});
desc.enumerable = !!desc.enumerable;
desc.configurable = !!desc.configurable;
// 如果没有 value 属性或者没有 initializer 属性，表明是 getter 和 setter
if ("value" in desc || desc.initializer) {
desc.writable = true;
}
那麼initializer 屬性是什麼呢？ Object.getOwnPropertyDescriptor() 傳回的物件並沒有這個屬性呀，確實，這是Babel 的Class 為了與decorator 配合而產生的屬性，比如說對於下面這種程式碼：
class MyClass {
@readonly
born = Date.now();
}
function readonly(target, name, descriptor) {
descriptor.writable = false;
return descriptor;
}
var foo = new MyClass();
console.log(foo.born);
Babel 就會編譯為：
// ...
(_descriptor = _applyDecoratedDescriptor(_class.prototype, "born", [readonly], {
configurable: true,
enumerable: true,
writable: true,
initializer: function() {
return Date.now();
}
}))
// ...
此時傳入_applyDecoratedDescriptor 函數的descriptor 就具有initializer 屬性。
第二部分原始碼解析
接下是應用多個decorators：
/**
* 第二部分
* @type {[type]}
*/
desc = decorators
.slice()
.reverse()
.reduce(function(desc, decorator) {
return decorator(target, property, desc) || desc;
}, desc);
對於一個方法應用了多個decorator，例如：
class MyClass {
@unenumerable
@readonly
method() { }
}
Babel 會編譯為：
_applyDecoratedDescriptor( _class.prototype, "method", [unenumerable, readonly], Object.getOwnPropertyDescriptor(_class.prototype, "method"), _class.prototype )
在第二部分的原始碼中，執行了reverse() 和reduce() 操作，由此我們也可以發現，如果同一個方法有多個裝飾器，會由內向外執行。
第三部分原始碼解析
/**
* 第三部分
* 设置要 decorators 的属性
*/
if (context && desc.initializer !== void 0) {
desc.value = desc.initializer ? desc.initializer.call(context) : void 0;
desc.initializer = undefined;
}
if (desc.initializer === void 0) {
Object["define" + "Property"](target, property, desc);
desc = null;
}
return desc;
如果desc 有initializer 屬性，表示當裝飾的是類別的屬性時，會將value 的值設為:
desc.initializer.call(context)
而context 的值為_class.prototype，之所以要call(context)，這也很好理解，因為有可能
class MyClass {
@readonly
value = this.getNum() + 1;
getNum() {
return 1;
}
}
最後無論是裝飾方法還是屬性，都會執行：
Object["define" + "Property"](target, property, desc);
由此可見，裝飾方法本質上還是使用Object.defineProperty() 來實現的。
應用程式
1.log
為一個方法新增log 函數，檢查輸入的參數：
class Math {
@log
add(a, b) {
return a + b;
}
}
function log(target, name, descriptor) {
var oldValue = descriptor.value;
descriptor.value = function(...args) {
console.log(`Calling ${name} with`, args);
return oldValue.apply(this, args);
};
return descriptor;
}
const math = new Math();
// Calling add with [2, 4]
math.add(2, 4);
再完善點：
let log = (type) => {
return (target, name, descriptor) => {
const method = descriptor.value;
descriptor.value = (...args) => {
console.info(`(${type}) 正在执行: ${name}(${args}) = ?`);
let ret;
try {
ret = method.apply(target, args);
console.info(`(${type}) 成功 : ${name}(${args}) => ${ret}`);
} catch (error) {
console.error(`(${type}) 失败: ${name}(${args}) => ${error}`);
}
return ret;
}
}
};
2.autobind
class Person {
@autobind
getPerson() {
return this;
}
}
let person = new Person();
let { getPerson } = person;
getPerson() === person;
// true
我們很容易想到的一個場景是React 綁定事件的時候：
class Toggle extends React.Component {
@autobind
handleClick() {
console.log(this)
}
render() {
return (
<button onClick={this.handleClick}>
button
</button>
);
}
}
我們來寫這樣一個autobind 函數：
const { defineProperty, getPrototypeOf} = Object;
function bind(fn, context) {
if (fn.bind) {
return fn.bind(context);
} else {
return function __autobind__() {
return fn.apply(context, arguments);
};
}
}
function createDefaultSetter(key) {
return function set(newValue) {
Object.defineProperty(this, key, {
configurable: true,
writable: true,
enumerable: true,
value: newValue
});
return newValue;
};
}
function autobind(target, key, { value: fn, configurable, enumerable }) {
if (typeof fn !== 'function') {
throw new SyntaxError(`@autobind can only be used on functions, not: ${fn}`);
}
const { constructor } = target;
return {
configurable,
enumerable,
get() {
/**
* 使用这种方式相当于替换了这个函数，所以当比如
* Class.prototype.hasOwnProperty(key) 的时候，为了正确返回
* 所以这里做了 this 的判断
*/
if (this === target) {
return fn;
}
const boundFn = bind(fn, this);
defineProperty(this, key, {
configurable: true,
writable: true,
enumerable: false,
value: boundFn
});
return boundFn;
},
set: createDefaultSetter(key)
};
}
3 .debounce
有的時候，我們需要對執行的方法進行防手震處理:
class Toggle extends React.Component {
@debounce(500, true)
handleClick() {
console.log('toggle')
}
render() {
return (
<button onClick={this.handleClick}>
button
</button>
);
}
}
我們來實作一下：
function _debounce(func, wait, immediate) {
var timeout;
return function () {
var context = this;
var args = arguments;
if (timeout) clearTimeout(timeout);
if (immediate) {
var callNow = !timeout;
timeout = setTimeout(function(){
timeout = null;
}, wait)
if (callNow) func.apply(context, args)
}
else {
timeout = setTimeout(function(){
func.apply(context, args)
}, wait);
}
}
}
function debounce(wait, immediate) {
return function handleDescriptor(target, key, descriptor) {
const callback = descriptor.value;
if (typeof callback !== 'function') {
throw new SyntaxError('Only functions can be debounced');
}
var fn = _debounce(callback, wait, immediate)
return {
...descriptor,
value() {
fn()
}
};
}
}
4.time
#用於統計方法執行的時間:
function time(prefix) {
let count = 0;
return function handleDescriptor(target, key, descriptor) {
const fn = descriptor.value;
if (prefix == null) {
prefix = `${target.constructor.name}.${key}`;
}
if (typeof fn !== 'function') {
throw new SyntaxError(`@time can only be used on functions, not: ${fn}`);
}
return {
...descriptor,
value() {
const label = `${prefix}-${count}`;
count++;
console.time(label);
try {
return fn.apply(this, arguments);
} finally {
console.timeEnd(label);
}
}
}
}
}
5.mixin
用於將物件的方法混入Class 中：
const SingerMixin = {
sing(sound) {
alert(sound);
}
};
const FlyMixin = {
// All types of property descriptors are supported
get speed() {},
fly() {},
land() {}
};
@mixin(SingerMixin, FlyMixin)
class Bird {
singMatingCall() {
this.sing('tweet tweet');
}
}
var bird = new Bird();
bird.singMatingCall();
// alerts "tweet tweet"
mixin 的一個簡單實作如下：
function mixin(...mixins) {
return target => {
if (!mixins.length) {
throw new SyntaxError(`@mixin() class ${target.name} requires at least one mixin as an argument`);
}
for (let i = 0, l = mixins.length; i < l; i++) {
const descs = Object.getOwnPropertyDescriptors(mixins[i]);
const keys = Object.getOwnPropertyNames(descs);
for (let j = 0, k = keys.length; j < k; j++) {
const key = keys[j];
if (!target.prototype.hasOwnProperty(key)) {
Object.defineProperty(target.prototype, key, descs[key]);
}
}
}
};
}
6.redux
實際開發中，React 與Redux 函式庫結合使用時，常常需要寫成下面這樣。
class MyReactComponent extends React.Component {}
export default connect(mapStateToProps, mapDispatchToProps)(MyReactComponent);
有了裝飾器，就可以改寫上面的程式碼。
@connect(mapStateToProps, mapDispatchToProps)
export default class MyReactComponent extends React.Component {};
相對來說，後一種寫法看起來比較容易理解。
7.注意
以上我們都是用來修飾類別方法，我們取得值的方式為：
const method = descriptor.value;
但是如果我們修飾的是類別的實例屬性，因為Babel 的緣故，透過value 屬性並不能取得值，我們可以寫成：
const value = descriptor.initializer && descriptor.initializer();
以上是淺談ES6中的裝飾器的詳細內容。更多資訊請關注PHP中文網其他相關文章！
陳述：
本文轉載於：segmentfault.com。如有侵權，請聯絡admin@php.cn刪除