[Typescript] Build Method decorators in Typescript

本文介绍如何使用TypeScript装饰器实现细粒度的日志记录功能。通过定义不同级别的日志记录器,可以根据当前系统的日志级别决定是否记录特定操作。示例中展示了如何为`Database`类的方法添加日志记录装饰器。

To using decorate, we can modifiy tsconfig.json:

{
  "compilerOptions": {
    ...
    "experimentalDecorators": true,
    ...  
  }
}

 

So for example we want to build a '@LogMethod' decorator, which arroding to the system logging level to decide whether should log the action.

enum LoggingLevel {
    INFO,
    WARNING,
    DEBUG,
    TRACE
}
const loggingLevel = LoggingLevel.DEBUG;

class Database {
    name = 'ABC';

    @LogMethod(LoggingLevel.DEBUG)
    saveData(data: any) {
        console.log(`save user ${data.name} to the database ${this.name}`);
    }
}

const db = new Database();
db.saveData({name: 'zhentian'});

So for example, current is 'DEBUG' for the system, so when log level set to the 'DEBUG' or 'TRACE', action will be logged, 'INFO', 'WARNING' will be not.

 

Decorator:

which is simplya function return a meta function:

function LogMethod(level: LoggingLevel):Function {
    return (target: any, propertyKey: string,
            descriptor: PropertyDescriptor) => {
    }

}

If we log out each params:

 

'descriptor' is something we are looking for, 'descriptor.value' holding the function which is 'saveData' function, we can put into a variable:

const originalFunction:Function = descriptor.value;

 

Then we can create a new function to wrap this 'originalFunction' in order to provide some additional functionality:

        descriptor.value = function(...args:any[]) {
            if (level <= loggingLevel) {
                console.log(">> " + propertyKey + " " +  JSON.stringify(args));
            }

            originalFunction.apply(this,args);
        };

 

Full code:

enum LoggingLevel {
    INFO,
    WARNING,
    DEBUG,
    TRACE
}
const loggingLevel = LoggingLevel.DEBUG;

function LogMethod(level: LoggingLevel):Function {
    return (target: any, propertyKey: string,
            descriptor: PropertyDescriptor) => {

        const originalFunction:Function = descriptor.value;

        descriptor.value = function(...args:any[]) {
            if (level <= loggingLevel) {
                console.log(">> " + propertyKey + " " +  JSON.stringify(args));
            }

            originalFunction.apply(this,args);
        };


    }

}

class Database {
    name = 'ABC';

    @LogMethod(LoggingLevel.DEBUG)
    saveData(data: any) {
        console.log(`save user ${data.name} to the database ${this.name}`);
    }
}

const db = new Database();
db.saveData({name: 'zhentian'});

 

转载于:https://www.cnblogs.com/Answer1215/p/8403077.html

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值