【愚公系列】2021年12月 Typescript-装饰器

愚公搬代码

发布于 2022-12-01 09:19:20

3900

发布于 2022-12-01 09:19:20

文章被收录于专栏：历史专栏

文章目录

一、装饰器

装饰器:装饰器是一种特殊类型的声明，它能够被附加到类声明，方法，属性或参数上，可以修改类的行为。通俗的讲装饰器就是一个函数方法，可以注入到类、方法、属性参数上来扩展类、属性、方法、参数的功能，可以认为就是在原有代码外层包装了一层处理逻辑。

装饰器在身边的例子随处可见

水龙头上边的起泡器就是一个装饰器，在装上以后就会把空气混入水流中，掺杂很多泡泡在水里。但是起泡器安装与否对水龙头本身并没有什么影响，即使拆掉起泡器，也会照样工作，水龙头的作用在于阀门的控制，至于水中掺不掺杂气泡则不是水龙头需要关心的。

在TypeScript中装饰器还属于实验性语法，你必须在命令行或tsconfig.json里启用experimentalDecorators编译器选项： “experimentalDecorators”: true

装饰器的写法：普通装饰器（无法传参）、装饰器工厂（可传参）

装饰器是过去几年中js最大的成就之一，已是Es7的标准特性之一

1.为什么要用装饰器

可能有些时候，我们会对传入参数的类型判断、对返回值的排序、过滤，对函数添加节流、防抖或其他的功能性代码，基于多个类的继承，各种各样的与函数逻辑本身无关的、重复性的代码。所以，对于装饰器，可以简单地理解为是非侵入式的行为修改。

使用装饰器的一个重要规则

要用装饰器扩展功能而不是覆盖原来的功能

2. 装饰器的作用

让人更加关注业务代码的开发，封装功能辅助性的代码。重点就是让人把焦点放在业务上，实现焦点分离。

3. 如何定义装饰器

装饰器本身其实就是一个函数，理论上忽略参数的话，任何函数都可以当做装饰器使用。

helloword.ts

function helloWord(target: any) {
    // target.username = 'dddd';
    console.log('hello Word!');
}

@helloWord
class HelloWordClass {
    // static username:string;
}
var p1 = new HelloWordClass();

4.装饰器执行时机

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

二、装饰器类型

常见的装饰器有：类装饰器、属性装饰器、方法装饰器、参数装饰器

1.类装饰器

类装饰器在类声明之前被声明（紧靠着类声明）。类装饰器应用于类构造函数，可以用来监视，修改或替换类定义。传入一个参数:类的构造函数

1.1 普通装饰器（无法传参）

function logClass(target:any){
    console.log(target);
    // target 就是当前类
    target.prototype.apiUrl='动态扩展的属性';
    target.prototype.run=function(){
        console.log('我是一个run方法');
    }
}

@logClass
class HttpClient{
    constructor(){
    }
    getData(){

    }
}
var http:any=new HttpClient();
console.log(http.apiUrl);
http.run();

如果需要向装饰器里传参，可以借助JavaScript中函数柯里化特性

1.2 类装饰器:装饰器工厂（可传参）

 function logClass(params:string){
         // target 就是当前类 ,params是装饰器传过来的参数
        return function(target:any){   //  这才是真正装饰器
            console.log(target);
            console.log(params);
            target.prototype.apiUrl=params;
        }
    }
    // @logClass('http://ruanmou.com/api') 是一个立即执行函数， 其实返回的是 logClass里面的闭包函数

    @logClass('http://ruanmou.com/api')
    class HttpClient{
        constructor(){
        }
        getData(){
        }
    }
    var http:any=new HttpClient();
    console.log(http.apiUrl);

2. 属性装饰器

属性装饰器表达式会在运行时当作函数被调用，给属性赋值传入下列2个参数： 1、对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。 2、成员的名字。

 //类装饰器，可以传参
    function logClass(params:string){
        return function(target:any){
            console.log(target);
            console.log(params);       
        }
    }

    //属性装饰器
    function logProperty(params:any){
        
        console.log(params);  //ruanmou.com
        return function(target:any,attr:any){
            console.log(target);  //HttpClient的 原型方法
            console.log(attr);  // 使用装饰器的那个属性,url
            target[attr]=params;
        }
    }
    @logClass('xxxx')
    class HttpClient {
        @logProperty('ruanmou.com')
        public url:any |undefined;
        // @logProperty('laney')
        public name:string | undefined;
        constructor(str:string){
            // this.name = str;
        }
        getData(){
            console.log(this.url);
        }
        say(){
            console.log(this.name);
        }
    }

    var http=new HttpClient('hello');

    http.getData();

3. 方法装饰器

它会被应用到方法的属性描述符上，可以用来监视，修改或者替换方法定义。

方法装饰会在运行时传入下列3个参数： 1、对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。 2、成员的名字。 3、成员的属性描述符。

3.1 方法装饰器一

