ES2017中的修饰器Decorator

前面的话

  修饰器(Decorator)是一个函数,用来修改类的行为。本文将详细介绍ES2017中的修饰器Decorator

概述

  ES2017 引入了这项功能,目前 Babel 转码器已经支持Decorator

  首先,安装babel-corebabel-plugin-transform-decorators。由于后者包括在babel-preset-stage-0之中,所以改为安装babel-preset-stage-0亦可

$ npm install babel-core babel-plugin-transform-decorators

  然后,设置配置文件.babelrc

{
  "plugins": ["transform-decorators"]
}

  这时,Babel就可以对Decorator转码了

  脚本中打开的命令如下

babel.transform("code", {plugins: ["transform-decorators"]})

类修饰

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

@testable
class MyTestableClass {
  // ...
}

function testable(target) {
  target.isTestable = true;
}

MyTestableClass.isTestable // true

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

@decorator
class A {}

// 等同于

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

  修饰器对类的行为的改变,是代码编译时发生的,而不是在运行时。这意味着,修饰器能在编译阶段运行代码,也就是说,修饰器本质就是编译时执行的函数

【参数】

  修饰器函数的第一个参数,是所要修饰的目标类

function testable(target) {
  // ...
}

  如果觉得一个参数不够用,可以在修饰器外面再封装一层函数

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对象操作

function testable(target) {
  target.prototype.isTestable = true;
}

@testable
class MyTestableClass {}

let obj = new MyTestableClass();
obj.isTestable // true

【mixins】

  下面是另外一个例子

// mixins.js
export function mixins(...list) {
  return function (target) {
    Object.assign(target.prototype, ...list)
  }
}

// main.js
import { mixins } from ‘./mixins‘

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

@mixins(Foo)
class MyClass {}

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

  上面代码通过修饰器mixins,把Foo类的方法添加到了MyClass的实例上面。可以用Object.assign()模拟这个功能

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

class MyClass {}

Object.assign(MyClass.prototype, Foo);

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

方法修饰

  修饰器不仅可以修饰类,还可以修饰类的属性

class Person {
  @readonly
  name() { return `${this.first} ${this.last}` }
}

  上面代码中,修饰器readonly用来修饰“类”的name方法

【参数】

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

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),然后被修改的描述对象再用来定义属性。

  下面是另一个例子,修改属性描述对象的enumerable属性,使得该属性不可遍历

class Person {
  @nonenumerable
  get kidCount() { return this.children.length; }
}

function nonenumerable(target, name, descriptor) {
  descriptor.enumerable = false;
  return descriptor;
}

【日志应用】

  下面的@log修饰器,可以起到输出日志的作用

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

function log(target, name, descriptor) {
  var oldValue = descriptor.value;

  descriptor.value = function() {
    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);

  上面代码中,@log修饰器的作用就是在执行原始的操作之前,执行一次console.log,从而达到输出日志的目的。

  修饰器有注释的作用

@testable
class Person {
  @readonly
  @nonenumerable
  name() { return `${this.first} ${this.last}` }
}

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

【执行顺序】

  如果同一个方法有多个修饰器,会像剥洋葱一样,先从外到内进入,然后由内向外执行

function dec(id){
    console.log(‘evaluated‘, id);
    return (target, property, descriptor) => console.log(‘executed‘, id);
}

class Example {
    @dec(1)
    @dec(2)
    method(){}
}
// evaluated 1
// evaluated 2
// executed 2
// executed 1

  上面代码中,外层修饰器@dec(1)先进入,但是内层修饰器@dec(2)先执行

  除了注释,修饰器还能用来类型检查。所以,对于类来说,这项功能相当有用。从长期来看,它将是JS代码静态分析的重要工具

注意事项

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

var counter = 0;

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

@add
function foo() {
}

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

@add
function foo() {
}

var counter;
var add;

counter = 0;

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

  下面是另一个例子

var readOnly = require("some-decorator");

@readOnly
function foo() {
}

  上面代码也有问题,因为实际执行是下面这样

var readOnly;

@readOnly
function foo() {
}

readOnly = require("some-decorator");

  总之,由于存在函数提升,使得修饰器不能用于函数。类是不会提升的,所以就没有这方面的问题。

  另一方面,如果一定要修饰函数,可以采用高阶函数的形式直接执行

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);
时间: 2024-10-04 22:43:35

ES2017中的修饰器Decorator的相关文章

python函数修饰器(decorator)

