【TypeScript】装饰器

在看VSCODE源码的时候,看到这样一部分代码:

class ... {
    constructor(
        ...
        @IStorageService private storageService: IStorageService
        ...
    ) {}
}

疑惑之际,查看一下官方文档:https://www.tslang.cn/docs/handbook/decorators.html#metadata
如文档所说,这个是TypeScript新加的一个特性:装饰器。装饰器是一个函数,在运行时会被调用。学过C++的朋友都知道,有很多的代码是跑在在main函数被调用之前的。那么这个装饰器是不是类似的特性呢?

我们先来写个demo.ts,看看其中一个参数装饰器的行为。

console.log('Begin');

function nameDec(target: Object, propertyKey: string | symbol, parameterIndex: number) {
    console.log(target);
    console.log(propertyKey);
    console.log(parameterIndex)
}

class Demo {
    constructor(@nameDec private name: string) {
        console.log(name);
    }
}

new Demo('Demo');
编译:
tsc --build tsconfig.json
运行:
node demo.js
结果:
Begin
[Function: Demo]
undefined
0
Demo

可以看到,装饰器的函数是跑在构造函数前面的。再编译出的demo.js看看装饰器做了什么事情:

var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
    return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __param = (this && this.__param) || function (paramIndex, decorator) {
    return function (target, key) { decorator(target, key, paramIndex); }
};
console.log('Begin');
function nameDec(target, propertyKey, parameterIndex) {
    console.log(target);
    console.log(propertyKey);
    console.log(parameterIndex);
}
var Demo = /** @class */ (function () {
    function Demo(name) {
        this.name = name;
        console.log(name);
    }
    Demo = __decorate([
        __param(0, nameDec)
    ], Demo);
    return Demo;
}());
new Demo('Demo');

那么,装饰器有什么运用场景呢?我们来看一个vscode的一段代码:

///////////////////////////////////////////////////////
// file.1
// 创建参数装饰器IStorageService
export const ID = 'storageService';
// createDecorator返回一个函数
export const IStorageService = createDecorator<IStorageService>(ID);
export interface IStorageService {
    _serviceBrand: any;
}

///////////////////////////////////////////////////////
// file.2
// createDecorator实现
function storeServiceDependency(id: Function, target: Function, index: number, optional: boolean): void {
    // 这里给constructor原型增加了一个_util.DI_DEPENDENCIES成员,同时将保存参数id和index
    if (target[_util.DI_TARGET] === target) {
        target[_util.DI_DEPENDENCIES].push({ id, index, optional });
    } else {
        target[_util.DI_DEPENDENCIES] = [{ id, index, optional }];
        target[_util.DI_TARGET] = target;
    }
}

export function createDecorator<T>(serviceId: string): { (...args: any[]): void; type: T; } {

    if (_util.serviceIds.has(serviceId)) {
        return _util.serviceIds.get(serviceId);
    }
    // createDecorator返回这个函数,函数调用storeServiceDependency
    const id = <any>function (target: Function, key: string, index: number): any {
        if (arguments.length !== 3) {
            throw new Error('@IServiceName-decorator can only be used to decorate a parameter');
        }
        storeServiceDependency(id, target, index, false);
    };

    id.toString = () => serviceId;

    _util.serviceIds.set(serviceId, id);
    return id;
}

///////////////////////////////////////////////////////
// file.3
// 在构造函数中使用参数装饰器IStorageService
export class SuggestMemories {
...
constructor(
    mode: MemMode,
    // 装饰_storageService
    @IStorageService private readonly _storageService: IStorageService
) {
    this._persistSoon = new RunOnceScheduler(() => this._flush(), 3000);
    this.setMode(mode);
}
...
}

///////////////////////////////////////////////////////
// file.4
// 使用createInstance创建SuggestMemories实例,只需传第一个参数
this._memory = _instantiationService.createInstance(SuggestMemories, this._editor.getConfiguration().contribInfo.suggestSelection);

///////////////////////////////////////////////////////
// file.5
// createInstance实现
private _createInstance<T>(desc: SyncDescriptor<T>, args: any[]): T {

// 收集没有被装饰的参数
let staticArgs = desc.staticArguments.concat(args);

// 通过id查找被装饰的参数
let serviceDependencies = _util.getServiceDependencies(desc.ctor).sort((a, b) => a.index - b.index);
let serviceArgs: any[] = [];
for (const dependency of serviceDependencies) {
    let service = this._getOrCreateServiceInstance(dependency.id);
    if (!service && this._strict && !dependency.optional) {
        throw new Error(`[createInstance] ${desc.ctor.name} depends on UNKNOWN service ${dependency.id}.`);
    }
    serviceArgs.push(service);
}
...
// ctor构造函数
const argArray = [desc.ctor];
// 两者加起来刚好是ctor的全部需要的参数
argArray.push(...staticArgs);
argArray.push(...serviceArgs);
// 调用构造函数创建对象
// 这里调用了Function.apply
return <T>create.apply(null, argArray);
}

通俗点来说,就是利用TypeScript的弱类型特性和装饰器特性,实现了一个加强版默认参数。

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

推荐阅读更多精彩内容

  • 由于本期采用的小程序框架是taro 偶然看到以下写法 看了typescript才发现是装饰器 官方文档如下 ht...
    芗芗_阅读 1,985评论 0 0
  • 前言 本文主要讲解如何使用TypeScript装饰器定义Express路由。文中出现的代码经过简化不能直接运行,完...
    一箭中的阅读 1,177评论 0 4
  • 详情可查看官方网址;https://www.tslang.cn/docs/handbook/decorators....
    sunxiaochuan阅读 683评论 0 1
  • 装饰器主要用于将一些常用操作进行抽象出一层对类,方法,属性,参数进行修饰的函数。常用例子:设置属性时,打日志等。 ...
    方大米阅读 713评论 0 1
  • 装饰器是一种特殊类型的声明,它可以用在类声明、方法、属性或者参数上。顾名思义,它是用来给附着的主体进行装饰,添加额...
    河的左岸阅读 5,851评论 0 4