TypeScript 清洁代码实践指南 - 来自 lcomment/development-recipes 的经验总结
2025-06-25 09:54:25作者:霍妲思
前言
在软件开发中,编写可维护、可读性高的代码是每个开发者都应该追求的目标。本文将基于 lcomment/development-recipes 项目中的 TypeScript 清洁代码实践,分享一些实用的编码规范和技巧。
变量命名规范
命名风格统一
在团队协作中,保持一致的命名风格至关重要。TypeScript 社区通常推荐以下风格:
- camelCase:变量和函数命名(如
userName
) - PascalCase:类和类型命名(如
UserProfile
) - UPPER_CASE:常量命名(如
MAX_COUNT
)
有意义的变量名
// 不好的实践
const d = 86400000; // 这个数字代表什么?
// 好的实践
const MILLISECONDS_IN_A_DAY = 24 * 60 * 60 * 1000;
关键点:
- 避免使用魔法数字
- 变量名应能清晰表达其用途
- 使用可搜索的名称(避免缩写除非是广泛认可的)
枚举(Enum)的最佳实践
TypeScript 的枚举类型非常适合为一组相关常量提供有意义的名称:
enum MediaType {
VIDEO = "video",
AUDIO = "audio",
IMAGE = "image"
}
function processMedia(mediaType: MediaType) {
switch(mediaType) {
case MediaType.VIDEO:
// 处理视频逻辑
break;
case MediaType.AUDIO:
// 处理音频逻辑
break;
}
}
优势:
- 提高代码可读性
- 减少拼写错误
- 便于类型检查
函数设计原则
单一职责原则
每个函数应该只做一件事,并且做好这件事:
// 不好的实践:函数做太多事情
function processUserData(user: User) {
validateUser(user);
saveToDatabase(user);
sendWelcomeEmail(user);
updateAnalytics(user);
}
// 好的实践:拆分职责
function handleNewUserRegistration(user: User) {
validateUser(user);
const savedUser = saveUserToDatabase(user);
notifyUser(savedUser);
trackRegistration(savedUser);
}
参数处理技巧
- 限制参数数量:理想情况下不超过2个参数
- 使用对象参数:当需要多个参数时
// 不好的实践:多个参数
function createPost(title: string, content: string, author: string, date: Date, tags: string[]) {
// ...
}
// 好的实践:使用参数对象
interface PostOptions {
title: string;
content: string;
author: string;
date: Date;
tags: string[];
}
function createPost(options: PostOptions) {
// ...
}
- 默认参数:简化条件判断
// 不好的实践
function fetchData(limit?: number) {
const actualLimit = limit !== undefined ? limit : 10;
// ...
}
// 好的实践
function fetchData(limit: number = 10) {
// ...
}
类设计原则
单一职责原则(SRP)
一个类应该只有一个引起它变化的原因:
// 不好的实践:承担太多职责
class UserManager {
authenticate() { /*...*/ }
sendEmail() { /*...*/ }
logActivity() { /*...*/ }
generateReport() { /*...*/ }
}
// 好的实践:职责分离
class Authenticator {
authenticate() { /*...*/ }
}
class Notifier {
sendEmail() { /*...*/ }
}
class ActivityLogger {
logActivity() { /*...*/ }
}
class ReportGenerator {
generateReport() { /*...*/ }
}
高内聚低耦合
高内聚:类的方法应该主要操作类的属性 低耦合:类之间的依赖应该最小化
// 不好的实践:低内聚高耦合
class OrderProcessor {
constructor(
private db: Database,
private emailService: EmailService,
private paymentGateway: PaymentGateway
) {}
processOrder() {
// 处理订单逻辑
// 发送邮件
// 处理支付
}
}
// 好的实践:高内聚低耦合
class OrderService {
constructor(private db: Database) {}
processOrder() {
// 只处理订单核心逻辑
}
}
class NotificationService {
constructor(private emailService: EmailService) {}
sendOrderConfirmation() {
// 处理邮件发送
}
}
class PaymentService {
constructor(private paymentGateway: PaymentGateway) {}
processPayment() {
// 处理支付逻辑
}
}
避免代码重复
重复代码是维护的噩梦,遵循DRY(Don't Repeat Yourself)原则:
// 不好的实践:重复逻辑
function calculateTotal(items: Item[]) {
let total = 0;
for (const item of items) {
total += item.price * item.quantity;
}
return total;
}
function calculateTax(items: Item[]) {
let subtotal = 0;
for (const item of items) {
subtotal += item.price * item.quantity;
}
return subtotal * 0.1;
}
// 好的实践:提取公共逻辑
function calculateSubtotal(items: Item[]) {
return items.reduce((sum, item) => sum + item.price * item.quantity, 0);
}
function calculateTotal(items: Item[]) {
return calculateSubtotal(items);
}
function calculateTax(items: Item[]) {
return calculateSubtotal(items) * 0.1;
}
总结
编写清洁的TypeScript代码需要遵循以下核心原则:
- 命名清晰:使用有意义的名称,保持风格一致
- 函数精简:单一职责,参数简洁
- 类设计合理:高内聚低耦合,职责单一
- 避免重复:遵循DRY原则
- 合理使用类型系统:充分利用TypeScript的类型特性
通过实践这些原则,你的代码将变得更易读、更易维护,团队协作效率也会显著提高。记住,清洁代码不是一次性的工作,而是需要持续关注和改进的过程。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0266cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
1.92 K

deepin linux kernel
C
22
6

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
192
274

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
929
553

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
422
392

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
65

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8