卓越软件工程师代码整洁之道

教练：刘捷

咨询公司 曾任职BEA(中国)资深软件架构师

曾任职BEA(中国)资深软件架构师，十余年的企业软件架构、开发和管理经验, 侧重于企业应用软件架构设计.主要负责客户大型项目的架构设计和研发。
作为技术专家保证项目的成功实施，运行和维护。参加过全国/全省多个大型的计算机应用项目，擅长的领域包括电信，金融、税务,大型互联网web2.0应用等。此前就职于IBM，任软件架构师。 在此之前曾任日本东京一家软件企业的资深技术顾问。

主题

内容

第1单元 代码就是债务

内容一：代码是债务
1. 代码的认识---代码就是债务
2. 代码是债务，越少越好
3. 你拥有的代码越多，添加新内容所要付出的成本就越高
4. 通过案例分析让代码库尽可能小的方法：
5. 通过国际研发中心电信计费系统演示代码是债务的思想，10多年国外研发团队设计与研发第一版本，目前几百人在维护
通过项目演示通过重构如何减少了一半的代码，维护的人员的减少

项目的失败可能归咎于各种各样的原因。一些项目因糟糕的需求而失败，另一些则由于钱和时间超支了，还有少数单纯是因为糟糕的管理所致。如果我们探究其根本原因，是否会发现所有项目失败的罪魁祸首是糟糕的代码呢？

Bob大叔坚信糟糕的代码所带来的成本之大足够让一个项目失败。

内容二 软件界要以新视角看待代码
1. 传统的软件工程对代码的错误认识
2. 代码的两面性，代码的静态结构和运行时行为
3. 客户和管理者往往仅仅关注代码的运行时的行为
4. 温伯格认为的主管必须关注代码
5. 软件设计与代码的关系—真正好的设计是在编码阶段一步一步而形成的,通过案例分析，设计如何根据代码进行演化
6. 编程真的是简单的劳动吗？
7. 通过多家项目案例进行分析，传统思想对代码的种种误解，我们提出了从3种新的角度来观察代码，
a) 从管理者的角度，我们仅仅观察代码的运行时行为，导致代码的静态结构混乱的根源。这就是代码的冰山原理，大量垃圾代码隐藏在冰山之下。
b) 设计师的角度认为只要有好的设计，软件质量就可以保证。其实我们认为代码是真正唯一可以精确描述的设计文档。
c) 程序员的视角，编程真的很难，通过某一个项目案例分析，20多人一周的工作量就为几行代码问题

第2单元编程价值观

内容一：编程价值观
1. 编程的方法学
2. 什么是好的代码，我们却认为“Good code is not bad code !”
3. 编程价值观---沟通,简单,灵活
4. 价值观决定行为
5. 优秀代码的评价标准, 什么是高质量编码? 特征是什么?
6. 软件代码的可读性
7. 代码的可扩展性
8. 糟糕代码的特征
9. 劣质代码的代价
10. 大师评价整洁代码的标准
11. 通过大量项目案例分析，什么是好的代码，对好代码新的认识

第3单元 高质量函数（该内容较多，根据实际情况调整）

内容一：高质量函数/过程
1. 为什么需要函数
2. 函数复杂度度量
3. 函数圈复杂度以及度量
4. 函数抽象层次-单一抽象层次原则SLAP(Single Level of Abstrction Principle)
5. 函数实现模式之—组合函数(Composed Method)
6. 万恶之源—函数过长
7. 函数的单一职责
8. 函数第一原则:是要短小,函数第二原则:是还要短小,函数第三原则:是必须短小
9. 函数重构之道—抽取方法(Extract Method)和抽取对象函数
10. 函数命名—怎样取好的函数名
11. 通过大量项目代码分析,函数的遇到的各种问题,如何编程高质量函数

内容二：函数易理解与沟通
1. 函数主体流
2. 函数的异常处理
3. 函数主题流程简化方法1-助手方法
4. 助手方法的应用场景
5. 助手方法的效果
6. 函数主题流程简化方法2-函数对象（MethodObject）
7. 通过真实项目代码进行分析，如果提高代码的可读性

内容三：函数灵活/易可扩展---函数接缝
1. 历史遗留代码维护问题
2. 某电信研发中心的维护问题—开发维护的效率问题。
3. 增加一个功能特性的成本并不单单是为这些功能编码所花费时间的成本，还应该包括特性扩展的障碍成本。
4. 代码的可维护成本分析—通过大量案例分析
a) 确定需要修改哪些部分有多难
b) 必要的改动有多少
c) 实现改动对系统其他部分的影响有多大
5. 如何实现代码的易扩展—函数接缝
6. 接缝（seam），指程序中的一些特殊的点，在这些点上你无需做任何修改就可以达到改动程序行为的目的
7. 通过案例分析，如何实现函数的灵活/易扩展。

