黑马程序员技术交流社区

标题: 【上海校区】JS 装饰器，一篇就够 [打印本页]
作者: 不二晨    时间: 2018-8-3 10:44
标题: 【上海校区】JS 装饰器，一篇就够
什么是装饰器Python 的装饰器在面向对象（OOP）的设计模式中，decorator被称为装饰模式。OOP的装饰模式需要通过继承和组合来实现，而Python除了能支持 OOP 的 decorator 外，直接从语法层次支持 decorator。
如果你熟悉 python 的话，对它一定不会陌生。那么我们先来看一下 python 里的装饰器是什么样子的吧：
def decorator(f):    print "my decorator"    return f@decoratordef myfunc():    print "my function"myfunc()# my decorator# my function复制代码这里的 @decorator 就是我们说的装饰器。在上面的代码中，我们利用装饰器给我们的目标方法执行前打印出了一行文本，并且并没有对原方法做任何的修改。代码基本等同于：
def decorator(f):    def wrapper():        print "my decorator"        return f()    return wrapperdef myfunc():    print "my function"myfunc = decorator(myfuc)复制代码通过代码我们也不难看出，装饰器 decorator 接收一个参数，也就是我们被装饰的目标方法，处理完扩展的内容以后再返回一个方法，供以后调用，同时也失去了对原方法对象的访问。当我们对某个应用了装饰以后，其实就改变了被装饰方法的入口引用，使其重新指向了装饰器返回的方法的入口点，从而来实现我们对原函数的扩展、修改等操作。
ES7 的装饰器ES7 中的 decorator 同样借鉴了这个语法糖，不过依赖于 ES5 的 Object.defineProperty 方法 。
Object.definePropertyObject.defineProperty()方法会直接在一个对象上定义一个新属性，或者修改一个对象的现有属性， 并返回这个对象。
该方法允许精确添加或修改对象的属性。通过赋值来添加的普通属性会创建在属性枚举期间显示的属性（for...in 或 Object.keys 方法）， 这些值可以被改变，也可以被删除。这种方法允许这些额外的细节从默认值改变。默认情况下，使用 Object.defineProperty() 添加的属性值是不可变的。
语法Object.defineProperty(obj, prop, descriptor)复制代码在ES6中，由于 Symbol类型 的特殊性，用 Symbol类型 的值来做对象的key与常规的定义或修改不同，而Object.defineProperty 是定义 key为 Symbol 的属性的方法之一。
属性描述符对象里目前存在的属性描述符有两种主要形式：数据描述符和存取描述符。
描述符必须是这两种形式之一；不能同时是两者。
数据描述符和存取描述符均具有以下可选键值：
configurable当且仅当该属性的 configurable 为 true 时，该属性描述符才能够被改变，同时该属性也能从对应的对象上被删除。默认为 false。
enumerableenumerable定义了对象的属性是否可以在 for...in 循环和 Object.keys() 中被枚举。
当且仅当该属性的 enumerable 为 true 时，该属性才能够出现在对象的枚举属性中。默认为 false。数据描述符同时具有以下可选键值：
value该属性对应的值。可以是任何有效的 JavaScript 值（数值，对象，函数等）。默认为 undefined。
writable当且仅当该属性的 writable 为 true 时，value 才能被赋值运算符改变。默认为 false。
存取描述符同时具有以下可选键值：
get一个给属性提供 getter 的方法，如果没有 getter 则为 undefined。该方法返回值被用作属性值。默认为 undefined。
set一个给属性提供 setter 的方法，如果没有 setter 则为 undefined。该方法将接受唯一参数，并将该参数的新值分配给该属性。默认为 undefined。
如果一个描述符不具有value,writable,get 和 set 任意一个关键字，那么它将被认为是一个数据描述符。如果一个描述符同时有(value或writable)和(get或set)关键字，将会产生一个异常。
用法类的装饰@testableclass MyTestableClass {  // ...}function testable(target) {  target.isTestable = true;}MyTestableClass.isTestable // true复制代码上面代码中，@testable 就是一个装饰器。它修改了 MyTestableClass这 个类的行为，为它加上了静态属性isTestable。testable 函数的参数 target 是 MyTestableClass 类本身。
基本上，装饰器的行为就是下面这样。
@decoratorclass A {}// 等同于class A {}A = decorator(A) || A;复制代码也就是说，装饰器是一个对类进行处理的函数。装饰器函数的第一个参数，就是所要装饰的目标类。
如果觉得一个参数不够用，可以在装饰器外面再封装一层函数。
function testable(isTestable) {  return function(target) {    target.isTestable = isTestable;  }}@testable(true)class MyTestableClass {}MyTestableClass.isTestable // true@testable(false)class MyClass {}MyClass.isTestable // false复制代码上面代码中，装饰器 testable 可以接受参数，这就等于可以修改装饰器的行为。
注意，装饰器对类的行为的改变，是代码编译时发生的，而不是在运行时。这意味着，装饰器能在编译阶段运行代码。也就是说，装饰器本质就是编译时执行的函数。
前面的例子是为类添加一个静态属性，如果想添加实例属性，可以通过目标类的 prototype 对象操作。
下面是另外一个例子。
// mixins.jsexport function mixins(...list) {  return function (target) {    Object.assign(target.prototype, ...list)  }}// main.jsimport { mixins } from './mixins'const Foo = {  foo() { console.log('foo') }};@mixins(Foo)class MyClass {}let obj = new MyClass();obj.foo() // 'foo'复制代码上面代码通过装饰器 mixins，把Foo对象的方法添加到了 MyClass 的实例上面。
方法的装饰装饰器不仅可以装饰类，还可以装饰类的属性。
class Person {  @readonly  name() { return `${this.first} ${this.last}` }}复制代码上面代码中，装饰器 readonly 用来装饰“类”的name方法。
装饰器函数 readonly 一共可以接受三个参数。
function readonly(target, name, descriptor){  // descriptor对象原来的值如下  // {  //   value: specifiedFunction,  //   enumerable: false,  //   configurable: true,  //   writable: true  // };  descriptor.writable = false;  return descriptor;}readonly(Person.prototype, 'name', descriptor);// 类似于Object.defineProperty(Person.prototype, 'name', descriptor);复制代码另外，上面代码说明，装饰器（readonly）会修改属性的 描述对象（descriptor），然后被修改的描述对象再用来定义属性。
函数方法的装饰装饰器只能用于类和类的方法，不能用于函数，因为存在函数提升。
另一方面，如果一定要装饰函数，可以采用高阶函数的形式直接执行。
function doSomething(name) {  console.log('Hello, ' + name);}function loggingDecorator(wrapped) {  return function() {    console.log('Starting');    const result = wrapped.apply(this, arguments);    console.log('Finished');    return result;  }}const wrapped = loggingDecorator(doSomething);复制代码core-decorators.jscore-decorators.js是一个第三方模块，提供了几个常见的装饰器，通过它可以更好地理解装饰器。
@autobindautobind 装饰器使得方法中的this对象，绑定原始对象。
@readonlyreadonly 装饰器使得属性或方法不可写。
@overrideoverride 装饰器检查子类的方法，是否正确覆盖了父类的同名方法，如果不正确会报错。
import { override } from 'core-decorators';class Parent {  speak(first, second) {}}class Child extends Parent {  @override  speak() {}  // SyntaxError: Child#speak() does not properly override Parent#speak(first, second)}// orclass Child extends Parent {  @override  speaks() {}  // SyntaxError: No descriptor matching Child#speaks() was found on the prototype chain.  //  //   Did you mean "speak"?}复制代码@deprecate (别名@deprecated)deprecate 或 deprecated 装饰器在控制台显示一条警告，表示该方法将废除。
import { deprecate } from 'core-decorators';class Person {  @deprecate  facepalm() {}  @deprecate('We stopped facepalming')  facepalmHard() {}  @deprecate('We stopped facepalming', { url: 'http://knowyourmeme.com/memes/facepalm' })  facepalmHarder() {}}let person = new Person();person.facepalm();// DEPRECATION Person#facepalm: This function will be removed in future versions.person.facepalmHard();// DEPRECATION Person#facepalmHard: We stopped facepalmingperson.facepalmHarder();// DEPRECATION Person#facepalmHarder: We stopped facepalming////     See http://knowyourmeme.com/memes/facepalm for more details.//复制代码@suppressWarningssuppressWarnings 装饰器抑制 deprecated 装饰器导致的 console.warn() 调用。但是，异步代码发出的调用除外。
使用场景装饰器有注释的作用@testableclass Person {  @readonly  @nonenumerable  name() { return `${this.first} ${this.last}` }}复制代码从上面代码中，我们一眼就能看出，Person类是可测试的，而name方法是只读和不可枚举的。
React 的 connect实际开发中，React 与 Redux 库结合使用时，常常需要写成下面这样。
class MyReactComponent extends React.Component {}export default connect(mapStateToProps, mapDispatchToProps)(MyReactComponent);复制代码有了装饰器，就可以改写上面的代码。装饰
@connect(mapStateToProps, mapDispatchToProps)export default class MyReactComponent extends React.Component {}复制代码相对来说，后一种写法看上去更容易理解。
新功能提醒或权限菜单点击时，进行事件拦截，若该菜单有新功能更新，则弹窗显示。
/** * @description 在点击时，如果有新功能提醒，则弹窗显示 * @param code 新功能的code * @returns {function(*, *, *)} */ const checkRecommandFunc = (code) => (target, property, descriptor) => {    let desF = descriptor.value;     descriptor.value = function (...args) {      let recommandFuncModalData = SYSTEM.recommandFuncCodeMap[code];      if (recommandFuncModalData && recommandFuncModalData.id) {        setTimeout(() => {          this.props.dispatch({type: 'global/setRecommandFuncModalData', recommandFuncModalData});        }, 1000);      }      desF.apply(this, args);    };    return descriptor;  };复制代码loading在 React 项目中，我们可能需要在向后台请求数据时，页面出现 loading 动画。这个时候，你就可以使用装饰器，优雅地实现功能。
@autobind@loadingWrap(true)async handleSelect(params) {  await this.props.dispatch({    type: 'product_list/setQuerypParams',    querypParams: params  });}复制代码loadingWrap 函数如下：
export function loadingWrap(needHide) {  const defaultLoading = (    <div className="toast-loading">      <Loading className="loading-icon"/>      <div>加载中...</div>    </div>  );  return function (target, property, descriptor) {    const raw = descriptor.value;        descriptor.value = function (...args) {      Toast.info(text || defaultLoading, 0, null, true);      const res = raw.apply(this, args);            if (needHide) {        if (get('finally')(res)) {          res.finally(() => {            Toast.hide();          });        } else {          Toast.hide();        }      }    };    return descriptor;  };}复制代码问题：这里大家可以想想看，如果我们不希望每次请求数据时都出现 loading，而是要求只要后台请求时间大于 300ms 时，才显示loading，这里需要怎么改？


作者：PinesCheng
链接：https://juejin.im/post/5b6156e4e51d45355d51f819



作者: 不二晨    时间: 2018-8-16 17:24
奈斯



欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2