关于 Code Review，你「必须」了解的一些关键点……
GreXMHP
8年前
<p>代码审查的重要性，对码农来说自是不言而喻，但整天说Code重要，你知道都应该关注哪些关键点吗？</p> <p>众所周知，在团队中进行代码审查（Code Review）可以提升代码质量，分享项目知识、明确责任，最终达到构建更好的软件、更好的团队。如果你花几秒钟搜索代码审查的相关信息，你会看到许多关于代码审查带来的价值的文章。</p> <p>也有许多方法来进行代码审查：在GitHub中提pull request，或使用像JetBrains的Upsource之类的工具。然而即使拥有清晰的流程和正确的工具，还遗留了一个大问题需要解决——我们需要找寻哪些问题。</p> <p>可能没有明确关于“我们需要找寻哪些问题”的文章，是因为有许多不同的要点需要考虑。正如任何其他的需求，各个团队对各个方面都有不同的优先级。</p> <p>本文的目标是列出一些审查者可以找寻的要点，而各个方面的优先级就因各个团队而异了。</p> <p>在我们继续之前，让我们考虑一下大家在代码审查时会讨论到的问题。对于代码的格式、样式和命名以及缺少测试这些问题是很常见的几点。如果你想拥有可持续的、可维护的代码，这些是有用的检查点。然而，在代码审查时讨论这些就有些浪费时间，因为很多这样的检查可以（也应该）被自动化。</p> <p>那哪些要点是只能由人工进行审查而不能依靠工具的呢？</p> <p>回答是有惊人数量的点只能由人工进行审查。在本文剩下的部分，我们会覆盖一系列广泛的特性，并深入其中的两点具体的区域：性能和安全。</p> <h2><strong>设计</strong></h2> <ul> <li> <p>如何让新代码与全局的架构保持一致？</p> </li> <li> <p>代码是否遵循SOLID原则，是否遵循团队使用的设计规范，如领域驱动开发等？</p> </li> <li> <p>新代码使用了什么设计模式？这样使用是否合适？</p> </li> <li> <p>基础代码是否有结合使用了一些标准或设计样式，新的代码是否遵循当前的规范？代码是否正确迁移，或参照了因不规范而淘汰的旧代码？</p> </li> <li> <p>代码的位置是否正确？比如涉及订单的新代码是否在订单服务相关的位置？</p> </li> <li> <p>新代码是否重用了现存的代码？新代码是否可以被现有代码重用？新代码是否有重复代码？如果是的话，是否应该重构成一个更可被重用的模式，还是当前还可以接受？</p> </li> <li> <p>新代码是否被过度设计了？是否引入现在还不需要的重用设计？团队如何平衡可重用和YAGNI(You Ain’t Gonna Need It)这两种观点？</p> </li> </ul> <h2><strong>可读性和可维护性</strong></h2> <ul> <li> <p>字段、变量、参数、方法、类的命名是否真实反映它们所代表的事物。</p> </li> <li> <p>我是否可以通过读代码理解它做了什么？</p> </li> <li> <p>我是否理解测试用例测了什么？</p> </li> <li> <p>测试是否很好地覆盖了用例的各种情况？它们是否覆盖了正常和异常用例？是否有忽略的情况？</p> </li> <li> <p>错误信息是否可被理解？</p> </li> <li> <p>不清晰的代码是否被文档、注释或容易理解的测试用例所覆盖？具体可以根据团队自身的喜好决定使用哪种方式。</p> </li> </ul> <h2><strong>功能</strong></h2> <ul> <li> <p>代码是否真的达到了预期的目标？如果有自动化测试来确保代码的正确性，测试的代码是否真的可以验证代码达到了协定的需求？</p> </li> <li> <p>代码看上去是否包含不明显的bug，比如使用错误的变量进行检查，或误把and写成or？</p> </li> </ul> <p>你是否考虑过……？</p> <ul> <li> <p>是否需要满足相关监管需求？</p> </li> <li> <p>作者是否需要创建公共文档或修改现存的帮助文档？</p> </li> <li> <p>是否检查了面向用户的信息的正确性？</p> </li> <li> <p>是否有会在生产环境中导致应用停止运行的明显错误？代码是否会错误地指向测试数据库，是否存在应在真实服务中移除的硬编码的stub代码？</p> </li> <li> <p>你对性能的需求是什么，你是否考虑了安全问题？这些是需要覆盖到的重大区域也是至关重要的话题。</p> </li> </ul> <p>让我们深入探讨下性能，这是一个真正能从代码审查中获益的方面。</p> <p>系统对性能方面的非功能性需求应当同所有架构、设计的领域一样被置于重要位置。无论你是开发只容许纳秒级延时的低延迟交易系统，还是管理“待办事项”的手机应用，你都应该了解用户所认为的“太慢”。</p> <p>在考虑我们是否需要就代码性能进行代码审查之前，我们应该问自己几个关于具体需求是什么的问题。虽然一些应用确实不需要考虑每毫秒都花费在哪里，对于大部分应用，花费几个小时的折腾进行优化来获得的些许CPU下降的价值也是有限的，但有些地方还是审查者可以检查一下的，进而确保代码不会有一些常见可避免的性能缺陷。</p> <h3><strong>这段代码是否有硬性的性能需求？</strong></h3> <p>接受审查的代码是否涉及之前发布的服务等级协议（SLA）？或这个需求本身有特别的性能需求？</p> <p>如果代码导致“登录页面加载太慢”，那原始的开发者需要找出合适的加载时间是多久，不然审查者或作者本人如何确保改进后的速度足够快？</p> <p>如果有硬性的需求，是否有测试能证明满足了该需求？任何注重性能的系统应该就性能提供自动化测试，这能确保发布的SLA达到预期（如所有订单请求要在10毫秒内处理）。没有这些，你只能依靠你的用户来告诉你没有达到对应的SLA。这不仅是一种糟糕的用户体验，还会带来原本可避免的罚金和支出。</p> <h3><strong>这个修复或新增的功能是否会反向影响到任何现存的性能测试结果</strong></h3> <p>如果你定期运行性能测试或有测试套件可以按需运行它们，那你就需要检查新的代码是否使得性能关键区域的系统性能有所下降。这可以是一个自动化的流程，但由于在持续集成环境中更常运行单元测试而不是性能测试，所以值得特别指出可以在代码审查中检查这项。</p> <h3><strong>调用外部的服务或应用的代价是昂贵的</strong></h3> <p>任何通过网路来使用外部系统的方式通常会比没有很好优化的方法有更差的性能。考虑以下几点：</p> <ol> <li> <p>调用数据库：最坏的情况是问题隐藏在系统抽象中，如关系对象映射（ORM）中。但是在代码审查中你应该可以找到常见的导致性能问题的问题，如在循环中逐个调用数据库，一种情况就是加载ID列表之后，再在数据库中逐个查询ID对应的每条数据。</p> </li> <li> <p>不必要的网络调用：就像数据库一样，远程服务有时也会被过度使用，原来只要一个远程调用就可实现的，或者可以使用批量或缓存防止昂贵网络调用的，却使用多个远程调用来实现。再次强调，像数据库一样，有时抽象类会隐藏调用远程API的方法。</p> </li> <li> <p>移动或可穿戴应用过于频繁地调用后端程序：这基本上和“不必要的网络调用”相同，但是在移动设备上会产生其他问题，这不仅会产生不必要的调用后端使得性能变差，还会更快地消耗电量甚至导致用户的金钱支出。</p> </li> </ol> <h3><strong>有效且高效地使用资源</strong></h3> <p>代码是否用锁来控制共享资源的访问？这是否会导致性能降低或死锁？</p> <p>锁是一个性能开销大户，并在多线程环境中很难理清。考虑使用以下模式：单线程写或修改值，其余线程只读，或使用无锁算法。</p> <ol> <li> <p>是否存在内存泄露？Java中一些常见的原因会是：可变的静态字段，使用ThreadLocal变量和使用类加载器。</p> </li> <li> <p>是否存在内存无限增长？这个和内存泄露不同，内存泄漏是指无用的对象不能被垃圾回收器回收。但对于任何语言，就算是没有垃圾回收的语言，也能创建无限变大的数据结构。作为审查者，如果你看见新的变量不断被加到list或map中，你就要问下，这个list或map什么时候失效或清除无用数据。</p> </li> <li> <p>代码是否关闭了连接或数据流？关闭连接或文件、网络数据流很容易会被忘记。当你审查别人代码时，如果使用到文件、网络或数据库连接，就要确保它们被正确地关闭了。</p> </li> <li> <p>资源池是否配置正确？针对一个环境的最佳配置取决于很多因素，所以作为审查者你很难马上知道像数据库连接池大小是否正确等这些问题。但是有一些是你一眼就可以看出来的，像资源池是否太小（比如大小设置为1）或太大（如数百万线程）。如果无法确定，就从默认值开始。没有使用默认值的就需要提供一定的测试或计算来证明这么配置的合理性。</p> </li> </ol> <h3><strong>审查者可以轻松找出的警告信号</strong></h3> <p>一些代码一眼就能看出存在潜在性能问题。这依赖于所使用的语言和类库。</p> <ul> <li> <p>反射：Java的反射比正常调用要慢。如果你在审查含有反射的代码，你就要问下是否必须使用它。</p> </li> <li> <p>超时：当你审查代码时，你可能不知道一个操作合适的超时时间，但是你要想一下“如果超时了，会对系统其他部分造成什么影响？”。作为审查者你应该考虑最坏的情况：当发生5分钟的延时，应用是否会阻塞？</p> <p>如果超时时间设置成1秒钟最坏的情况会是怎么样的？如果代码作者不能确定超时长度，你作为审查者也不知道一个选定的时间的好坏，那么是时候找一个理解这其中影响的人参与代码审查了。</p> </li> <li> <p>并行：代码是否使用多线程来运行一个简单的操作？这样是否花费了更多的时间以及复杂度而并没有提升性能？如果使用现代化的Java，那其中潜在的问题相较于显示创建线程中的问题更不容易被发现：代码是否使用Java 8新的并行流计算但并没有从并行中获益？比如，在少量元素上使用并行流计算，或者只是运行非常简单的操作，这可能比在顺序流上运算还要慢。</p> </li> </ul> <p><strong>正确性</strong></p> <p>这些不一定影响系统的性能，但是它们与多线程环境运行关系密切，所以和这个主题有关：</p> <ul> <li> <p>代码是否使用了正确的适合多线程的数据结构。</p> </li> <li> <p>代码是否存在竞态条件（race conditions）？多线程环境中代码非常容易造成不明显的竞态条件。作为审查者，可以查看不是原子操作的get和set。</p> </li> <li> <p>代码是否正确使用锁？和竞态条件相关，作为审查者你应该检查被审代码是否允许多个线程修改变量导致程序崩溃。代码可能需要同步、锁、原子变量来对代码块进行控制。</p> </li> <li> <p>代码的性能测试是否有价值？很容易将小型的性能测试代码写得很糟糕，或者使用不能代表生产环境数据的测试数据，这样只会得到错误的结果。</p> </li> <li> <p>缓存：虽然缓存是一种能防止过多高消耗请求的方式，但其本身也存在一些挑战。如果审查的代码使用了缓存，你应该关注一些常见的问题，如，不正确的缓存失效方式。</p> </li> </ul> <p><strong>代码级优化</strong></p> <p>对大部分并不是要构建低延时应用的机构来说，代码级优化往往是过早优化，所以首先要知道代码级优化是否必要。</p> <ul> <li> <p>代码是否在不需要的地方使用同步或锁操作？如果代码始终运行在单线程中，锁往往是不必要的。</p> </li> <li> <p>代码是否可以使用原子变量替代锁或同步操作？</p> </li> <li> <p>代码是否使用了不必要的线程安全的数据结构？比如是否可以使用ArrayList替代Vector？</p> </li> <li> <p>代码是否在通用的操作中使用了低性能的数据结构？如在经常需要查找某个特定元素的地方使用链表。</p> </li> <li> <p>代码是否可以使用懒加载并从中获得性能提升？</p> </li> <li> <p>条件判断语句或其他逻辑是否可以将最高效的求值语句放在前面来使其他语句短路？</p> </li> <li> <p>代码是否存在许多字符串格式化？是否有方法可以使之更高效？</p> </li> <li> <p>日志语句是否使用了字符串格式化？是否先使用条件判断语句校验了日志等级，或使用延迟求值？</p> </li> </ul> <p><strong>简单的代码即高效的代码</strong></p> <p>Java代码中有一些简单的东西可以供审查者寻找，这些会使JVM很好地替你优化你的代码：</p> <ul> <li> <p>短小的方法和类。</p> </li> <li> <p>简单的逻辑，即消除嵌套的条件或循环语句。</p> </li> </ul> <h2><strong>安全</strong></h2> <p>你在构建一个安全、稳固的系统所花费的精力，和花在其他特性上的一样，取决于项目本身，项目运行的地方、它使用的用户、需要访问的数据等。我们现在着重看一些你可能在代码审查时关注的地方。</p> <h3><strong>尽可能使用自动化</strong></h3> <p>有惊人数量的安全检查可以被自动化，而不需要人工干预。安全测试不一定要启动所有系统进行完整的渗透测试，一些问题可以在代码级就能被发现。</p> <p>常见问题如SQL注入或跨站脚本可以在持续集成环境通过相应工具检查出。你也能通过OWASP依赖检测工具自动化检查你依赖中已知的漏洞。</p> <h3><strong>有时需要“看情况”</strong></h3> <p>对有的校验你可以简单回答“是”或“否”，有时你需要一个工具指出潜在的问题，之后再由人工来决定这个是否需要解决。这也正是Upsource真正的闪光点。Upsource显示代码检查结果，审查者可以利用这些来决定代码是否需要改动或还可以接受目前的情况。</p> <h3><strong>理解你用到的依赖</strong></h3> <p>第三方类库是侵蚀系统安全并引起漏洞的一个途径。当审查代码时至少你要检查是否引入了新的依赖（如第三方类库）。如果你还没有自动化检查漏洞，你应该检查新引入的类库中已知的问题。</p> <p>你也应该尝试着最小化每个类库的版本，当然如果其他依赖有一个额外的间接依赖，这点可能达不到。但最简单的最小化自己代码暴露在他人代码的（通过类库或服务）安全问题中的方法有：</p> <ul> <li> <p>尽可能使用源码并理解它的可信度。</p> </li> <li> <p>使用你所能得到的质量最高的类库。</p> </li> <li> <p>追踪你在何处使用了什么，当新的漏洞出现，你可以查看你受影响的程度。</p> </li> </ul> <h3><strong>检查是否新的路径和服务需要认证</strong></h3> <p>无论你开发web应用、提供web服务或一些其他需要认证的API，当你增加一个新的URI或服务时，你应该确保它不能在没有认证的情况下被访问（假设认证是你系统的需求）。你只要简单地检查代码的开发者写了合适的测试用例来展示进行了认证。</p> <p>你应该不只针对使用用户名和密码的人类用户来考虑认证。其他系统或自动化流程来访问你的应用或服务也会需要认证。这可能影响你们系统中对“用户”的定义。</p> <h3><strong>数据是否需要加密</strong></h3> <p>当你保存一些数据到磁盘或通过线缆传输，你需要了解数据是否应该被加密。显然密码永远不应该是简单文本，但是有诸多其他情况数据需要加密。如果被审查的代码通过线缆来传送数据或保存在某地或以其他方式离开你的系统，且你不知道它是否应该被加密，尝试询问下你组织中可以回答这个问题的人。</p> <h3><strong>密码是否被很好地控制？</strong></h3> <p>这里的密码包含密码（如用户密码、数据库密码或其他系统的密码）、秘钥、令牌等等。这些永远不应该存放在会提交到源码控制系统的代码或配置文件中，有其他方式管理这些密码，例如通过密码服务器（secret server）。当审查代码时，要确保这些密码不会悄悄进入你的版本控制系统中。</p> <h3><strong>代码的运行是否应该被日志记录或监控？是否正确地使用？</strong></h3> <p>日志和监控需求因各个项目而不同，一些需要合规，一些拥有比别人严格的行为、事件日志规范。如果你有规章规定哪些需要记录日志，何时、如何记录，那么作为代码审查者你应该检查提交的代码是否满足要求。如果你没有固定的规章，那么就考虑：</p> <ul> <li> <p>代码是否改变了数据（如增删改操作）？是否应该记录由谁何时改变了什么？</p> </li> <li> <p>代码是否涉及关键性能的部分？是否应该在性能监控系统中记录开始时间和结束时间？</p> </li> <li> <p>每条日志的日志等级是否恰当？一个好的经验法则是“ERROR”触发一个提示发送到某处，如果你不想这些消息在凌晨3点叫醒谁，那么就将之降级为“INFO”或“DEBUG”。当在循环中或一条数据可能产生多条输出的情况下，一般不需要将它们记录到生产日志文件中，它们更应该被放在“DEBUG”级别。</p> </li> </ul> <p><strong>记得叫上专家</strong></p> <p>安全是个很大的话题，大到足以让你的公司聘请技术安全专家。我们有安全专家就可以获得他们的帮助，如，邀请他们参加代码审查，或邀请他们在审查代码时和我们结对。</p> <p>如果这个无法实现，我们可以充分学习我们系统的环境，来理解我们有哪种安全需求（面向内部的企业级应用和面向客户的网页应用有不同的标准），所以我们可以更好地理解我们应该在代码审查中看什么。</p> <h2><strong>总结</strong></h2> <p>代码审查是一个很好的方式，不仅确保了代码质量和一致性，也在团队中或团队间分享了项目知识。即使你已经自动化了基础的校验，还有许多不同代码、设计的方面需要考虑。</p> <p>代码审查工具，如Upsource，通过在每个代码提交的检查中高亮可疑的代码并分析哪些问题已经被修复，新引入哪些问题，可以帮你定位一些潜在的问题。工具也可以简化流程，因为它提供了一个平台来讨论设计和代码实现，也可以邀请审查者、作者和其他相关人员参加讨论直到达成共识。</p> <p>最后，团队需要花时间决定代码质量的哪些因素对他们是重要的，也需要专家人工决定哪些规则应用到各个代码审查中，参与到审查中的每个人都应该具备并使用人际交往的技巧，如积极的反馈、谈判妥协以达到最终的共识，即代码应该怎么样才“足够好”可以通过审查。</p> <p> </p> <p> </p> <p> </p> <p>来自：http://mp.weixin.qq.com/s?__biz=MjM5MDE0Mjc4MA==&mid=2650994555&idx=1&sn=b196e2dfb293ec7829523011316a7e06&chksm=bdbf0f288ac8863e014eae215469f4bbc0b8e88fa286c3cd38b467348466c663415ffed0e4ca&scene=0#wechat_redirect</p> <p> </p>