JS裝飾者模式和TypeScript裝飾器

更新時間：2021年04月30日 09:24:53 作者：淺笑·

學習的目的是對裝飾者模式模式有進一步的理解，并運用在自己的項目中；對TypeScript裝飾器的理解，更好的使用裝飾器，例如在nodejsweb框架中、vue-property-decorator中，或者是自定義裝飾器，能熟練運用并掌握其基本的實現(xiàn)原理。

裝飾者模式介紹

裝飾者模式（Decorator Pattern）也稱為裝飾器模式，在不改變對象自身的基礎上，動態(tài)增加額外的職責。屬于結構型模式的一種。

使用裝飾者模式的優(yōu)點：把對象核心職責和要裝飾的功能分開了。非侵入式的行為修改。

舉個例子來說，原本長相一般的女孩，借助美顏功能，也能拍出逆天的顏值。只要善于運用輔助的裝飾功能，開啟瘦臉，增大眼睛，來點磨皮后，咔嚓一拍，驚艷無比。

經過這一系列疊加的裝飾，你還是你，長相不增不減，卻能在鏡頭前增加了多重美。如果你愿意，還可以嘗試不同的裝飾風格，只要裝飾功能做的好，你就能成為“百變星君”。

可以用代碼表示，把每個功能抽象成一個類：

// 女孩子
class Girl {
  faceValue() {
    console.log('我原本的臉')
  }
}

class ThinFace  {
  constructor(girl) {
    this.girl = girl;
  }
  faceValue() {
    this.girl.faceValue();
    console.log('開啟瘦臉')
  }
}

class IncreasingEyes  {
  constructor(girl) {
    this.girl = girl;
  }
  faceValue() {
    this.girl.faceValue();
    console.log('增大眼睛')
  }
}

let girl = new Girl();
girl = new ThinFace(girl);
girl = new IncreasingEyes(girl);

// 閃瞎你的眼
girl.faceValue(); //

從代碼的表現(xiàn)來看，將一個對象嵌入到另一個對象中，相當于通過一個對象對另一個對象進行包裝，形成一條包裝鏈。調用后，隨著包裝的鏈條傳遞給每一個對象，讓每個對象都有處理的機會。

這種方式在增加刪除裝飾功能上都有極大的靈活性，假如你有勇氣展示真實的臉，去掉瘦臉的包裝即可，這對其他功能毫無影響；假如要增加磨皮，再來個功能類，繼續(xù)裝飾下去，對其他功能也無影響，可以并存運行。

在JavaScript中增加小功能使用類，顯的有點笨重，JavaScript的優(yōu)點是靈活，可以使用對象來表示：

let girl = {
  faceValue() {
    console.log('我原本的臉')
  }
}
function thinFace() {
  console.log('開啟瘦臉')
}
function IncreasingEyes() {
  console.log('增大眼睛')
}

girl.faceValue = function(){
  const originalFaveValue = girl.faceValue;  // 原來的功能
  return function() {
    originalFaveValue.call(girl);
    thinFace.call(girl);
  }
}()
girl.faceValue = function(){
  const originalFaveValue = girl.faceValue;  // 原來的功能
  return function() {
    originalFaveValue.call(girl);
    IncreasingEyes.call(girl);
  }
}()

girl.faceValue();

在不改變原來代碼的基礎上，通過先保留原來函數，重新改寫，在重寫的代碼中調用原來保留的函數。

用一張圖來表示裝飾者模式的原理：

從圖中可以看出來，通過一層層的包裝，增加了原先對象的功能。

TypeScript中的裝飾器

TypeScript 中的裝飾器使用 @expression 這種形式，expression 求值后為一個函數，它在運行時被調用，被裝飾的聲明信息會被做為參數傳入。

Javascript規(guī)范里的裝飾器目前處在建議征集的第二階段，也就意味著不能在原生代碼中直接使用，瀏覽器暫不支持。

可以通過babel或TypeScript工具在編譯階段，把裝飾器語法轉換成瀏覽器可執(zhí)行的代碼。（最后會有編譯后的源碼分析）

以下主要討論TypeScript中裝飾器的使用。

TypeScript 中的裝飾器可以被附加到類聲明、方法、訪問符(getter/setter)、屬性和參數上。

開啟對裝飾器的支持，命令行編譯文件時：

tsc --target ES5 --experimentalDecorators test.ts

配置文件tsconfig.json

{
    "compilerOptions": {
        "target": "ES5",
        "experimentalDecorators": true
    }
}

裝飾器的使用

裝飾器實際上就是一個函數，在使用時前面加上@符號，寫在要裝飾的聲明之前，多個裝飾器同時作用在一個聲明時，可以寫一行或換行寫：

