源码资源

源码资源一般分两类,一类是在线资源,一类是本地资源。

在线资源

这类资源一般是一个网站,提供在线源码阅读与检索功能。
比如 GitHub 就是一个大型的源码分享网站。我们可以在 GitHub 上面分享我们的源码,其他人可以在线阅读,也可以下载到本地,通过导入源码开发或者阅读工具进行阅读。

另外还有一些专业方向的在线阅读源码网站,以 Android 为例,AOSPXRef 网站是一个专门的在线阅读 Android 系统源码的站点,在上面可以查看和搜索各种版本的 Android 系统源码。
关于源码阅读:源码资源、阅读工具、阅读思路

本地资源

本地资源这个好理解,其实就是离线源码,所有的源码打包下载到本地,由本地的阅读工具导入打开阅读。
比如在GitHub上面通过 Clone 或者 Download 方式导入到本地的代码:
关于源码阅读:源码资源、阅读工具、阅读思路

两者区别

  1. 如果源码太大,建议使用在线资源,比如 Android 源码一个版本可能就有几十个 G ;下载下来费时费力,而且不好管理。而在线资源已经拥有了所有版本的资源,查找使用方便。
  2. 本地资源可用性灵活,可以使用多款阅读工具阅读;在线资源一般只能使用网站提供的工具检索和查看。
  3. 在线资源受制于第三方网站,有可能出现不稳定;而本地资源一般保存在本机,安全性和完整性有保障。

阅读工具

这里我们根据在线资源和本地资源,分别介绍一款工具,方便代码阅读。

Octotree

Octotree 是一款 Chrome 插件,它可以将 Github 项目以树形结构展示,方便快速切换查看不同目录下的文件。
关于源码阅读:源码资源、阅读工具、阅读思路
Octotree 是通过 Github API 获取项目数据的,如果超过了默认的 API 请求限制流,那么 Octotree 会需要我们提供 GitHub Personal Access Token。我们可以在 GitHub 如下路径中创建: Settings -> Developer settings -> Personal access tokens -> Generate new token 创建令牌。

Sourcetrail

阅读源码的工具挺多的,比如老牌的 Source Insight。
不过今天我们要介绍的这款源码阅读工具是 SourceTrail 。
官网地址:https://www.sourcetrail.com/
它的口号就是:Get productive on unfamiliar source code.
显而易见,它是用来阅读本地源码的,尤其是不熟悉的、新引入的。
目前支持 C 、 C++ 、Python 和 Java 语言,同时还提供了相关 SDK 用于拓展支持其它语言。
** SourceTrail 最大的特点是使用图形化的方式展示代码结构,使得开发人员更容易了解源代码。**

接下来我们简单介绍下它的使用方式,这里我们下载了 okhttp-3.1.2-sources 的源码,我们用 SourceTrail 打开它。
关于源码阅读:源码资源、阅读工具、阅读思路
加载后首页可以看到OkHtt源码的概括,比如多少个文件,有哪些包,多少类等等。
我们选择Dispatcher文件:
关于源码阅读:源码资源、阅读工具、阅读思路
可以看到, Dispatch 左边显示的是有哪些类调用到了 Dispatcher ,而右边显示的是 Dispatcher 调用了哪些类。
点击左边的 1 这个路径:
关于源码阅读:源码资源、阅读工具、阅读思路
左边展示的是调用类具体调用的地方,右边显示的是具体的源码。

接下来我们点击右边 2 这个路径:
关于源码阅读:源码资源、阅读工具、阅读思路
我们可以看到 Dispatcher 具体调用的 Util 中的方法的位置,右边显示的是具体源码。

阅读思路

每个人都有不同的阅读代码习惯,这里介绍几种阅读方法,供探讨,欢迎交流。

直接阅读

直接阅读是指以代码结构为主线去阅读。
以 Android 项目源码为例,项目结构都包含在 androidmanifest.xml 中,里面包含了启动类和 Application 的定义,可以从这里为阅读起点。

奔着目的去阅读

这种方式比较适合接手项目来开发的方式,比如需要增加或者修改一个功能,你必须得在源码中找到对应的位置,查看它当前的解决方案,然后才能着手去修改。你不需要知道所有代码是怎么写的,只需要定位,然后阅读,最后修改。这种方式也是目前很多项目中开发人员采用的方式。
比如改 Bug 就是一个典型的例子,通过 Bug 让你去找到出错的位置,然后看它是怎么实现的,实现中是怎么产生 Bug 的。

带着解决方案去阅读

这是一种新的阅读思路,比如OkHttp源码,其中有Http请求和响应的处理,那我们能不能在阅读前先自己想一下,如果是我,该如何实现?我们先想到一种解决方案,然后带着这种解决方案去源码里寻找解决方案,然后对比一下两者的实现是不是一致的。

相关文章: