使用 Type 還是 Interface？

有幾種常用規(guī)則：

• 在定義公共 API 時(shí)(比如編輯一個(gè)庫(kù)）使用 interface，這樣可以方便使用者繼承接口
• 在定義組件屬性（Props）和狀態(tài)（State）時(shí)，建議使用 type，因?yàn)?nbsp;type的約束性更強(qiáng)

interface 和 type 在 ts 中是兩個(gè)不同的概念，但在 React 大部分使用的 case 中，interface 和 type 可以達(dá)到相同的功能效果，type 和 interface 最大的區(qū)別是：

• type 類型不能二次編輯，而 interface 可以隨時(shí)擴(kuò)展

interface Animal {
  name: string
}

// 可以繼續(xù)在原有屬性基礎(chǔ)上，添加新屬性：color
interface Animal {
  color: string
}
/********************************/
type Animal = {
  name: string
}
// type類型不支持屬性擴(kuò)展
// Error: Duplicate identifier 'Animal'
type Animal = {
  color: string
}

獲取未導(dǎo)出的 Type

某些場(chǎng)景下我們?cè)谝氲谌降膸?kù)時(shí)會(huì)發(fā)現(xiàn)想要使用的組件并沒有導(dǎo)出我們需要的組件參數(shù)類型或者返回值類型，這時(shí)候我們可以通過(guò) ComponentProps/ ReturnType 來(lái)獲取到想要的類型。

// 獲取參數(shù)類型
import { Button } from 'library' // 但是未導(dǎo)出props type
type ButtonProps = React.ComponentProps<typeof Button> // 獲取props
type AlertButtonProps = Omit<ButtonProps, 'onClick'> // 去除onClick
const AlertButton: React.FC<AlertButtonProps> = props => (
  <Button onClick={() => alert('hello')} {...props} />
)

// 獲取返回值類型
function foo() {
  return { baz: 1 }
}
type FooReturn = ReturnType<typeof foo> // { baz: number }

Props

通常我們使用 type 來(lái)定義 Props，為了提高可維護(hù)性和代碼可讀性，在日常的開發(fā)過(guò)程中我們希望可以添加清晰的注釋。

現(xiàn)在有這樣一個(gè) type

type OtherProps = {
  name: string
  color: string
}

在使用的過(guò)程中，hover 對(duì)應(yīng)類型會(huì)有如下展示

// type OtherProps = {
//   name: string;
//   color: string;
// }
const OtherHeading: React.FC<OtherProps> = ({ name, color }) => (
  <h1>My Website Heading</h1>
)

增加相對(duì)詳細(xì)的注釋，使用時(shí)會(huì)更清晰，需要注意，注釋需要使用 /**/ ， // 無(wú)法被 vscode 識(shí)別

// Great
/**
 * @param color color
 * @param children children
 * @param onClick onClick
 */

type Props = {
  /** color */
  color?: string
  /** children */
  children: React.ReactNode
  /** onClick */
  onClick: () => void
}

// type Props
// @param color — color
// @param children — children
// @param onClick — onClick
const Button: React.FC<Props> = ({ children, color = 'tomato', onClick }) => {
  return (
    <button style={{ backgroundColor: color }} onClick={onClick}>
      {children}
    </button>
  )
}

常用 Props ts 類型

基礎(chǔ)屬性類型

