在 Vue 中使用 TypeScript 的一些思考(實(shí)踐)

Vue.extend or vue-class-component

使用 TypeScript 寫 Vue 組件時,有兩種推薦形式:

  • Vue.extend():使用基礎(chǔ) Vue 構(gòu)造器,創(chuàng)建一個“子類”。此種寫法與 Vue 單文件組件標(biāo)準(zhǔn)形式最為接近,唯一不同僅是組件選項(xiàng)需要被包裹在 Vue.extend() 中。
  • vue-class-component:通常與 vue-property-decorator 一起使用,提供一系列裝飾器,能讓我們書寫類風(fēng)格的 Vue 組件。

兩種形式輸出結(jié)果一致,同是創(chuàng)建一個 Vue 子類,但在書寫組件選項(xiàng)如 props,mixin 時,有些不同。特別是當(dāng)你使用 Vue.extend() 時,為了讓 TypeScript 正確推斷類型,你將不得不做一些額外的處理。接下來,我們來聊一聊它們的細(xì)節(jié)差異。

Prop

由于組件實(shí)例的作用域是孤立的,當(dāng)從父組件傳遞數(shù)據(jù)到子組件時,我們通常使用 Prop 選項(xiàng)。同時,為了確保 Prop 的類型安全,我們會給 Prop 添加指定類型驗(yàn)證,形式如下:

export default {
  props: {
    someProp: {
      type: Object,
      required: true,
      default: () => ({ message: 'test' })
    }
  }
}

我們定義了一個 someProp,它的類型是 Object。

使用 JavaScript 時,這并沒有什么不對的地方,但當(dāng)你使用 TypeScript 時,這有點(diǎn)不足,我們并不能得到有關(guān)于 someProp 更多有用的信息(比如它含有某些屬性),甚至在 TypeScript 看來,這將會是一個 any 類型:

image

這意味著我們可以使用 someProp 上的任意屬性(存在或者是不存在的)都可以通過編譯。為了防止此種情況的發(fā)生,我們將會給 Prop 添加類型注釋。

Vue.extend()

使用 Vue.extend() 方法添加類型注釋時,需要給 type 斷言:

import Vue from 'vue'

interface User {
  name: string,
  age: number
}

export default Vue.extend({
  props: {
    testProps: {
      type: Object as () => User
    }
  }
})

當(dāng)組件內(nèi)訪問 testProps 時,便能得到相關(guān)提示:

image

然而,你必須以函數(shù)返回值的形式斷言,并不能直接斷言:

export default Vue.extend({
  props: {
    testProps: {
      type: Object as User
    }
  }
})

它會給出錯誤警告,User 接口并沒有實(shí)現(xiàn)原生 Object 構(gòu)造函數(shù)所執(zhí)行的方法:
Type 'ObjectConstructor' cannot be converted to type 'User'. Property 'id' is missing in type 'ObjectConstructor'.

實(shí)際上,我們可從 Prop type declaration

export type Prop<T> = { (): T } | { new (...args: any[]): T & object }

export type PropValidator<T> = PropOptions<T> | Prop<T> | Prop<T>[];

export interface PropOptions<T=any> {
  type?: Prop<T> | Prop<T>[];
  required?: boolean;
  default?: T | null | undefined | (() => object);
  validator?(value: T): boolean;
}

可知 Prop type 可以以兩種不同方式出現(xiàn):

  • 含有一個調(diào)用簽名的范型 type,該簽名返回 T;
  • 一個范型構(gòu)造函數(shù)簽名,該函數(shù)創(chuàng)建指定類型 T 對象 (返回值 T & object 用于降低優(yōu)先級,當(dāng)兩種方式同時滿足時取第一種,其次它還可以用于標(biāo)記構(gòu)造函數(shù)不應(yīng)該返回原始類型)。

當(dāng)我們指定 type 類型為 String/Number/Boolean/Array/Object/Date/Function/Symbol 等原生構(gòu)造函數(shù)時,Prop<T> 會返回它們各自簽名的返回值。

當(dāng) type 類型為 String 構(gòu)造函數(shù)時,它的調(diào)用簽名返回為 string:

// lib.es5.d.ts
interface StringConstructor {
  new(value?: any): String;
  (value?: any): string;
  readonly prototype: String;
  fromCharCode(...codes: number[]): string;
}

而這也是上文中,當(dāng)指定 type 類型為 Object 構(gòu)造函數(shù)時,經(jīng)過 Vue 的聲明文件處理,TypeScript 推斷出為 any 類型的原因:

interface ObjectConstructor {
  new(value?: any): Object;
  (): any;
  (value: any): any;
  // 其它屬性 ....
}

類似的,當(dāng)我們使用關(guān)鍵字 as 斷言 Object 為 () => User 時,它能推斷出為 User 。

從 type 第二部分可知,除傳入原生構(gòu)造函數(shù)外,我們還可傳入自定義類:

image

此外,這里有個 PR 暴露一個更直觀的類型( Vue 2.6 版本才可以用):

props: {
  testProp: Object as PropTypes<{ test: boolean }>
}

vue-class-component

得益于 vue-propperty-decorator Prop 修飾器,當(dāng)給 Prop 增加類型推斷時,這些將變得簡單:

import { Component, Vue, Prop } from 'vue-property-decorator'

@Component
export default class Test extends Vue {
  @Prop({ type: Object })
  private test: { value: string }
}

當(dāng)我們在組件內(nèi)訪問 test 時,便能獲取它正確的類型信息。

mixins

mixins 是一種分發(fā) Vue 組件中可復(fù)用功能的一種方式。當(dāng)在 TypeScript 中使用它時,我們希望得到有關(guān)于 mixins 的類型信息。

當(dāng)你使用 Vue.extends() 時,這有點(diǎn)困難,它并不能推斷出 mixins 里的類型:

// ExampleMixin.vue
export default Vue.extend({
  data () {
    return {
      testValue: 'test'
    }
  }
})

// other.vue
export default Vue.extend({
  mixins: [ExampleMixin],
  created () {
    this.testValue // error, testValue 不存在!
  }
})

我們需要稍作修改:

// other.vue
export default ExampleMixin.extend({
  mixins: [ExampleMixin],
  created () {
    this.testValue // 編譯通過
  }
})

但這會存在一個問題,當(dāng)使用多個 mixins 且推斷出類型時,這將無法工作。而在這個 Issuse 中官方也明確表示,這無法被修改。

使用 vue-class-component 這會方便很多:

// ExampleMixin.vue
import Vue from 'vue'
import Component from 'vue-class-component'

@Component
export class ExampleMixin extends Vue {
  public testValue = 'test'
}

// other.vue
import Component, { mixins } from 'vue-class-component'
import ExampleMixin from 'ExampleMixin.vue'

@Component({
  components: {
    ExampleMixin
  }
})
export class MyComp extends mixins(ExampleMixin) {
  created () {
    console.log(this.testValue) // 編譯通過
  }
}

也支持可以傳入多個 mixins。

一些其它

做為 Vue 中最正統(tǒng)的方法(與標(biāo)準(zhǔn)形式最為接近),Vue.extends() 有著自己的優(yōu)勢,在 VScode Vetur 插件輔助下,它能正確提示子組件上的 Props:

image

而類做為 TypeScript 特殊的存在(它既可以作為類型,也可以作為值),當(dāng)我們使用 vue-class-component 并通過 $refs 綁定為子類組件時,便能獲取子組件上暴露的類型信息:

image

導(dǎo)入 .vue 時,為什么會報錯?

當(dāng)你在 Vue 中使用 TypeScript 時,所遇到的第一個問題即是在 ts 文件中找不到 .vue 文件,即使你所寫的路徑并沒有問題:

image

在 TypeScript 中,它僅識別 js/ts/jsx/tsx 文件,為了讓它識別 .vue 文件,我們需要顯式告訴 TypeScript,vue 文件存在,并且指定導(dǎo)出 VueConstructor:

declare module '*.vue' {
  import Vue from 'vue'
  export default Vue
}

但是,這引起了另一個問題,當(dāng)我們導(dǎo)入一個并不存在的 .vue 文件時,也能通過編譯:

image

是的,這在情理之中。

當(dāng)我嘗試在 .vue 文件中導(dǎo)入已存在或者不存在的 .vue 文件時,卻得到不同的結(jié)果:

文件不存在時:

image

文件存在時:

image

文件不存在時,引用 Vue 的聲明文件。文件存在時,引用正確的文件定義。

這讓人很困惑,而這些都是 Vetur 的功勞。

在這個 PR 下,我找到相關(guān)解答:這個 PR 里,Vetur 提供解析其他 .vue 文件的功能,以便能獲取正確的信息,當(dāng) .vue 文件不存在時,會讀取 .d.ts 里的信息。

參考

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,835評論 6 534
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,676評論 3 419
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,730評論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,118評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,873評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,266評論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,330評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,482評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,036評論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,846評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,025評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,575評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,279評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,684評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,953評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,751評論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,016評論 2 375

推薦閱讀更多精彩內(nèi)容