beprofessional-项目规范之道(二).pdfVIP

Be Professional - 项目规范之道 (二) 编写整洁代码 Writing clean code requires the disciplined use of a myriad little techniques applied through a painstakingly acquired sense of cleanliness. This code-sense is the key. Some of us are born with it. Some of us have to fight to acquire it. Not only does it let us see whether code is good or bad, but it also shows us the strategy for applying our discipline to transform bad code into clean code. 1. 基本要求 Coding Style ，如果有要求，应该严格遵循，任何例外的情况需要讨论决定。 可读性，要容易理解，命名要具有足够描述性，不能有歧义，代码路径、结构要清 晰、简洁。 一致性， 包括但不限于标识符命名、 错误处理、 日志格式、 文件组织方式、 HTTP API 接口设计、 UI 交互等各个方面，越是一致的系统越容易上手，越容易维护，反之则 维护成本越高。 健壮性，进行必要的输入验证，充分得考虑边界情况，异常处理要周全，防止内存 泄露，防止竞态条件，多线程安全，等等。 性能，考虑数据量大或者访问频繁时的情况，对内存、数据库的使用要高效，算法 要尽量最优。 1. 任何涉及数量的地方， 在业务场景合理的前提下考虑把数量放大到最大， 为 最坏的情况做打算。 2. 数据库： 操作应尽量批量进行，只查询必需的字段，减少 IO 消耗。 特别大的查询应在数据库中分页，由程序控制分批次处理，全量取出在内存中计算 或者根本不考虑数据量大小是常见的低级错误。合理使用索引，例如尽量使用前缀 索引减少索引的数量 安全性，进行必要的权限检查，不能过度信任客户端输入。 DRY （Dont Repeat Yourself ）原则，复制、粘贴的行为是要坚决禁止的，不知道 如何复用代码的要主动与其他成员讨论。 单一职责原则，一个类、文件或者模块不能做的太多，不能做不该它做的事，好的 设计是只把一件事做好。 开放、封闭原则，要方便扩展，要考虑到以后的需求。 代码改动方式要合适，不能一味得堆砌代码，需要适时停下来进行重构。 保持干净，不能存在任何无用的文件、代码，所有文档、注释需要同步更新，不能 包含注释掉的代码，不能包含临时调试代码，例外情况应该添加注释说明。 所有 Warning 都应该被立即修复，觉得不需要修的，讨论决定后通过修改配置文 件禁用掉。 2. 进阶要求 使用多态减少或转移 `if` 判断， /watch?v=4F72VULWFvcindex=1list=PL693EF D059797C21E 3. 提高代码可读性的技巧 局部变量尽量就近声明。 return early, Best Practices for Modern PHP Development-, How and Why to Avoid Excessive Nesting 在语言本身语法允许的情况下，将主流程放在文件上部，子流程按被调用顺序放在 文件下部，这样打开文件后可以比较快的抓住重点，比如： main = - doStuff1() doStuff2() doStuff3() doStuff1 = - console.log 1 d