简洁代码》--开发人员的必读书，让代码更易读、更易修复

"易读的代码才是好代码"。

如果你是一名开发人员，你可能听说过《简洁代码》（Clean Code）这本书，它阐述了软件开发的基本原则和实践，特别强调协作和可维护性。罗伯特-C-马丁（Robert C. Martin）的这本书不仅仅介绍了如何编写代码、 开发人员的理念和态度帮助取代

在本篇文章中，我们将为您介绍这本开发者之书的总体概况，梳理每一章的重点内容，并说明为什么它是一本必读之书。

Cleancode 概览

• 作者：罗伯特：罗伯特-C-马丁
• 出版商：洞察力
• 出版年份2008
• 读者对象： 所有重视可读性和可维护性的软件开发人员，从初学者到有经验者。
• 关键信息
  • 整洁的代码应易于阅读和修复。
  • 协作性和可维护性强的代码是开发人员的必备条件。
  • 不要忽视不良代码，应立即加以改进。

第 1 章：什么是简洁代码？

- 整洁的代码是 可读性, 清晰度, 尽量减少重复在代码中。

- "我稍后再解决 "的心态很危险。 勒布朗定律俗话说，"后会无期"。

第 2 章：有意义的名称

- 名称是理解代码的最重要因素。

• 好名字的标志
  • 明确传达意图：光看名称就能知道它的作用。
  • 保持一致：在整个项目中遵循命名惯例。
  • 例如
    • 坏例子int a；
    • 一个很好的例子：Int userAge；

第 3 章：功能

- 函数是一个 只执行一个操作应该是 短小精悍你应该

- 将复杂的逻辑分解成更小的函数，使其更易于重复使用和阅读。

- 始终牢记 "功能只做一件事 "的原则。

第 4 章：注释

- 您的代码应与注释本身一样清晰，避免不必要的注释。

• 一个好的注释范例：
  • "此方法验证用户输入的值"。
• 错误注释示例
  • "增加一个值"（一个重复代码描述的注释）

第 5 章：格式设置

- 像报纸文章一样格式化您的代码

- 将较高层次的概念放在最前面，然后再逐层深入到越来越多的细节。

- 通过一致的缩进和空白管理，让代码更易读。

第 6 章：对象和数据结构

- 对象是 添加操作赞成 添加数据对其有利。

- 根据问题的不同，在面向对象和程序方法之间做出选择。

第 7 章：错误处理

- 错误处理应清晰明了，不影响程序逻辑。

• 很好的例子：
  • catch (IOException e) { log.error("File processing error", e); }
• 坏例子
  • catch (Exception e) { e.printStackTrace(); }

第 8 章：界限

• 明确划分与外部库或应用程序接口的界限非常重要。

• 使用封装类减少对外部库的依赖并管理边界。

• 举例说明：将业务逻辑与外部库中的代码分开，可以最大限度地减少库变更的影响。

第 9 章：单元测试

• 整洁的代码必须包括测试代码。

• 测试能确保代码的灵活性和可靠性，并能在重构时及早发现问题。

• 良好测试的特点：
  • 运行速度很快。
  • 独立。
  • 易于阅读和理解。

• 它强调了测试驱动开发（TDD）的重要性，并建议先编写测试，然后再开发代码。

第 10 章：班级

• 类是一个 单一责任原则（SRP）以符合要求。

• 随着班级规模的扩大，班级的凝聚力会降低，也更难维持，因此要按角色将班级分开。

• 封装向外界隐藏了类内部的具体实现，并提供了一个清晰的接口。

第 11 章：系统

• 简洁的系统设计要求保持简单，消除冗余。

• 交流和文档编写非常重要，编写时要确保仅通过代码就能理解系统的行为。

• 在系统设计中考虑模块化和分层，以最大限度地减少变更带来的影响。

第 12 章：创造力

• 创造力是简化系统复杂性的能力，同时产生明确和可预测的结果。

• 他强调，清洁代码遵循以下四项原则
  • 通过所有测试
  • 删除重复内容。
  • 要有表现力。
  • 尽量减少类和方法。

第 13 章：并发

• 并发对于优化性能至关重要，但也会增加复杂性和出错几率。

• 并发控制策略：
  • 编写线程安全代码，减少线程之间的依赖性。
  • 尽量减少状态共享，使用不可变对象以避免错误。
  • 仅通过单元测试很难发现并发问题，因此需要涵盖各种场景的测试。

第 14 章：渐进式改进

• 在进行增量改进（重构）的同时，应保持代码的整洁。

• 重构的基本原则
  • 做一些小改动，以保持系统的稳定性。
  • 编写测试，确保现有功能的行为一致。
• 可维护代码不是一蹴而就的，它需要不断改进。

第 15 章：了解 JUnit

• JUnit 是一个基于 Java 的单元测试框架，可帮助您编写简洁的测试代码。

• 如何编写简洁的测试代码
  • 测试名称清楚地表明了测试的目的和预期结果。
  • 使用 Given-When-Then 模式明确测试方案。
  • JUnit 可自动进行测试，帮助您在开发过程中保持一致性。

第 16 章：重构 SerialDate

本章将以一个具体实例来说明重构日期相关类的过程。

• 重构策略
  • 删除重复代码
  • 方法分离和类分割。
  • 通过界面设计提高代码的灵活性。

• 强调测试代码的可靠性在重构过程中至关重要。

第 17 章：嗅觉和启发法

气味代码是代码结构中效率低下或有问题的部分。

顶级气味和解决方案：

长方法：将方法分解成较小的单元。

• 类的依赖性：尽量减少依赖性，充分利用接口。
• 重复代码：提取到通用模块。

启发式方法是通过经验积累起来的规则和准则，是改进代码的有用基准。

实用技巧

"清洁代码 "的实际应用如下。

1. 重构 改进现有代码，减少重复，提高可读性

2. 编写测试代码 确保代码质量，增强维护信心

3. 统一命名规则： 确保团队内部的一致性并加强协作

组织您的书评

"清洁代码》不仅仅是一本编码指南、 发展理念和实践在本书中。整洁的代码不仅能提高个人效率，还能极大地促进与团队的合作。 可读、易修复的代码那么这本书将使你的开发能力更上一层楼！

猜猜我推荐哪本书作为开发人员的必读书？ 就是那本在另一份开发人员推荐书单上名列前茅的书！ 开发人员书籍推荐--"软技能"，完美融合开发与生活的必读书！ 请看这篇文章。