// 換行寫
@test1
@test2
declaration

//寫一行
@test1 @test2 ...
declaration

定義face.ts文件：

function thinFace() {
  console.log('開啟瘦臉')
}

@thinFace
class Girl {
}

編譯成js代碼，在運行時，會直接調用thinFace函數。這個裝飾器作用在類上，稱之為類裝飾器。

如果需要附加多個功能，可以組合多個裝飾器一起使用：

function thinFace() {
  console.log('開啟瘦臉')
}
function IncreasingEyes() {
  console.log('增大眼睛')
}

@thinFace
@IncreasingEyes
class Girl {
}

多個裝飾器組合在一起，在運行時，要注意，調用順序是從下至上依次調用，正好和書寫的順序相反。例子中給出的運行結果是：

'增大眼睛'

'開啟瘦臉'

如果你要在一個裝飾器中給類添加屬性，在其他的裝飾器中使用，那就要寫在最后一個裝飾器中，因為最后寫的裝飾器最先調用。

裝飾器工廠

有時需要給裝飾器傳遞一些參數，這要借助于裝飾器工廠函數。裝飾器工廠函數實際上就是一個高階函數，在調用后返回一個函數，返回的函數作為裝飾器函數。

function thinFace(value: string){
  console.log('1-瘦臉工廠方法')
  return function(){
    console.log(`4-我是瘦臉的裝飾器，要瘦臉${value}`)
  }
}
function IncreasingEyes(value: string) {
  console.log('2-增大眼睛工廠方法')
  return function(){
    console.log(`3-我是增大眼睛的裝飾器，要${value}`)
  }
}

@thinFace('50%')
@IncreasingEyes('增大一倍')
class Girl {
}

@符號后為調用工廠函數，依次從上到下執(zhí)行，目的是求得裝飾器函數。裝飾器函數的運行順序依然是從下到上依次執(zhí)行。

運行的結果為：

1-瘦臉工廠方法

2-增大眼睛工廠方法

3-我是增大眼睛的裝飾器，要增大一倍

4-我是瘦臉的裝飾器，要瘦臉50%

總結一下：

寫了工廠函數，從上到下依次執(zhí)行，求得裝飾器函數。
裝飾器函數的執(zhí)行順序是從下到上依次執(zhí)行。

類裝飾器

作用在類聲明上的裝飾器，可以給我們改變類的機會。在執(zhí)行裝飾器函數時，會把類構造函數傳遞給裝飾器函數。

function classDecorator(value: string){
  return function(constructor){
    console.log('接收一個構造函數')
  }
}

function thinFace(constructor){
  constructor.prototype.thinFaceFeature = function() {
    console.log('瘦臉功能')
  }
}

@thinFace
@classDecorator('類裝飾器')
class Girl {}

let g = new Girl();

g.thinFaceFeature(); // '瘦臉功能'

上面的例子中，拿到傳遞構造函數后，就可以給構造函數原型上增加新的方法，甚至也可以繼承別的類。

方法裝飾器

作用在類的方法上，有靜態(tài)方法和原型方法。作用在靜態(tài)方法上，裝飾器函數接收的是類構造函數；作用在原型方法上，裝飾器函數接收的是原型對象。
這里拿作用在原型方法上舉例。

function methodDecorator(value: string, Girl){
  return function(prototype, key, descriptor){
    console.log('接收原型對象，裝飾的屬性名，屬性描述符', Girl.prototype === prototype)
  }
}

function thinFace(prototype, key, descriptor){
  // 保留原來的方法邏輯
  let originalMethod = descriptor.value;
  // 改寫，增加邏輯，并執(zhí)行原有邏輯
  descriptor.value = function(){
    originalMethod.call(this);  // 注意修改this的指向
    console.log('開啟瘦臉模式')
  }
}

class Girl {

  @thinFace
  @methodDecorator('方式裝飾器', Girl)
  faceValue(){
    console.log('我是原本的面目')
  }
}

let g = new Girl();

g.faceValue();

從代碼中可以看出，裝飾器函數接收三個參數，原型對象、方法名、描述對象。對描述對象陌生的，可以參考這里;

要增強功能，可以先保留原來的函數，改寫描述對象的value為另一函數。

當使用g.faceValue()訪問方法時，訪問的就是描述對象value對應的值。

在改寫的函數中增加邏輯，并執(zhí)行原來保留的原函數。注意原函數要用call或apply將this指向原型對象。

屬性裝飾器

作用在類中定義的屬性上，這些屬性不是原型上的屬性，而是通過類實例化得到的實例對象上的屬性。

