細數 TS 中那些奇怪的符號

TypeScript 是一種由微軟開發的自由和開源的編程語言。它是 JavaScript 的一個超集,並且本質上向這個語言添加了可選的靜態類型和基於類的面向對象編程。javascript

本文阿寶哥將分享這些年在學習 TypeScript 過程當中,遇到的 10 大 「奇怪」 的符號。其中有一些符號,阿寶哥第一次見的時候也以爲 「一臉懵逼」,但願本文對學習 TypeScript 的小夥伴能有一些幫助。html

好的,下面咱們來開始介紹第一個符號 —— ! 非空斷言操做符java

1、! 非空斷言操做符

在上下文中當類型檢查器沒法判定類型時,一個新的後綴表達式操做符 ! 能夠用於斷言操做對象是非 null 和非 undefined 類型。具體而言,x! 將從 x 值域中排除 null 和 undefined 。git

那麼非空斷言操做符到底有什麼用呢?下面咱們先來看一下非空斷言操做符的一些使用場景。github

1.1 忽略 undefined 和 null 類型

function myFunc(maybeString: string | undefined | null) {
  // Type 'string | null | undefined' is not assignable to type 'string'.
  // Type 'undefined' is not assignable to type 'string'. 
  const onlyString: string = maybeString; // Error
  const ignoreUndefinedAndNull: string = maybeString!; // Ok
}

1.2 調用函數時忽略 undefined 類型

type NumGenerator = () => number;

function myFunc(numGenerator: NumGenerator | undefined) {
  // Object is possibly 'undefined'.(2532)
  // Cannot invoke an object which is possibly 'undefined'.(2722)
  const num1 = numGenerator(); // Error
  const num2 = numGenerator!(); //OK
}

由於 ! 非空斷言操做符會從編譯生成的 JavaScript 代碼中移除,因此在實際使用的過程當中,要特別注意。好比下面這個例子:web

const a: number | undefined = undefined;
const b: number = a!;
console.log(b);

以上 TS 代碼會編譯生成如下 ES5 代碼:typescript

"use strict";
const a = undefined;
const b = a;
console.log(b);

雖然在 TS 代碼中,咱們使用了非空斷言,使得 const b: number = a!; 語句能夠經過 TypeScript 類型檢查器的檢查。但在生成的 ES5 代碼中,! 非空斷言操做符被移除了,因此在瀏覽器中執行以上代碼,在控制檯會輸出 undefinedshell

2、?. 運算符

TypeScript 3.7 實現了呼聲最高的 ECMAScript 功能之一:可選鏈(Optional Chaining)。有了可選鏈後,咱們編寫代碼時若是遇到 nullundefined 就能夠當即中止某些表達式的運行。可選鏈的核心是新的 ?. 運算符,它支持如下語法:apache

obj?.prop
obj?.[expr]
arr?.[index]
func?.(args)

這裏咱們來舉一個可選的屬性訪問的例子:編程

const val = a?.b;

爲了更好的理解可選鏈,咱們來看一下該 const val = a?.b 語句編譯生成的 ES5 代碼:

var val = a === null || a === void 0 ? void 0 : a.b;

上述的代碼會自動檢查對象 a 是否爲 nullundefined,若是是的話就當即返回 undefined,這樣就能夠當即中止某些表達式的運行。你可能已經想到可使用 ?. 來替代不少使用 && 執行空檢查的代碼:

if(a && a.b) { } 

if(a?.b){ }
/**
* if(a?.b){ } 編譯後的ES5代碼
* 
* if(
*  a === null || a === void 0 
*  ? void 0 : a.b) {
* }
*/

但須要注意的是,?.&& 運算符行爲略有不一樣,&& 專門用於檢測 falsy 值,好比空字符串、0、NaN、null 和 false 等。而 ?. 只會驗證對象是否爲 nullundefined,對於 0 或空字符串來講,並不會出現 「短路」。

2.1 可選元素訪問

可選鏈除了支持可選屬性的訪問以外,它還支持可選元素的訪問,它的行爲相似於可選屬性的訪問,只是可選元素的訪問容許咱們訪問非標識符的屬性,好比任意字符串、數字索引和 Symbol:

