所在位置:首页 -- 企业内训 -- 正文

代码整洁之道-卓越软件代码质量体系最佳实践内训课程


发布时间:2013-2-17  来源:admin

一、为什么需要该课程
管理者最担心听到开发人员这样抱怨:“不能再增加功能了!我们得停下来重写代码。软件代码一团糟,就像纸糊的老虎,根本应付不了持续增加的用户需求。我们实在维护不下去了!最好推倒重写吧”
这一幕在很多公司上演过,现在依然在不断重演。一旦公司陷入这种困境,以前版本的开发者往往沦为替罪羊。新的开发者一般就会骂前人怎么写这么烂的代码。他们准备推倒重来,准备重写系统。在重写代码的过程中,用户无法看到产品的任何改进。你可能认为重写代码至多也就几个月,但是实际花费的时间无一例外要多得多。你只能坐在一旁,眼睁睁看着用户投奔竞争对手,而这个时候,竞争对手恰恰在不断地改进产品。
因此我们认为软件质量,不但依赖于架构及项目管理,而且与代码质量紧密相关。这一点,无论是敏捷开发流派还是传统开发流派,都不得不承认。干净整洁的代码,既在质量上较为可靠,也为后期维护、升级,架构演进奠定了良好基础。在最近几年的业界,大家都把精力花费在了软件需求,架构,过程和管理等,反而代码这个与软件开发骨肉相连的环节反而被忽视了。
我们研发中心有一个理念”代码是债务而不是资产”。最开始,团队会编写代码,做出产品,并用它来赚钱,但是,之后团队应该尽可能地寻找减少代码的方法和使代码尽量整洁,从而降低成本。软件界有一个真理,你拥有的代码越多,维护代码所要付出的成本就越高。如果你的代码结构越好,你做了越多的单元测试,你的代码质量越好、越小、耦合越松,那么添加新代码所需要付出的成本就越少。因此OOP大师 Craig Larman: “最好维护的代码就是没有代码,好的程序员的代码产量是负的,因为他通过减少代码来增加功能”。对比现实中,很多人以为,LOC(line of code)越多的feature越大,写LOC越多的程序员越牛。这其实是极其错误的观念。
因此我们必须有全面的管理制度让我们保持代码少而整洁。所以软件大师Michael Feathers认为"未来属于知道如何有策略地删除代码的公司”。持有代码的成本要比我们想象的大。意识到这一点的公司更具有竞争优势。
为了切实帮助软件企业降低企业项目开发成本,大面积提高软件工程师编程能力和代码质量管理能力,我们特别推出了代码质量实战训练营. 分享多家大型研发中心代码管理经验给大家. 该课程适应于各个阶段的技术人员.初级工程师能够透过大师的眼睛来看待编程,了解编程的价值观和原则;具有丰富经验的设计师和架构师可以通过模式进行反思,探究成功实践背后的意义.把价值观,原则和开发实践结合;管理者通过学习业界著名研发中心的管理经验和失败的教训,来制定自己公司的代码管理策略.质量管理相关人员学习如何定制代码质量指标,通过哪些工具进行监控,怎样管理代码质量。
 

 

我们已经为几十家企业提供了多次培训和咨询服务,以下企业已经选择了我们的内训课程
互联网研发企业,比如百度研发中心2次,阿里巴巴1次
电信研发企业,比如思科研发中心5次,阿尔卡特-朗讯研发中心11次,华为研发中心 1次,摩托罗拉研发中心 1次,大唐电信研发 1次
企业软件研发企业,比如Adobe中国研发中心,北京久其研发中心,博古中国研发中心
嵌入式软件企业,比如阿尔卑斯中国研发中心,德国M&M Software,西门子研发中心
外包类企业,联盟计算机服务(天津)有限公司ACS 3次。
金融行业:恒生电子2次,华腾1次,中国人民银行研发中心,工商银行研发中心

我们已经为几十期公开课,已经有100多家企业已经选择了我们的公开课程
腾讯(深圳)有限公司, EMC中国研发中心,华为终端有限公司、 斯伦贝谢技术,通用电气医疗系统(中国)有限公司,华为技术有限公司,广州从兴电子开发有限公司、福建星网锐捷股份有限公司,广州菲特网络科技有限公司,盛立金融(杭州)软件公司 ,索尼中国研发中心, 爱德万,上海金慧软件有限公司,珠海世纪鼎利通信科技股份,兰吉尔仪表系统有限公司,珠海飞企软件有限公司,广东佳和通信技术有限公司,珠海一多监测科技有限公司,远光软件股份有限公司

你可以参加吗?
各类软件企业和研发中心的程序员、软件设计师、架构师, 项目经理,质量部门员工。
- 如果你不重视代码质量, 请不要参加. 本课程面向重视代码质量的管理者。
- 如果你不认为写好代码是一件重要,困难并且有趣的事情,请你不要参加. 本课程面向追求卓越的程序员,我们认为编程是一种态度。
- 如果你已经多年不写代码,最好不要参加,本课程面向一线还在编程的程序员/设计师/架构师。

