如何阅读一份源代码?_如何阅读一套战斗系统的源码-程序员宅基地

技术标签: 方法论  数据结构  

先跑起来

精简环境。

调试手段

断点调试。并不是所有项目代码,跑起来之后都自带调试信息能够断点调试的。所以在自己的调试环境里需要先确定这一点。比如一些C相关的项目,基本都是”./configure & make”来编译,但是makefile中的编译flags使用了O2之类的优化选项,此时需要自己先手动修改成”-O0 -g”,即编译生成的二进制中不优化且带上调试信息。

使用顺手的工具

好的工具会让你事半功倍,这一点应该很多人都同意。

我阅读Go代码的时候,喜欢使用IDEA,这个IDE工具可以完美的做到以下几点:

符号的定位、跳转、查找符号被引用的地方。
左边能够展开一个源码文件中的所有符号。
反之,很多人推崇的VSCode,我几次尝试使用用来阅读GoC类代码,都觉得不够顺手,查找符号能力不行、也没有地方可以看到一个文件中出现的符号。

C\C++类的代码,在尝试各种工具之后,还是使用Vim+Ctags+Cscope来写CC++代码。

情景分析

假如有了前面的基础,已经能够让项目顺利在自己的调试环境跑起来了,那么就可以对项目代码进行情景分析了。

所谓的“情景分析”,我的理解就是自己构造一些情景,然后通过加断点、调试语句等分析在这些场景下的行为。

以我自己为例,在写《Lua设计与实现》时,讲解到Lua虚拟机指令的解释和执行过程中,需要针对每个指令做分析,此时用的就是情景分析的方法。我会模拟出来使用该指令的Lua脚本代码,然后在程序里断点调试这些场景下的行为。

我惯用的做法,是在某个重要的入口函数上面加上断点,然后构造触发场景的调试代码,当代码在断点处停下,通过查看堆栈、变量值等等来观察代码的行为。

例如,Lua解释器代码中中,生成Opcode最终都会调用函数luaK_code,那么我就在这个函数上面加上断点,然后构造我想要调试的场景,只要在断点处中断,我通过函数堆栈就能看到完整的调用流程:

情景分析的好处在于:不会在一个项目中大海捞针似的查找,而是能够把问题缩小到一个范围内展开来理解。

“情景分析”这一概念不是我想出来的名词,比如有这么几本分析代码的书籍,如:《Linux内核源代码情景分析》,《Windows内核情景分析》。

利用好测试用例

好的项目都会自带不少用例,这类型的例子有:etcdgoogle出品的几个开源项目。

如果测试用例写的很仔细,那么很值得好好去研究一下。原因在于:测试用例往往是针对某个单一的场景,独自构造出一些数据来对程序的流程进行验证。所以,其实跟前面的“情景分析”一样,都是让你从大的项目转而关注具体某个场景的手段之一。

厘清核心数据结构之间的关系

虽然说“程序设计=算法+数据结构”,然后我实际中的体会,数据结构更加重要。

因为结构定义了一个程序的架构,结构定下来了才有具体的实现。

因此,在阅读一份代码时,厘清核心的数据结构之间的关系尤其重要。这个时候,需要使用一些工具来画一下这些结构之间的关系,我的源码分析类博客中有很多这样的例子,比如《Leveldb代码阅读笔记》、《Etcd存储的实现》等等。

需要说明的是,情景分析、厘清核心数据结构这两步并没有严格的顺序关系,不见得是先做某事再做某事,而是交互进行的。

比如,你如果现在刚接手某个项目,需要简单的了解一下项目,可以先阅读代码了解都有哪些核心数据结构。理解了之后,如果不清楚某些情景下的流程,可以使用情景分析法。总而言之,交替进行直到解答你的疑问为止。

整体和细节

阅读代码的过程中,需要在整体和细节之间做权衡。

比如,有时候你需要大体了解一个整体的框架、轮廓、流程之后,才能再针对具体的细节深入进去。这个时候,不宜针对具体的函数实现、算法等深入分析。而细节的分析,又不能缺少,否则一些东西的理解又流于表面。

所以,如何把握整体和细节是一个需要累积阅读代码经验才能把握好的。我的建议是:过程中还是以整体为首,在不理解整体的前提之前,不要太过深入某个细节。把某个函数、数据结构当成一个黑盒,知道它们的输入、输出就好,只要不影响整体的理解就暂且放下接着往前看。

多问自己几个问题

输出的手段有很多,在阅读代码时,比较建议的是自己能够多问自己一些问题,比如:

为什么选择这个数据结构来描述这个问题?类似的场景下,其他项目是怎么设计的?都有哪些数据结构做这样的事情?
如果由我来设计这样的项目,我会怎么做?
等等等等。越是主动积极的思考,就越有更好的输出,输出质量与学习质量成正比关系。

写自己的代码阅读笔记

我从开始写博客,就是写不少各种项目的代码解读类文章,网名“codedump”也源于想把“code内部的实现原理dump出来”之意。

前面提到学习质量与输出质量成正比关系,这是我自己的深刻体会。也因为如此,所以才要坚持阅读源码之后写自己的分析类笔记。

写这类笔记,有以下几个需要注意的地方。

虽然是笔记,但是要想象着在向一个不太熟悉这个项目的人讲解原理,或者想象一下是几个月甚至几年后的自己回头来看这个文章。在这种情况下,会尽量的把语言组织好,循循善诱的解释。

尽量避免大段的贴代码。我认为在这类文章中,大段贴上代码有点自欺欺人:就是看上去自己懂了,其实并不见得。如果真要解释某段代码,可以使用伪代码或者缩减代码的方式。记住:不要自欺欺人,要真的懂了。如果真的想在代码上加上自己的注释,我有一个建议是fork出来一份该项目某个版本的代码,提交到自己的github上,上面随时可以加上自己的注释并且保存提交。比如我自己注释的etcd 3.1.10代码:etcd-3.1.10-codedump,类似的我阅读的其他项目都会在githubfork出一个带上codedump后缀的项目。

多画图,一图胜千言,使用图形展示代码流程、数据结构之间的关系。我最近才发现画图能力也是很重要的能力,自己在从头学习如何使用图像来表达自己的想法。

写作是很重要的基础能力,我一个朋友最近教育我,大体的意思是说:如果你在某方面的能力很强,如果再加上写作好、英语好,那么将极大放大你在这方面的能力。而类似写作、英语这样的底层基础能力,不是一撮而就的,需要长时间保持练习才可以。而写博客,对于技术人员而言,就是一种很好的锻炼写作的手段。

总结

以上是我简单总结的一些阅读源码时候的手段和注意方法,大体而言有那么几点吧:

只有更好的输出才能更好的消化知识,所谓的搭建调试环境、情景分析、多问自己问题、写代码阅读笔记等都是围绕输出来展开的。总而言之,不能像一条死鱼一样指望着光靠看代码就能完全理解它的原理,需要想办法跟它互动起来。
写作是人的基础硬实力之一,不仅锻炼自己表达能力,还能帮助整理自己的思路。对程序员而言锻炼写作能力的手段之一就是写博客,越早开始锻炼越好。
最后,如同任何可以习得的技能一般,阅读代码这种能力也需要长时间、大量的反复练习,下一次就从自己感兴趣的项目开始锻炼自己的这种技能吧。

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/sunshineywz/article/details/104277664

智能推荐

通过C语言实现“指针遍历数组”-程序员宅基地

本文介绍了通过C语言实现指针遍历数组的方法,包括指针的基本概念和相关代码示例。文章通过指针p和二级指针d的使用,展示了数组首地址、首元素和指针地址的打印输出。

疯狂的Web应用开源项目_web 开源工作日历-程序员宅基地

文章浏览阅读2.2k次。下面是一个Web应用的开源列表。没什么可说的,太疯狂了。尤其是Web 2.0那一堆。我不知道你怎么想,有些开源项目的源码写得挺不好的,尤其是性能方面。或许你会以为改一改他们就可以成为为自己所用,不过,改这些开源的项目还真不容易。玩玩还可以。数字媒体相册(Flickr, Picasa)Gallery,基于PHP + MySQL的Web相册。非常易于使用,包括一个配置向导,对于_web 开源工作日历

tp3与tp5的区别 以及 tp5与laravel的区别_tp3版本-程序员宅基地

文章浏览阅读2.6k次。Tp3 和 Tp5之间的区别Tp5版本和Tp3的差异较大的,它们的主要区别:1.URL和路由5.0的URL访问不再支持普通URL模式,路由也不支持正则路由定义,而是全部改为规则路由配合变量规则(正则定义)的方式:主要改进有以下几点:1.增加路由变量规则、2.增加组合变量支持、3.增加资源路由、4.增加路由分组、5.增加闭包定义支持、6.增加MISS路由定义、7.支持URL路由..._tp3版本

docker介绍-程序员宅基地

文章浏览阅读88次。简介:docker是目前最火的技术,没有之一1,与openstack相比,docker的优点:2,docker的使用场景(docker能干什么):1,简化配置2,提高开发效率3,应用隔离4,服务器整合5,多用户使用6,快速部署7,代码流水线管理8,开发调试安装前准备升级内核-3.0参考文档:http://w..._"[graphdriver] prior storage driver \"devicemapper\" failed: error running devi"