裝飾器同樣會接受兩個參數，原型對象，和屬性名。而沒有屬性描述對象，為什么呢？這與TypeScript是如何初始化屬性裝飾器的有關。目前沒有辦法在定義一個原型對象的成員時描述一個實例屬性。

function propertyDecorator(value: string, Girl){
  return function(prototype, key){
    console.log('接收原型對象，裝飾的屬性名，屬性描述符', Girl.prototype === prototype)
  }
}

function thinFace(prototype, key){
  console.log(prototype, key)
}

class Girl {
  @thinFace
  @propertyDecorator('屬性裝飾器', Girl)
  public age: number = 18;
}

let g = new Girl();

console.log(g.age); // 18

其他裝飾器的寫法

下面組合多個裝飾器寫在一起，出了上面提到的三種，還有訪問符裝飾器、參數裝飾器。這些裝飾器在一起時，會有執(zhí)行順序。

function classDecorator(value: string){
  console.log(value)
  return function(){}
}
function propertyDecorator(value: string) {
  console.log(value)
  return function(){
    console.log('propertyDecorator')
  }
}
function methodDecorator(value: string) {
  console.log(value)
  return function(){
    console.log('methodDecorator')
  }
}
function paramDecorator(value: string) {
  console.log(value)
  return function(){
    console.log('paramDecorator')
  }
}
function AccessDecorator(value: string) {
  console.log(value)
  return function(){
    console.log('AccessDecorator')
  }
}
function thinFace(){
  console.log('瘦臉')
}
function IncreasingEyes() {
  console.log('增大眼睛')
}


@thinFace
@classDecorator('類裝飾器')
class Girl {
  @propertyDecorator('屬性裝飾器')
  age: number = 18;
  
  @AccessDecorator('訪問符裝飾器')
  get city(){}

  @methodDecorator('方法裝飾器')
  @IncreasingEyes
  faceValue(){
    console.log('原本的臉')
  }

  getAge(@paramDecorator('參數裝飾器') name: string){}
}

運行了這段編譯后的代碼，會發(fā)現(xiàn)這些訪問器的順序是，屬性裝飾器 -> 訪問符裝飾器 -> 方法裝飾器 -> 參數裝飾器 -> 類裝飾器。

更詳細的用法可以參考官網文檔：https://www.tslang.cn/docs/handbook/decorators.html#decorator-factories

裝飾器運行時代碼分析

裝飾器在瀏覽器中不支持，沒辦法直接使用，需要經過工具編譯成瀏覽器可執(zhí)行的代碼。

分析一下通過工具編譯后的代碼。

生成face.js文件：

tsc --target ES5 --experimentalDecorators face.ts

打開face.js文件，會看到一段被壓縮后的代碼，可以格式化一下。

先看這段代碼：

__decorate([
    propertyDecorator('屬性裝飾器')
], Girl.prototype, "age", void 0);
__decorate([
    AccessDecorator('訪問符裝飾器')
], Girl.prototype, "city", null);
__decorate([
    methodDecorator('方法裝飾器'),
    IncreasingEyes
], Girl.prototype, "faceValue", null);
__decorate([
    __param(0, paramDecorator('參數裝飾器'))
], Girl.prototype, "getAge", null);
Girl = __decorate([
    thinFace,
    classDecorator('類裝飾器')
], Girl);

__decorate的作用就是執(zhí)行裝飾器函數，從這段代碼中能夠看出很多信息，印證上面得到的結論。

通過__decorate調用順序，可以看出來，多個類型的裝飾器一起使用時，順序是，屬性裝飾器 -> 訪問符裝飾器 -> 方法裝飾器 -> 參數裝飾器 -> 類裝飾器。

調用了__decorate函數，根據使用的裝飾器類型不同，傳入的參數也不相同。

第一個參數傳入的都一樣，為數組，這樣確保和我們書寫的順序一致，每一項是求值后的裝飾器函數，如果寫的是@propertyDecorator()則一上來就執(zhí)行，得到裝飾器函數，這跟上面分析的一致。

類裝飾器會把類作為第二個參數，其他的裝飾器，把原型對象作為第二個參數，屬性名作為第三個，第四個是null或void 0。void 0的值為undefined，也就等于沒傳參數

要記住傳給__decorate函數參數的個數和值，在深入到__decorate源碼中，會根據這些值來決定執(zhí)行裝飾器函數時，傳入參數的多少。

好，來看__decorate函數實現(xiàn)：