type AppProps = {
  message: string
  count: number
  disabled: boolean
  /** array of a type! */
  names: string[]
  /** string literals to specify exact string values, with a union type to join them together */
  status: 'waiting' | 'success'
  /** 任意需要使用其屬性的對(duì)象（不推薦使用，但是作為占位很有用） */
  obj: object
  /** 作用和`object`幾乎一樣，和 `Object`完全一樣 */
  obj2: {}
  /** 列出對(duì)象全部數(shù)量的屬性 （推薦使用） */
  obj3: {
    id: string
    title: string
  }
  /** array of objects! (common) */
  objArr: {
    id: string
    title: string
  }[]
  /** 任意數(shù)量屬性的字典，具有相同類型*/
  dict1: {
    [key: string]: MyTypeHere
  }
  /** 作用和dict1完全相同 */
  dict2: Record<string, MyTypeHere>
  /** 任意完全不會(huì)調(diào)用的函數(shù) */
  onSomething: Function
  /** 沒有參數(shù)&返回值的函數(shù) */
  onClick: () => void
  /** 攜帶參數(shù)的函數(shù) */
  onChange: (id: number) => void
  /** 攜帶點(diǎn)擊事件的函數(shù) */
  onClick(event: React.MouseEvent<HTMLButtonElement>): void
  /** 可選的屬性 */
  optional?: OptionalType
}

常用 React 屬性類型

export declare interface AppBetterProps {
  children: React.ReactNode // 一般情況下推薦使用，支持所有類型 Great
  functionChildren: (name: string) => React.ReactNode
  style?: React.cssProperties // 傳遞style對(duì)象
  onChange?: React.FormEventHandler<HTMLInputElement>
}

export declare interface AppProps {
  children1: JSX.Element // 差, 不支持?jǐn)?shù)組
  children2: JSX.Element | JSX.Element[] // 一般, 不支持字符串
  children3: React.ReactChildren // 忽略命名，不是一個(gè)合適的類型，工具類類型
  children4: React.ReactChild[] // 很好
  children: React.ReactNode // 最佳，支持所有類型 推薦使用
  functionChildren: (name: string) => React.ReactNode // recommended function as a child render prop type
  style?: React.CSSProperties // 傳遞style對(duì)象
  onChange?: React.FormEventHandler<HTMLInputElement> // 表單事件, 泛型參數(shù)是event.target的類型
}

Forms and Events

onChange

change 事件，有兩個(gè)定義參數(shù)類型的方法。

第一種方法使用推斷的方法簽名（例如：React.FormEvent <HTMLInputElement> ：void）

import * as React from 'react'

type changeFn = (e: React.FormEvent<HTMLInputElement>) => void
const App: React.FC = () => {
  const [state, setState] = React.useState('')
  const onChange: changeFn = e => {
    setState(e.currentTarget.value)
  }
  return (
    <div>
      <input type="text" value={state} onChange={onChange} />
    </div>
  )
}

第二種方法強(qiáng)制使用 @types / react 提供的委托類型，兩種方法均可。

import * as React from 'react'
const App: React.FC = () => {
  const [state, setState] = React.useState('')
  const onChange: React.ChangeEventHandler<HTMLInputElement> = e => {
    setState(e.currentTarget.value)
  }
  return (
    <div>
      <input type="text" value={state} onChange={onChange} />
    </div>
  )
}

onSubmit

如果不太關(guān)心事件的類型，可以直接使用 React.SyntheticEvent，如果目標(biāo)表單有想要訪問(wèn)的自定義命名輸入，可以使用類型擴(kuò)展

import * as React from 'react'

const App: React.FC = () => {
  const onSubmit = (e: React.SyntheticEvent) => {
    e.preventDefault()
    const target = e.target as typeof e.target & {
      password: { value: string }
    } // 類型擴(kuò)展
    const password = target.password.value
  }
  return (
    <form onSubmit={onSubmit}>
      <div>
        <label>
          Password:
          <input type="password" name="password" />
        </label>
      </div>
      <div>
        <input type="submit" value="Log in" />
      </div>
    </form>
  )
}

Operators

常用的操作符，常用于類型判斷

• typeof and instanceof: 用于類型區(qū)分

• keyof: 獲取 object 的 key
• O[K]: 屬性查找
• [K in O]: 映射類型
• + or - or readonly or ?: 加法、減法、只讀和可選修飾符
• x ? Y : Z: 用于泛型類型、類型別名、函數(shù)參數(shù)類型的條件類型
• !: 可空類型的空斷言
• as: 類型斷言
• is: 函數(shù)返回類型的類型保護(hù)