function tryGetArrayElement<T>(arr?: T[], index: number = 0) {
  return arr?.[index];
}

以上代碼通過編譯後會生成如下 ES5 代碼:

"use strict";
function tryGetArrayElement(arr, index) {
    if (index === void 0) { index = 0; }
    return arr === null || arr === void 0 ? void 0 : arr[index];
}

經過觀察生成的 ES5 代碼,很明顯在 tryGetArrayElement 方法中會自動檢測輸入參數 arr 的值是否爲 nullundefined,從而保證了咱們代碼的健壯性。

2.2 可選鏈與函數調用

當嘗試調用一個可能不存在的方法時也可使用可選鏈。在實際開發過程當中,這是頗有用的。系統中某個方法不可用,有多是因爲版本不一致或者用戶設備兼容性問題致使的。函數調用時若是被調用的方法不存在,使用可選鏈可使表達式自動返回 undefined 而不是拋出一個異常。

可選調用使用起來也很簡單,好比:

let result = obj.customMethod?.();

該 TypeScript 代碼編譯生成的 ES5 代碼以下:

var result = (_a = obj.customMethod) === null
  || _a === void 0 ? void 0 : _a.call(obj);

另外在使用可選調用的時候,咱們要注意如下兩個注意事項:

  • 若是存在一個屬性名且該屬性名對應的值不是函數類型,使用 ?. 仍然會產生一個 TypeError 異常。
  • 可選鏈的運算行爲被侷限在屬性的訪問、調用以及元素的訪問 —— 它不會沿伸到後續的表達式中,也就是說可選調用不會阻止 a?.b / someMethod() 表達式中的除法運算或 someMethod 的方法調用。

3、?? 空值合併運算符

在 TypeScript 3.7 版本中除了引入了前面介紹的可選鏈 ?. 以外,也引入了一個新的邏輯運算符 —— 空值合併運算符 ??當左側操做數爲 null 或 undefined 時,其返回右側的操做數,不然返回左側的操做數

與邏輯或 || 運算符不一樣,邏輯或會在左操做數爲 falsy 值時返回右側操做數。也就是說,若是你使用 || 來爲某些變量設置默認的值時,你可能會遇到意料以外的行爲。好比爲 falsy 值(''、NaN 或 0)時。

這裏來看一個具體的例子:

const foo = null ?? 'default string';
console.log(foo); // 輸出:"default string"

const baz = 0 ?? 42;
console.log(baz); // 輸出:0

以上 TS 代碼通過編譯後,會生成如下 ES5 代碼:

"use strict";
var _a, _b;
var foo = (_a = null) !== null && _a !== void 0 ? _a : 'default string';
console.log(foo); // 輸出:"default string"

var baz = (_b = 0) !== null && _b !== void 0 ? _b : 42;
console.log(baz); // 輸出:0

經過觀察以上代碼,咱們更加直觀的瞭解到,空值合併運算符是如何解決前面 || 運算符存在的潛在問題。下面咱們來介紹空值合併運算符的特性和使用時的一些注意事項。

3.1 短路

當空值合併運算符的左表達式不爲 nullundefined 時,不會對右表達式進行求值。

function A() { console.log('A was called'); return undefined;}
function B() { console.log('B was called'); return false;}
function C() { console.log('C was called'); return "foo";}

console.log(A() ?? C());
console.log(B() ?? C());

上述代碼運行後,控制檯會輸出如下結果:

A was called 
C was called 
foo 
B was called 
false

3.2 不能與 && 或 || 操做符共用

若空值合併運算符 ?? 直接與 AND(&&)和 OR(||)操做符組合使用 ?? 是不行的。這種狀況下會拋出 SyntaxError。

// '||' and '??' operations cannot be mixed without parentheses.(5076)
null || undefined ?? "foo"; // raises a SyntaxError

// '&&' and '??' operations cannot be mixed without parentheses.(5076)
true && undefined ?? "foo"; // raises a SyntaxError

但當使用括號來顯式代表優先級時是可行的,好比:

(null || undefined ) ?? "foo"; // 返回 "foo"

3.3 與可選鏈操做符 ?. 的關係

空值合併運算符針對 undefined 與 null 這兩個值,可選鏈式操做符 ?. 也是如此。可選鏈式操做符,對於訪問屬性可能爲 undefined 與 null 的對象時很是有用。

interface Customer {
  name: string;
  city?: string;
}

let customer: Customer = {
  name: "Semlinker"
};

let customerCity = customer?.city ?? "Unknown city";
console.log(customerCity); // 輸出:Unknown city

前面咱們已經介紹了空值合併運算符的應用場景和使用時的一些注意事項,該運算符不只能夠在 TypeScript 3.7 以上版本中使用。固然你也能夠在 JavaScript 的環境中使用它,但你須要藉助 Babel,在 Babel 7.8.0 版本也開始支持空值合併運算符。

4、?: 可選屬性

在面嚮對象語言中,接口是一個很重要的概念,它是對行爲的抽象,而具體如何行動須要由類去實現。 TypeScript 中的接口是一個很是靈活的概念,除了可用於對類的一部分行爲進行抽象之外,也經常使用於對「對象的形狀(Shape)」進行描述

在 TypeScript 中使用 interface 關鍵字就能夠聲明一個接口:

interface Person {
  name: string;
  age: number;
}

let semlinker: Person = {
  name: "semlinker",
  age: 33,
};

在以上代碼中,咱們聲明瞭 Person 接口,它包含了兩個必填的屬性 nameage。在初始化 Person 類型變量時,若是缺乏某個屬性,TypeScript 編譯器就會提示相應的錯誤信息,好比:

// Property 'age' is missing in type '{ name: string; }' but required in type 'Person'.(2741)
let lolo: Person  = { // Error
  name: "lolo"  
}

爲了解決上述的問題,咱們能夠把某個屬性聲明爲可選的:

interface Person {
  name: string;
  age?: number;
}

let lolo: Person  = {
  name: "lolo"  
}

4.1 工具類型

4.1.1 Partial<T>

在實際項目開發過程當中,爲了提升代碼複用率,咱們能夠利用 TypeScript 內置的工具類型 Partial<T> 來快速把某個接口類型中定義的屬性變成可選的:

interface PullDownRefreshConfig {
  threshold: number;
  stop: number;
}

/**
 * type PullDownRefreshOptions = {
 *   threshold?: number | undefined;
 *   stop?: number | undefined;
 * }
 */ 
type PullDownRefreshOptions = Partial<PullDownRefreshConfig>

是否是以爲 Partial<T> 很方便,下面讓咱們來看一下它是如何實現的:

/**
 * Make all properties in T optional
 */
type Partial<T> = {
  [P in keyof T]?: T[P];
};
4.1.2 Required<T>

既然能夠快速地把某個接口中定義的屬性所有聲明爲可選,那能不能把全部的可選的屬性變成必選的呢?答案是能夠的,針對這個需求,咱們可使用 Required<T> 工具類型,具體的使用方式以下:

interface PullDownRefreshConfig {
  threshold: number;
  stop: number;
}

type PullDownRefreshOptions = Partial<PullDownRefreshConfig>

/**
 * type PullDownRefresh = {
 *   threshold: number;
 *   stop: number;
 * }
 */
type PullDownRefresh = Required<Partial<PullDownRefreshConfig>>

一樣,咱們來看一下 Required<T> 工具類型是如何實現的:

/**
 * Make all properties in T required
 */
type Required<T> = {
  [P in keyof T]-?: T[P];
};

原來在 Required<T> 工具類型內部,經過 -? 移除了可選屬性中的 ?,使得屬性從可選變爲必選的。

5、& 運算符

在 TypeScript 中交叉類型是將多個類型合併爲一個類型。經過 & 運算符能夠將現有的多種類型疊加到一塊兒成爲一種類型,它包含了所需的全部類型的特性。

type PartialPointX = { x: number; };
type Point = PartialPointX & { y: number; };

let point: Point = {
  x: 1,
  y: 1
}

