20 个编写清晰高效的 TypeScript 代码的技巧-51CTO.COM

编写干净、清晰且高效的 TypeScript 代码对于维护可扩展和可维护的代码库至关重要。

今天这篇文章将与您分享20个实用技巧的代码示例，以帮助您提高 TypeScript 开发技能并生成高质量的代码。

1.使用显式类型而不是“any”

尽可能避免使用 any 类型，因为它会破坏 TypeScript 的优势。相反，显式定义变量、函数和参数的类型。

这样做：

function add(a: number, b: number): number { return a + b;}1.

而不是这个：

function add(a: any, b: any): any { return a + b;}1.

2. 在 tsconfig.json 中启用“严格”模式

启用“严格”模式可确保 TypeScript 执行广泛的类型检查，从而在开发过程的早期捕获潜在的错误。

{ “compilerOptions”: { “strict”: true }}1.

3.使用只读数组

利用只读来防止对对象和数组的意外修改。

这样做：

const person: Readonly<{ name: string; age: number }> = { name: 
'Alice', age: 30 };person.age = 31; // Error: Cannot assign to 'age' because it 
is a read-only propertyconst numbers: ReadonlyArray = [1, 2, 
3];numbers.push(4); // Error: Property 'push' does not exist on type 'readonly 
number[]'1.
2.
3.
4.
5.

而不是这个：

const person = { name: 'Alice', age: 30 };person.age = 31; // Allowedconst 
numbers = [1, 2, 3];numbers.push(4); // Allowed1.
2.

4. 使用解构来提取属性

解构可以使您的代码更简洁、更易于阅读。

这样做：

function printPersonDetails({ name, age }: { name: string; age: number }) { 
console.log(`Name: ${name}, Age: ${age}`);}1.
2.

而不是这个：

function printPersonDetails(person: { name: string; age: number }) { 
console.log(`Name: ${person.name}, Age: ${person.age}`);}1.
2.

5. 数组泛型优于类型转换

使用数组泛型来指定数组中元素的类型，而不是类型转换。

这样做：

const numbers: Array = [1, 2, 3];const firstNumber: number = 
numbers[0];1.
2.

而不是这个：

const numbers: any[] = [1, 2, 3];const firstNumber: number = numbers[0] as 
number;1.
2.

6. 使用枚举作为常量

使用枚举来表示一组相关常量，以提高代码的可读性和可维护性。

这样做：

enum Fruit { APPLE = 'apple', BANANA = 'banana', ORANGE = 'orange',}1.

而不是这个：

const FRUIT_APPLE = 'apple';const FRUIT_BANANA = 'banana';const FRUIT_ORANGE 
= 'orange';1.
2.

7. 对于对象形状，优先选择接口而不是类型别名

在定义对象的形状时使用接口来利用其可扩展性。

这样做：

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

而不是这个：

type Person = { name: string; age: number;};1.

8. 对可配置对象使用可选属性

在接口中使用可选属性可以在配置对象时实现灵活性。

👍这样做：

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

而不是这个：

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

9. 使用 TypeScript 的实用类型

利用 TypeScript 的内置实用程序类型(例如 Partial、Pick 和 Omit)来避免不必要的重复并简化代码。

interface Person { name: string; age: number; address: string;}type 
PartialPerson = Partial; // Makes all properties optionaltype PersonName 
= Pick; // Extracts a subset of propertiestype PersonWithoutAge 
= Omit; // Removes a property1.
2.
3.
4.

10. 对多种可能的类型使用联合类型

使用联合类型指定一个变量可以保存多种类型的值。

这样做：

function formatInput(input: string | number) { return `Input: ${input}`;}1.

而不是这个：

function formatInput(input: string | number) { return `Input: ${input}`;}1.

11.利用交叉类型来组合类型

使用交集类型将多种类型合并为单一类型。

这样做：

interface Shape { color: string;}interface Circle { radius: number;}interface 
Rectangle { width: number; height: number;}type RedCircle = Shape & 
Circle;type RedRectangle = Shape & Rectangle;const redCircle: RedCircle = { 
color: 'red', radius: 5 };const redRectangle: RedRectangle = { color: 'red', 
width: 10, height: 20 };1.
2.
3.
4.
5.

而不是这个：

interface Employee { name: string; age: number;}interface Manager { teamSize: 
number;}type EmployeeManager = Employee & Manager;const employee: 
EmployeeManager = { name: 'John Doe', age: 30, teamSize: 5 };1.
2.
3.

12. 使用类型保护进行类型断言

使用类型保护来缩小条件块中变量的类型范围。

这样做：

function formatValue(value: string | number): string { if (typeof value === 
'number') { return value.toFixed(2); } else if (typeof value === 'string') { 
return value.toUpperCase(); } else { throw new Error('Invalid value'); }}1.
2.
3.

而不是这个：

function processValue(value: string | number): string { if (typeof value === 
'number') { return value.toFixed(2); } else { return value.toUpperCase(); }}1.
2.

13.更喜欢函数式编程技术

利用函数式编程技术(例如不变性和纯函数)来提高代码清晰度并减少副作用。

这样做：

const sum = Array.from({ length: 10 }, (_, i) => i + 1).reduce((acc, val) 
=> acc + val, 0);1.
2.

而不是这个：

let sum = 0;for (let i = 1; i <= 10; i++) { sum += i;}1.

14. 使用空合并运算符 (??)

空值合并运算符 (??) 提供了一种处理空值或未定义值的简洁方法。

这样做：

const defaultValue = value ?? 'Default';1.

而不是这个：

const defaultValue = value !== null && value !== undefined ? value : 
'Default';1.
2.

15. 使用可选链接 (?.)

可选链接 (?.) 简化了对可能未定义或为 null 的对象属性的访问。

这样做：

const username = user?.profile?.name;1.

而不是这个：

const username = user && user.profile && 
user.profile.name;1.
2.

16.杠杆类型推断

利用 TypeScript 的类型推断功能来避免冗余的类型注释。

这样做：

const name = 'Alice';1.

而不是这个：

const name: string = 'Alice';1.

17.避免深层嵌套

利用 TypeScript 的类型推断功能来避免冗余的类型注释。

这样做：

function process() { // Code}if (condition1 && condition2 && 
condition3) { process();}1.
2.

而不是这个：

if (condition1) { if (condition2) { if (condition3) { // Code } }}1.

18.遵循一致的命名约定

遵守变量、函数和类的一致命名约定，以提高代码的可读性。使用传达实体目的的描述性名称。

19.模块化你的代码

将代码分解为更小的模块，每个模块负责特定的功能。这提高了可重用性和可维护性。

20.写下清晰简洁的评论

添加注释来解释复杂的算法、重要的决策或边缘情况。避免仅仅重述代码的过多注释。

总结

编写清晰高效的 TypeScript 代码需要练习、注重细节并遵守最佳实践。本文分享的20个技巧，将能够帮助您生成更易于理解、维护和扩展的高质量代码。最后，祝编程快乐!