Tips

使用查找類型訪問(wèn)組件屬性類型

通過(guò)查找類型減少 type 的非必要導(dǎo)出，如果需要提供復(fù)雜的 type，應(yīng)當(dāng)提取到作為公共 API 導(dǎo)出的文件中。

現(xiàn)在我們有一個(gè) Counter 組件，需要 name 這個(gè)必傳參數(shù)：

// counter.tsx
import * as React from 'react'
export type Props = {
  name: string
}
const Counter: React.FC<Props> = props => {
  return <></>
}
export default Counter

在其他引用它的組件中我們有兩種方式獲取到 Counter 的參數(shù)類型

第一種是通過(guò) typeof 操作符（推薦）

// Great
import Counter from './d-tips1'
type PropsNew = React.ComponentProps<typeof Counter> & {
  age: number
}
const App: React.FC<PropsNew> = props => {
  return <Counter {...props} />
}
export default App

第二種是通過(guò)在原組件進(jìn)行導(dǎo)出

import Counter, { Props } from './d-tips1'
type PropsNew = Props & {
  age: number
}
const App: React.FC<PropsNew> = props => {
  return (
    <>
      <Counter {...props} />
    </>
  )
}
export default App

不要在 type 或 interface 中使用函數(shù)聲明

保持一致性，類型/接口的所有成員都通過(guò)相同的語(yǔ)法定義。

--strictFunctionTypes 在比較函數(shù)類型時(shí)強(qiáng)制執(zhí)行更嚴(yán)格的類型檢查，但第一種聲明方式下嚴(yán)格檢查不生效。

?

interface ICounter {
  start: (value: number) => string
}

?

interface ICounter1 {
  start(value: number): string
}





interface Animal {}
interface Dog extends Animal {
  wow: () => void
}
interface Comparer<T> {
  compare: (a: T, b: T) => number
}
declare let animalComparer: Comparer<Animal>
declare let dogComparer: Comparer<Dog>
animalComparer = dogComparer // Error
dogComparer = animalComparer // Ok
interface Comparer1<T> {
  compare(a: T, b: T): number
}
declare let animalComparer1: Comparer1<Animal>
declare let dogComparer1: Comparer1<Dog>
animalComparer1 = dogComparer // Ok
dogComparer1 = animalComparer // Ok

事件處理

我們?cè)谶M(jìn)行事件注冊(cè)時(shí)經(jīng)常會(huì)在事件處理函數(shù)中使用 event 事件對(duì)象，例如當(dāng)使用鼠標(biāo)事件時(shí)我們通過(guò) clientX、clientY 去獲取指針的坐標(biāo)。

大家可能會(huì)想到直接把 event 設(shè)置為 any 類型，但是這樣就失去了我們對(duì)代碼進(jìn)行靜態(tài)檢查的意義。

function handleEvent(event: any) {、
  console.log(event.clientY)
}

試想下當(dāng)我們注冊(cè)一個(gè) Touch 事件，然后錯(cuò)誤的通過(guò)事件處理函數(shù)中的 event 對(duì)象去獲取其 clientY 屬性的值，在這里我們已經(jīng)將 event 設(shè)置為 any 類型，導(dǎo)致 TypeScript 在編譯時(shí)并不會(huì)提示我們錯(cuò)誤， 當(dāng)我們通過(guò) event.clientY 訪問(wèn)時(shí)就有問(wèn)題了，因?yàn)?nbsp;Touch 事件的 event 對(duì)象并沒有 clientY 這個(gè)屬性。

通過(guò) interface 對(duì) event 對(duì)象進(jìn)行類型聲明編寫的話又十分浪費(fèi)時(shí)間，幸運(yùn)的是 React 的聲明文件提供了 Event 對(duì)象的類型聲明。

Event 事件對(duì)象類型

• ClipboardEvent<T = Element> 剪切板事件對(duì)象

