如何阅读开源项目代码:六步法实战指南 | 源码学习

如何阅读开源项目代码:六步法实战指南 #

引言 #

阅读优秀的开源项目代码是提升编程能力的重要途径,但很多开发者不知从何入手。本文分享一套实用的六步阅读方法,帮助你更好地理解和学习开源项目。

相信每个人都有一套自己的策略,这里整理了下我平时阅读项目代码的六大步,希望可以对大家有所帮助。

  1. 粗略看官方文档,明确项目都有什么主要功能,以及如何运行项目
  2. 找到项目的入口,把项目运行起来
  3. 找到主要功能对应的代码。挑一个主要功能进行调试,比如一个美妆项目,那可以挑一个口红颜色强度的功能进行调试,找到该功能的触发函数,再往深处找到功能的具体实现,尝试着修改部分代码,比如打印一些log,并尝试着为项目添加一些注释;
  4. 再多挑几个功能调试,多尝试着了解这几个功能具体是怎么实现的,尝试着画出功能的整个调用流程图;
  5. 以点带面,通过几个功能调试的练习,进一步理解整个项目的架构,这里可以更多的配合文档食用(这里首选官方文档,也可以看下网上有没有其他的源码分析文章,站在巨人的肩膀上往往事半功倍),尝试着画出整个项目的架构图;
  6. 如果有必要,从功能入手,主要的功能点都深入到源码层面进行分析(可以根据实际情况选择是否深入细节,比如你只想要了解项目的整体架构,或者想了解某个问题的解决方案。其实大多数时候我们可能都没必要过多的深入细节通读源码,比如代码里有个红黑树,我们根本没必要深入研究,这显然不是我们真正想要关注的点。);

注意:千万不要一上来就死扣细节

那样你会被折磨的很惨

阅读分析代码一定要有合适的工具,需要方便全局搜索,方便前进和后退、高亮等基础且常用的功能,我常用的是VS Code和Clion,听说Source Insight也不错,我看见很多人都在用,大家可以根据自己喜好选择合适的工具。

实战环节:这里尝试按照上述思路来分析下glog的源码实现。

  1. 第一步:看文档https://github.com/google/glog),了解glog都有什么功能。额,log库的功能很明确,就是按照一定格式打印log。
  2. 第二步:把项目运行起来。glog的编译链接很简单,文档里面有详细的操作步骤。
  3. 第三步:找到主要功能对应的代码。挑一个主要功能进行调试。正常glog打log的方式是LOG(LEVEL) << xxx;,输出的log有一定格式,时间-线程ID-信息等,那能否尝试着通过修改源码的方式改变输出的log格式呢。
  4. 第四步:再挑几个主要功能分析调试,比如glog如何实现的log写文件功能,如何做到的线程安全?
  5. 第五步:分析了这么多功能,对整体代码会有一个大体的认知,再结合其他的源码分析文章去分析glog项目整体结构,尝试着画出项目整体架构图。
  6. 第六步:如果自己对某个细节感兴趣,尝试深入细节,比如我很好奇log在写文件的过程中是如何刷新到磁盘中,是什么时候将数据刷新到磁盘中的?