出版时间:2012-8 出版社:电子工业出版社 作者:季奥米季斯·斯宾耐立思(Diomidis Spinellis) 页数:416 译者:左飞,吴跃,杨宁
Tag标签:无
前言
原作者中文版序 中国是首个将我的“开源视角”系列作品再版的国家。这可能有很多原因,而其中一个特别吸引人的原因与孔子的著作有关,他在《论语》中广泛地强调了学习研究的重要性。回顾之前撰写《代码阅读》和《代码质量》的历程,我了解到,实际上,我鼓励了那些从事开发工作的同事和学生借助研究学习软件代码来提升他们自身的知识和技能,这正是我遵循孔子金玉良言的一种方式。 《代码阅读》一书阐述了开发者应当如何阅读已有的代码。关于为何要进行代码阅读,不少人也给出了许多现实中的原因:修正问题、添加特性、寻找有用的片段,或者作为你所在机构质量控制流程的一部分对其进行复查。然而,进行代码阅读最重要的原因其实是从中学习。从已有的高质量代码中,我们可以学习如何将严谨的代码风格应用于实践,如何编写有用的注释,如何编排代码以方便他人读懂,如何选择有意义的标识符,以及如何将复杂的代码组织为可管控的部分。另外,通过研究代码,我们还可以学习到新的算法、API及架构。简而言之,阅读代码可以帮助我们成为更加优秀的程序员。 《代码质量》一书,退后一步,方为大观。当代码被组装为程序时将会产生所谓的聚现属性:可靠性、安全性、CPU利用率、空间占用率、可移植性及可维护性。尽管这些属性可能看起来抽象且难以约束,但是诸多成功的经验表明,借助研究专家级的代码,我们可以学习到许多极好的提升代码质量的方法。我们可以从中发现严谨的错误测试、安全证书的保守处理、高效的算法、灵巧的抽象技术及应用于实践中的基本设计模式。简而言之,这将有助于我们成为极其优秀的程序员。 伟大的哲学家孔子曾经提过:“学而不思则罔,思而不学则殆”。因此我推荐大家主动花些时间来研究已有的代码并从中予以学习。 Diomidis Spinellis 2011年9月于雅典 推 荐 序 今年恰逢“十二五”开局之年,在全球软件技术和产业格局孕育重大调整之际,我国软件产业也在工业化、信息化“两化融合”的大背景下迎来了又一个快速发展的新阶段,这其中机遇与挑战并存。当下软件和信息服务业市场的规模不断扩大,物联网作为又一个万亿元级别的产业将产生千亿元级别的服务外包。预计到2020年,全球潜在的服务外包市场需求将达到1.65~1.8万亿美元,大力发展软件业及信息服务业将成为各国抓住新机遇、全面深度参与全球化、提升软件产业技术力量的重要途径。目前我国软件产业规模虽已过万亿元,但在核心技术、基础软件等方面仍有很大发展空间。 高素质人才的储备是推进产业健康快速发展的根本保证。高端软件人才的大量持续涌现,关键在于教育,这其中高校无疑要发挥重要的作用。我们高校软件教育者既要继续贯彻党的教育理念,进一步深化我国高级软件人才培养体系的发展进程;同时又要看到我国与欧美等高水平软件人才教育国家之间的距离,师夷长技,以求在全球化浪潮中谋得一席之地。作为一位优秀的软件教育者,Diomidis Spinellis教授的某些理念无疑是非常值得我们学习和借鉴的。他以人类学习自然语言的认知规律为出发点,独辟新径,强调借助代码阅读来提高编程能力。目前这一思潮也已逐渐由欧美向我国渗透。 代码阅读是每一个软件从业人员经常进行的活动,其重要性对于每一个开发者不言而喻,但人们更多的是在本着修改前人代码而进行此项活动的,换言之,仅仅使用了代码阅读的工作属性,而未见开发其学习属性。其实,代码阅读还帮助人们完成了“观察-模仿-创造”这样一个过程的初始阶段。南朝刘勰《文心雕龙》里讲“观千剑而后识器”,与之类似,清乾隆年间蘅塘退士还说“熟读唐诗三百首,不会作诗也会吟”,这都是强调了观察对于之后创造的重要性(巧合的是写诗和写代码的观察都是借助阅读来完成的)。 令人遗憾的是,一直以来,许多人都认为阅读代码不是件容易的事情,不仅不容易,很多时候还非常枯燥;即使是自己写的代码,有时隔一段时间再回顾也会不知所云。很多人在自己的编码生涯中都或多或少有过一些阅读代码的经历,有自己的一些方法,但也仅仅是一些个人实践而已,缺乏对整体的把握,经常是只见树木不见森林(很多时候仅仅能看到一小部分树木)。为了在学习的过程中少走一些弯路,业界代码阅读与质量提升方面的开宗明义之作--Diomidis Spinellis教授所撰写的两部经典之作《代码阅读》和《代码质量》无疑是推荐给每位从业人员的理想读物。这两部曾荣获美国Jolt软件开发震撼大奖的作品,影响了一代程序员,是相关领域中的经典名作。 我阅读了两部书的译稿,并非常欣喜地将它们推荐给每一位读者。该书译者和编辑们严谨、认真的工作使得本版最大程度地还原了作者的原意,相信经由他们的辛勤努力,必将能为广大读者献上一道惊艳的佳作。 欧阳修说:“立身以立学为先,立学以读书为本。”衷心希望广大读者借由本书立学解惑,提升自我。 李战怀 于2011岁末 译 者 序 由国际知名的Addison-Wesley出版社推出的“高效软件开发系列”丛书为现代软件开发的方方面面提供了专业的建议和意见。收录在该系列中的书籍本本都是技术方面声名卓著的佳作,这些书籍的作者在创作时煞费苦心,力求作品篇幅适中、易于阅读,同时保证作品的价值能够历久弥新,不会随时光的流逝而渐显黯淡。系列中的每一本都描述了一项软件开发的核心话题,这些内容可能是业界专家们在开发中始终秉承的,也可能是需要本书的读者们引以为戒的,而之所以这样做,目的只有一个,就是要创造出最杰出的软件。 希腊教授Diomidis Spinellis的两部著作《代码阅读》和《代码质量》均收录在此系列中。其中,本书作为该领域的开山之作,曾荣获美国第14届“软件开发”年度震撼大奖。在IT产业蓬勃发展的今日,电子工业出版社顺应时代发展和广大读者希冀,隆重推出了《Jolt获奖系列》书丛,《代码阅读》和《代码质量》再次被收入其中。经典之作《代码阅读》得以拨云开雾,同广大中国读者见面。 当今世界,互联网迅猛发展,开源软件大行其道,海量的优质代码犹如一座丰富的宝藏正热切地等待着每一位开发人员去发掘,去阅读。正如本书英文原版序言的作者Dave Thomas所说的那样:“没有哪位伟大的小说家从未读过其他人的著作,也没有哪位伟大的画家从来没有研究过他人的画作。”阅读代码显然是每个软件开发人员都必须做的事情。一方面,可能是出于向优秀范例程序学习的目的,另一方面,也可能是出于代码复用的目的。于是,人们总会出于这样或那样的原因去阅读代码(有可能是别人的,也有可能是自己写的)。然而,长久以来,“如何正确地阅读代码,实现去粗取精?如何高效地阅读代码,做到得心应手?”始终没有一套完备的指导法则。 直到本书出现,我们才豁然开朗,原来代码阅读也是有章法可依的,也是一门学问。众所周知,本书是第一部专门将代码阅读作为一项独立活动加以论述的书籍,即使在其出版多年之后的今天,也依然是该领域的扛鼎之作。正如本书作者所说的那样:“代码阅读应该得到正确地训练,并用做提高编程能力的一种方法。”值得注意的是,目前,在国外先进的计算机教育体系中,代码阅读课程、活动和实践已纳入到相应的正规课程安排之中。 在中国,各大技术论坛、专业网站也为广大从业人员和程序设计爱好者提供了大量可交流的代码资源。作为译者,我们真诚地将该书推介给国内的读者,希望借由本书,可以推动开源运动,使更多人获益,也可以推动代码共享与阅读的方法与实践,提高国人学习编程的效率,以期获得事半功倍的效果。 说到学习编程,我不禁想到了最近网上热炒的“蹭课哥”。据悉,来自山东菏泽,现年27岁的农村青年贾作胜,原本高中毕业后,由于家庭经济困难等原因,未能如愿继续深造。后来,进城打工的他成为了清华大学的一名普通的保安员。业余时间,他一直刻苦学习,还常到教室旁听各种课程和名家讲座。天道酬勤,今年这位往日的“蹭课哥”,凭借旁听和自学,考上了山东师范大学。同样是保安,我又不禁想到了一个我身边的真实的例子。这个故事我不止一次讲起,还曾经在我的一本书的序言里引用过。若干年前,我所在公司楼下有一位与众不同的小保安。说他与众不同是因为当时经常能看到他捧着一本厚厚的《Java编程思想》之类的书在啃读,这种争分夺秒、刻苦学习的形象当时给我们很多人留下了深刻的印象。功夫不负有心人,这位保安后来顺利转型,成为了一名软件工程师。 无论是过去还是现在,都有如此之多的形形色色的人因为各种原因前仆后继地在努力钻研编程。我也曾经在文章中指出,研读他人的代码是学习编程的道路上,除动手实践外最重要也最必要的学习方法之一。本书的读者可能已经在行业内摸爬滚打多年,也可能初出茅庐,可能是高等院校计算机相关专业的学生,也可能只是某个角落里默默奋发的小保安。无论你是其中的哪一个,我都真心地希望本书能够在你成长为编程达人的道路上助一臂之力。我希望能够有更多像小保安一样的人得以华丽转身。若能如此,我心足矣。 怀揣着这样的心情,我们始终秉持着一丝不苟的态度,力求把经典之作原汁原味地带给中国读者。而一本专业技术领域的译作得以成功问世,其中之波折也是再所难免。幸得多位业内专家不吝指导,使得我们的工作备感鼓舞。在本书翻译之初,Diomidis Spinellis教授即给我们提出了许多宝贵的建议,他的指导给予了我们极大的帮助。此外,中国计算机学会数据库专业副主任、西北工业大学博士生导师、计算机学院副院长李战怀教授审阅了译稿,并欣然为本书作序推荐,感激之情,溢于言表。 本书得以顺利付梓,我们还要感谢中国航空工业集团第一飞机设计研究院工程师张贵、西安市公安局网监支队秦磊、西安交通大学电信学院研究生杨骥。三人在各自的技术方向上拥有丰富的实践经验,其中,张贵曾参与开发多个大型飞行模拟器项目,而杨骥和秦磊的研究方向则分别侧重于嵌入式开发和网络安全方面。以上诸位在百忙之中积极参与了本书的翻译工作,对于他们严肃认真的工作态度,笔者表示由衷敬佩。 最高品质的图书始终是作译者永恒的追求。但有一千个读者,就有一千个哈姆雷特。因此,我们也真诚地希望本书的读者能够把阅读中的所想所得与我们分享,也欢迎就书中可能存在的纰漏与我们沟通交流,从而使本书日臻完善,以利来者。 左飞 2011年秋
内容概要
Jolt大奖素有“软件业之奥斯卡”的美称,本丛书精选自Jolt历届获奖图书,以植根于开发实践中的独到工程思想与杰出方法论为主要甄选方向。作者使用了超过600个现实的例子来向你展现如何甄别代码的好坏;如何阅读,应当注意什么,以及如何使用这些知识来改进自己的代码。本书在一些现实中的大型实例基础上,论述了代码阅读的策略,并向读者展示了如何将这些代码阅读和代码理解的技艺运用于实践。
作者简介
自1985年开始,本书作者Diomidis
Spinellis在开发大量开创性的,并受到极高评价的商业和开源项目的过程中,一直在钻研、发展本书中所提及的各项技术,期间他编写和维护的代码行数超过25万行。他在英国伦敦帝国理工学院获得了软件工程方向的硕士学位及计算机科学博士学位。目前,他是希腊雅典经济与商业大学管理科学与技术系的教授。他曾撰写过多部畅销世界的计算机技术图书,包括《架构之美》、《代码质量》和《代码阅读》等。
书籍目录
第1章 导论1
1.1 为何以及如何阅读代码2
1.1.1 将代码作为文献2
1.1.2 将代码作为范例5
1.1.3 维护6
1.1.4 演进6
1.1.5 重用8
1.1.6 检查8
1.2 如何阅读本书9
1.2.1 排版约定9
1.2.2 图表11
1.2.3 练习12
1.2.4 辅助材料13
1.2.5 工具13
1.2.6 提纲13
1.2.7 关于“伟大语言”的争论14
进阶阅读15
第2章 基本编程元素17
2.1 一个完整的程序17
2.2 函数和全局变量22
2.3 while循环、条件和块26
2.4 switch语句29
2.5 for循环31
2.6 break和continue语句34
2.7 字符和布尔表达式36
2.8 goto语句39
2.9 局部重构41
2.10 do循环和整数表达式46
2.11 再论控制结构49
进阶阅读55
第3章 高级C数据类型57
3.1 指针57
3.1.1 链式数据结构58
3.1.2 数据结构的动态分配58
3.1.3 引用调用59
3.1.4 数据元素的访问60
3.1.5 数组类型的参数和返回结果61
3.1.6 函数指针63
3.1.7 用做别名的指针65
3.1.8 指针和字符串67
3.1.9 直接内存访问69
3.2 结构体70
3.2.1 组合数据元素70
3.2.2 从函数中返回多个数据元素71
3.2.3 映射数据的组织方式71
3.2.4 以面向对象方式编程73
3.3 联合体75
3.3.1 有效利用内存空间75
3.3.2 实现多态76
3.3.3 不同内部表征的访问77
3.4 动态内存分配79
3.4.1 空闲内存管理81
3.4.2 包含动态分配数组的结构体83
3.5 typedef声明85
进阶阅读87
第4章 C数据结构89
4.1 向量90
4.2 矩阵和表94
4.3 栈98
4.4 队列100
4.5 映射103
4.5.1 散列表106
4.6 集合108
4.7 链表109
4.8 树117
4.9 图122
4.9.1 节点存储122
4.9.2 边的表示124
4.9.3边的存储127
4.9.4 图的属性129
4.9.5 隐含结构129
4.9.6 其他表示方法130
进阶阅读130
第5章 高级控制流程131
5.1 递归131
5.2 异常机制137
5.3 并行性141
5.3.1 硬件和软件的并行性142
5.3.2 控制模型143
5.3.3 线程实现148
5.4 信号151
5.5 非局部跳转154
5.6 宏替换157
进阶阅读162
第6章 应对大型项目163
6.1 设计和实现技术163
6.2 项目的组织165
6.3 编译过程与makefile文件172
6.4 配置179
6.5 版本控制184
6.6 项目专用工具191
6.7 测试196
进阶阅读203
第7章 编码规范和约定205
7.1 文件的名称和组织206
7.2 缩进208
7.3 格式编排210
7.4 命名约定213
7.5 编程实践217
7.6 过程规范219
进阶阅读220
第8章 文档221
8.1 文档类型221
8.2 阅读文档222
8.3 文档中存在的问题234
8.4 其他文档来源236
8.5 常见的开源文档格式239
进阶阅读245
第9章 架构414
9.1 系统结构248
9.1.1 集中式存储库和分布式方法248
9.1.2 数据流架构252
9.1.3 面向对象结构254
9.1.4 分层架构257
9.1.5 层次260
9.1.6 切片261
9.2 控制模型263
9.2.1 事件驱动系统263
9.2.2 系统管理器266
9.2.3 状态转移268
9.3 元素包装270
9.3.1 模块270
9.3.2 命名空间272
9.3.3 对象276
9.3.4 泛型实现287
9.3.5 抽象数据类型292
9.3.6 库292
9.3.7 进程和过滤器296
9.3.8 组件297
9.3.9 数据存储库299
9.4 架构重用301
9.4.1 框架301
9.4.2 代码向导302
9.4.3 设计模式303
9.4.4 领域专有的架构305
进阶阅读308
第10章 代码阅读工具311
10.1 正则表达式312
10.2 用编辑器浏览代码314
10.3 用grep搜索代码317
10.4 找出文件的差异325
10.5 开发自用工具326
10.6 借助编译器阅读代码329
10.7 代码浏览器与美化器333
10.8 运行时工具338
10.9 非软件工具342
可用工具与进阶读物343
第11章 完整示例345
11.1 概况345
11.2 攻克计划347
11.3 代码重用348
11.4 测试与调试354
11.5 文档361
11.6 观察报告362
附录A 源代码致谢人员名单363
附录B 源代码致谢人员名单363
附录C 源代码致谢人员名单363
章节摘录
版权页: 插图: 在分析一个重要的程序时,最好先找出其最重要的部分。在本例中,这些部分是全局变量(图2—2:1)和函数main(图2—3)、getstops(见图2—5:1)以及usage(见图2—5:8)。 整型变量nstops和整型数组tabstops声明为全局变量,它们的作用域在函数体之外。因此,它们对于所分析文件中的所有函数都是可见的。 紧接着的三个函数声明声明了该文件内之后将出现的函数。由于其中的一些函数可能会在其定义之前使用,因此在C/C++程序中,这些声明允许编译器校验传递给函数的参数以及其返回值,并生成相应的正确代码。如果没有给出前置声明,那么C编译器会依据函数第一次被使用的情形来做出关于函数返回值类型和参数的假设;C++编译器将这种情况标记为错误。如果接下来的函数定义与这些假设不相符,那么编译器将给出一条警告或错误信息。然而,若定义于另一个文件中的函数匹配这个错误的声明,则该通过,程序或许能够编译,但是在运行时会失败。 值得注意的是,两个函数被声明为static,而变量没有。这就是说这两个函数仅仅在该文件中可见,而那些变量则有可能对组成该程序的所有文件都可见。因为expand仅由一个文件组成,所以这一差别在本例中并不重要。多数连接器(用来合并编译后的C文件)都十分原始,对所有程序文件都可见的那些变量(即没有被声明为static的变量),可能会与定义于其他文件中的同名变量进行让人吃惊的交互。因此,在审查代码时,最好确保所有只用于单个文件的变量都声明为static。 下面一起来看一下组成expand的函数。想要了解一个函数(或方法)在做什么,可以采用如下策略之一。 根据函数名猜测。 阅读函数开头的注释。 分析该函数是如何被使用的。 阅读函数体内的代码。 查询外部程序文档。 在本例中,可以很肯定地猜出函数usage将展示有关程序用法的信息然后退出;许多命令行程序都有与之具有同样功能和名称的函数。当你分析大量的代码时,你将会逐渐得出变量和函数的名称以及命名规范。这些将会帮助你正确的猜出它们的用途。然而,你应当做好准备,根据代码阅读过程中必然会出现的一些新证据来随时对最初的猜测做出修改。另外,基于猜测修改代码时,应当设计一个流程来验证最初的假设。这一流程可以包括用编译器检查、引入断言或执行恰当的测试用例。 getsopts的角色比较难于理解。这里没有任何注释,函数体中的代码比较复杂,其名称也可以多种方式解读。注意它被用在程序中一个单独的部分(图2—3:3),这可以帮助我们做进一步的分析。使用到getopt的部分在程序中负责处理程序选项(图2—3:2)。因此,可以肯定地(在本例中也是正确地)认为getopt将处理制表位说明选项。在阅读代码时,这种渐进式的理解较为常见;理解了某一部分的代码可以使得其他部分变得容易理解。基于这种渐进式的理解方式,在理解较为困难的代码时,可以采用类似组合拼图游戏时的策略:从容易的部分开始。
编辑推荐
《Jolt大奖精选丛书:代码阅读》荣获2003年Jolt世界图书大奖,参阅《代码阅读》对于大专院校相关专业的师生、计算机领域的从业人员或稗序设计爱好者都大有裨益。
图书封面
图书标签Tags
无
评论、评分、阅读与下载