python语言本身具有丰富的功能和表达语法,其中修饰器是一个非常有用的功能.在设计模式中,decorator能够在无需直接使用子类的方式来动态地修正一个函数,类或者类的方法的功能.当你希望在不修改函数本身的前提下扩展函数的功能时非常有用. 简单地说,decorator就像一个wrapper一样,在函数执行之前或者之后修改该函数的行为,而无需修改函数本身的代码,这也是修饰器名称的来由. 关于函数 在Python中,函数是first class citizen,函数本身也是对象,这意味着我们可以对

Python的wraps修饰器详解

本文和大家分享的主要是python 中wraps 修饰器相关内容,一起来看看吧,希望对大家 学习python有所帮助. 在了解  wraps  修饰器之前,我们首先要了解  partial  和  update_wrapper  这两个函数,因为在 wraps  的代码中,用到了这两个函数. partial 首先说  partial  函数,在  官方文档  的描述中,这个函数的声明如下:  functools.partial(func, *args, **keywords)  .它的作用就是返

[python]在场景中理解装饰器

原来我也自己通过查资料,来学习python的装饰器,但是效果不好.因为没有接触过需要用到装饰器的场景,所以 一起的资料都只停留在纸面上,但是今天偶然看到了vimer的这篇文章:http://www.vimer.cn/2011/04/python%E8%A3%85%E9%A5%B0%E5%99%A8%E7%9A%84%E4%B8%80%E4%B8%AA%E5%A6%99%E7%94%A8.html 我们就根据这篇文章的思路来,在场景中理解python装饰器 其中的一个场景是:爬取数据的时候,目标网

对Python中装饰器(Decorator)的理解与进阶

有时候我们项目中的某些功能做些修改即需要对内部的某些函数添加一些附加功能,但是为了安全起见不想改变函数的源代码以及函数的调用方式,那么装饰器在这个地方会给我们带来很大的帮助. 装饰器(Decorator):(又叫语法糖) 定义:本质是函数,功能(装饰其它函数)就是为其他函数添加附加功能 原则:(1).不能修改被装饰的函数的源代码 (2).不能修改被装饰的函数的调用方式 1.先来实现一个简单的装饰器示例: #!/usr/bin/env python # -*- coding:utf-8 -*- #

@修饰符--python中的装饰器

http://blog.csdn.net/shangzhihaohao/article/details/6928808 装饰器模式可以在不影响其他对象的情况下,以动态.透明的方式给单个对象添加职责,也能够处理那些可以撤销的职责.经常用于日志记录.性能测试等场合. 想象一下这个很常见的场景,你写了一个方法只提供给以登陆的用户访问(事实上我也是通过django的@login_required才了解到@修饰符的),你可以写以下代码: 这当然没什么问题,但是你又写了一个方法B,也要求只有登录用户可以访问

Decorator [?dek?re?t?(r)] 修饰器/装饰器 -- 装饰模式

装饰模式 -- 原先没有,后期添加的属性和方法 修饰器(Decorator)是一个函数,用来修饰类的行为.这是ES7的一个提案,目前Babel转码器已经支持. 需要先安装一个插件: npm install babel-plugin-transform-decorators-legacy --save-dev 然后在项目根目录下,找到:.babelrc => 修改为 "plugins": ["transform-runtime","transform-

PYTHON修饰器的函数式编程

转自:http://coolshell.cn/articles/11265.html Python修饰器的函数式编程 Python的修饰器的英文名叫Decorator,当你看到这个英文名的时候,你可能会把其跟Design Pattern里的Decorator搞混了,其实这是完全不同的两个东西.虽然好像,他们要干的事都很相似--都是想要对一个已有的模块做一些"修饰工作",所谓修饰工作就是想给现有的模块加上一些小装饰(一些小功能,这些小功能可能好多模块都会用到),但又不让这个小装饰(小功能

ES6学习笔记九:修饰器

一:修饰器(Decorator)是一个函数,用来修改类的行为. 1)定义与使用 function 修饰器名(target) { //target是被修饰对象,可用target.xxx进行调用修改 } @修饰器名 class MyClass { // ... } //调用修饰器 MyClass.修饰器; 修饰器对类的行为的改变,是代码编译时发生的,而不是在运行时.这意味着,修饰器能在编译阶段运行代码. 2)带参数的修饰器 function 修饰器名(参数列表) { return function(

Python修饰器

Python的修饰器的英文名叫Decorator,当你看到这个英文名的时候,你可能会把其跟Design Pattern里的Decorator搞混了,其实这是完全不同的两个东西.虽然好像,他们要干的事都很相似——都是想要对一个已有的模块做一些“修饰工作”,所谓修饰工作就是想给现有的模块加上一些小装饰(一些小功能,这些小功能可能好多模块都会用到),但又不让这个小装饰(小功能)侵入到原有的模块中的代码里去.但是OO的Decorator简直就是一场恶梦,不信你就去看看wikipedia上的词条(Deco