面对枯燥的源码,如何才能看得下去

转载自   面对枯燥的源码,如何才能看得下去

一个软件开发人员,工作到了一定的年限(一般是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%,继续看吧。

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

梳理框架

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

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

批判性思考

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

总结

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/325338.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

前端防xss攻击(去掉空格等能影响和攻击数据库的字段)

用法:把要传给后端的数据放到此能过滤的函数里面即可就能实现自动过滤的功能 eg 代码 export function XSSFilter(str: string) {// 过滤emoji表情str str.replace(/\uD83C[\uDF00-\uDFFF]|\uD83D[\uDC00-\uDE4F]/g, );// 过滤所有html标签str str.replace(/&l…

[深圳/广州]微软SQL技术沙龙分享会(MVP)

[深圳/广州] 新一期俱乐部活动报名开始,这次是广深地区SQL Server 技术沙龙分享会(MVP),SQL Server作为一个数据平台,不管是SQL Server 2017 on Linux 还是把一门开源R语言融入其最赚钱的旗舰商业数据库,微软已经决定&…

IntelliJ IDEA 2018.2 发布,支持 Java 11

转载自 IntelliJ IDEA 2018.2 发布,支持 Java 11 近期,JetBrains发布了其旗舰产品IntelliJ IDEA的2018.2版本。新版本支持即将推出的Java 11、断点意图(Breakpoints Intentions)、MacBook的Touch Bar等特性,并改进了…

发布支持多线程的PowerShell模块 —— MultiThreadTaskRunner

应用场景 多线程在需要批量处理一些任务的时候相当有用,也更加有利于充分利用现有计算机的能力。所有主流的开发语言都支持多线程。 默认情况下,PowerShell作为一个脚本语言,是不支持多线程操作的,虽然有所谓的后台任务&#xf…

java中,在一个有序数组中插入元素,使得数组保持有序排列

//已知有一个数组,/*数组里面的元素有a b c d e f y z,从控制台中随机输入一个字母,按照升序的顺序插入到该数组中并且遍历输出。*/public static void test1(){String [] str{"a","b","c","d","e",&…

[翻译]编写高性能 .NET 代码 第一章:工具介绍 -- Visual Studio

Visual Studio vs虽然不是全宇宙唯一的IDE,但它是.net开发人员最常用的开发工具。它自带一个性能分析工具,你可以使用它来做开发,不同的vs版本在工具上会略有差别。 VS可以分析CPU使用率,内存分配以及资源锁情况。它能在你开发与…

Java 程序员必备的 Intellij IDEA 插件

转载自 Java 程序员必备的 Intellij IDEA 插件 来源:柠檬学园 以下是我用过不错的Intellij插件,分享给大家希望能帮到大家。 1. .ignore 地址:https://plugins.jetbrains.com/plugin/7495--ignore 生成各种ignore文件,一键创建g…

表单中去掉重置和提交按钮和搜索框

去掉重置和提交按钮 <ProFormsubmitter{{// 配置按钮文本searchConfig: {resetText: 重置,submitText: 提交,},// 配置按钮的属性resetButtonProps: {style: {// 隐藏重置按钮display: none,},},submitButtonProps: {},// 完全自定义整个区域render: (props, doms) > {c…

ASP.NET 开发者 开始学习ASP.NET Core 2吧

.NET Core 从2016年6月28日发布&#xff0c;过去了将近一年的时间&#xff0c;但是在工作中发现大家对.net core的接受程度并不高&#xff0c;这只是一个感觉&#xff0c;俗话说“没有调查就没有发言权”&#xff0c; 这两天通过微信小程序在微信群里做了一个调查&#xff0c;参…

Spring Boot Redis Cluster 实战干货

转载自 Spring Boot Redis Cluster 实战干货 添加配置信息 spring.redis:database: 0 # Redis数据库索引&#xff08;默认为0&#xff09;#host: 192.168.1.8#port: 6379password: 123456timeout: 10000 # 连接超时时间&#xff08;毫秒&#xff09; pool: max-active: 8 #…

编写高性能 .NET 代码 第一章:工具介绍 -- Performance Counters(性能计数器)

Performance Counters&#xff08;性能计数器&#xff09; 性能计数器是监视应用程序和系统性能的最简单的方法之一。它有几十个类别数百个计数器在&#xff0c;包括一些.net特有的计数器。要访问这些可以通过系统自带的 性能监控程序&#xff08;perfmon.exe&#xff09;来实…

EF通用数据层封装类(支持读写分离,一主多从)

浅谈orm 记得四年前在学校第一次接触到 Ling to Sql&#xff0c;那时候瞬间发现不用手写sql语句是多么的方便&#xff0c;后面慢慢的接触了许多orm框架&#xff0c;像 EF&#xff0c;Dapper,Hibernate,ServiceStack.OrmLite 等。当然每种orm都有各自的优势&#xff0c;也有不足…

前端进行时间段筛选

传给后端参数时进行格式化 weekResultTimeStart:params.insertTime!null?moment(params.insertTime[0]).format(YYYY-MM-DD HH:mm:ss):null,weekResultTimeEnd:params.insertTime!null?moment(params.insertTime[1]).format(YYYY-MM-DD HH:mm:ss):null,注意点&#xff1a; 前…

IdentityServer4(OAuth2.0服务)折腾笔记

以下&#xff0c;称这个使用了IdentityServer4的OAuth2.0服务的项目称为Passport项目。 组件说明&#xff08;Nuget&#xff09; Passport项目所需组件 项目以Asp.net Core Identity项目模板初始化&#xff0c;集成IdentityServer4中间件&#xff1b;集成IdentityServer4.AspN…

map遍历进行展示

{userList.map((item,index)> <Option key{index} value{item.userId}>{item.realName||null}</Option>)||null}

Javase基础

Javase基础1.XML文档作用 保存和传输数据 类如&#xff1a; <标题> 标题 </标题> 2.Java的特性优势&#xff08;编译型语言和解释性语言&#xff09; 1.安全 2.面向对象 3.简单性&#xff08;C&#xff09; 4.高性能 5.分布式 6.多线程 7.高并发 8.跨平台 可移植性…

LocalDateTime与LocalDate之间的相互转换

LocalDateTime转换为LocalDate和LocalTime LocalDate转为LocalDateTime

DDD领域驱动之干货 (一)

说道DDD不得不说传统的架构与DDD的架构区别。 传统的架构不外乎就是三层&#xff0c;而在这三层里面又不断的细分&#xff0c;始终没有达到想要的效果&#xff0c;那么为什么当时还是采用三层。 当然在DDD没有提出的时候三层是大多数人的选择。 那么当领域驱动被提出来的时候…

第十三章 常用类(Math 类、Arrays 类、System类、Biglnteger 和BigDecimal 类、日期类)

一、Math 类&#xff08;P481&#xff09; Math 类包含&#xff0c;用于执行基本数学运算的方法&#xff0c;如初等指数、对数、平方根和三角函数。 &#xff08;1&#xff09;abs&#xff1a;绝对值 &#xff08;2&#xff09;pow&#xff1a;求幂 &#xff08;3&#xff09;c…