《2022年教你如何读懂源代码 .pdf》由会员分享，可在线阅读，更多相关《2022年教你如何读懂源代码 .pdf（23页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、1 / 23 分析源代码方法如何看懂源代码 -(分析源代码方法 精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 1 页，共 23 页2 / 23 我们在写程序时，有不少时间都是在看别人的代码。例如看小组的代码，看小组整合的守则，若一开始没规划怎么看，就会“ 噜看噜苦 台语） ” 不管是参考也好，从开源抓下来研究也好，为了了解箇中含意，在有限的时间下，不免会对庞大的源代码解读感到压力。网路上有一篇关于分析看代码的方法，做为程序设计师的您，不妨参考看看，换个角度来分析。也能更有效率的解读你想要的程序码片段。六个章节： 1 ）读懂程序码，使心法皆为我所用
2、。 2 ）摸清架构，便可轻松掌握全貌。 3 ）优质工具在手，读懂程序非难事。 4 ）望文生义，进而推敲组件的作用。 5 ）找到程序入口，再由上而下抽丝剥茧。 6 ）阅读的乐趣，透过程序码认识作者。阅读他人的程序码 1 ） -读懂程序码，使心法精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 2 页，共 23 页3 / 23 皆为我所用程序码是别人写的，只有原作者才真的了解程序码的用途及涵义。许多程序人心里都有一种不自觉的恐惧感，深怕被迫去碰触其他人所写的程序码。但是，与其抗拒接收别人的程序码，不如彻底了解相关的语言和惯例，当成是培养自我实力的基石。对
3、大多数的程序人来说，撰写程序码或许是令人开心的一件事情，但我相信，有更多人视阅读他人所写成的程序码为畏途。许多人宁可自己重新写过一遍程序码，也不愿意接收别人的程序码，进而修正错误，维护它们，甚至加强功能。这其中的关键究竟在何处呢？若是一语道破，其实也很简单，程序码是别人写的，只有原作者才真的了解程序码的用途及涵义。许多程序人心里都有一种不自觉的恐惧感，深怕被迫去碰触其他人所写的程序码。这是来自于人类内心深处对于陌生事物的原始恐惧。读懂别人写的程序码，让你收获满满不过，基于许多现实的原因，程序人时常受迫要去接收别人的程序码。例如，同事离职了，必须接手他遗留下来的工作，也有可能你是刚进部门精选学习
4、资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 3 页，共 23 页4 / 23 的菜鸟，而同事经验值够了，升级了，风水轮流转，一代菜鸟换菜鸟。甚至，你的公司所承接的专案，必须接手或是整合客户前一个厂商所遗留下来的系统，你们手上只有那套系统的原始码运气好时，还有数量不等的文件）。诸如此类的故事，其实时常在程序人身边或身上持续上演着。许多程序人都将接手他人的程序码，当做一件悲惨的事情。每个人都不想接手别人所撰写的程序码，因为不想花时间去探索，宁可将生产力花在产生新的程序码，而不是耗费在了解这些程序码上。很遗憾的是，上述的情况对程序人来说很难避免。我们总是必须
5、碰触到其他人所写成的程序码，甚至必须了解它，加以修改。对于这项需求，在现今开放原始码的风气如此盛行的今日，正如之前的 “ 程序设计 2.0 ”文中所提到的，你可以透过开放原始码学习到新的技术，学习到高手的架构设计，大幅提高学习的效率及效果。你甚至可以直接自开放原始码专案中抽取，提炼出自己所需的程序码，站在巨人的肩膀上，直接由彼端获得所需的生产力。从这个观点来看，读懂别人精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 4 页，共 23 页5 / 23 所写的程序码，就不再只是从负面观点的“ 被迫接收” ，而是极具正面价值的“ 汲取养份。 ” 先了解系
6、统架构与行为模式，再细读倘若撰写程序码是程序人的重要技艺之一，那么读懂别人的程序码，接着加以修改，也势必是另一个重要的技艺。如果你不能熟悉这项工作，不仅在遭逢你所不愿面对的局面时，无法解决眼前接手他人程序码的难题，更重要的是，当你看着眼前现成的程序码，却不知如何从中撷取自己所需，导致最后只能入宝山空手回，望之兴叹。接触他人的程序码，大致上可以分为三种程度：一，了解，二，修改，扩充，三，抽取，提炼。了解别人的程序码是最基础的工作，倘若不能了解自己要处理的程序码，就甭论修改或扩充，更不可能去芜存菁，从中萃取出自己所需，回收再利用别人所撰写的程序码。虽说是“ 阅读” ，但程序码并不像文章或小说一样，
7、透过这种做法，便能够获得一定程度的了解。阅读文章或小说时，几乎都是循序地阅读，你只消翻开第一页，一行精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 5 页，共 23 页6 / 23 行阅读下去即可。但是，有许多程序人在试着阅读其他人的程序码时，却往往有不知如何读起的困难。或许找到系统的第一页也就是程序码执行的启始点）并不难，但是复杂度高的系统，有时十分庞大，有时千头万绪。从程序码的启始点开始读起，一来要循序读完所有的程序码旷日费时，二来透过这种方式来了解系统，很难在脑中构建出系统的面貌，进而了解到系统真正的行为。所以，阅读程序码的重点，不在于读完每
8、一行程序码，而是在于有效率地透过探索及阅读，从而了解系统的架构及行为模式。以便在你需要了解任何片段的细节实作时，能够很快在脑上对映到具体的程序码位置，直到那一刻，才是细读的时机。熟悉沟通语言与惯例用语不论如何，有些基本的准备，是阅读他人程序码时必须要有的。首先，你最好得了解程序码写成的程序语言。想精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 6 页，共 23 页7 / 23 要读懂法文写成的小说，总不能连法文都不懂吧。有些情况则很特殊。我们虽然不懂该程序码撰写所用的语言，但是因为现代语言的高阶化，而且流行的程序语言多半都是血统相近，所以即使不那么
9、熟悉，有时也可勉力为之。除了认识所用语言之外，再来就是要先确认程序码所用的命名惯例 命名惯例） 。了解命名惯例很重要，不同的程序人或开发团队，差异可能很大。这命名惯例涵盖的范围通常包括了变数的名称，函式的名称，类别 如果是物件导向的话）的名称，原始码档案，甚至是专案建构目录的名称。倘若使用了像设计模式之类的方法，这些名称更有一些具体的表述方式。命名惯例有点像是程序人在程序语言之上，另行建构的一组沟通行话。程序人会透过共通约束，遵守的命名惯例，来表达一些较高阶的概念。例如，有名的匈牙利式命名法，便将变数名称以属性，型别，说明合并在一起描述。对程序人来说，这种方式能够提供更丰富的资讯，以了解该变数
10、的作用及性质。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 7 页，共 23 页8 / 23 对程序码阅读来说，熟悉这个做法之所以重要，是因为当你了解整个系统所采用的惯例时，你便能试着以他们所共同操用的语汇来进行理解。倘若，不能了解其所用的惯例，那么这些额外提供的资讯，就无法为你所用。像以设计模式写成的程序码，同样处处充满着模式的名称，诸如：工厂，门面，代理等等。以这些名称指涉的类别，也直接透过名称，表达了它们自身的作用。对于懂得这命名惯例的读者来说，不需要深入探索，也能很快捕捉到这些类别的意义。当你拿到一套必须阅读的程序码时，最好先取得命名惯例
11、的说明文件。然而，并不是每套程序码都附有此类的说明文件。另一个方式，就是自己到程序码中，大略浏览一遍，有经验的程序人可以轻易发掘出该系统所用的命名惯例。常见的命名方式不脱那几类，这时候经验就很重要，倘若你知道的惯例越多，就越能轻易识别他人所用的惯例。如果运气很糟，程序码所用的惯例是前所未见的，那么你也得花点时间归纳，凭自己的力量找出这程序码命名上的规则。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 8 页，共 23 页9 / 23 掌握程序码撰写者的心态与习惯大多数的程序码，基本上都依循一致的命名惯例。不过运气更差的时候，一套系统中可能会充斥着多
12、套命名惯例。这有可能是因为开发团队由多组人马所构成，每组人马都有不同的文化，而在专案开发管理又没有管控得宜所造成。最糟的情况，程序码完全没有明显的惯例可言，这时候阅读的难度就更高了。想要阅读程序码，得先试着体会程序码作者的“ 心”。想要这么做，就得多了解对方所使用的语言，以及惯常运用的语汇。在下一回中，我们将继续探讨阅读程序码的相关议题。阅读他人的程序码 2 ） -摸清架构，便可轻松掌握全貌在本文中，我们的重点放在：要了解一个系统，最好是采取由上至下的方式。先试着捕捉系统架构性的观念，不要过早钻进细节，因为那通常对于你了解全貌，没有多大的帮助。阅读程序码不需要从第一行读起，我们的目的并不是在于
13、读遍每一段程序码。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 9 页，共 23 页10 / 23 基于许多原因，程序人需要阅读其他人所写成的程序码。而对程序设计2.0 时代的程序人来说，最正面的价值在于，能读懂别人程序的人，才有能力从中萃取自己所需的程序，借以提高生产力。阅读程序码的目的，在于了解全貌而非细节想要读懂别人程序码的根本基础，便是了解对方所用的程序语言及命名惯例。有了这个基础之后，才算是具备了基本的阅读能力。正如我之前提到的 想要读懂法文写成的小说，总不能连法文都不懂吧。阅读程序码和阅读文学作品，都需要了解撰写所用的语言及作者习用的
14、语汇。但我们在阅读文学作品通常是采循序的方式，也就是从第一页开始，一行一行地读下去，依循作者为你铺陈的步调，逐渐进到他为你准备好的世界里。阅读程序码却大大不同。我们很少从第一行开始读起，因为除非它是很简单的单执行绪程序，否则很少这么做。因为要是这么做，就很难了解整个系统的全貌。是的，我们这边提到了一个重点，阅读程序码的目的在于了解系统的全貌，而不是在于只是为了地毯式的读遍每一段程精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 10 页，共 23 页11 / 23 序码。就拿物件导向程序语言所写成的系统来说，整个系统被拆解，分析成为一个个独立的类别。
15、阅读个别类别的程序码，或许可以明白每项类别物件个别的行为。但对于各类别物件之间如何交互影响，如何协同工作，又很容易陷入盲人摸象的困境。这是因为各类别的程序码，只描述个别物件的行为，而片段的阅读就只能造就片面的认识。由上而下厘清架构后，便可轻易理解组成关系如果你想要跳脱困境，不想浪费大量时间阅读程序码，却始终只能捕捉到对系统片段认识，就必须转换到另一种观点来看待系统。从个别的类别行为着手，是由下至上自下而上）的方法。在阅读程序码时，却应该先采由上至下自上而下）的方式。对程序码的阅读来说，由上至下意谓着，你得先了解整个系统架构。系统的架构是整个系统的骨干，支柱。它表现出系统最突出的特征。知道系统架
16、构究竟属于那一种类型，通常大大有益于了解系统的个别组成之间的静态及动态关系。有些系统因为所用的技术精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 11 页，共 23 页12 / 23 或框架的关系，决定了最上层的架构。例如，采用的 Java Servlet 的/ JSP 的技术的应用系统，最外层的架构便是以J2EE 的或起码的 J2EE 中的Web 容器）为根本。使用的 Java Servlet 的/ JSP 的技术时，决定了某些组成之间的关系。例如， Web 容器依据 web.xml 中的内容载入所有的Servlets ，听众，以及过滤器。每当语
17、境发生事件例如初始化）时，它便会通知监听类别。每当它收到来自客户端的请求时，便会依循设定的所有过滤器链，让每个过滤器都有机会检查并处理此一请求，最后再将请求导至用来处理该请求的Servlet 的。当我们明白某个系统采用这样的架构时，便可以很容易地知道各个组成之间的关系。即使我们还不知道究竟有多少Servlets ，但我们会知道，每当收到一个请求时，总是会有个相对应的服务器来处理它。当想要关注某个请求如何处理时，我应该去找出这个请求对应的服务器。了解架构，必须要加上层次感同样的，以爪哇写成的网页应用程序中，也许会精选学习资料 - - - - - - - - - 名师归纳总结 - - - - -
18、- -第 12 页，共 23 页13 / 23 应用诸如 Struts 的之类的的 MVC 框架，以及像Hibernate 的这样的资料存取框架。它们都可以视为最主要的架构下的较次级架构。而各个应用系统，甚至有可能在Struts 的及休眠之下，建立自有的更次级的架构。也就是说，当我们谈到“ 架构” 这样的观念时，必须要有层次感。而不论是那一层级的架构，都会定义出各自的角色，以及角色间的关系。对阅读者来说，相较于直接切入最细微的单一角色行为，不如了解某个特定的架构中，究竟存在多少角色，以及这些角色之间的互动模式，比较能够帮助我们了解整个系统的运作方式。这是一个很重要的关键，当你试着进到最细节处之
19、前，应该先试着找出参与的角色，及他们之间的关系。例如，对事件驱动式的架构而言，有3个很重要的角色。一个是事件处理的分派器事件调度） ，一个是事件产生者事件发生器），另一个则是事件处理器事件处理程序）。事件产生器产生事件，并送至事件分派器，而事件分派器负责找出各事件相对应的事件处理器，精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 13 页，共 23 页14 / 23 并且转交该事件，并命令事件处理器加以处理。像的图形用户界面的Windows 应用程序，便是采用事件驱动式的架构。当你知道此类的应用程序皆为事件驱动式的架构时，你便可以进一步得知，在这样
20、的架构下会有3种主要的角色。虽然也许还不清楚整个系统中，究竟会需要处理多少事件的类型，但对你而言，已经建立了对系统全貌最概观的认识。虽然你还不清楚所有的细节，但诸如确切会有那些事件类型之类的资讯，在此刻还不重要 不要忘了，我们采取的是由上而下的方式，要先摸清楚主建筑结构，至于壁纸的花色怎么处理，那是到了尾声时才会做的事。探索架构的第一件事：找出系统如何初始化有经验的程序人，对于时常被运用的架构都很熟悉。常常只需要瞧上几眼，就能明白一个系统所用的架构，自然就能够直接联想到其中会存在的角色，以及角色间的关系。然而，并不是每个系统所用的架构，都是大众所熟悉，或是一眼能够望穿的。这时候，你需要探索。目
21、标同样要放在精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 14 页，共 23 页15 / 23 界定其中的角色，以及角色间的静态，动态关系。不论某个系统所采用的架构是否为大部分人所熟知的，在试着探索一个系统的长相时，我们应该找出来几个答案，了解在它所用的架构下，下列这件事是如何被完成的：一，系统如何初始化，二，与这个系统相接的其他系统或使用者）有那些，而相接的介面又是什么。三，系统如何反应各种事件，四，系统如何处理各种异常及错误。系统如何初始化是很重要的一件事，因为初始化是为了接下来的所有事物而做的准备。从初始化的方式，内容，能知道系统做了什么准
22、备，对于系统会有什么行为展现，也就能得窥一二了。之所以要了解与系统相接的其他系统或使用者），为的是要界定出系统的边界。其他的系统可能会提供输入给我们所探索的系统，也可能接收来自这系统的输出，了解这边界所在，才能确定系统的外观。而系统所反应的事件类型，以及如何反应，基本上就代表着系统本身的主要行为模式。最后，我精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 15 页，共 23 页16 / 23 们必须了解系统处理异常及错误的方式，这同样也是系统的重要行为，但容易被忽略。之前，我们提到必须先具备一个系统的语言基础，才能够进一步加以阅读，而在本文中，我们
23、的重点放在：要了解一个系统，最好是采取由上至下的方式。先试着捕捉系统架构性的观念，不要过早钻进细节，因为那通常对于你了解全貌，没有多大的帮助。阅读他人的程序码 3 ） -优质工具在手，读懂程序非难事系统的复杂度往往超过人脑的负荷。阅读程序码的时候，你会需要更多工具提供协助。使用好的整合式开发环境 IDE ）的或文字编辑器，就能提供最基本的帮助。阅读程序码的动作，可以是很原始的，利用最简单的文字编辑器，逐一开启原始码，然后凭借着一己的组织能力，在不同的程序码间跳跃，拼凑出脑中想要构建的图像。不过，系统的复杂度往往超过人脑的负荷。阅读程序码的时候，你会需要更多工具提供协助。使用好的整合式开发环境
24、IDE ）的或文字编辑器，精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 16 页，共 23 页17 / 23 就能提供最基本的帮助。善用文字编辑器或IDE 中，加速解读程序码许多文字编辑器提供了常见程序语言的语法及关键字标示功能。这对于阅读来说，绝对能够起很大的作用。有些文字编辑器例如我常用的编辑器及偶而使用的记事本+ + ） ，甚至能够自动列出某个原始档中所有定义的函式清单，更允许你直接从清单中选择函式，直接跳跃到该函式的定义位置。这对于阅读程序码的人来说，就提供了极佳的便利性。因为在阅读程序码时，最常做的事，就是随着程序中的某个控制流，将阅读
25、的重心，从某个函式移至它所呼叫的另一个函式。所以对程序人来说，阅读程序码时最常做的事之一就是：找出某个函式位在那一个原始档里，接着找到该函式所在的位置。好的的 IDE 能够提供的协助就更多了。有些能够自动呈现一些额外的资讯，最有用的莫过于函式的原型宣告了。例如，有些的IDE 支援当游标停留在某函式名称上一段时间后，它会以提示的方式显示该函式的原型宣告。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 17 页，共 23 页18 / 23 对阅读程序码的人来说，在看到程序码中呼叫到某个函式时，可以直接利用这样的支援，立即取得和这个函式有关的原型资讯，马
26、上就能知道呼叫该函式所传入的各个引数的意义，而不必等到将该函式的定义位置找出后，才能明白这件事。grep 按读者：推荐来源透视）是一个基本而极为有用的工具除了选用好的文字编辑器或的IDE 之外，还有一个基本，但却极为有用的工具，它就是grep 按。熟悉的 Unix 作业系统的程序人，对grep 按这个公用程序多半都不陌生。 grep 按最大的用途，在于它允许我们搜寻某个目录包括递回进入所有子目录）中所有指定档案，是否有符合指定条件常数字串或正规表示式）档案。倘若有的话，则能帮你指出所在的位置。这在阅读程序码时的作用极大。当我们随着阅读的脚步，遇上了任何一个不认识，但自认为重要的类别，函式，资料
27、结构定义或变数，我们就得找出它究竟位在这茫茫程序码海中的何处，才能将这个图块从未知变为已知。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 18 页，共 23 页19 / 23 grep 按之所以好用，就是在于当我们发现某个未知的事物时，可以轻易地利用它找出这个未知的事物究竟位在何方。此外，虽说grep 按是 Unix系统的标准公用程序之一，但是像视窗这样子的平台，也有各种类型的grep 按程序。对于在视窗环境工作的程序人来说，可以自行选用觉得称手的工具。gtags 可建立索引，让搜寻更有效率grep 按虽然好用，但是仍然有一些不足之处。第一个缺点
28、在于它并不会为所搜寻的原始码档案索引。每当你搜寻时，它都会逐一地找出所有的档案，并且读取其中的所有内容，过滤出满足指定条件的档案。当专案的原始码数量太大时，就会产生搜寻效率不高的问题。第二个缺点是它只是一个单纯的文字档搜寻工具，本身并不会剖析原始码所对应的语言语法。当我们只想针对 “ 函式” 名称进行搜寻时，它有可能将注解中含有该名称的原始码，也一并找了出来。针对 grep 按的缺点，打算阅读他人程序码的程序精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 19 页，共 23 页20 / 23 人，可以考虑使用像是gtags 这样子的工具。 gtag
29、s 是源代码的 GNU 全局标记系统，它不只搜寻文字层次，而且因为具备了各种语言的语法剖析器，所以在搜寻时，可以只针对和语言有关的元素，例如类别名称，函式名称等。而且，它能针对原始码的内容进行索引，这意谓一旦建好索引之后，每次搜寻的动作，都毋需重新读取所有原始码的内容并逐一搜寻。只需要以现成的索引结构为基础，即可有效率的寻找关键段落。gtags 提供了基于命令列的程序，让你指定原始码所在的目录执行建立索引的动作。它同时也提供程序让你得如同操作grep 按一般，针对索引结构进行搜寻及检索。它提供了许多有用的检索方式，例如找出专案中定义某个资料结构的档案及定义所在的行号，或者是找出专案中所有引用某
30、资料结构的档案，以及引用处的行号。这么一来，你就可以轻易地针对阅读程序码时的需求予以检索。相较于grep 按所能提供的支援，gtags 这样的工具，简直是强大许多。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 20 页，共 23 页21 / 23 再搭配 htags 制作的 HTML 文件，更是如虎添翼还有一个绝对需要一提的工具。这个叫做htags的工具，能够帮你将已制作完成的索引结构，制作成为一组相互参考的的HTML 文件。基本上，利用这样的的HTML 文件阅读程序码，比起单纯地直接阅读原始码，来得更有结构。原因是阅读程序码时，这样的的HTML
31、 文件，已经为你建立起在各个原始码档案片段间跳跃的链结。例如，图一是针对一个有名的开放原始码专案ffmpeg ，由 gtags 所产生出来的的HTML 文件首页的一部分。htags 工具首先为你找出所有定义的Main ）函式的档案，并且列出所在的函式。找出的Main ）函式，时常是阅读程序码的第一步，因为主要 ）函式是程序的主要入口点，所有的动作皆由此启动，它是一切事物的源头。凭借 htags 制作的的 HTML 文件，你可以轻易地精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 21 页，共 23 页22 / 23 点击超连结，直接进到的Main ）函式所在的程序码片段，如图二。当我们检视上述原始码时，发现av_register_all ）是个陌生，无法了解的事物，而想要搞懂它究竟是什么，可以再继续点击这个函式，如图三。这真是太方便了！阅读至此，你会猛然发现， gtags 仿佛就是为了阅读程序码而专门量身打造的利器。精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 22 页，共 23 页23 / 23 精选学习资料 - - - - - - - - - 名师归纳总结 - - - - - - -第 23 页，共 23 页