function get(params:any){
        return function(target:any,methodName:any,desc:any){
            
            console.log(target);
            console.log(methodName);
            console.log(desc);
            target.apiUrl='xxxx';
            target.run=function(){
                console.log('run');
            }
        }
    }

    class HttpClient{  
        public url:any |undefined;
        constructor(){
        }
        @get('http://www.baidu.com')
        getData(){
            console.log(this.url);
        }
    }

    var http:any=new HttpClient();
    console.log(http.apiUrl);
    http.run();

3.2 方法装饰器二

function get(params:any){
    return function(target:any,methodName:any,desc:any){
        console.log(target);
        console.log(methodName);
        console.log(desc.value);       
        
        //修改装饰器的方法  把装饰器方法里面传入的所有参数改为string类型

        //1、保存当前的方法

        var oMethod=desc.value;
        desc.value=function(...args:any[]){                
            args=args.map((value)=>{
                return String(value);
            })
            oMethod.apply(this,args);
        }

    }
}

class HttpClient{  
    public url:any |undefined;
    constructor(){
    }
    @get('http://www.baidu.com')
    getData(...args:any[]){
        console.log(args);
        console.log('我是getData里面的方法');
    }
}

var http=new HttpClient();
http.getData(123,'xxx');

4.参数装饰器

参数装饰器表达式会在运行时当作函数被调用，可以使用参数装饰器为类的原型增加一些元素数据，传入下列3个参数：

1、对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。 2、方法的名字。 3、参数在函数参数列表中的索引。

function logParams(params: any) {
    // 1、对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。
    // 2、方法的名字。
    // 3、参数在函数参数列表中的索引。
    return function (target: any, methodName: any, paramsIndex: any) {
    //   console.log(params);
    //   console.log(target);
    //   console.log(methodName);
    //   console.log(paramsIndex);
      target.apiUrl = params;
    };
  }

  class HttpClient {
    public url: any | undefined;
    constructor() {}
    getData(@logParams("3yteam.com") uuid: any) {
      console.log(uuid);
    }
  }

  var http: any = new HttpClient();
  http.getData(123456);
  console.log(http.apiUrl);

三、访问器装饰器

访问器装饰器应用于访问器的属性描述符，可用于观察，修改或替换访问者的定义。访问器装饰器不能在声明文件中使用，也不能在任何其他环境上下文中使用（例如在声明类中）

注意: TypeScript不允许为单个成员装饰get和set访问器。相反，该成员的所有装饰器必须应用于按文档顺序指定的第一个访问器。这是因为装饰器适用于属性描述符，它结合了get和set访问器，而不是单独的每个声明。

访问器装饰器表达式会在运行时当作函数被调用，传入下列3个参数：

对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。
成员的名字。
成员的属性描述符。

下面是使用了访问器装饰器（@configurable）的例子，应用于Point类的成员上：

function configurable(value: boolean) {
    return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
        descriptor.configurable = value;
    };
}

 class Point {
    private _x: number;
    private _y: number;
    constructor(x: number, y: number) {
        this._x = x;
        this._y = y;
    }

    @configurable(false)
    get x() { return this._x; }

    @configurable(false)
    get y() { return this._y; }
}

四、装饰器执行顺序

属性》方法》方法参数》类

如果有多个同样的装饰器，它会先执行后面的

function logClass1(params:string){
        return function(target:any){
          console.log('类装饰器1')
        }
    }
    
    function logClass2(params:string){
        return function(target:any){
          console.log('类装饰器2')
        }
    }
    
    function logAttribute1(params?:string){
        return function(target:any,attrName:any){
          console.log('属性装饰器1')
        }
    }
    
    function logAttribute2(params?:string){
        return function(target:any,attrName:any){
          console.log('属性装饰器2')
        }
    }
    
    function logMethod1(params?:string){
        return function(target:any,attrName:any,desc:any){
          console.log('方法装饰器1')
        }
    }
    function logMethod2(params?:string){
        return function(target:any,attrName:any,desc:any){
          console.log('方法装饰器2')
        }
    }
     
    function logParams1(params?:string){
        return function(target:any,attrName:any,desc:any){
          console.log('方法参数装饰器1')
        }
    }
    
    function logParams2(params?:string){
        return function(target:any,attrName:any,desc:any){
          console.log('方法参数装饰器2')
        }
    }
    
    @logClass1('http://www.3yteam.com/api')
    @logClass2('xxxx')
    class HttpClient{
        @logAttribute1()
        @logAttribute2()
        public apiUrl:string | undefined;
        constructor(){
        }
    
        @logMethod1()
        @logMethod2()
        getData(){
            return true;
        }
    
        setData(@logParams1() attr1:any,@logParams2() attr2:any,){
    
        }
    }
    
    var http:any=new HttpClient();

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2020-08-02，如有侵权请联系 cloudcommunity@tencent.com 删除

打包

typescript

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

打包

typescript

登录后参与评论

0 条评论

热度