在上面代碼中咱們先定義了 PartialPointX 類型,接着使用 & 運算符建立一個新的 Point 類型,表示一個含有 x 和 y 座標的點,而後定義了一個 Point 類型的變量並初始化。

5.1 同名基礎類型屬性的合併

那麼如今問題來了,假設在合併多個類型的過程當中,恰好出現某些類型存在相同的成員,但對應的類型又不一致,好比:

interface X {
  c: string;
  d: string;
}

interface Y {
  c: number;
  e: string
}

type XY = X & Y;
type YX = Y & X;

let p: XY;
let q: YX;

在上面的代碼中,接口 X 和接口 Y 都含有一個相同的成員 c,但它們的類型不一致。對於這種狀況,此時 XY 類型或 YX 類型中成員 c 的類型是否是能夠是 stringnumber 類型呢?好比下面的例子:

p = { c: 6, d: "d", e: "e" };

q = { c: "c", d: "d", e: "e" };

爲何接口 X 和接口 Y 混入後,成員 c 的類型會變成 never 呢?這是由於混入後成員 c 的類型爲 string & number,即成員 c 的類型既能夠是 string 類型又能夠是 number 類型。很明顯這種類型是不存在的,因此混入後成員 c 的類型爲 never

5.2 同名非基礎類型屬性的合併

在上面示例中,恰好接口 X 和接口 Y 中內部成員 c 的類型都是基本數據類型,那麼若是是非基本數據類型的話,又會是什麼情形。咱們來看個具體的例子:

interface D { d: boolean; }
interface E { e: string; }
interface F { f: number; }

interface A { x: D; }
interface B { x: E; }
interface C { x: F; }

type ABC = A & B & C;

let abc: ABC = {
  x: {
    d: true,
    e: 'semlinker',
    f: 666
  }
};

console.log('abc:', abc);

以上代碼成功運行後,控制檯會輸出如下結果:

由上圖可知,在混入多個類型時,若存在相同的成員,且成員類型爲非基本數據類型,那麼是能夠成功合併。

6、| 分隔符

在 TypeScript 中聯合類型(Union Types)表示取值能夠爲多種類型中的一種,聯合類型使用 | 分隔每一個類型。聯合類型一般與 nullundefined 一塊兒使用:

const sayHello = (name: string | undefined) => { /* ... */ };

以上示例中 name 的類型是 string | undefined 意味着能夠將 stringundefined 的值傳遞給 sayHello 函數。

sayHello("semlinker");
sayHello(undefined);

此外,對於聯合類型來講,你可能會遇到如下的用法:

let num: 1 | 2 = 1;
type EventNames = 'click' | 'scroll' | 'mousemove';

示例中的 12'click' 被稱爲字面量類型,用來約束取值只能是某幾個值中的一個。

6.1 類型保護

當使用聯合類型時,咱們必須儘可能把當前值的類型收窄爲當前值的實際類型,而類型保護就是實現類型收窄的一種手段。

類型保護是可執行運行時檢查的一種表達式,用於確保該類型在必定的範圍內。換句話說,類型保護能夠保證一個字符串是一個字符串,儘管它的值也能夠是一個數字。類型保護與特性檢測並非徹底不一樣,其主要思想是嘗試檢測屬性、方法或原型,以肯定如何處理值。

目前主要有四種的方式來實現類型保護:

6.1.1 in 關鍵字
interface Admin {
  name: string;
  privileges: string[];
}

interface Employee {
  name: string;
  startDate: Date;
}

type UnknownEmployee = Employee | Admin;

function printEmployeeInformation(emp: UnknownEmployee) {
  console.log("Name: " + emp.name);
  if ("privileges" in emp) {
    console.log("Privileges: " + emp.privileges);
  }
  if ("startDate" in emp) {
    console.log("Start Date: " + emp.startDate);
  }
}
6.1.2 typeof 關鍵字
function padLeft(value: string, padding: string | number) {
  if (typeof padding === "number") {
      return Array(padding + 1).join(" ") + value;
  }
  if (typeof padding === "string") {
      return padding + value;
  }
  throw new Error(`Expected string or number, got '${padding}'.`);
}

