一个软件开发人员,工作到了一定的年限(一般是3、4年左右),如果他还没学会阅读源码,那么他就会遇到瓶颈。因为到了这个时候的开发,他应该不仅仅只会做那些 CURD 的业务逻辑,而应该会根据公司的实际情况去写框架。而基本上没有谁能像天才一样从零写出一个框架,很多人写框架其实都是从模仿开始的。而你要模仿,那么你首先得看得懂框架源码才行。所以说阅读源码才显得那么重要。

我在工作一两年的时候有尝试去看过 JDK 的源码,那时候感觉就跟看天书一样,看一点都觉得痛苦。一直到工作三年左右,因为同事都在看源码,我也开始看一些源码。我看的第一个框架的源码是 dubbo,虽然说没有完全搞懂它。但是通过阅读 dubbo 源码,我弄懂了 JDK 的 SPI 机制,知道 SPI 在框架开发中的作用。一直到最近阅读公司的一个网关框架,我才慢慢有一点阅读源码的经验和套路。正好趁热打铁,把这些经验写下来,希望你们也能早日踏上源码阅读之路。

搜索网上资料

阅读一个框架的源码,最基础的操作肯定是扫一遍网上的各种分析文章。通过这个操作,你可以对这个框架有个大致的了解。站在巨人的肩膀上,少走许多弯路。但如果你看的项目是公司内部的框架,那么你只能找公司内部的文档了,更甚者,有些连文档都没有。那么你可以略过这一步。

扫一遍源码

当你拿到框架的源码的时候,你可以大致把源码的每个包,以及每个包下面的文件扫读一遍。扫读并不需要你弄清楚每一行代码的意思,只需要让你知道源码每一部分的作用。

如果一个开源框架足够标准,那么他的命名是非常语义化的。所以我们扫读的时候,通过包名、文件名就可以判断出这个包是用来干嘛的。例如 util 包是工具类,那我们可以直接跳过。vo 包是存放实体模型的,同样可以跳过。protocol 包是存放协议相关的等等。通过这么一个步骤,你会对整个项目有一个基本的印象,知道这个项目大概有哪些东西,哪些相对比较重要。

找到入口

阅读任何一个框架的源码,首先就是要找到框架的入口。通过上面扫读源码,你应该能够发现一些入口的迹象,例如对于 Dubbo 来说,你会发现它有一个名为 dubbo-demo 的子模块,那么我们肯定重点看它。进一步发掘需求你会发现它的入口就是 dubbo-demo 中的 Provider 类、Consumer 类。我们可以直接接运行这两个类的 main 方法,并一步步跟踪代码的执行情况。

通读源码

找到入口之后,下一步就是通读所有源码了,就是把源码的每个文件每一行都看一遍。在这个阶段不求完全弄懂细致的业务逻辑,但是要形成一个大概的框架,知道这个框架是如何设计的,有哪些大致的模块,这些模块是如何设计的。

在通读源码这个阶段是最枯燥无味的,也是最容易放弃的。一方面因为源码实在过于多,另一方面因为没有一个目标,所以看着看着心里没有底,所以容易放弃。我一开始也是如此,但之后我想出了一个比较好的办法,通过数字化的方式让自己知道阅读进度。这样自己就不会觉得心里没底,不知道要多久才能看完了。

我的方法是给我的 IDE 装一个代码统计插件:Statistics。这个插件能够统计项目中的源码行数。例如下面是我统计 dubbo 项目源码的截图,它会列出每个 java 文件的源码行数,以及总共的行数。

从上面的截图我们可以看到 dubbo 项目里,源码的行数有 11 万行。这样一来,自己心理也有个大致的预期了。接下来,我会把这些数据拷贝出来,放在一个 Excel 表格里,就像下面这样子:

在 Excel 表格中,我只会存放每个源码文件的名字、其源码行数、源码行数占比。接下来我会按着入口,一个个去看源文件,把每个方法看过一遍,看过的方法我会写一个注释,例如:csy mark,并写上我的注释。当我把一个文件都看过之后,我会把 Excel 表格中对应的文件最右边一列,写上其百分比。最后我会在下边有一行,统计我所看完文件的百分比。

我每看完一个方法,我就写一个 csy done 来鼓励下自己。每看完一个文件,我就在 Excel 中把它标记为完成,最下边的已读百分比也会跟着不断升高。通过这种方式,我让枯燥无味的源码阅读,有些一点趣味,有了一些目标。

通读源码是最枯燥的,最容易没有方向和目标的。有了数字化的记录,你可以知道自己现在的进度是怎么样,看了多少的源码。很多时候我们看了很久,发觉没什么进度的样子,又不想看了。这时候你可以给自己定一个目标,例如:一天看完 5% 的源码就可以休息。那当你想偷懒的时候,看看 Excel 下方的已读百分比,还没到 5%,继续看吧。

这种方式对于我来说,还是有一定作用的。但对于你们不知道有没有作用,你们可以尝试一下。如果有用的话,就来评论告诉我吧。

梳理框架

在通读源码的过程中,你就会对框架有许多新的认识,会知道这个框架大致分为哪几个部分,每个部分的作用是什么,这个模块用了什么设计理念等等。

如果说上个阶段是通读源码,那么这个阶段就是要把你在通读源码过程中的收获整理出来。在整理的过程中,你肯定会有更多的疑问,你会不断地细化,不断地精读。

批判性思考

通过了上面几个阶段,你会发现你对这个框架有了整体的认识,并且对每个模块的实现细节都有了比较深刻的认识。这个时候,你可以想一想为什么它要这么做,这么做有什么好处,那能用另一种方式做得更好吗?