• DragEvent<T =Element> 拖拽事件對(duì)象
• ChangeEvent<T = Element> Change 事件對(duì)象
• KeyboardEvent<T = Element> 鍵盤事件對(duì)象
• MouseEvent<T = Element> 鼠標(biāo)事件對(duì)象
• TouchEvent<T = Element> 觸摸事件對(duì)象
• WheelEvent<T = Element> 滾輪時(shí)間對(duì)象
• AnimationEvent<T = Element> 動(dòng)畫事件對(duì)象
• TransitionEvent<T = Element> 過(guò)渡事件對(duì)象

事件處理函數(shù)類型

當(dāng)我們定義事件處理函數(shù)時(shí)有沒有更方便定義其函數(shù)類型的方式呢？答案是使用 React 聲明文件所提供的 EventHandler 類型別名，通過(guò)不同事件的 EventHandler 的類型別名來(lái)定義事件處理函數(shù)的類型

type EventHandler<E extends React.SyntheticEvent<any>> = {
  bivarianceHack(event: E): void
}['bivarianceHack']
type ReactEventHandler<T = Element> = EventHandler<React.SyntheticEvent<T>>
type ClipboardEventHandler<T = Element> = EventHandler<React.ClipboardEvent<T>>
type DragEventHandler<T = Element> = EventHandler<React.DragEvent<T>>
type FocusEventHandler<T = Element> = EventHandler<React.FocusEvent<T>>
type FormEventHandler<T = Element> = EventHandler<React.FormEvent<T>>
type ChangeEventHandler<T = Element> = EventHandler<React.ChangeEvent<T>>
type KeyboardEventHandler<T = Element> = EventHandler<React.KeyboardEvent<T>>
type MouseEventHandler<T = Element> = EventHandler<React.MouseEvent<T>>
type TouchEventHandler<T = Element> = EventHandler<React.TouchEvent<T>>
type PointerEventHandler<T = Element> = EventHandler<React.PointerEvent<T>>
type UIEventHandler<T = Element> = EventHandler<React.UIEvent<T>>
type WheelEventHandler<T = Element> = EventHandler<React.WheelEvent<T>>
type AnimationEventHandler<T = Element> = EventHandler<React.AnimationEvent<T>>
type TransitionEventHandler<T = Element> = EventHandler<
  React.TransitionEvent<T>
>

bivarianceHack 為事件處理函數(shù)的類型定義，函數(shù)接收一個(gè) event 對(duì)象，并且其類型為接收到的泛型變量 E 的類型, 返回值為 void

關(guān)于為何是用 bivarianceHack 而不是(event: E): void，這與 strictfunctionTypes 選項(xiàng)下的功能兼容性有關(guān)。(event: E): void，如果該參數(shù)是派生類型，則不能將其傳遞給參數(shù)是基類的函數(shù)。

class Animal {
  private x: undefined
}
class Dog extends Animal {
  private d: undefined
}
type EventHandler<E extends Animal> = (event: E) => void
let z: EventHandler<Animal> = (o: Dog) => {} // fails under strictFunctionTyes
type BivariantEventHandler<E extends Animal> = {
  bivarianceHack(event: E): void
}['bivarianceHack']
let y: BivariantEventHandler<Animal> = (o: Dog) => {}

Promise 類型

在做異步操作時(shí)我們經(jīng)常使用 async 函數(shù)，函數(shù)調(diào)用時(shí)會(huì) return 一個(gè) Promise 對(duì)象，可以使用 then 方法添加回調(diào)函數(shù)。Promise<T> 是一個(gè)泛型類型，T 泛型變量用于確定 then 方法時(shí)接收的第一個(gè)回調(diào)函數(shù)的參數(shù)類型。

type IResponse<T> = {
  message: string
  result: T
  success: boolean
}
async function getResponse(): Promise<IResponse<number[]>> {
  return {
    message: '獲取成功',
    result: [1, 2, 3],
    success: true,
  }
}

getResponse().then(response => {
  console.log(response.result)
})

