代码审查是由作者以外的人独立或与作者共同检查源代码,以评估其正确性、可维护性、安全性,以及是否适合某个软件系统。在当代软件工程中,代码审查通常针对拟议的变更,而非整个程序:审查者检查补丁,讨论其影响,然后要求修改或批准将其集成。这个术语也涵盖结构化审查、非正式的同行检查,以及针对现有代码的专项检查。
代码审查通过评估仅靠执行程序可能无法揭示的属性,对软件测试形成补充,例如设计是否过于复杂、接口是否准确表达了预期的契约,或实现是否依赖未记录的假设。代码审查还可以传播有关系统的知识,并留下技术决策的记录。其成效取决于审查流程、审查者的专业能力、变更的规模和呈现方式,以及人工判断与自动化检查如何配合。审查通过表明一项变更已经接受检查,并不证明它没有缺陷。
历史发展与主要形式
对程序进行系统性检查的做法,早于现代在线协作平台的出现。迈克尔·E. 费根于1976年发表的论文《通过设计和代码审查减少程序开发中的错误》是将这一做法规范化的一项重要成果,文中介绍了在IBM公司形成的审查实践。费根将审查看作一项有组织的工程活动,包含明确的角色分工、准备工作、缺陷记录和后续跟进。这种方法既适用于设计文档,也适用于代码,体现了程序尚未运行便可发现缺陷的原则。
传统的软件审查会将非正式评审中可能合并进行的几项活动分开。参与者各自做好准备;主持人负责管理流程;讲读者可以展示或转述待审内容;发现的缺陷则记录下来,以便修正。讨论以发现问题为目标,而不是在会议期间重新设计系统。准入和退出标准有助于判断工作产物是否已具备接受审查的条件,以及发现的问题是否已得到处理。这些程序提供了可追溯性,但也需要投入日程安排和组织管理方面的精力。
轻量级同行评审逐渐从一些不那么正式的做法中发展起来,例如由同事检查补丁、通过电子邮件交换意见,或在工作站旁进行简短讨论。随着开源软件的发展,异步评审变得尤为重要,因为贡献者往往分布在不同地区。在Linux内核等项目中,邮件列表评审至今仍占据重要地位,补丁、相关说明和后续修订都在公开的讨论串中展开讨论。在这种环境下,评审与子系统的维护职责以及补丁提交惯例紧密相连。
现代评审平台将讨论直接与版本控制关联起来。Gerrit 等系统,以及 GitHub 和 GitLab 的评审功能,可以显示不同修订版本之间的差异,将评论附加到特定代码行,并记录批准状态。拉取请求在某些平台上也称为合并请求,它将拟议的集成变更、相关讨论和自动化检查结果汇集在一起。请求本身是一个协作对象,而评审只是通过它开展的活动之一。
另有一些实践与评审存在交集,但并不等同于评审。在结对编程中,两名开发者在实现过程中共同工作,持续检查代码,而不是事后另行审查。走查通常侧重于讲解和建立共同理解,而审查则侧重于发现缺陷。安全审计可以不依赖代码的开发历史而独立检查代码。这些形式在开展时机、独立性和所需证据方面各不相同;不能简单地将其中任何一种视为其他形式的更复杂版本。
目标、范围与局限
审查最直接的目标,是在缺陷进入共享系统之前将其发现。审查者会对照需求、接口契约以及周边代码所预期的行为来检查实现。一个函数可能对常规输入给出正确结果,却无法妥善处理空集合,在操作部分完成后发生故障,或违背调用方所依赖的假设。当相关需求并未明确写出,或分散在多个组件中时,审查尤其有价值。
可维护性是另一个独立目标。审查者会评估命名能否传达含义、抽象是否对应真实概念,以及能否在不还原隐含推理过程的情况下理解控制流。即使实现是正确的,也仍可能引入重复代码,或使互不相关的组件产生耦合。这类变更可能造成技术债务,即增加后续工作成本的设计或实现状况。审查并不要求消除所有不完善之处,而是要区分当前变更引入的问题与原本就存在、可能应另行处理的问题。
适当的审查范围往往不止于可执行语句。测试、软件文档、构建定义、配置、数据库迁移和部署说明,都可能决定一项变更能否正常发挥作用。修改应用程序编程接口时,可能需要同步调整客户端,并提供兼容性保证。一次缩短超时时间的配置变更,对生产环境行为的影响可能远大于一次规模大得多的重构。
审查还会检查变更是否与软件架构保持一致。例如,一个旨在隔离存储细节的模块,不应通过其公共接口暴露某种数据库特有的对象。局部采用的捷径或许能立刻奏效,却可能破坏其他组件所依赖的边界。反过来,架构审查也不应成为任意重新设计系统中无关部分的机会。区分必要的修正与可选的改进,是控制审查范围的关键。
代码审查存在根本性的局限。审查者看到的只是选定的产物,而且可能缺少生产环境的工作负载、运维历史或完整需求。仅靠检查源代码,既无法确定实测性能,也无法展示程序在所有可能执行情况下的行为。形式验证可以在明确的假设下证明指定的性质,而普通审查提供的是专家判断,并不附带这样的证明。即使得出了形式化结果,规格说明是否充分、部署条件是否合适等问题仍然存在。因此,审查应当是更广泛的质量保障流程的一部分,而不能充当适用于一切情况的质量关卡。
以变更为单位的工作流程与批准的含义
一次典型的审查始于作者准备好一组逻辑连贯的变更,并说明其目的。说明应交代要解决的问题、选用的方案、相关约束以及测试提供的证据。一份有用的变更说明会将预期行为与非关键的实现细节区分开来。否则,审查者就不得不从补丁中推断目标,从而更难识别出那些技术上看似合理、实际却实现了错误需求的方案。
作者可以自行选择审查者,也可以由系统根据代码归属规则和开发历史推荐人选。选择审查者时需要考虑不同类型的专业能力:对受影响组件的熟悉程度、对业务需求的理解,以及安全或存储等特定领域的知识。负责某个领域的维护者,未必是最有资格评估某项变更所有方面的人。因此,一些项目会区分普通评论、特定领域的批准,以及允许集成的授权。
审查者会将拟议的修订与其基准版本进行比较,通常借助 Git(版本控制系统) 的历史记录和相关文件还原上下文。评论可能指出缺陷、提出问题、要求提供证据,或建议替代方案。这些类别会产生不同的后续要求。一个问题可能揭示了确实存在的歧义,但并不意味着实现有误;而阻断性问题则表明,在接受变更之前,必须先解决某个问题。明确指出严重程度并说明理由,可以减少作者对需要修改哪些内容的不确定性。
修改又带来了第二个审查问题:如何确定自上次检查以来发生了哪些变化。审查工具可能会显示增量差异、将先前的评论标记为已过时,或在提交被重写后保留相关讨论。批准通常针对变更的某个特定状态。如果新增提交大幅改变了行为,先前的批准可能就不再代表有效的审查。分支策略可以要求重新批准,但具体行为取决于代码仓库的设置。
集成与批准是两回事。即使一项变更获得了正面评价,仍可能因检查未通过、与其他更新冲突,或发布限制而无法集成。反过来,自动化构建成功也不能代替人工批准。系统可能要求在合并前获得指定审查者的批准、通过各项检查,或确保基准版本为最新状态。接受审查的内容必须与实际集成的内容保持对应;解决合并冲突时,可能会引入此前没有任何审查者检查过的代码。
也可以在集成后进行审查,尤其是在紧急修复或以持续提交为核心的工作流程中。这种做法改变的是承担风险的时间,而不是取消审查。因此,流程必须考虑在部署后发现严重问题时如何处理,包括修正、回滚以及检查相关变更。
审查者如何推理代码行为
有效的审查既需要阅读局部代码,也需要重建对系统行为的理解。逐行检查可以发现可疑的表达式,但许多重要缺陷源自文件或操作之间的相互关系。审查者通常先了解变更的目的,找到相关入口,再追踪数据流和控制流在受影响组件中的走向。这样便能建立一个模型,据此评估具体的实现选择。
一种方法是识别不变量,即操作前后都必须成立的性质。例如,在转账操作中,如果中间状态会暴露给外部,或者重试时只重复执行转账的一侧操作,那么仅仅保持总余额不变还不够。此时,审查范围就需要扩展到数据库事务的边界、错误处理和重复执行。对于算法,审查者可以检查循环不变量,或分析实现是否能保证终止,以及是否正确处理了边界条件。
边界分析着重考察常规示例遗漏的情况。典型问题包括元素数量为零或一、取值达到最大值、输入格式错误、依赖项不可用,以及操作中断。在C编程语言中,一个表达式即使在数学上合理,也可能因为有符号整数溢出或无效内存访问而表现出不同的行为。审查需要依据语言的实际语义进行推理,而不是采用理想化的算术解释。
并发场景需要考虑各种可能的交错执行顺序。在并发计算中,单独执行时正确的代码,可能会因为另一个执行流程在检查与更新之间修改了共享状态而出错。审查者会检查所有权、同步、加锁顺序和对象生命周期。即使每个受保护的操作本身都是正确的,以不一致的顺序获取两把锁仍可能引发死锁。测试未必能足够频繁地重现有问题的调度顺序,因此可能无法暴露这类缺陷。
同样,性能审查也要区分看似合理的担忧与有证据支持的问题。嵌套扫描可能使工作量的增长趋势从大约 变为 ,但其实际影响取决于输入规模和执行频率。审查者可以指出需要测量,而不必声称能仅凭源代码预测准确的延迟。例如,在循环中增加一次查询之所以可能产生显著影响,原因可能在于网络往返,而非处理器指令数量。
相关测试本身也是审查对象。审查者会检查断言是否表达了预期契约、是否覆盖了失败路径,以及测试夹具是否意外排除了相关情况。如果测试只是重复实现中的逻辑,就可能重现同样的错误,而不是独立验证行为。因此,清晰易读的示例和明确的预期结果,可能比大量表面上各不相同的测试用例更有价值。
工具支持与自动化检查
审查平台降低了比较代码版本和协调讨论所需的机械性工作量。其核心界面通常是差异视图,显示新增、删除和未改动的行。其他功能包括文件导航、修改建议、串式评论、审查者指派以及决策历史记录。这些功能让分布式协作切实可行,但界面也会影响注意力的分配:审查者可能只关注突出显示的行,而忽略那些虽未改动、但所依赖的前提已不再成立的代码。
自动化检查可以替代人工审查中的重复性工作。编译器可以拒绝包含许多语法错误和类型错误的代码;格式化工具可以统一代码排版;代码检查工具则可以检测特定的可疑模式。程序静态分析无需执行被审查的程序,就能检查其代码,所用方法从简单的语法规则到数据流分析不等。例如,分析器可以追踪不可信的值是否可能在未经适当检查的情况下传入敏感操作。
这些技术提供的保证各不相同。有些分析会对可能的行为作保守近似,因此可能报告实际上不可能出现的执行路径。另一些分析则有意采用范围更窄的启发式方法,以确保结果便于采取行动,但也可能漏掉真实缺陷。因此,一份未发现问题的报告,只表示按当前配置进行的分析没有报告问题,并不意味着程序不存在问题。审查者需要了解工具的适用范围,而不能把所有自动化结果都视为具有同等证明力的证据。
持续集成将代码变更与可重复执行的构建和测试联系起来。审查页面可以汇总单元测试结果、兼容性检查、安全扫描和打包结果。环境和配置同样重要:在某个操作系统上通过测试,并不能证明代码兼容所有受支持的平台。对检查本身的修改也需要仔细审查,因为禁用某项测试或排除某个目录,可能会让有缺陷的变更看起来一切正常。
测试工具可以提供更深入的证据。变异测试以受控方式改变程序行为,检验测试是否能够检测到这些变化。模糊测试会探索大量输入,通常利用执行反馈加以引导,以发现崩溃或其他故障。两者都不能取代审查:变异测试的结果需要解读,而模糊测试发现的触发故障的输入,也不一定能解释故障在架构层面的成因。这些工具的输出为审查者提供了可供调查的具体问题。
自动化也会带来管理风险。如果机器人评论重复出现,或未能合理区分优先级,就可能淹没讨论。检查配置可能过时,而看似可信的状态也可能掩盖相关任务根本没有运行的事实。将机械性故障、疑似缺陷和建议性发现区分开来,有助于维持审查结果的明确含义。在持续交付系统中,这种区分尤为重要,因为一旦审查获批且检查通过,变更就可能很快发布。
安全审查与信任边界
安全审查考察当输入、调用方、依赖项或执行条件具有敌意时,变更后的代码会如何表现。常规功能审查关注获授权的操作能否正常执行;安全审查还要关注未经授权的操作是否因此成为可能。审查范围以威胁模型为依据,其中明确了受保护的资产、攻击者的能力以及信任边界。缺少这些背景信息,审查者可能会把注意力放在熟悉的编码模式上,却忽略真正导致敏感数据或权限暴露的操作。
输入处理是常见的审查重点。在构造 SQL结构化查询语言命令的代码中,审查者需要区分通过参数绑定传入的数据,以及通过拼接进入可执行查询语法的数据。转义并不能在所有情况下替代这种数据与语法的分离。同样的思路也适用于操作系统命令、生成的标记代码和文件路径。关键在于接收端的解释器如何处理这个值,而不是它在构造该值的语言中看起来是否无害。
授权错误经常出现在其他方面都正确的应用逻辑中。身份认证用于确认身份,而访问控制则决定该身份可以执行哪些操作。即使处理程序已经验证了调用方的身份,如果没有检查数据归属或租户边界,仍可能暴露其他用户的记录。因此,审查需要沿着完整操作流程追踪权限,包括间接调用、后台任务和其他入口,而不能只看是否进行了登录检查。
内存和资源管理会带来不同的风险。长度计算错误可能引发缓冲区溢出,而对象生命周期错误则可能导致存储空间释放后,指向该空间的引用仍可被使用。即使采用内存安全的语言,也可能发生资源耗尽:输入数据无上限地膨胀、单次请求需要过多处理工作,或连接创建不设上限,都可能使拒绝服务攻击成为可能。因此,安全审查不仅要关注危险的库函数调用,还应涵盖算法行为和运行行为。
涉及密码学的变更,需要关注成熟的密码构造、密钥处理、随机性以及协议上下文。使用了公认的算法,并不意味着其使用方式就是安全的。审查者可能需要专业知识,才能评估 nonce 的使用要求,或判断签名是否覆盖了所有与安全相关的字段。诊断日志也值得检查,因为凭据或个人数据可能通过与主函数返回值无关的路径泄露。
最后,审查本身也是信任流程的一部分。恶意变更可能伪装成维护工作,分散在多个修订版本中,或附带具有误导性的测试。将编写者与批准者分离、管控代码仓库权限,以及审查构建和依赖项的变更,都能减少修改未被察觉的机会。不过,人工批准并不能为每一项上游制品提供真实性验证,也不能替代更全面的软件供应链安全流程。
协作、责任归属与决策
代码审查既是技术检查,也是围绕共享软件展开的组织层面的协商。作者详细了解自己刚刚完成的实现;审查者则可能了解作者尚未接触过的历史约束、运行故障或未来计划。富有成效的讨论会将这些不同来源的知识明确表达出来。与不加解释地要求修改某个行为相比,说明某个客户端依赖该行为的评论,能传递更有长期价值的信息。
审查意见的约束力各不相同。有些涉及正确性要求,有些旨在落实已达成共识的规范,还有些只是个人偏好。混淆这些类别,可能使讨论旷日持久,却无助于改进软件。项目通常会区分必须解决的问题和可选建议,并将格式处理交给工具。这并不意味着不再需要判断,而是将讨论范围收窄到适合由人来理解和判断的问题上。
责任归属结构既影响质量,也影响处理效率。要求组件负责人批准,可以保留对组件的深入了解,并明确责任。但责任过度集中也可能造成审查积压,使项目依赖少数人。让更多审查者参与,有助于将知识分散到更多人手中,不过经验较少的审查者在处理细微变更时可能需要帮助。审查者可以只评估某个特定问题,而不必被要求为系统的所有方面作出保证。
这种互动也具有教育作用。通过具体工作,审查让贡献者接触不熟悉的模块、设计规范和调试技巧。它也能揭示代码中难以理解的地方。如果一位具备相应能力的审查者反复误解某项操作,问题可能出在实现或文档上,而不完全在于阅读者。如果未来的维护者也需要同样的信息,那么仅在审查讨论串中写下解释,可能还不够。
异步工作会带来延迟,也会限制沟通。简短的评论可能缺少交谈时具备的上下文,而同步会议则可能让其他时区的参与者无法出席。因此,团队会结合书面审查与直接讨论。当讨论转移到其他场合时,将技术决策与变更一同记录下来,可以让未参与讨论的人也能从中受益。
存在分歧并不一定说明流程失效。分歧可能暴露出尚未确定的需求,或兼容性与简洁性之间的取舍。如何解决分歧取决于项目的治理机制:指定的维护者、架构决策流程或成文规范,都可能决定最终结果。统计批准人数并不能自动解决技术问题;如果新增的参与者都以为困难的部分已经由别人检查过,那么增加人数也不会让审查变得更加严谨。
实证评估与流程设计
有关审查的研究区分了正式检查与当代借助工具开展的同行审查。阿尔贝托·巴凯利(Alberto Bacchelli)和克里斯蒂安·伯德(Christian Bird)在 2013 年发表的研究《现代代码审查的期望、成效与挑战》中考察了业界实践,并强调审查的作用不止于发现缺陷,还包括知识传递和增进团队成员对彼此工作的了解。凯特琳·萨多夫斯基(Caitlin Sadowski)及其同事在 2018 年发表的研究《现代代码审查:谷歌案例研究》中,介绍了轻量级审查的大规模实施情况。这类研究记录的是特定环境中的实践,并不能据此确立一种普遍最优的流程。
衡量审查成效并不容易,因为一些重要成果并不会显现出来。审查期间修复的缺陷可能永远不会出现在问题跟踪系统中。审查者可能促使作者简化设计,却没有留下可被归类为缺陷的评论。反过来,讨论中评论很多,可能反映的是需求不明确或例行的细节修正,而不一定意味着检查格外深入。因此,单凭评论数量很难有效衡量审查质量。
常见的流程运行指标包括首次响应时间、从提交到集成的总耗时、修订次数,以及经过审查的变更所占的比例。这些指标描述的是不同现象。集成耗时较长,可能是因为审查者无暇处理、实现工作难度较高,或团队有意暂缓发布。仅凭提交与批准时间戳之间的差值,无法可靠地推断实际花在阅读上的时间。因此,将总耗时视为审查者投入的精力,可能导致比较结果失真。
基于缺陷的指标也需要谨慎使用。研究可能发现,审查覆盖率或审查者参与程度与后续缺陷报告之间存在关联,但这种关系会受到变更复杂度、组件成熟度、贡献者经验以及基于风险的筛选等因素影响。复杂变更可能恰恰因为更容易包含缺陷,才会受到更严格的审查。观察到的关联并不能直接证明,在另一种环境下增加审查者或评论就能改善结果。
变更规模是一项重要的流程变量,因为审查者的注意力和工作记忆有限。与混杂了重构、行为变更和格式调整的补丁相比,规模较小、内容连贯的变更通常更便于检查其意图与影响。不过,代码行数只是衡量难度的间接指标。对并发协议的一处简短修改,可能比大规模的重复性更新更需要深入推理。任意设定的规模阈值都无法涵盖所有类型的变更。
因此,评估需要将量化指标与实际案例分析相结合。可以从遗漏到后续阶段的缺陷、审查延误、参与者体验,以及日后是否仍能理解当时的决策等方面评估流程。激励方式也很重要:奖励快速批准可能助长流于表面的审查,而奖励评论数量则可能催生不必要的异议。真正应当衡量的是工程决策的质量与成本,而不仅仅是记录下来的活动数量。
AI 辅助审查与生成的代码变更
人工智能可以通过概括变更、拟写审查意见、定位相关代码和建议测试来辅助审查。当前的系统通常使用大语言模型,结合指令和选取的代码仓库上下文来理解补丁。与识别特定语法模式的固定规则不同,这类模型能够解释代码的表面意图以及涉及多个模块的行为。这种灵活性也使其输出更难预测。
上下文是一个关键限制。补丁可能涉及另一个代码仓库中定义的契约、生成的接口、部署设置,或模型输入中未包含的运维惯例。即使上下文窗口很长,也不能保证相关依据已被选入,或得到了正确解读。自动审查工具可能信心十足地反对某种有意设计的行为,也可能忽略未在局部代码中注明的不变量。
模型生成的审查发现需要核实。人工智能幻觉可能导致模型引用不存在的函数,对某个库作出缺乏依据的断言,或给出听起来合理却与代码不符的解释。有效的评估应当区分风格建议、可复现的故障以及有充分依据的推理链。编译、测试和检查所引用的定义,可以验证一条审查发现中的部分内容,但即使代码成功执行,也仍不足以证明其中的每项断言。
审查 AI 生成的代码也给人工审查者带来了相关挑战。生成的实现可能在语法上无可挑剔,却依赖过时的接口、不恰当的假设,或引入不必要的复杂性。代码生成得快,并不意味着审查负担就此消失。当AI 编程代理能够修改多个文件并运行工具时,审查对象还包括它对测试、配置和依赖项的修改,而不仅仅是主要实现。
自动审查工具的运行也会跨越信息安全边界。代码仓库文件、议题描述和评论中可能包含不可信的指令。如果模型将这些内容视为权威指令而非数据,提示注入就可能干扰其行为。因此,工具权限、对机密信息的访问权限,以及提交的代码被发送到何处,都会影响部署审查工具本身的风险。这些问题与其技术性审查意见是否准确是两回事。
评估 AI 审查时,必须区分有说服力的表述与真正有用的缺陷检测。需要考察的问题包括:报告的问题是否真实存在,是否遗漏了重要缺陷,审查发现是否与现有工具的结果重复,以及人工需要花费多少时间来排除错误的审查意见。由于语言、框架和审查惯例各不相同,针对具体代码仓库开展测试十分重要。将合并权限交给自动化系统,还涉及另一项治理决策:接受变更的责任,始终有别于生成建议的机制。