写一个Angular装饰器(Decorators)- 学于ng-zorro源码

写一个Angular装饰器(Decorators)- 学于ng-zorro源码

本文将围绕:

1. what is it?
2. why use it?
3. how to use it?

业务需求场景提供(参考):

  1. 格式化 @Input

  2. 动态校验 @Input 传入的值类型

  3. ...

代码完整示例:

本文示例代码

1. What is it?

先看看TypeScript官方对Decorators 解释:

装饰器是一种特殊类型的声明,它能够被附加到类声明,方法, 访问符,属性或参数上。 装饰器使用 @expression这种形式,expression求值后必须为一个函数,它会在运行时被调用,被装饰的声明信息做为参数传入。

例如Angular中的 @Input

  @Input 
  value: string;

这样看是不是清晰了点,实际上装饰器的作用是对设计模式中的装饰者模式的实现。

装饰者模式:

指在不必 改变原类文件 或者 使用继承 的情况下,动态扩展对象的功能

装饰器分为:

类装饰器: (target) => {}

方法装饰器:(target, methodName: string, descriptor: PropertyDescriptor) => {}

参数装饰器:(target, methodName: string, paramIndex: number) => {}

属性装饰器:(target, propertyName: string) => {}

2. Why use it?

正如前面提供的两个业务场景,我们取第一个使用装饰器解决下该问题。

思路: 我们需要控制一个组件loading的状态,那么设isLoading为true或者false,来控制开关。

OK,我们开始写代码:

Child Comonent:

// html
  <div *ngIf="isLoading">isLoading 为 true</div>
  <div *ngIf="!isLoading">isLoading 为 false</div>

//ts
  @Input() isLoading = false;

Parent Component

  <app-child [isLoading]="'false'"></app-child>

Result

格式化前

我传了'false'但是为什么显示的是true,细心的人可以发现是因为传了一个不规范的字段,正如我写的'false',传的是一个string,进行转译!!'false',我们可以看到它是一个true。

除了误传'false',还会有开发者传入一个value,有值或无值做一个开关控制。

作为组件的提供者,希望避免这样的传值,我们可以对传入的值进行格式化,可如下操作:

 @Input()
  get isLoading() {
    return this._isLoading;
  }
  set isLoading(v) {
    this._isLoading = coerceBooleanProperty(v);
  }
  _isLoading = false;

coerceBooleanProperty:是@angular/cdk/coercion中的一个方法,主要用途将传入的值进行强制转化为boolean.

我们再看一下页面显示:

利用setter 格式化后

可以发现这个成功解决我们的问题,但是如果每个地方都要写一个setter 和getter ,并且创建一个新的变量_isLoading,那也太麻烦了,这时候装饰器就派上用场了。

3. How to use it?

首先我们先看一下简单的装饰器:

//类装饰器
function Man(target: Function):void{
    target.prototype.__isMan = true;
}

//使用类装饰器
@Man
class Person{
    constructor(){}
}

//测试装饰后的结果
let person = new Person();
console.log(person.__isMan);//true

这是一个类装饰器,还有其他几种,前面可以看到,具体写法就举例。但是如果我们在写一个项目,还会遇到方法,参数,属性修饰器,所以我们需要统一一下方法。

在这之前我们先看看ts官方给的一个提示:

如果我们要定制一个修饰器如何应用到一个声明上,我们得写一个装饰器工厂函数。 装饰器工厂就是一个简单的函数,它返回一个表达式,以供装饰器在运行时调用。

代码来源于ng-zorro源码:

因此我们需要写一个通用的工厂函数。

工厂函数拆解:

一个通用装饰器工厂函数的外壳如下(详细在文章后面):



// 因为我们需要一个通用的装饰器工厂函数,所以我们传入两个参数name和fallback
// name: 装饰器名字(如:InputBoolean)
// fallback:调用需要执行的函数(如:toBoolean)

// 其次因为装饰器分为5种,但是我们主要针对属性和方法装饰器,因此
// originalDescriptor可为空(属性装饰器不包括该值,可看前面装饰器的介绍)

function propDecoratorFactory(name:string,fallback:function){
 
  return propDecorator(
    target: any, 
    propName: string, 
    originalDescriptor?: TypedPropertyDescriptor<any>
  ){
      ... 
  }
}

通用装饰器工厂函数完整版(个人的理解在代码注释中):

function propDecoratorFactory<T, D>(name: string, fallback: (v: T) => D): (target: any, propName: string) => void {
  function propDecorator(target: any, propName: string, originalDescriptor?: TypedPropertyDescriptor<any>): any {

    // 创建私有名字
    const privatePropName = `$$__${propName}`;

    // 首先判断是否设置过该值,防止重复操作
    if (Object.prototype.hasOwnProperty.call(target, privatePropName)) {
      console.warn(`The prop "${privatePropName}" is already exist, it will be overrided by ${name} decorator.`);
    }

    // 利用Object.defineProperty创建监听
    Object.defineProperty(target, privatePropName, {
      configurable: true,
      writable: true
    });

    // 触发情况:访问时会触发getter,设值时会触发setter
    // 具体不解释,可以看es6对Object.defineProperty的解释
    // 题外话,可以一同可看proxy,proxy对Object.defineProperty进行了优化。
    return {
      get(): string {
        // get 雷同于Setter解释
        return originalDescriptor && originalDescriptor.get
          ? originalDescriptor.get.bind(this)()
          : this[privatePropName];
      },
      set(value: T): void {
        // 首先判断修饰器下是否存在Setter,setter存在于originalDescriptor中,我们将先进行规定的format
        // 然后将format值传入其中,调用set 方法继续按照开发者的要求执行
        // 所以如下一个使用的执行顺序是:
        // @Input @InputBoolean set value(v){ this._v = v }
        //  1.调用Object.defineProperty对target上的$$__value进行监听,创建setter + getter
        //  2.setter(内) 触发 ,对传入的值进行格式化(即:调用传入的fallback(v)),拿到格式化的值后format_v
        //  3.调用originalDescriptor 中的setter(外:即开发者创建)方法,传入格式化的值format_v进行做后续处理
        // 因此此处只会对传入的值进行格式化,不会做任何操作。
        if (originalDescriptor && originalDescriptor.set) {
          originalDescriptor.set.bind(this)(fallback(value));
        }
        this[privatePropName] = fallback(value);
      }
    };
  }

  return propDecorator;
}

OK,定义完工厂函数之后,我们需要定义装饰器入口(InputBoolean),和格式化的函数(toBoolean)

// 装饰器入口
export function InputBoolean(): any {
  return propDecoratorFactory('InputBoolean', toBoolean);
}

// 格式化boolean函数
export function toBoolean(value: boolean | string): boolean {
  return coerceBooleanProperty(value);
}

然后使用:

  @Input() @InputBoolean() isLoading = false;

可以看到最终结果:

利用装饰器 格式化后

以上是我学习后的记录,如若有问题,欢迎吐槽~~就稍微稍微轻一点点~

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

推荐阅读更多精彩内容