你的角色和收获
课程根据著名编程大师的理论:
编程是一种态度,编程是一种技艺,编程是一种习惯。
面向以下不同的人群,有不同收获。

角色
收获
技术负责人/技术总监
树立代码质量意识
代码是债务
代码的两面性,静态结构与动态功能
软件技术债务和代码腐化
国际多家著名研发企业的代码质量管理思想
项目经理/项目管理人员/架构师
- 学习其他研发机构的代码管理思想
- 代码管理手段
- 代码管理相关流程和相关工具
- 代码监控
测试部门/质量管理部门
- 代码审查
- 代码检查列表
- 代码管理手段
- 代码管理制度的建立
资深开发人员
- 编程技艺和相关编程实践
- 重构手段
一般开发人员
- 编程技艺和相关编程实践
- 重构手段
- 代码坏味道

你有这样的基础吗?
学员学习本课程应具备下列基础知识:
了解Java/C#或者C++/C或者其他任何一种编程语言,你一定要写过代码吧!

第一篇: 编程是一种态度-------价值观
主题
培训内容
第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、函数重构之道—抽取方法(Extract Method)和抽取对象函数
9、函数命名—怎样取好的函数名
10、通过大量项目代码分析,函数的遇到的各种问题,如何编程高质量函数

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


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

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

 

第4单元
高质量类

内容一:类基础-数据抽象类型(Abstract Data Types)
1、类的基础:抽象数据类
2、需要用到ADT的场景
3、使用ADT的益处
4、基本类型依赖坏味道
5、数据泥团坏味道
6、案例—通过电信项目介绍数据的抽象
7、通过大量项目代码演示数据抽象类型解决的问题

内容二:面向对象设计----职责分配
1、单一职责原则
2、RDD-职责驱动的面向对象设计方法
3、上帝类,代码之中的大量的上帝类
4、通过案例分析,如何进行设计高质量类和重构

内容三:面向对象的编程
1、上帝类/过大的类--违反单一职责
2、依恋情结-一个方法视乎过于强调处理其他类的数据,而不是处理自己的数据
3、发散式改变
4、散弹式修改
5、消息链
6、中间人
7、不当的紧密性
8、案例—通过电信项目介绍OOP

第5单元
单元测试与代码可测试性

内容一:单元测试
1、单元测试基本知识
2、单元测试框架提供了什么功能
3、好的测试是什么样子的
4、为什么要写单元测试,为什么不写单元测试
5、为什么要写"好"的单元测试
6、通过案例分析单元测试的基本概念,以及如何评价好的单元测试,单元测试为价值。

内容二:编写可测试代码
1、
如何编写可信赖的测试
2、如何编写可维护性的测试
3、如何编写可读的测试
4、测试代码的重构
5、 通过大量真实项目案例分析如何编写可测试性代码

第三篇: 编程是一种习惯-------管理篇
第6单元
代码重构

内容一:代码重构
1、重构必然性
2、破窗效应与技术债务
3、 实际重构遇到的4大问题
a)如何发现重构点
b)如何去重构(重构方式)
c)如何知道重构何止截止
d)如何保证重构的正确性
4、介绍常见的重构技术
5、重构到模式的目录
6、 通过多个案例分析,重构面临的问题和解决之道

内容二:大型项目的重构案例分析
1、通过大型项目的重构,分析重构的最佳实践

内容三:重构目录
1、重构名录
2、介绍常见的重构技术
3、分别通过相关案例展示重构手段
4、 通过项目的重构案例,分析重构的手段

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

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

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

第8单元
代码质量体系最佳实践

内容一:代码质量管理4个现代化
1、代码管理的4个现代化
a)质量量化(如何设置质量指标)
b)工具化(如何寻找合适的工具
c)自动化(把流程自动化,忘记流程)
d)持续优化(反思与优化)
2、多家电信研发中心,如何实现4个代码现代化

内容二:代码静态分析工具
1、代码静态分析工具概述
2、以Java语言代码静态分析工具为例介绍,该内容的思想仍然适合其他语言
a)Sonar集成平台
b)CheckStyle:用于编码标准
c)PMD 的 CPD:帮助发现代码重复
d)Coverlipse:测量代码覆盖率
e)Depend:提供依赖项分析
f)Metric:有效地查出复杂度
g)其他语言相关代码静态分析工具
3、通过案例演示工具在项目之中的应用

内容三:代码评审
1、代码评审前期准备
2、代码评审的代码量
3、代码评审的检查表
4、代码评审的总结与学习

内容四:代码质量管理体系
1、结合国内多家研发中心的代码管理经验分享
2、代码质量体系的建立