// 已存在此函數，直接使用，否則自己定義
var __decorate = (this && this.__decorate) ||
// 接收四個參數： 
//decorators存放裝飾器函數的數組、target原型對象|類，
//key屬性名、desc描述（undefined或null）
function(decorators, target, key, desc) {
  var c = arguments.length,
  // 拿到參數的個數
  r = c < 3 // 參數小于三個，說明是類裝飾器，直接拿到類
    ? target
    : desc === null // 第四個參數為 null，則需要描述對象；屬性裝飾器傳入是  void 0，沒有描述對象。
        ? desc = Object.getOwnPropertyDescriptor(target, key) 
        : desc,
  d;
  // 如果提供了Reflect.decorate方法，直接調用；否則自己實現(xiàn)
  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") 
    r = Reflect.decorate(decorators, target, key, desc);
  else 
    // 裝飾器函數執(zhí)行順序和書寫的順序相反，從下至上 執(zhí)行
    for (var i = decorators.length - 1; i >= 0; i--) 
      if (d = decorators[i]) // 拿到裝飾器函數
          r = (c < 3 // 參數小于3個，說明是類裝飾器，執(zhí)行裝飾器函數，直接傳入類
            ? d(r) 
            : c > 3 // 參數大于三個，是方法裝飾器、訪問符裝飾器、參數裝飾器，則執(zhí)行傳入描述對象
              ? d(target, key, r) 
              : d(target, key) // 為屬性裝飾器，不傳入描述對象
            ) || r;

  // 給被裝飾的屬性，設置得到的描述對象，主要是針對，方法、屬性來說的
  /*** 
     * r 的值分兩種情況，
     *  一種是通過上面的 Object.getOwnPropertyDescriptor 得到的值
     *  另一種，是裝飾器函數執(zhí)行后的返回值，作為描述對象。
     *      一般不給裝飾器函數返回值。
    */
  return c > 3 && r && Object.defineProperty(target, key, r),r;
};

上面的參數裝飾器，調用了一個函數為__params，

var __param = (this && this.__param) || function (paramIndex, decorator) {
    return function (target, key) { decorator(target, key, paramIndex); }
};

目的是，要給裝飾器函數傳入參數的位置paramIndex。

看了編譯后的源碼，相信會對裝飾器的理解更深刻。

以上就是JS裝飾者模式和TypeScript裝飾器的詳細內容，更多關于JS的資料請關注腳本之家其它相關文章！

您可能感興趣的文章:

JS實現(xiàn)的5級聯(lián)動Select下拉選擇框實例
這篇文章主要介紹了JS實現(xiàn)的5級聯(lián)動Select下拉選擇框,涉及javascript數組調用及遍歷的相關技巧,具有一定參考借鑒價值,需要的朋友可以參考下
2015-08-08
JavaScript-RegExp對象只能使用一次問題解決方法
RegExp對象執(zhí)行了一次后就廢掉了,所以每次用RegExp都需要重新new一個，下面有個示例，需要的朋友可以參考下
2014-06-06
Jquery實現(xiàn)的tab效果可以指定默認顯示第幾頁
tab效果想必大家在網上都有見過很多吧，在本文將為大家介紹下如何實現(xiàn)可以在代碼里面指定默認顯示第幾頁的tab效果，感興趣的朋友不要錯過
2013-10-10
微信小程序批量上傳圖片到七牛(推薦)
這篇文章主要介紹了微信小程序批量上傳圖片到七牛,本文通過實例代碼給大家介紹的非常詳細，具有一定的參考借鑒價值，需要的朋友可以參考下
2019-12-12
js clearInterval()方法的定義和用法
clearInterval()方法能夠取消setInterval()方法設置的定時器，本文給大家詳解clearInterval()方法的定義和用法，感興趣的朋友參考下。
2015-11-11
js學習總結之DOM2兼容處理重復問題的解決方法
這篇文章主要為大家詳細介紹了js學習總結之DOM2兼容處理重復問題的解決方法，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2017-07-07
對javascript的一點點認識總結《javascript高級程序設計》讀書筆記
Javascript專為與網頁交互而設計的腳本語言，由下列三個部門構造
2011-11-11
微信小程序使用wx.request請求服務器json數據并渲染到頁面操作示例
這篇文章主要介紹了微信小程序使用wx.request請求服務器json數據并渲染到頁面操作,結合實例形式分析了微信小程序使用wx.request發(fā)送網絡請求及返回結果渲染到wxml界面相關操作技巧,需要的朋友可以參考下
2019-03-03
js事件冒泡實例分享(已測試)
js事件冒泡實例：摘的網上的例子，但是他寫的有錯誤，自己改正了下，已驗證通過，感興趣的朋友可以參考下哈
2013-04-04
別了 JavaScript中的isXX系列
我們很容易被漂亮的代碼吸引，也不知不覺的在自己的代碼庫中加入這些。卻沒有冷靜的想過它們的優(yōu)劣。這不，我就收集了一系列形如是否為……？的判斷的boolean函數
2012-08-08