整洁代码经典实例_[阿根廷]马克西米利亚诺孔蒂耶里（Maximiliano Contieri）_9787519892401

本书通过JavaScript、PHP、Python、Java等多种编程语言的真实示例,提供了经过验证的实践方法,帮助你扩展和维护大型系统。每章涵盖了包括可读性、耦合性、可测试性、安全性和可扩展性在内的基本概念,还有代码坏味道及其相应的解决方案。随着阅读的深入,本书中的重构实例及其解决的问题会变得越来越复杂。你将学习以下内容：理解整洁代码的好处,并学习如何识别改进机会。逐步学习重构技术。理解整洁代码背后的理论。在多种现代编程语言中看到实际的例子。获得代码坏味道的全面列表,了解它们的影响及可能的解决方案。编写简洁直观的代码,注重可读性和学习性。

前言代码随处可见，从网页开发到智能合约、嵌入式系统、区块链、詹姆斯·韦伯的机载软件系统、外科手术机器人等各个领域。软件有效地接管了世界，我们目前正在见证专业人工智能代码生成工具的崛起。这意味着整洁的代码比以往任何时候都更加重要。随着你在日益庞大的专有或开源代码库中持续工作，整洁的代码是保持其新鲜并随时准备进化的方法。本书的读者对象本书帮助你识别代码库中的常见问题，强调这些问题的后果，并最终通过易于跟随的经典实例帮助你避免这些问题。这是一本宝贵的资源，可以极大地帮助程序员、代码审查者、架构师和学生改善他们的编程技能和现有系统。本书的组织结构本书分为25 章。每章都以一些原则和基础知识开始，展示整洁代码的好处、后果以及在错误应用时的缺点。第1 章讨论了整洁代码的单一指导规则：将真实世界的实体与你的设计进行一一映射。这一规则作为其他所有原则的基础。在每章中，你会发现几个按主题组织的经典实例，提供工具和建议来改变你的代码。每个经典实例的目的是帮助你在当前情况下做出积极的改变和改进。除了经典实例和示例外，你还将介绍各种软件设计原则、启发法和规则。由于整洁的代码不仅仅是某一种编程语言的属性，因此经典实例中包含了多种编程语言的代码示例。许多重构书籍都依赖于一种语言，作者使用最新趋势的编程语言。但这本书与编程语言无关，大多数实例适用于许多语言（除非有说明）。即使大部分代码可以直接运行，你也应该将代码视为伪代码。当我需要在可读性和性能之间做出选择时，我总是选择可读性。本书中提供了常见术语的定义，但你也可以在书中的术语表中找到它们的所有内容。使用本书所需的条件为了运行代码示例，你需要一个工作环境，比如 OReilly 沙盒（https://learning.oreilly.com/interactive）或 Replit（https://replit.com）。我鼓励你将代码示例转换成你喜欢的编程语言。现在你可以利用人工智能代码生成器免费进行翻译。我使用过 GitHub Copilot、OpenAI Codex、Bard、ChatGPT 等工具来帮助我编写本书的代码示例。利用这些工具使我能够在本书中使用超过25 种不同的编程语言，即使我并不是许多编程语言的专家。以数字格式获取本书这本整洁代码经典实例提供了免费访问的在线版本，随时可用，并可进行搜索，网址为https://cleancodecookbook.com。本书中使用的约定本书使用以下排版约定：斜体（Italic）表示新术语、URL、电子邮件地址、文件名和文件扩展名。等宽字体（Constant width）用于程序清单，以及段落中引用程序元素，如变量或函数名称、数据库、数据类型、环境变量、语句和关键字。等宽加粗字体（Constant width bold）显示用户应该按照字面输入的命令或其他文本。等宽斜体（Constant width italic）显示应该用用户提供的值或上下文确定的值替换的文本。使用代码示例可从https://github.com/mcsee/clean-code-cookbook 下载补充材料（代码示例、练习等）。如果你有技术问题或在使用代码示例时遇到问题，请发送电子邮件至errata@oreilly.com.cn。这本书旨在帮助你完成工作。通常情况下，如果这本书提供了示例代码，你可以在你的程序和文档中使用它。除非你要复制大部分代码，否则无需征得我们的许可。例如，编写一个使用本书多个代码块的程序不需要许可。出售或分发来自OReilly 图书的示例代码需要许可。通过引用本书并引用示例代码来回答问题不需要许可。将本书的大量示例代码合并到产品文档中需要许可。我们感谢但通常不要求署名。署名通常包括标题、作者、出版社和ISBN。例如：Clean Code Cookbook by Maximiliano Contieri (OReilly). Copyright 2023 Maximiliano Contieri。如果你认为你使用的代码示例超出了合理使用范围或上述许可的限制，请随时与我们联系，邮箱为permissions@oreilly.com。OReilly 在线学习平台（OReilly Online Learning）近40 年来，OReilly Media 致力于提供技术和商业培训、知识和卓越见解，来帮助众多公司取得成功。公司独有的专家和改革创新者网络通过OReilly 书籍、文章以及在线学习平台，分享他们的专业知识和实践经验。OReilly 在线学习平台按照您的需要提供实时培训课程、深入学习渠道、交互式编程环境以及来自OReilly 和其他200 多家出版商的大量书籍与视频资料。更多信息，请访问网站：https://www.oreilly.com/。联系我们任何有关本书的意见或疑问，请按照以下地址联系出版社。美国：OReilly Media, Inc.1005 Gravenstein Highway NorthSebastopol, CA 95472中国：北京市西城区西直门南大街2 号成铭大厦C 座807 室（100035）奥莱利技术咨询（北京）有限公司我们为本书建立了一个网页，列出勘误表、示例和任何额外信息。你可以在https://oreil.ly/clean-code-cookbook 上访问此页面。有关我们的图书和课程的新闻和信息，请访问https://oreilly.com。在LinkedIn 上找到我们：https://linkedin.com/company/oreilly-media。在Twitter 上关注我们：https://twitter.com/oreillymedia。在YouTube 上观看我们：https://youtube.com/oreillymedia。致谢这本书献给我的妻子Maria Virginia，她一直充满爱心和支持，还有我亲爱的女儿Malena 和Miranda，以及我的父母Juan Carlos 和Alicia。我深表感谢Maximo Prieto 和Hernan Wilkinson，他们宝贵的见解和知识为本书提出的观点做出了巨大贡献。我也感激我在软件工程公司的同事们分享的想法，以及我在布宜诺斯艾利斯大学的同行老师多年来分享的知识和专业知识。最后，我要感谢技术审阅者Luben Alexandrov、Daniel Moka 和Carlos E. Ferro，以及我的编辑Sara Hunter，他们的指导和建议极大地改进了这本书。

