前言
最近,在开发一个组件库时,我注意到使用TypeScript表示出了抵触情绪,常常抱怨说:“TypeScript太麻烦了,我们不想用!”起初,我对此感到困惑:TypeScript真的有那么麻烦吗?然而,当我抽时间审查队伍的代码时,我终于发现了问题所在。在这篇文章中,我想和大家分享我的一些发现和解决方案。
一、类型复用不足
在代码审查过程中,我发现了大量的重复类型定义,这显著降低了代码的复用性。
进一步交流后,我了解到许多团队成员并不清楚如何在TypeScript中复用类型。TypeScript允许我们使用type和interface来定义类型。
当我询问他们type与interface之间的区别时,大多数人都表示不清楚,这也就难怪他们不知道如何有效地复用类型了。
type定义的类型可以通过交叉类型(&)来进行复用,而interface定义的类型则可以通过继承(extends)来实现复用。值得注意的是,type和interface定义的类型也可以互相复用。下面是一些简单的示例:
复用type定义的类型:
type Point = { x: number; y: number; }; type Coordinate = Point & { z: number; };
复用interface定义的类型:
interface Point { x: number; y: number; }; interface Coordinate extends Point { z: number; }
interface复用type定义的类型:
type Point = { x: number; y: number; }; interface Coordinate extends Point { z: number; }
type复用interface定义的类型:
interface Point { x: number; y: number; }; type Coordinate = Point & { z: number; };
二、复用时只会新增属性的定义
我还注意到,在类型复用时,团队成员往往只是简单地为已有类型新增属性,而忽略了更高效的复用方式。
例如,有一个已有的类型Props需要复用,但不需要其中的属性c。在这种情况下,团队成员会重新定义Props1,仅包含Props中的属性a和b,同时添加新属性e。
interface Props { a: string; b: string; c: string; } interface Props1 { a: string; b: string; e: string; }
实际上,我们可以利用TypeScript提供的工具类型Omit来更高效地实现这种复用。
interface Props { a: string; b: string; c: string; } interface Props1 extends Omit<Props, 'c'> { e: string; }
类似地,工具类型Pick也可以用于实现此类复用。
interface Props { a: string; b: string; c: string; } interface Props1 extends Pick<Props, 'a' | 'b'> { e: string; }
Omit和Pick分别用于排除和选择类型中的属性,具体使用哪一个取决于具体需求。
三、未统一使用组件库的基础类型
在开发组件库时,我们经常面临相似功能组件属性命名不一致的问题,这不仅影响了组件库的易用性,也降低了其可维护性。
为了解决这一问题,定义一套统一的基础类型至关重要。这套基础类型为组件库的开发提供了坚实的基础,确保了所有组件在命名上的一致性。
以表单控件为例,我们可以定义如下基础类型:
import { CSSProperties } from 'react'; type Size = 'small' | 'middle' | 'large'; interface BaseProps<T> { className?: string; style?: CSSProperties; visible?: boolean; size?: Size; disabled?: boolean; readOnly?: boolean; defaultValue?: T; value?: T; onChange: (value: T) => void; }
基于这些基础类型,定义具体组件的属性类型变得简单而直接:
interface WInputProps extends BaseProps<string> { maxLength?: number; showCount?: boolean; }
通过使用type关键字定义基础类型,我们可以避免类型被意外修改,进而增强代码的稳定性和可维护性。
四、处理含有不同类型元素的数组
在审查自定义Hook时,我发现团队成员倾向于返回对象,即使Hook只返回两个值。
虽然这样做并非错误,但它违背了自定义Hook的一个常见规范:当Hook返回两个值时,应使用数组返回。
团队成员解释说,他们不知道如何定义含有不同类型元素的数组,通常会选择使用any[],但这会带来类型安全问题,因此他们选择返回对象。
实际上,元组是处理这种情况的理想选择。通过元组,我们可以在一个数组中包含不同类型的元素,同时保持每个元素类型的明确性。
function useMyHook(): [string, number] { return ['示例文本', 42]; } function MyComponent() { const [text, number] = useMyHook(); console.log(text); // 输出字符串 console.log(number); // 输出数字 return null; }
在这个例子中,useMyHook函数返回一个明确类型的元组,包含一个string和一个number。在MyComponent组件中使用这个Hook时,我们可以通过解构赋值来获取这两个不同类型的值,同时保持类型安全。
五、处理参数数量和类型不固定的函数
审查团队成员封装的函数时,我发现当函数的参数数量不固定、类型不同或返回值类型不同时,他们倾向于使用any定义参数和返回值。
他们解释说,他们只知道如何定义参数数量固定、类型相同的函数,对于复杂情况则不知所措,而且不愿意将函数拆分为多个函数。
这正是函数重载发挥作用的场景。通过函数重载,我们可以在同一函数名下定义多个函数实现,根据不同的参数类型、数量或返回类型进行区分。
function greet(name: string): string; function greet(age: number): string; function greet(value: any): string { if (typeof value === "string") { return `Hello, ${value}`; } else if (typeof value === "number") { return `You are ${value} years old`; } }
在这个例子中,我们为greet函数提供了两种调用方式,使得函数使用更加灵活,同时保持类型安全。
对于箭头函数,虽然它们不直接支持函数重载,但我们可以通过定义函数签名的方式来实现类似的效果。
e GreetFunction = { (name: string): string; (age: number): string; }; const greet: GreetFunction = (value: any): string => { if (typeof value === "string") { return `Hello, ${value}`; } else if (typeof value === "number") { return `You are ${value} years old.`; } return ''; };
这种方法利用了类型系统来提供编译时的类型检查,模拟了函数重载的效果。
六、组件属性定义:使用type还是interface?
在审查代码时,我发现团队成员在定义组件属性时既使用type也使用interface。
询问原因时,他们表示两者都可以用于定义组件属性,没有明显区别。
由于同名接口会自动合并,而同名类型别名会冲突,我推荐使用interface定义组件属性。这样,使用者可以通过declare module语句自由扩展组件属性,增强了代码的灵活性和可扩展性。
interface UserInfo { name: string; } interface UserInfo { age: number; } const userInfo: UserInfo = { name: "张三", age: 23 };
结语
TypeScript的使用并不困难,关键在于理解和应用其提供的强大功能。如果你在使用TypeScript过程中遇到任何问题,不清楚应该使用哪种语法或技巧来解决,欢迎在评论区留言。