Decorator

标签(空格分隔): 前端 es6


概念

修饰器(Decorator)是一个函数,用来修改类的行为。这是ES7的一个提案,目前Babel转码器已经支持。

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

// babel转换依赖插件
{
  "plugins": ["transform-decorators-legacy"]
}

基本使用

第一种使用

const test1 = (target) => {
    target.key1 = 1 // 扩展静态属性
    target.prototype.key1 = 2 // 扩展动态属性
}

test1
class test1Class {}

let test1Obj = new test1Class()

// 结果
test1Class.key1
test1Obj.key1

第二种使用

const test2 = (name) => {
  return (target) => {
    target.uname = '李云龙' // name是class的关键词,不能使用。
    target.prototype.name = name
  }
}

@test2('testname')
class test2Class {}

let test2Obj = new test2Class()

// 结果
test2Class.name
test2Class.uname
test2Obj.name

原理

@decorator
class A {}

// 等同于

class A {}
A = decorator(A) || A;

对方法的修饰

额外方法

const readonly = (target, name, descriptor) => {
  // descriptor对象原来的值如下
  // {
  //   value: specifiedFunction, // 置换调用
  //   enumerable: false,  // 是否可以枚举(for in 循环能否遍历的到)
  //   configurable: true, // 是否可以配置(是否可以用delete删除)
  //   writable: true  // 是否可以修改(为false的时候,只是修改没起作用,不会报错)
  // };
  descriptor.writable = false
  return descriptor
}

const configurable = (target, name, descriptor) => {
  descriptor.configurable = false
  return descriptor
}

const enumerable = (target, name, descriptor) => {
  descriptor.enumerable = false
  return descriptor
}

class test3Class {
  @configurable
  @readonly
  testKey = {
    @enumerable
    @configurable
    testKey: 1
  }
}

let test3Obj = new test3Class()

// test3Obj.testKey = {key: 2}
test3Obj.testKey

// test3Obj.testKey.testKey = 2

for (let key in test3Obj.testKey) {console.log(key)}
delete test3Obj.testKey
test3Obj.testKey.testKey

对value的操作

class Math {
  @log
  add(a, b) {
    return a + b;
  }
}

function log(target, name, descriptor) {
  var oldValue = descriptor.value;
  console.log(oldValue, target)
  descriptor.value = function() {
    // 这里把console.log改成另外一个监听的add函数,就是一个简单的观察者模式了
    console.log(`Calling "${name}" with`, arguments);
    return oldValue.apply(null, arguments);
  };

  return descriptor;
}

const math = new Math();

// passed parameters should get logged now
math.add(2, 4);

为什么decorator不能用于函数

修饰器只能用于类和类的方法,不能用于函数,因为存在函数提升。

var counter = 0;

var add = function () {
  counter++;
};
@add
function foo() {
}

等价于

var counter;
var add;

@add
function foo() {
}

counter = 0;

add = function () {
  counter++;
};

高级用法(拓展用法)

mixin

const mixins = (...list) {
  return function (target) {
    Object.assign(target.prototype, ...list);
  };
}

const Foo = {
  foo() { console.log('foo') }
};

@mixins(Foo)
class MyClass {}

let obj = new MyClass();
obj.foo() // "foo"

通过mixins这个修饰器,实现了在MyClass类上面“混入”Foo对象的foo方法。

不过,上面的方法会改写MyClass类的prototype对象,如果不喜欢这一点,也可以通过类的继承实现mixin。

class MyBaseClass {
  foo() { console.log('foo') }
}

class MyClass extends MyBaseClass {
  /* ... */
}

另一种写法

let MyMixin = (superclass) => class extends superclass {
  foo() {
    console.log('foo from MyMixin');
  }
};

class MyBaseClass {
  foo() { console.log('foo') }
}

class MyClass extends MyMixin(MyBaseClass) {
  /* ... */
}

实战

以下截取自bimbox

    @Emit() // save-user-profile
    saveUserProfile () {
      if (this.avatarData) {
        this.saveAvatar(this.usernameId, this.avatarData);
      }
      this.saveTitleCertificate();
    }

以下截取自vue-property-decorator

/** vue-property-decorator verson 6.1.0 MIT LICENSE copyright 2018 kaorun343 */
'use strict';
import Vue from 'vue';
import Component, { createDecorator } from 'vue-class-component';
import 'reflect-metadata';
export { Component, Vue };

// Code copied from Vue/src/shared/util.js
var hyphenateRE = /\B([A-Z])/g;
var hyphenate = function (str) { return str.replace(hyphenateRE, '-$1').toLowerCase(); };
/**
 * decorator of an event-emitter function
 * @param  event The name of the event
 * @return MethodDecorator
 */
export function Emit(event) {
    return function (target, key, descriptor) {
        key = hyphenate(key);
        var original = descriptor.value;
        descriptor.value = function emitter() {
            var args = [];
            for (var _i = 0; _i < arguments.length; _i++) {
                args[_i] = arguments[_i];
            }
            if (original.apply(this, args) !== false)
                this.$emit.apply(this, [event || key].concat(args));
        };
    };
}

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,874评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,102评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,676评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,911评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,937评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,935评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,860评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,660评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,113评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,363评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,506评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,238评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,861评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,486评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,674评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,513评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,426评论 2 352

推荐阅读更多精彩内容