总结

上面几个阶段是我阅读几个框架源码之后的一些体会,相信会是一个不错的源码阅读指南。如果你有更好的源码阅读经验或方法,欢迎留言与我交流。

写在最后:欢迎留言讨论,加关注,持续更新!!!

阿里P7分享如何面对枯燥的源码的更多相关文章

  1. 厉害!这份阿里面试官 甩出的Spring源码笔记,GitHub上已经爆火

    前言 时至今日,Spring 在 Java 生态系统与就业市场上,面试出镜率之高,投产规模之广,无出其右.随着技术的发展,Spring 从往日的 IoC 框架,已发展成 Cloud Native 基础 ...

  2. 分享45个android实例源码,很好很强大

    分享45个android实例源码,很好很强大 http://www.apkbus.com/android-20978-1-1.html 分享45个android实例源码,很好很强大http://www ...

  3. 分享45个android实例源码,很好很强大.收藏吧!!!

    andriod闹钟源代码 http://www.apkbus.com/android-20974-1-1.html android源码分享之指南针程序 http://www.apkbus.com/an ...

  4. Visual Studio 2015开发Qt项目实战经验分享(附项目示例源码)

    Visual Studio 2015开发Qt项目实战经验分享(附项目示例源码)    转 https://blog.csdn.net/lhl1124281072/article/details/800 ...

  5. 阿里云视频直播API签名机制源码

    阿里云视频直播API签名机制源码 本文展示:通过代码实现下阿里视频直播签名处理规则 阿里云视频直播签名机制,官方文档链接:https://help.aliyun.com/document_detail ...

  6. 分享一套主流框架源码资料,征服阿里 P7 面试必备!

    2019年已经过完一半了, 我在这里为大家准备了一份资料,征服阿里 P7 面试必备! 希望这些资料可以帮助到大家,从一个码农进阶为一个优秀的程序员,也可以帮大家提升系统实战能力. 这些资料包括: 讲解 ...

  7. 【腾讯Bugly干货分享】微信iOS SQLite源码优化实践

    本文来自于腾讯bugly开发者社区,非经作者同意,请勿转载,原文地址:http://dev.qq.com/topic/57b58022433221be01499480 作者:张三华 前言 随着微信iO ...

  8. 【分享】Maven插件的源码下载(SVN)

    偶然的情况下找到了Maven插件源码的网址,现分享下 http://svn.apache.org/repos/asf/maven/plugins/ 可以使用SVN下载,在添加新的资源路径时,把上面的网 ...

  9. Webfunny知识分享:webpack sourceMap解析源码

    前端的业务越来越庞大,导致我们需要引入的js等静态资源文件的体积也越来越大,不得不使用压缩js文件的方式来提高加载的效率. 编译工具的诞生,极大地方便了我们处理js文件的这一过程,但压缩后的js文件极 ...

随机推荐

  1. python中简化的验证码功能

    验证码一般用来验证登陆.交易等行为,减少对端为机器操作的概率,python中可以使用random模块,char()内置函数来实现一个简单的验证码功能. import random def veri_c ...

  2. 上交所跨市场ETF申购赎回实时回报

    申购赎回实时回报:1.二级市场过户记录(二级市场代码)2.沪市成分股过户记录(全部成分股)3.非沪市资金记录4.沪市资金记录5.ETF一级市场过户记录(一级市场代码)

  3. java书籍推荐转

    http://blog.csdn.net/chaozhi_guo/article/details/51274634 一.<深入理解Java虚拟机:JVM高级特性与最佳实践> 如果你不满足于 ...

  4. MySQL创建及删除临时表

    示例SQL: drop temporary table if exists testdb.tmp_test_table; create temporary table testdb.tmp_test_ ...

  5. Docker 镜像小结---操作指令介绍(七)

    目录 一.搜索镜像 二.下载镜像 三.查看本地镜像 四.显示镜像构建历史 五.删除镜像 六.镜像创建 七.上传镜像 八.给镜像打 tag 九.存出和载入镜像 一.搜索镜像 很多情况下我们可能需要下载某 ...

  6. Unity接入九游SDK学习与踩坑

    学习之路漫漫,应修之期远兮.持之以恒,方得始终. 这几日接入九游SDK,于浑浑噩噩中成长. 下面是步骤: 一:下载九游SDK 二:打开Android Studio新建一个工程,并且新建一个Androi ...

  7. ELK实战搭建+x-pack安全认证

    阅读目录: ELK日志平台入门简介1.1   ELK原理拓扑图1.2   Elasticsearch安装配置1.3   Kibana安装配置1.4   Kibana汉化及时区修改1.5   Logst ...

  8. 洛谷 题解 UVA1151 【买还是建 Buy or Build】

    [题意] 平面上有\(n(n<=1000)\)个点,你的任务是让所有n个点联通.为此,你可以新建一些边,费用等于两个端点的欧几里得距离平方.另外还有\(q(q<=8)\)个套餐可以购买,如 ...

  9. mysql数据恢复,binlog详解

    个人博客:mysql数据恢复,binlog详解 binlog日志恢复数据,是挽救错误操作和数据损坏一根救命稻草,所以认识和使用binglog对于技术人员还是很有必要的 binlog一般用于 主从复制 ...

  10. hadoop--Unable to load native-hadoop library for your platform解决方法

    笔者实验环境:centos 7.4.1708,hadoop-2.6.0-cdh5.14.2. 执行hadoop命令时出现以下告警,不能加载相关库: WARN util.NativeCodeLoader ...