目录
序 1
前言 3
第1 章整洁代码 9
1.1 什么是代码坏味道？ .9
1.2 重构是什么？ .10
1.3 什么是经典实例？ 10
1.4 为什么要写整洁的代码？ 11
1.5 可读性、性能,或者两者兼而有之. 11
1.6 软件类型 11
1.7 机器生成的代码 12
1.8 本书中的命名考虑 12
1.9 设计模式13
1.10 编程语言范式 13
1.11 对象与类的比较 13
1.12 可变性 .14
第2 章建立原则 15
2.0 引言 .15
2.1 为什么它是一个模型？ .16
2.2 为什么它是抽象的？ 16
2.3 为什么它是可编程的？ .16
2.4 为什么它是部分的？ 17
2.5 为什么它是解释性的？ .17
2.6 为什么它与现实有关？ .18
2.7 推断规则18
2.8 唯一的软件设计原则 18
第3 章贫血模型 25
3.0 引言 .25
3.1 将贫血对象转换为丰富对象 26
3.2 识别你的对象的本质 28
3.3 移除对象中的setter .30
3.4 移除贫血代码生成器 32
3.5 移除自动属性 .34
3.6 移除DTO .35
3.7 完善空构造函数 39
3.8 移除getter 40
3.9 防止对象随意调用 44
3.10 移除动态属性 45
第4 章原始偏执 49
4.0 引言 .49
4.1 创建小对象 50
4.2 实例化原始数据 52
4.3 实例化关联数组 53
4.4 移除滥用字符串 55
4.5 实例化时间戳 .57
4.6 实例化子集为对象 58
4.7 实例化字符串验证 59
4.8 移除不必要的属性 62
4.9 创建日期区间 .64
第5 章可变性 67
5.0 引言 .67
5.1 将变量改为常量 69
5.2 声明变量为可变变量 70
5.3 禁止改变本质 .72
5.4 避免可变的常量数组 74
5.5 移除延迟初始化 76
5.6 冻结可变常量 .78
5.7 移除副作用 81
5.8 防止提升82
第6 章声明式代码 85
6.0 引言 .85
6.1 缩小重用变量的范围 86
6.2 移除空行87
6.3 移除带版本的方法 89
6.4 移除双重否定 .90
6.5 改变错位的责任 91
6.6 替换显式迭代 .93
6.7 记录设计决策 .94
6.8 用常量替换魔法数字 95
6.9 分离是什么和怎么做 97
6.10 文档化正则表达式 .98
6.11 重写Yoda 条件 99
6.12 移除滑稽方法 100
6.13 避免回调地狱 101
6.14 生成良好的错误消息 .104
6.15 避免魔法修正 106
第7 章命名 . 109
7.0 引言 109
7.1 扩展缩写.109
7.2 重命名和拆分Helpers 和Utils 112
7.3 重命名MyObjects . 115
7.4 重命名结果变量 . 116
7.5 重命名以类型命名的变量 . 118
7.6 重命名长名称 119
7.7 重命名抽象名称 .120
7.8 更正拼写错误 122
7.9 从属性中移除类名 .122
7.10 移除类和接口的首字母 124
7.11 重命名base/do 函数 125
7.12 将复数类转换为单数 .127
7.13 从名称中移除Collection .128
7.14 移除类名中的Impl前缀/ 后缀 .129
7.15 根据角色重命名参数 .130
7.16 移除冗余的参数名称 .131
7.17 移除名称中的不必要上下文 133
7.18 避免数据命名 134
第8 章注释 . 137
8.0 引言 137
8.1 删除被注释的代码 .138
8.2 删除过时的注释 .140
8.3 删除逻辑注释 141
8.4 删除Getter 注释 .143
8.5 将注释转换为函数名称 144
8.6 删除方法内的注释 .145
8.7 用测试替换注释 148
第9 章标准 . 151
9.0 引言 151
9.1 遵循代码规范 151
9.2 统一缩进方式 154
9.3 统一命名规范 156
9.4 用英文编写代码 .157
9.5 统一参数顺序 159
9.6 修复另外的问题 .160
第10 章复杂性 163
10.0 引言 163
10.1 移除重复代码 163
10.2 移除设置/ 配置和功能切换 166
10.3 将状态作为属性更改 .167
10.4 移除代码中的特殊设计 170
10.5 打破多个Promises 172
10.6 打破长链的协作 173
10.7 将方法提取到对象中 .175
10.8 关注数组构造函数 177
10.9 移除幽灵对象 179
第11 章膨胀者 181
11.0 引言 181
11.1 分解过长的方法 181
11.2 减少过多参数 183
11.3 减少多余变量 185
11.4 移除过多的括号 188
11.5 移除过多的方法 189
11.6 分解过多的属性 190
11.7 减少导入列表 192
11.8 拆分与功能 193
11.9 拆分臃肿的接口 195
第12 章 YAGNI 199
12.0 引言 199
12.1 移除死代码 .200
12.2 使用代码代替图表 201
12.3 重构只有一个子类的类 203
12.4 移除只使用一次的接口 205
12.5 移除设计模式的滥用 .207
12.6 替换业务集合 208
第13 章快速失败 211
13.0 引言 211
13.1 变量重新赋值的重构 . 211
13.2 强制前提条件 213
13.3 使用更严格的参数 216
13.4 移除开关语句中的默认情况 217
13.5 避免在遍历时修改集合 219
13.6 重新定义哈希和相等性 220
13.7 无功能性变化的重构 .222
第14 章条件语句 225
14.0 引言 225
14.1 用多态替换偶然的if 语句 226
14.2 为事件重命名标志变量 234
14.3 实例化布尔变量 235
14.4 替换Switch/Case/elseif 语句 .237
14.5 使用集合替换硬编码的if 条件 .239
14.6 将布尔值改为短路条件 241
14.7 添加隐式else .242
14.8 重写条件箭头代码 243
14.9 避免使用短路技巧 245
14.10 重写嵌套的箭头代码 247
14.11 避免返回布尔值进行条件检查 249
14.12 更改布尔值的比较方式 .251
14.13 从长三元表达式中提取 .252
14.14 将非多态函数转换为多态函数 254
14.15 改变相等比较 .256
14.16 使硬编码的业务条件具体化 257
14.17 移除不必要的布尔值 258
14.18 重写嵌套三元条件 259
第15 章空值 263
15.0 简介 263
15.1 创建空对象 .263
15.2 移除可选链路 267
15.3 将可选属性转换为集合 270
15.4 使用真实对象作为空对象272
15.5 不使用空对象表示未知位置 275
第16 章过早优化 279
16.0 引言 279
16.1 避免对象上的标识符 .280
16.2 移除过早的优化 283
16.3 移除位运算的过早优化 285
16.4 减少过度泛化 286
16.5 改变结构优化 287
16.6 移除锚定船只 289
16.7 从领域对象中提取缓存 290
16.8 基于实现的回调事件的移除 293
16.9 移除构造函数中的查询 294
16.10 从析构函数中移除代码 .295
第17 章耦合 299
17.0 引言 299
17.1 显式化隐藏假设 299
17.2 替换单例模式 301
17.3 打破上帝对象 304
17.4 打破分歧性变更 307
17.5 将9999 特殊标志值转换为正常值 .309
17.6 移除散弹代码 311
17.7 移除可选参数 313
17.8 防止特性依恋 315
17.9 移除中间人 .317
17.10 将默认参数移到末尾 319
17.11 避免连锁反应 .321
17.12 移除业务对象上的意外方法 323
17.13 从用户界面中移除业务代码 324
17.14 改变类之间的耦合 328
17.15 重构数据团 330
17.16 打破不恰当的亲密关系 .332
17.17 转换可互换对象.334
第18 章全局变量 337
18.0 引言 337
18.1 实例化全局函数 337
18.2 实例化静态函数 339
18.3 用结构化代码替换GoTo .340
18.4 移除全局类 .341
18.5 改变全局日期创建 344
第19 章层次结构 347
19.0 引言 347
19.1 打破深层继承 347
19.2 打破悠悠球层次结构 .350
19.3 打破子分类以重用代码 352
19.4 用行为替换is-a关系 .355
19.5 移除嵌套类 .357
19.6 重命名孤立类 359
19.7 使具体类成为最终类 .360
19.8 显式定义类的继承关系 362
19.9 迁移空类 364
19.10 推迟过早的分类.366
19.11 移除受保护的属性 368
19.12 完成空实现 370
第20 章测试 373
20.0 引言 373
20.1 测试私有方法 374
20.2 为断言添加描述 376
20.3 将 assertTrue 迁移到特定断言 377
20.4 用真实对象替换模拟对象 379
20.5 优化通用断言 382
20.6 移除不稳定的测试 383
20.7 更改浮点数断言 385
20.8 将测试数据改为真实数据386
20.9 保护违反封装的测试 .389
20.10 移除不相关的测试信息 .391
20.11 在每个合并请求中添加覆盖率 393
20.12 根据日期重写测试 394
20.13 学习一种新的编程语言 .396
第21 章技术债务 399
21.0 引言 399
21.1 移除依赖于生产环境的代码 400
21.2 移除缺陷跟踪器 402
21.3 移除警告/ 严格模式关闭 403
21.4 预防和移除 ToDo 和 FixMe 405
第22 章异常 407
22.0 引言 407
22.1 删除空的异常块 407
22.2 删除不必要的异常 409
22.3 重写预期情况下的异常 411
22.4 重写嵌套的try/catch 块 412
22.5 用异常替换返回代码 .414
22.6 重写异常箭头代码 416
22.7 隐藏终端用户的低级错误418
22.8 缩小异常范围 419
第23 章元编程 423
23.0 简介 423
23.1 移除元编程用法 424
23.2 实例化匿名函数 428
23.3 移除预处理器 430
23.4 移除动态方法 431
第24 章类型 435
24.0 引言 435
24.1 移除类型检查 435
24.2 处理真值 437
24.3 将浮点数改为小数 441
第25 章安全性 443
25.0 引言 443
25.1 输入过滤 443
25.2 更改顺序ID 445
25.3 移除包依赖 .447
25.4 替换恶意正则表达式 .449
25.5 保护对象反序列化 450
术语表 453

你还可能感兴趣

我要评论