Web服务器处理并发连接请求的工作模型_常用的web服务器请求处理模型有哪些-程序员宅基地

文章浏览阅读2.4k次。一、单线程web服务器(Single-threaded web servers)此种架构方式中,web服务器一次处理一个请求,结束后读取并处理下一个请求。在某请求处理过程中,其它所有的请求将被忽略,因此,在并发请求较多的场景中将会出现严重的性能问题。(即一次只能处理一个请求) 二、多进程/多线程web服务器此种架构方式中,web服务器生成多个进程或线程并行处理多个用户请求,进程或线程可以按需或事先..._常用的web服务器请求处理模型有哪些

Linux-在linux修改文件夹及其子文件夹的权限_centos 更改文件夹子文件权限-程序员宅基地

文章浏览阅读2.2k次。加入-R 参数,就可以将读写权限传递给子文件夹例如chmod -R 777 /home/mypackage那么mypackage 文件夹和它下面的所有子文件夹的属性都变成了777.777是读、写、执行权限..._centos 更改文件夹子文件权限

随便推点

html中可以单独使用的标签,html标签怎么用-程序员宅基地

文章浏览阅读867次。如何选择使用的HTML标签?什么时候选择什么样的标签?在网页布局中HTML标签如何选择?在布局时会遇到如何选择HTML标签布局,但对于非新手CSSer来说非常简单,但对于刚刚学习或刚刚入手CSS制作来说却是一个无形问题。这里为大家简单介绍在DIV+CSS布局中如何选择HTML标签:1、框架布局(使用DIV标签)在网页中框架布局一般使用DIV布局,无论大小DIV盒子一般均使用DIV标签(2、列表型布..._html多个li标签单独调用

Python字符串类型:字符串索引、字符串切片、字符串format()方法格式化、字符串操作符、字符串处理函数_字符串类型类型的索引方式-程序员宅基地

文章浏览阅读956次。字符串:由0个或多个字符组成的有序序列sequence。一、字符串表示方式:2类4种由一对单引号或双引号表示,该方式仅用于表示单行字符串由一对三单引号或三双引号,该方式可以表示多行字符串如果希望在字符串中包含单引号,外面就用双引号;反之亦然。否则出错如果希望在字符串中既包含单引号又包含双引号,外面用三单引号注:无论单双,无论几个,外面的引号一定都是英文引号。反斜杠()的作用:①转义符;②续行符转义符与后面相邻的一个字符共同组成了新的含义,如\n表示换行,\表示反斜杠,\‘表示单引_字符串类型类型的索引方式

win7休眠开启与关闭_win7 关闭休眠-程序员宅基地

文章浏览阅读4w次。从开始菜单中找到“附件→命令提示符”,手工输入如下命令:powercfg-a,从这里可以清楚的看到,计算机是支持休眠的,显示“尚未启用休眠"。仍然在命令提示符下进行操作, 开始休眠方法:手工键入如下命令:powercfg -hibernate on(关闭则为powercfg -hibernate off) 命令执行之后立即就可以生效,无需要重新启动系统,再次执行“powercfg -a..._win7 关闭休眠

完美解决mysql保存中文出现1366错误_在mysql shell中输入 show variables like 'character%'; -程序员宅基地

文章浏览阅读5.7w次,点赞14次,收藏48次。最近在使用sqlalchemy将中文存放至mysql数据库的表中时出现:Warning Code :1366 Incorrect string value: '\xE5\x9C\xA8' for column 'content' at row 1这是因为我们存放的中文,而我们的表并不支持中文字符集,使用 show variables like 'character%'; 查看mysql当前..._在mysql shell中输入 show variables like 'character%'; 结果出现 (code 1366):

《ElasticStack从入门到实践》学习笔记1_elastic stack从入门到精通 笔记-程序员宅基地

文章浏览阅读760次。一、ElasticSearch入门介绍 1、常见术语: A、Document 文档 用户存储在ES中的数据文档。 B、Index 索引 由具有相同字段的文档列表组成。在当前版本,不在推荐下设Type,在后续版本,不再设立Type。 ..._elastic stack从入门到精通 笔记

dinic (poj2987)_poj2987 dinic-程序员宅基地

文章浏览阅读995次。program poj2987; const inf=10000001;var d,dis,pre,s,q:array[0..10000] of longint; p,next,b:array[0..200000] of longint; c:array[0..200000] of int64; aa,bb,o,i,m,tt,ans1,t:longint; ans,n,f:int64;procedure link(aa,bb:longint;cc:int_poj2987 dinic

推荐文章

热门文章

相关标签