首先聲明 IResponse 的泛型接口用于定義 response 的類型，通過(guò) T 泛型變量來(lái)確定 result 的類型。然后聲明了一個(gè) 異步函數(shù) getResponse 并且將函數(shù)返回值的類型定義為 Promise<IResponse<number[]>> 。最后調(diào)用 getResponse 方法會(huì)返回一個(gè) promise 類型，通過(guò) then 調(diào)用，此時(shí) then 方法接收的第一個(gè)回調(diào)函數(shù)的參數(shù) response 的類型為，{ message: string, result: number[], success: boolean} 。

泛型參數(shù)的組件

下面這個(gè)組件的 name 屬性都是指定了傳參格式，如果想不指定，而是想通過(guò)傳入?yún)?shù)的類型去推導(dǎo)實(shí)際類型，這就要用到泛型。

const TestB = ({ name, name2 }: { name: string; name2?: string }) => {
  return (
    <div className="test-b">
      TestB--{name}
      {name2}
    </div>
  )
}

如果需要外部傳入?yún)?shù)類型，只需 ->

type Props<T> = {
  name: T
  name2?: T
}
const TestC: <T>(props: Props<T>) => React.ReactElement = ({ name, name2 }) => {
  return (
    <div className="test-b">
      TestB--{name}
      {name2}
    </div>
  )
}

const TestD = () => {
  return (
    <div>
      <TestC<string> name="123" />
    </div>
  )
}

什么時(shí)候使用泛型

當(dāng)你的函數(shù)，接口或者類：

• 需要作用到很多類型的時(shí)候，舉個(gè)

當(dāng)我們需要一個(gè) id 函數(shù)，函數(shù)的參數(shù)可以是任何值，返回值就是將參數(shù)原樣返回，并且其只能接受一個(gè)參數(shù)，在 js 時(shí)代我們會(huì)很輕易地甩出一行

const id = arg => arg

由于其可以接受任意值，也就是說(shuō)我們的函數(shù)的入?yún)⒑头祷刂刀紤?yīng)該可以是任意類型，如果不使用泛型，我們只能重復(fù)的進(jìn)行定義

type idBoolean = (arg: boolean) => boolean
type idNumber = (arg: number) => number
type idString = (arg: string) => string
// ..

如果使用泛型，我們只需要

function id<T>(arg: T): T {
  return arg
}

// 或
const id1: <T>(arg: T) => T = arg => {
  return arg
}

• 需要被用到很多地方的時(shí)候，比如常用的工具泛型 Partial。

功能是將類型的屬性變成可選， 注意這是淺 Partial。

type Partial<T> = { [P in keyof T]?: T[P] }

如果需要深 Partial 我們可以通過(guò)泛型遞歸來(lái)實(shí)現(xiàn)

type DeepPartial<T> = T extends Function
  ? T
  : T extends object
  ? { [P in keyof T]?: DeepPartial<T[P]> }
  : T
type PartialedWindow = DeepPartial<Window>

參考資料

[1]2ality's guide: http://2ality.com/2018/04/type-notation-typescript.html

[2]chibicode's tutorial: https://ts.chibicode.com/todo/

[3]TS 部分:
https://reactjs.org/docs/static-type-checking.html#typescript

[4]React 部分:
http://www.typescriptlang.org/play/index.html?jsx=2&esModuleInterop=true&e=181#example/typescript-with-react

[5]被證明:
https://www.reddit.com/r/reactjs/comments/iyehol/import_react_from_react_will_go_away_in_distant/

[6]一些 issue:
https://github.com/DefinitelyTyped/DefinitelyTyped/issues/33006

[7]問(wèn)題:
https://github.com/babel/babel/issues/9800

[8]參考鏈接:
https://Twitter.com/hswolff/status/1133759319571345408

[9]TypeScript3.0+: https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-0.html

[10]存在一些邊界 case 仍然存在問(wèn)題:
https://github.com/typescript-cheatsheets/react-typescript-cheatsheet/issues/61

本文轉(zhuǎn)載自前端大全