typeof 類型保護只支持兩種形式:typeof v === "typename"typeof v !== typename"typename" 必須是 "number""string""boolean""symbol"。 可是 TypeScript 並不會阻止你與其它字符串比較,語言不會把那些表達式識別爲類型保護。

6.1.3 instanceof 關鍵字
interface Padder {
  getPaddingString(): string;
}

class SpaceRepeatingPadder implements Padder {
  constructor(private numSpaces: number) {}
  getPaddingString() {
    return Array(this.numSpaces + 1).join(" ");
  }
}

class StringPadder implements Padder {
  constructor(private value: string) {}
  getPaddingString() {
    return this.value;
  }
}

let padder: Padder = new SpaceRepeatingPadder(6);

if (padder instanceof SpaceRepeatingPadder) {
  // padder的類型收窄爲 'SpaceRepeatingPadder'
}
6.1.4 自定義類型保護的類型謂詞(type predicate)
function isNumber(x: any): x is number {
  return typeof x === "number";
}

function isString(x: any): x is string {
  return typeof x === "string";
}

7、_ 數字分隔符

TypeScript 2.7 帶來了對數字分隔符的支持,正如數值分隔符 ECMAScript 提案中所概述的那樣。對於一個數字字面量,你如今能夠經過把一個下劃線做爲它們之間的分隔符來分組數字:

const inhabitantsOfMunich = 1_464_301;
const distanceEarthSunInKm = 149_600_000;
const fileSystemPermission = 0b111_111_000;
const bytes = 0b1111_10101011_11110000_00001101;

分隔符不會改變數值字面量的值,但邏輯分組令人們更容易一眼就能讀懂數字。以上 TS 代碼通過編譯後,會生成如下 ES5 代碼:

"use strict";
var inhabitantsOfMunich = 1464301;
var distanceEarthSunInKm = 149600000;
var fileSystemPermission = 504;
var bytes = 262926349;

7.1 使用限制

雖然數字分隔符看起來很簡單,但在使用時仍是有一些限制。好比你只能在兩個數字之間添加 _ 分隔符。如下的使用方式是非法的:

// Numeric separators are not allowed here.(6188)
3_.141592 // Error
3._141592 // Error

// Numeric separators are not allowed here.(6188)
1_e10 // Error
1e_10 // Error

// Cannot find name '_126301'.(2304)
_126301  // Error
// Numeric separators are not allowed here.(6188)
126301_ // Error

// Cannot find name 'b111111000'.(2304)
// An identifier or keyword cannot immediately follow a numeric literal.(1351)
0_b111111000 // Error

// Numeric separators are not allowed here.(6188)
0b_111111000 // Error

固然你也不能連續使用多個 _ 分隔符,好比:

// Multiple consecutive numeric separators are not permitted.(6189)
123__456 // Error

7.2 解析分隔符

此外,須要注意的是如下用於解析數字的函數是不支持分隔符:

  • Number()
  • parseInt()
  • parseFloat()

這裏咱們來看一下實際的例子:

Number('123_456')
NaN
parseInt('123_456')
123
parseFloat('123_456')
123

很明顯對於以上的結果不是咱們所指望的,因此在處理分隔符時要特別注意。固然要解決上述問題,也很簡單隻須要非數字的字符刪掉便可。這裏咱們來定義一個 removeNonDigits 的函數:

const RE_NON_DIGIT = /[^0-9]/gu;

function removeNonDigits(str) {
  str = str.replace(RE_NON_DIGIT, '');
  return Number(str);
}

該函數經過調用字符串的 replace 方法來移除非數字的字符,具體的使用方式以下:

removeNonDigits('123_456')
123456
removeNonDigits('149,600,000')
149600000
removeNonDigits('1,407,836')
1407836

8、<Type> 語法

8.1 TypeScript 斷言

有時候你會遇到這樣的狀況,你會比 TypeScript 更瞭解某個值的詳細信息。一般這會發生在你清楚地知道一個實體具備比它現有類型更確切的類型。