内容四：函数参数
1. 函数参数过长
2. 最理想的参数数量是零,其次是一,再次是二,有足够的理由才能使用三个以上参数.
3. 函数参数重构之道-引入参数对象(introduce parameter object
4. 函数参数的顺序.
5. 不要把程序参数当做工作变量/临时变量
6. 函数参数模式-collecting parameter
7. 函数返回值
8. 通过大量项目代码是函数参数问题
9. 演示函参数的重构

内容五：变量
1. “一旦了解在程序设计中如何使用变量，他就掌握了程序设计的精华。”-Dijkstra
2. 为什么需要变量—变量的引入的理由
3. 单一变量用途
4. 变量与方法
5. 变量作用域
6. 变量声明与初始化
7. 通过案例分析， 函数的变量如何处理与控制。


内容六：函数代码重复
1. 重复的危害
2. 强加的重复/无意的重复/无耐心的重复/开发者之间的重复
3. 不要重复自己DRY—Don't Repeat Yourself Principle
4. Make It Easy to Reuse（让复用变得容易）
5. 魔法数(Magic number)
6. 重复性代码(Duplicated Code)
7. 接口不同的相似类(Alternative Classes with Different Interfaces)
8. 系统分离关注点
9. 系统架构的基础通用服务组件
10. 通过某项目代码是介绍重复编码问题
11. 演示研发过程之中的常见重复问题,以及如何解决

内容七：条件表达式
1. 复杂表达式的简化
2. IF/ELSE语句应该如何编写
3. Switch/Case语句应该如何编写
4. 复杂条件表示式的危害
5. 过分深层的缩进，或者“嵌套”，已经困扰了计算机界达25年之久，并且至今仍然是产生混乱代码的罪魁祸首之一
6. 复杂表达式重构之道—引入解释变量/分解条件/抽取方法计算条件
7. 表驱动法-多级嵌套IF语句的必然之道
8. 表驱动法使用总则
9. 某保险项目表驱动法应用案例分析
10. 通过大量项目代码演示条件表达式编码问题
11. 复杂表达式的注意事项,如何解决

内容八：利用多态解决复杂表达式
1. 面向对象多态技术的新认识
2. 减少使用if语句,重构到多态
3. 以State/Strategy取代类型代码
4. 引入Null Object
5. 以Command替换条件调度程序
6. 转移聚集操作到Visitor
7. 转移装饰功能到Decorator
8. 通过大量项目代码演示多态可以解决的编程问题


内容九：函数组织
1. 尽管组织直线代码是一个相当简单的任务，代码结构上的不合理会对代码的质量，正确性，可读性和可维护性带来影响。
2. 把函数代码分成“段落”
3. 选择一个有意义的顺序，始终一致的使用它
4. 应该把代码组织得一次只做一件事情
5. 组织直线型代码。嵌套可以，但是不应该交叠
6. 系统应该由许多短小的函数而不是少量巨大的大函数组成！
7. 系统应该由许多短小的类而不是少量巨大的大类组成！
8. 把子程序提取另一个程序，不会降低整个程序的复杂度，只是把决策点转移到其他地方。
9. 但是可以降低你在同一时间必须关注的复杂度水平。重点是要降低你需要在头脑中同时考虑的项目的数量，所以一个给定子程序的复杂度是有价值的。
10. 通过大量真实案例的代码进行分析函数的代码的组织技术


内容十：函数的错误处理和异常管理
1. 函数的错误处理
2. 使用异常而非返回码
3. 依赖磁铁（Dependeny magent）
4. 主体流-明确表达控制流的主体
5. 异常流-尽可能清晰地表达异常控制流，而不干扰对主体流的表达
6. 标准的异常处理9种方法
7. 通过大量真实案例的代码进行分析函数的错误处理和异常处理

第4单元 代码重构

内容一：代码重构
1. 重构必然性
2. 破窗效应与技术债务
3. 实际重构遇到的4大问题
4. 介绍常见的重构技术
5. 重构到模式的目录
6. 通过多个案例分析，重构面临的问题和解决之道

第5单元 修改遗留系统代码

内容一：修改遗留项目代码
1. 必须修改遗留的代码起因
2. 遗留代码修改危险事项
3. 如何对依赖代码做测试
4. 依赖代码的感知与分离
5. 依赖代码修改的接缝技术
6. 修改依赖代码的工具
7. 降低风险的措施
8. 接依赖技术
9. 通过多个大型项目案例分析，如何修改遗留代码，分析如何解耦

内容二：拒绝退化-如何修改遗留系统，而不破坏现有系统结构
1. 拒绝退化—“首先不要伤害”
2. Sprout Method
3. Sprout Class
4. Wrap Method
5. Wrap Method
6. 通过案例分析，如何修改遗留代码，而不破坏现有系统代码结构