每个做技术的人,都遇到过那种“看一眼就想重写”的代码。功能没问题,测试也过了,可一旦要加点需求,或者排查一个线上问题,整个人就像一头扎进了沼泽——改一个变量,牵连三个模块;查一条链路,翻遍五六个文件。越是大项目越明显,写代码一时爽,维护火葬场。我做了十多年开发,从业务系统到基础设施都碰过,一个越来越深的感受是:高质量代码的核心指标不是“写得多漂亮”,而是“改起来多省事”。 维护成本低,才是代码质量的终极检验标准。这篇内容就是围绕“高质量代码怎么写、怎么让维护成本真正降下来”展开的,不聊虚的,只讲我在真实项目里反复验证过的思路、技法,以及踩过的坑,适合刚入门的新人,也适合被遗留系统折磨得想跑路的老兵。
1. 先搞清楚一件事:维护成本到底贵在哪里
很多人一提高质量代码,第一反应就是“代码要优雅”“要符合设计模式”“要写得高端”。这个方向其实错了。优雅和高端是手段,不是目的。真正要回答的问题是:为什么同一套系统,有的团队改动一个需求要两三天,有的团队两小时就能上线?差距不在手速,而在维护成本的结构性差异。
1.1 新鲜代码和半年后的代码,是两种完全不同的东西
写代码的时候,大脑里有一张完整的地图——这个变量为什么存在,那个函数从哪里被调用,异常分支为什么这么处理,全都清清楚楚。但半年后,甚至两周后,这张地图就会模糊。你再打开一个文件,面对的是一个个孤零零的函数和字段,只有代码本身,没有你当时的思考过程。
这就是维护成本的原点:代码不是写给机器看的,机器只在乎编译结果;代码是写给下一个人类看的,而那个下一个人,往往就是三个月后的你自己。 所有降低维护成本的技巧,本质上都是围绕一件事:减少下一个人(包括未来的你)恢复“上下文”的难度。
我早期有个很痛的教训。当时做了一个订单状态机,为了赶进度,把状态流转逻辑全部塞在了一个方法里,用大量的 if-else 硬扛。当时觉得自己思路特别清晰,每个分支都记得住。结果三个月后线上出现了状态跳转异常,我打开那个方法,差点没认出来这代码是自己写的。光是把所有调用链捋清楚,就花了一个下午。从那以后我明白了一个道理:写代码时引以为傲的“心算能力”,在维护阶段一文不值。
1.2 读懂代码的隐性成本:读的时间远大于写的时间
工作里有个粗略估算:一个成熟项目里,开发者花在“读代码”上的时间是“写代码”的好几倍。读老代码、读别人的代码、读自己以前写的代码,全算进去。写一个功能可能只花两天,但为了搞清楚“在哪儿改、怎么改、改了会影响什么”,你可能需要花三天去读相关代码。
这就是为什么“可读性”不是软技能,而是实打实的生产力。你每把代码写清楚一分,未来就有无数人替你剩下一分时间。我见过有些团队追求代码行数少、看起来高大上,把一个逻辑压缩成几行链式调用,还用了很多函数式技巧。实际维护起来,每个接手的人都要在脑子里手动展开那些语法糖,花的时间比多写几行朴素的代码要多得多。
所以我在团队里定了一个不成文的规矩:任何一段代码,如果团队里最菜的开发需要超过两分钟才能看懂它在干嘛,这段代码就不合格。 这听起来苛刻,但非常有效。它会逼着你把复杂逻辑拆开、把命名改直白、把注释补清楚。
1.3 变更才是维护成本的大头,不是缺陷
还有一个认知要从根上扭转:维护成本里,修 bug 只占一小部分,真正的大头是需求变更。产品想改个规则、运营要加个渠道、合规要求调整流程,这些是永无止境的。
所以判断代码质量好不好,最直接的问题就是:来一个新需求,你要改多少个地方? 改的地方越少,说明代码的扩展性越好,维护成本越低。反之,如果一个需求要从接口层改到数据库层,改完还得同步改一堆配置,那这段代码的未来基本就是灾难。
我自己常用一个“改动点计数法”来评估一段代码的健壮度:领一个新需求,数一数需要动几个文件的几处位置。如果超过三处,我通常会停下来反思是不是设计出了问题。这方法不精确,但特别直观,能让“维护成本”这个抽象概念落地。
需要模型API调用? 免费领10W Token,多模型网关一键接入 Claude、DeepSeek 等主流模型。
2. 可读性不是锦上添花,是维护成本的地基
既然读懂代码是维护的第一大开销,那第一优先级就清楚了:把代码写“直白”,而不是写“聪明”。很多程序员觉得秀技术是本事,但在维护面前,直白往往比聪明更值钱。
2.1 命名是给未来的自己写备忘
变量名、函数名、类名,是代码里最高频的文档。如果你愿意在这上面多花30秒,未来就能给每个读代码的人节省三分钟。算下来,回报率高得吓人。
我见过太多的命名是 data、temp、flag、handleData 这种。等你需要回来看的时候,根本不知道这个 data 到底是什么数据。一个几十行的函数里出现五六个 temp,基本等于要了老命。正确姿势是想清楚这个东西“在业务上到底是什么”,然后把业务名词写进代码里。比如 unpaidOrderList、expiredSubscriptionIds,一眼就知道含义,根本不需要额外注释。
函数名的核心是“动宾结构”加“业务意图”。checkStatus() 不如 isOrderCancelable() 明确,process() 不如 applyCouponToCart() 来得清楚。命名这件事没有太多技巧,就是真诚地面对下一个读代码的人,假装他完全不知道业务逻辑,你的名字得让他直接进入状态。
2.2 函数设计:一个函数只做一件事
“一个函数只做一件事”这句话被说烂了,但真正做到的人不多。一个关键判断标准是:如果这个函数需要你用“然后”来介绍它在做什么,它就做了不止一件事。
比如一个函数叫 initOrderAndSendNotification,从名字就能看出它干了两件事——初始化订单 + 发通知。正确的拆法是把发通知的部分独立出去,让 initOrder 只关心订单初始化,通知逻辑由调用方再组合。这样以后通知渠道变了、通知模板改了,你只需要去改通知那个模块,订单逻辑完全不受影响。
函数还要控制长度。我不喜欢定死“不能超过40行”这种机械标准,但有一条经验:如果一个函数需要你上下滚动才能看完,它的逻辑就很值得怀疑。 拆分的依据不一定是长度,而是“你有没有在同一个函数里处理了不同层次的逻辑”。
举个例子,你可能在用一个函数处理“从数据库读数据 → 做业务校验 → 组装返回对象”,这三个逻辑层次不一样。任何人接手都想先看主干、再看细节,如果你把细节全部平铺在一个函数里,他就只能从第一行硬读到最后一行。拆成三层,每层一个小函数,主干读起来就像一篇提纲,细节要看再钻进去,体验完全不一样。
2.3 注释写“为什么”,不要写“是什么”
很多人写注释是在翻译代码:// 循环遍历列表,计算总和。这句话代码本身已经说了,注释再重复一遍,除了占行数没有任何价值。真正需要注释的地方是“为什么”。
比如你临时绕过了某个校验,用了 workaround,这时候必须留注释说明:为什么这么做、正常的做法是什么、什么时候可以去掉这个 workaround。三年后有个可怜人看到这段代码,就不会以为是你手误然后“好心”帮你修正,结果弄出一个线上事故。
还有那些“看起来不合理的代码”,很可能背后隐藏着业务约束或历史原因。比如“这里不能直接删记录,只能标记删除,因为下游系统会关联查询历史快照”。这种上下文信息代码里完全看不出来,你不写注释,没有第二个人知道。代码是表达“做什么”,注释是表达“为什么”,两样缺一不可。
我自己有一条经验:写注释前先看一遍代码,如果注释和代码表达的是同一个意思,就删掉注释;如果代码没法直接表达出这个原因,才值得写。另外,尽量把注释写在复杂判断/特殊处理旁边,别写在一长串逻辑的开头,方便别人精准定位。
3. 降低修改成本的三个核心技法
前面说的都是“让人读懂”的问题,但维护成本还有另一半:让人改起来安心。 一段代码读懂了却不敢改,同样会拖垮交付效率。下面这三个方向是我在项目里验证过最有用的。
3.1 用“心智负重”判断代码质量
“心智负重”是我比较喜欢的一个概念,简单说就是读这一段代码时,你需要同时在脑子里记住多少东西。
比如你在一个函数里同时操作了 A、B、C 三个状态,并且它们之间还有交叉影响,这段代码的心智负重就很高。有个很常见的例子,是到处用全局变量或共享的可变状态。函数 A 改了某个全局值,函数 B 依赖这个值做判断,你说改函数 B 的时候要不要先全局搜索一遍所有可能改这个值的地方?这种代码的心智负荷对维护者是巨大的。
降低心智负重最直接的手段是:明确数据流。 函数尽量通过参数接收输入、通过返回值输出,少用全局状态;数据流向清楚,改一个功能你只需要关心入口和出口,不用去猜中间有多少隐藏影响。
状态管理也是同一个逻辑。能用局部变量就不用成员变量,能用不可变数据就不用可变数据。写着可能麻烦一点点,但换来的是半年后改代码时“只用关心一个局部范围”的安全感。
3.2 模块化边界的划分不要凭感觉
模块化不是把代码拆成很多文件就叫模块化,核心是边界清晰:每个模块只对自己的内部负责,对外暴露最小接口。
一个很常见的反例是,有个工具类叫 Utils,什么函数都往里塞,团队里每个人都往里加过东西,最后这个类几百个方法,什么都负责,什么都说不清楚。边界不清晰,改的时候只能靠搜索关键词来定位影响范围,跨模块牵连一堆,改起来胆战心惊。
边界怎么划比较靠谱?我从实践中总结出两个原则:一是按“变化的频率”划分,二是按“依赖的方向”划分。
变化频率,指的是那些经常一起变动的代码应该放在边界内,很少变动的放到稳定层。比如业务规则经常变,消息框架很少变,那就把业务规则和消息框架解耦,不要混在一起。依赖方向,指的是模块之间的依赖尽量单向,下游模块不要反过来依赖上游。听上去像是教科书上的分层架构,但实操时常常被忽视。
举个例子,我之前接手一个老系统,“订单服务”里直接调了“库存服务”的内部方法,又反过来被“库存服务”调用,造成了循环依赖。每次上线,两边团队都要同时协调发版,一个改动影响到所有依赖链上的模块。最后我们费了不少劲把循环依赖拆掉,这件事让我深刻体会到“依赖方向”比什么都重要——你依赖的我不能依赖你,否则将来每一行改动都可能变成一场灾难。
3.3 消灭重复代码的正确姿势:不要急着抽象
DRY(Don't Repeat Yourself)原则几乎人人都知道,但很多人对它的理解就是“看到两段差不多的代码就赶紧抽成公共方法”。这个习惯如果在前期做得太急,反而会给维护挖坑。
为什么?因为“相似”不等于“相同”,更不等于“未来会一起变化”。你把两段目前看起来一样、但业务语义上没什么关系的代码强行抽成一个公共方法,一旦其中一处的需求发生改动,你改公共方法就会影响另一处;不改,公共方法里就得加 if 分支。结果一个所谓“复用”的方法,变成了长满 if 的怪物。
我现在的做法是:先容忍两三次重复,等真正看到了三次以上的重复,并且明确它们会朝同一个方向演进,才去抽象。 抽象的时候,给方法起一个“业务语义”的名字,而不是“代码形态”的名字。比如有两个方法都做了“发邮件”,但一个是通知用户订单发货,一个是通知管理员库存不足,它们未来演进方向大概率不同,那就不应该抽成一个 sendEmail(),非要抽的话也应该抽出底层的基础能力,而不是把业务逻辑捆在一起。
这里有个实用判断法:如果你打算抽出来的公共代码里有参数,专门用来区分“不同场景下的不同行为”,那基本说明抽象得不对。这往往是业务逻辑混在一起了,将来维护时每加一个场景,就要给公共方法加一个参数,然后继续改内部逻辑,最后这个公共方法变成核心维护黑洞。
4. 让Bug在进入生产前就暴露:测试策略与错误处理的务实用法
维护成本里还有一块大头:排障。代码上线后出了问题,你要在日志、监控、告警和数据中间反复拼图,有时一查就是一整天。排除已上线的故障成本极高,远高于开发阶段修复问题的成本。所以,高质量代码一定要在“让问题尽早暴露”这个方向上做足功夫。
4.1 先写测试再写功能:收益不是一时的
测试这件事,很多人觉得麻烦、觉得浪费时间,但真正进入维护期后,它是最省钱的投资。有测试兜底,改代码的时候才敢放心重构;没测试,等于每次修改都是高空走钢丝——哪怕只是改一个变量名,都可能悄悄改坏一个关联逻辑。
我采用的是实用主义的测试策略,不追求什么测试驱动开发的“神圣流程”。关键是先给核心业务逻辑写测试,尤其是那些算钱、算状态、算权限的判断。这部分逻辑一旦出错,损失是直接可见的。测试不要求覆盖每行代码,但核心路径和容易出错的分支必须有。
写测试有另一个隐藏好处:为了“可测试”,你会被动地把代码拆得合理。 如果一个函数不好测,大概率是它依赖了太多外部环境,比如直接读取全局配置、直接发起网络请求、直接查数据库。要把这些依赖都换成参数或接口注入,代码自然就解耦了。没有测试压迫着,很多代码会写成一个大泥球。
4.2 错误处理:该停就停,别吞异常
维护阶段最让人崩溃的错误处理方式有三种:一是空 catch,二是返回一个不具体的默认值,三是只打日志却继续执行。
空 catch 直接把异常吞掉,上线后看起来一切正常,但数据已经错了。返回默认值也很阴险,比如查询用户失败时返回 null,再往上层层传,某个地方不小心调用了 null 的方法,抛出一个 NPE,日志里根本看不到真正的根因。只打日志继续往下走,则可能造成数据一致性的故障,比直接崩还麻烦。
正解是“快速失败”(fail fast)。出错就尽早抛出异常,把错误信息写清楚,让问题在第一时间浮出水面,而不是让它潜伏几周直到爆出更大的雷。这一点特别重要:线上问题每藏深一层,排查时间就会指数级增长。而且,快速失败还能迫使你在开发阶段就发现错误,降低上线的风险。
4.3 日志不是业务负担,是排障的探照灯
说到排障,日志是绕不开的。很多人觉得打日志是额外工作,能省则省。但真到线上问题排查的时候,你会恨不得每行逻辑都留下痕迹。一个务实的建议是:在“决策点”打日志。
什么叫决策点?就是代码做了一个决定的地方。比如“用户请求进入优惠计算”“命中满减规则”“不满足免邮条件,开始计算运费”“调用外部接口,返回结果超时”。这些关键节点如果都清晰打日志,特别是带业务标识(订单号、用户ID),线上一出问题,就能像看故事一样快速还原全过程,省去很多瞎猜的时间。
日志还要注意级别。debug 留给开发期,info 记录关键链路,warn 记录意外但不影响主流程的情况,error 记录影响功能的异常。别把日志级别乱用,否则真正重要的 error 会被淹没在海量 info 里,排障效率反而更低。
5. 团队协作里比个人技术更重要的质量守门人
单人项目可以靠自律,但到了团队协作,代码质量就不是一个人的事了。一套多人开发的代码库,如果没有统一约束,会像混乱的集市,每个人按自己的风格摆摊,最后谁也看不懂谁的代码。团队层面的质量建设,远比单打独斗重要。
5.1 Code Review是最便宜的质量保障
很多团队把代码评审当成走流程,或者干脆用工具自动合并,不做人工评审。省下的那点时间,会在未来的 bug 和返工里加倍还回去。Code Review 的核心意义不在于“挑错”,而是让每一段代码至少有两个大脑理解过。发现问题越早,修复成本越低;换来的是知识在团队里传递,每个人都对系统有更多了解,修起问题来更有把握。
做 Code Review 我一般会重点看几类问题:一是命名和可读性——这段代码别人能否看懂;二是边界情况——有没有处理空值、超时、并发这些“角落”;三是未来变化——这个设计如果需求变了,要改多少地方?四是依赖方向——有没有不合理的耦合或循环依赖。
被评审的人也很重要。不要觉得别人的评论是在说你写得差。有一次我们团队新来的同事在代码里用了一个非常不常规的并发写法,我问了一句为什么这么写,他解释是因为之前查过资料,对性能有要求。我觉得解释合理,就留着。后来线上真碰到了并发问题,正是他的思路规避了。所以我的原则是:Review 的目的是让代码更稳妥、让团队理解更深,不是证明谁比谁强。
5.2 风格统一是降低团队心智负担的关键
团队里最打击读代码效率的事情,就是不同人用完全不相同的风格写代码。一会儿驼峰、一会儿下划线;一会儿缩进两个空格、一会儿四个空格;一会儿用单例、一会儿拼命 new。这些看似小的事情,会在读代码时不断打断你的思路,本来读一遍能解决的问题,不知不觉要读两三遍。
风格统一不追求哪种风格绝对更好,选一套合理、主流的规则,然后所有人遵守就够了。能靠工具强制的,都交给工具:格式化有 Prettier 或 gofmt 这类配置,静态检查有 ESLint、Checkstyle 或 golangci-lint。把这些检查接入 CI(持续集成)或提交钩子,不合格根本进不了主分支。靠人记住规范是最不可靠的,靠工具强推效率最高。
5.3 技术债务要记账,别靠口头传承
任何一个实际运营中的项目,都会因为赶上线、冲版本而留下一些妥协的方案。这是非常正常的,不是谁的错,但你要把它记下来。至少要有张表,记录哪些地方是“带病上线”的、为什么带的病、后续计划什么时候治、谁负责跟进。
最怕的是,技术债不记录,全靠团队里几个老成员口口相传。人一走,债就失传了,新来的人看到那些烂代码不但不知道缘由,还可能“好心”修复导致更多事故。
我还建议每过一段时间,集中安排一次“质量还债”时间。不用太长,一两天就够,专门处理平时累积的小问题,比如清理无用代码、补关键测试、优化慢查询。控制好范围,不要演变成大规模重构,否则风险会急剧上升。这种持续小还款,比憋一年来一次大重构,要稳妥得多,性价比也更高。
6. 我踩过的坑:维护期的真实教训与最终建议
最后这条,聊聊我过去几年印象最深的一些维护教训。这些东西很难写进规范文档,但实战里经常要命。
6.1 重构老代码最重要的第一步:先有测试再动手
接到老项目重构任务时,最大的诱惑是“既然要重构了,那就顺手把结构全部理顺”。但经验告诉我,这是重构成败的分水岭。
几年前我重构过一个报表模块,当时看到代码里一堆重复逻辑,我痛下决心来一次大重写。结果因为没有测试,重构到一半,报表数字就和旧系统对不上了——更尴尬的是,我根本不知道在哪个环节改跑偏的,最后只能推倒重来。
正确做法是:动手重构之前,先把当前行为用测试固化下来。 不需要测试写得多漂亮,哪怕是给关键函数写一个入参返回值的断言,只要能在重构后用来做回归对比就行。有了这条安全网,大改的时候心里才不慌,改完跑一遍测试,绿灯亮了基本说明没破坏功能。没有这个安全网,任何重构都可能是给自己挖坟。
6.2 有些地方不值得“高质量”,要分清主次
我必须说句逆风话:不是所有代码都值得投入同样的高质量成本。有些代码写完之后几乎就不再动了,比如一些一次性的数据迁移脚本、临时的线下工具,你花大量时间去抽象、去写测试,未必划算。高质量的目标是长久维护,如果一段代码三个月后就要删掉,那就该用“快糙猛”的方式处理。
分清主次的核心,不是靠感觉,而是用“变更频率”和“影响范围”来判断。核心业务、高频变更、跨团队依赖的模块,必须要高质量;边角功能、生命周期短的一次性脚本,不必追求完美。我看过很多团队,把精力花在了不怎么重要的辅助代码上,而真正核心的交易链路反而没人做加固。这个主次颠倒,代价非常大。
6.3 最后分享一个前面提到的“改动点计数法”实践细节
我上文中提到的“改动点计数法”不是随便说说的,我在团队里实际执行过一段时间:产品提出需求,技术评估时不问“要几天完成”,而是先问“要改几个文件的几处逻辑”。如果改了超过三个点,说明代码结构可能不够好,这时候我们会退回设计阶段重新想一想,而不是拿到评估直接报进度。
这个方法比较粗糙,并不适合所有团队,但它给了我很多提示:有些看起来很快的需求,恰恰因为代码设计不合理而变成了“处处开火”的修改;相反,那些模块化做得好的部分,改动常常只要在一个文件甚至一个函数里就能完成。我的经验是,代码质量高的项目,改需求就像换水龙头,拧一个阀门就完事;代码质量差的项目,改需求像修老房子,水管、电线、墙皮都要跟着动,而且你还猜不准老房子里藏了什么结构。
目前我见过的优秀工程师,几乎都有这种本能:写代码时脑中会有一个“未来半年后,有人要在这个函数里加需求”的画面。他会提前把扩展点留好、把逻辑拆清楚、把命名起明白,然后把整个过程当作理所当然。这其实就是高质量代码的全部秘密——不是写的时候炫技,而是改的时候省心。你现在写的每一行代码,都是未来某个同事(很可能就是你自己)的垫脚石或绊脚石。少在“写”上固步自封,多在“改”上换位思考,这才是维护成本低的正路。