經過類型斷言這種方式能夠告訴編譯器,「相信我,我知道本身在幹什麼」。類型斷言比如其餘語言裏的類型轉換,可是不進行特殊的數據檢查和解構。它沒有運行時的影響,只是在編譯階段起做用。

類型斷言有兩種形式:

8.1.1 「尖括號」 語法
let someValue: any = "this is a string";
let strLength: number = (<string>someValue).length;
8.1.2 as 語法
let someValue: any = "this is a string";
let strLength: number = (someValue as string).length;

8.2 TypeScript 泛型

對於剛接觸 TypeScript 泛型的讀者來講,首次看到 <T> 語法會感到陌生。其實它沒有什麼特別,就像傳遞參數同樣,咱們傳遞了咱們想要用於特定函數調用的類型。

參考上面的圖片,當咱們調用 identity<Number>(1)Number 類型就像參數 1 同樣,它將在出現 T 的任何位置填充該類型。圖中 <T> 內部的 T 被稱爲類型變量,它是咱們但願傳遞給 identity 函數的類型佔位符,同時它被分配給 value 參數用來代替它的類型:此時 T 充當的是類型,而不是特定的 Number 類型。

其中 T 表明 Type,在定義泛型時一般用做第一個類型變量名稱。但實際上 T 能夠用任何有效名稱代替。除了 T 以外,如下是常見泛型變量表明的意思:

  • K(Key):表示對象中的鍵類型;
  • V(Value):表示對象中的值類型;
  • E(Element):表示元素類型。

其實並非只能定義一個類型變量,咱們能夠引入但願定義的任何數量的類型變量。好比咱們引入一個新的類型變量 U,用於擴展咱們定義的 identity 函數:

function identity <T, U>(value: T, message: U) : T {
  console.log(message);
  return value;
}

console.log(identity<Number, string>(68, "Semlinker"));

除了爲類型變量顯式設定值以外,一種更常見的作法是使編譯器自動選擇這些類型,從而使代碼更簡潔。咱們能夠徹底省略尖括號,好比:

function identity <T, U>(value: T, message: U) : T {
  console.log(message);
  return value;
}

console.log(identity(68, "Semlinker"));

對於上述代碼,編譯器足夠聰明,可以知道咱們的參數類型,並將它們賦值給 T 和 U,而不須要開發人員顯式指定它們。

9、@XXX 裝飾器

9.1 裝飾器語法

對於一些剛接觸 TypeScript 的小夥伴來講,在第一次看到 @Plugin({...}) 這種語法可能會以爲很驚訝。其實這是裝飾器的語法,裝飾器的本質是一個函數,經過裝飾器咱們能夠方便地定義與對象相關的元數據。

@Plugin({
  pluginName: 'Device',
  plugin: 'cordova-plugin-device',
  pluginRef: 'device',
  repo: 'https://github.com/apache/cordova-plugin-device',
  platforms: ['Android', 'Browser', 'iOS', 'macOS', 'Windows'],
})
@Injectable()
export class Device extends IonicNativePlugin {}

在以上代碼中,咱們經過裝飾器來保存 ionic-native 插件的相關元信息,而 @Plugin({...}) 中的 @ 符號只是語法糖,爲何說是語法糖呢?這裏咱們來看一下編譯生成的 ES5 代碼:

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 Device = /** @class */ (function (_super) {
    __extends(Device, _super);
    function Device() {
        return _super !== null && _super.apply(this, arguments) || this;
    }
    Device = __decorate([
        Plugin({
            pluginName: 'Device',
            plugin: 'cordova-plugin-device',
            pluginRef: 'device',
            repo: 'https://github.com/apache/cordova-plugin-device',
            platforms: ['Android', 'Browser', 'iOS', 'macOS', 'Windows'],
        }),
        Injectable()
    ], Device);
    return Device;
}(IonicNativePlugin));

經過生成的代碼可知,@Plugin({...})@Injectable() 最終會被轉換成普通的方法調用,它們的調用結果最終會以數組的形式做爲參數傳遞給 __decorate 函數,而在 __decorate 函數內部會以 Device 類做爲參數調用各自的類型裝飾器,從而擴展對應的功能。

9.2 裝飾器的分類

在 TypeScript 中裝飾器分爲類裝飾器、屬性裝飾器、方法裝飾器和參數裝飾器四大類。

9.2.1 類裝飾器

類裝飾器聲明:

declare type ClassDecorator = <TFunction extends Function>(
  target: TFunction
) => TFunction | void;

類裝飾器顧名思義,就是用來裝飾類的。它接收一個參數:

  • target: TFunction - 被裝飾的類

看完第一眼後,是否是感受都很差了。沒事,咱們立刻來個例子:

function Greeter(target: Function): void {
  target.prototype.greet = function (): void {
    console.log("Hello Semlinker!");
  };
}

@Greeter
class Greeting {
  constructor() {
    // 內部實現
  }
}

let myGreeting = new Greeting();
myGreeting.greet(); // console output: 'Hello Semlinker!';

上面的例子中,咱們定義了 Greeter 類裝飾器,同時咱們使用了 @Greeter 語法糖,來使用裝飾器。

友情提示:讀者能夠直接複製上面的代碼,在 TypeScript Playground 中運行查看結果。
9.2.2 屬性裝飾器

屬性裝飾器聲明:

declare type PropertyDecorator = (target:Object, 
  propertyKey: string | symbol ) => void;

屬性裝飾器顧名思義,用來裝飾類的屬性。它接收兩個參數:

  • target: Object - 被裝飾的類
  • propertyKey: string | symbol - 被裝飾類的屬性名

趁熱打鐵,立刻來個例子熱熱身:

function logProperty(target: any, key: string) {
  delete target[key];

  const backingField = "_" + key;

  Object.defineProperty(target, backingField, {
    writable: true,
    enumerable: true,
    configurable: true
  });

  // property getter
  const getter = function (this: any) {
    const currVal = this[backingField];
    console.log(`Get: ${key} => ${currVal}`);
    return currVal;
  };

  // property setter
  const setter = function (this: any, newVal: any) {
    console.log(`Set: ${key} => ${newVal}`);
    this[backingField] = newVal;
  };

  // Create new property with getter and setter
  Object.defineProperty(target, key, {
    get: getter,
    set: setter,
    enumerable: true,
    configurable: true
  });
}

class Person { 
  @logProperty
  public name: string;

  constructor(name : string) { 
    this.name = name;
  }
}

const p1 = new Person("semlinker");
p1.name = "kakuqo";

以上代碼咱們定義了一個 logProperty 函數,來跟蹤用戶對屬性的操做,當代碼成功運行後,在控制檯會輸出如下結果:

Set: name => semlinker
Set: name => kakuqo
9.2.3 方法裝飾器

方法裝飾器聲明:

declare type MethodDecorator = <T>(target:Object, propertyKey: string | symbol,          
  descriptor: TypePropertyDescript<T>) => TypedPropertyDescriptor<T> | void;

方法裝飾器顧名思義,用來裝飾類的方法。它接收三個參數:

  • target: Object - 被裝飾的類
  • propertyKey: string | symbol - 方法名
  • descriptor: TypePropertyDescript - 屬性描述符

廢話很少說,直接上例子:

function LogOutput(tarage: Function, key: string, descriptor: any) {
  let originalMethod = descriptor.value;
  let newMethod = function(...args: any[]): any {
    let result: any = originalMethod.apply(this, args);
    if(!this.loggedOutput) {
      this.loggedOutput = new Array<any>();
    }
    this.loggedOutput.push({
      method: key,
      parameters: args,
      output: result,
      timestamp: new Date()
    });
    return result;
  };
  descriptor.value = newMethod;
}

class Calculator {
  @LogOutput
  double (num: number): number {
    return num * 2;
  }
}

let calc = new Calculator();
calc.double(11);
// console ouput: [{method: "double", output: 22, ...}]
console.log(calc.loggedOutput);
9.2.4 參數裝飾器

參數裝飾器聲明:

declare type ParameterDecorator = (target: Object, propertyKey: string | symbol, 
  parameterIndex: number ) => void

參數裝飾器顧名思義,是用來裝飾函數參數,它接收三個參數:

  • target: Object - 被裝飾的類
  • propertyKey: string | symbol - 方法名
  • parameterIndex: number - 方法中參數的索引值
function Log(target: Function, key: string, parameterIndex: number) {
  let functionLogged = key || target.prototype.constructor.name;
  console.log(`The parameter in position ${parameterIndex} at ${functionLogged} has
    been decorated`);
}

class Greeter {
  greeting: string;
  constructor(@Log phrase: string) {
    this.greeting = phrase; 
  }
}

// console output: The parameter in position 0 
// at Greeter has been decorated

10、#XXX 私有字段

在 TypeScript 3.8 版本就開始支持 ECMAScript 私有字段,使用方式以下:

class Person {
  #name: string;

  constructor(name: string) {
    this.#name = name;
  }

  greet() {
    console.log(`Hello, my name is ${this.#name}!`);
  }
}

let semlinker = new Person("Semlinker");

semlinker.#name;
//     ~~~~~
// Property '#name' is not accessible outside class 'Person'
// because it has a private identifier.

與常規屬性(甚至使用 private 修飾符聲明的屬性)不一樣,私有字段要牢記如下規則:

  • 私有字段以 # 字符開頭,有時咱們稱之爲私有名稱;
  • 每一個私有字段名稱都惟一地限定於其包含的類;
  • 不能在私有字段上使用 TypeScript 可訪問性修飾符(如 public 或 private);
  • 私有字段不能在包含的類以外訪問,甚至不能被檢測到。

10.1 私有字段與 private 的區別

說到這裏使用 # 定義的私有字段與 private 修飾符定義字段有什麼區別呢?如今咱們先來看一個 private 的示例:

class Person {
  constructor(private name: string){}
}

let person = new Person("Semlinker");
console.log(person.name);

在上面代碼中,咱們建立了一個 Person 類,該類中使用 private 修飾符定義了一個私有屬性 name,接着使用該類建立一個 person 對象,而後經過 person.name 來訪問 person 對象的私有屬性,這時 TypeScript 編譯器會提示如下異常:

Property 'name' is private and only accessible within class 'Person'.(2341)

那如何解決這個異常呢?固然你可使用類型斷言把 person 轉爲 any 類型:

console.log((person as any).name);

經過這種方式雖然解決了 TypeScript 編譯器的異常提示,可是在運行時咱們仍是能夠訪問到 Person 類內部的私有屬性,爲何會這樣呢?咱們來看一下編譯生成的 ES5 代碼,也許你就知道答案了:

var Person = /** @class */ (function () {
    function Person(name) {
      this.name = name;
    }
    return Person;
}());

var person = new Person("Semlinker");
console.log(person.name);

這時相信有些小夥伴會好奇,在 TypeScript 3.8 以上版本經過 # 號定義的私有字段編譯後會生成什麼代碼:

class Person {
  #name: string;

  constructor(name: string) {
    this.#name = name;
  }

  greet() {
    console.log(`Hello, my name is ${this.#name}!`);
  }
}

以上代碼目標設置爲 ES2015,會編譯生成如下代碼:

"use strict";
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) 
  || function (receiver, privateMap, value) {
    if (!privateMap.has(receiver)) {
      throw new TypeError("attempted to set private field on non-instance");
    }
    privateMap.set(receiver, value);
    return value;
};

var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) 
  || function (receiver, privateMap) {
    if (!privateMap.has(receiver)) {
      throw new TypeError("attempted to get private field on non-instance");
    }
    return privateMap.get(receiver);
};

var _name;
class Person {
    constructor(name) {
      _name.set(this, void 0);
      __classPrivateFieldSet(this, _name, name);
    }
    greet() {
      console.log(`Hello, my name is ${__classPrivateFieldGet(this, _name)}!`);
    }
}
_name = new WeakMap();

經過觀察上述代碼,使用 # 號定義的 ECMAScript 私有字段,會經過 WeakMap 對象來存儲,同時編譯器會生成 __classPrivateFieldSet__classPrivateFieldGet 這兩個方法用於設置值和獲取值。

11、參考資源

12、推薦閱讀

相關文章
相關標籤/搜索