搭建大型源码阅读环境——使用 OpenGrok

时间  2019-11-17 标签 搭建 大型 源码 阅读 环境 使用 opengrok

RTFSC 是程序员打怪升级路上避不开的功课，那营造一个温馨的环境来提高上课的体验就颇有必要了。java

好比阅读 AOSP 这种大型源码，用什么姿式来阅读才能丝般顺滑，让 F**king Source Code 也变得不那么可恶呢？android

工具的选择

阅读源码的工具我尝试过如下几类：git

  1. IDE程序员

    在看特定类型项目时这是个人首选。好比它本来就是一个 Visual Studio 工程，那固然用 Visual Studio 来打开阅读，看 Android App 或者 Library 源码固然用 Android Studio 体验更好。github

  2. 编辑器配合插件web

    好比 Vim + Ctags + Cscope，再配合文件模糊查找插件 LeaderF 和神器 YouCompleteMe，在源码规模不大时很方便，打开也轻快，阅读一些小项目时我仍是乐意使用它们。chrome

  3. 专门的源码阅读工具apache

    在针对特大型源码时，好比 AOSP 和 Chromium，使用上述两种方案可能会感受乏力，这时候就须要祭出专门的源码阅读工具了。vim

    一类是商业软件，好比 Windows 下有著名的 Source Insight，跨平台的有 Understand，功能都很强大，都是不错的选择。固然它们都价格不菲。浏览器

    而我这里要讲的主角 OpenGrok 属于另外一类，免费，开源，运行流畅，功能也绝不逊色。

若是你还在寻觅适合你本身的解决方案，大能够花一点时间将以上几种都尝试一遍，哪一个称手用哪一个，也能够像我同样，针对不一样的项目使用不一样的工具。想直观了解 OpenGrok 的同窗能够直接先看看一些使用 OpenGrok 的在线源码查看网站，看看它可否知足你的需求，其中的一些列在 OpenGrok installations。

OpenGrok 特性

译自官方 Wiki。

OpenGrok 提供以下特性：

  1. 快速搜索代码的引擎

    • 搜索全文、定义、符号、文件路径和修改历史

    • 搜索任意指定子目录（分层搜索）

    • 增量更新索引文件

    • 支持相似 Google 的查询语法，好比 path:Makefile defs:target

    • 搜索日期范围内修改的文件

    • 支持使用通配符搜索，如 * 表示多个字符，? 表示单个字符

    • 在搜索结果中展现匹配行

  2. 一个 Web 只读版的版本历史查看界面

    • 文件的修改日志

    • 文件在两个版本间的 diff

    • 文件夹的历史记录

  3. 带语法高亮的交叉引用显示，可使用 CSS 自定义样式

  4. 能够开发插件支持新的语言和版本控制系统

    已经支持的语言： Supported Languages and Formats

    已经支持的版本控制系统：Supported Revision Control Systems

配置 OpenGrok

截屏

按惯例先上图吧，万一你一眼就发现不是你的菜呢（截图来自官网）。

搜索功能和源码树：

OpenGrok Search and Browse
OpenGrok Search and Browse

代码导航和版本历史记录：

OpenGrok Navitation and History
OpenGrok Navitation and History

安装和配置

以下以 Windows 下为例，Mac OS X 与 Linux 下与此相似，不少步骤能使用 brew 或者 apt-get 会更方便。

  1. 安装 JDK，并配置 JAVA_HOME 或者 JRE_HOME 环境变量为安装目录。

  2. 下载 Tomcat，解压到一个目录，如 D:\Programs\apache-tomcat-8.5.8，并将此目录添加为 CATALINA_HOME 环境变量。

  3. 下载 Universal Ctags for Windows，将 ctags.exe 文件所在目录添加到 PATH 环境变量。

  4. 下载 OpenGrok 的最新包，好比 opengrok-0.13-rc4.zip，解压到一个目录，如 D:\Programs\opengrok-0.13-rc4。

  5. 配置 data root。

    data root 用于放置生成的索引文件和配置信息，好比我在 OpenGrok 目录下建立了一个 data 目录用做 data root，即 D:\Programs\opengrok-0.13-rc4\data。

  6. 将 OpenGrok 的 lib 目录里的 source.war 解压到 D:\Programs\apache-tomcat-8.5.8\webapps\source，配置 WEB-INF\web.xml 文件的 CONFIGURATION 为上一步生成的 data 目录下的 configureation.xml，好比个人配置：

    <display-name>OpenGrok</display-name>
<description>A wicked fast source browser</description>
<context-param>
  <description>Full path to the configuration file where OpenGrok can read its configuration</description>
  <param-name>CONFIGURATION</param-name>
  <param-value>D:/Programs/opengrok-0.13-rc4/data/configuration.xml</param-value>
</context-param>复制代码

  7. 配置 source root。

    可让 OpenGrok 认为 source root 下的每一个子文件夹是一个项目，因此咱们利用这个特性来配置和阅读多个项目源码就行了。

    个人作法是在 OpenGrok 下建立了一个子目录 D:\Programs\opengrok-0.13-rc4\projects，而后将须要阅读的源码使用符号连接的方式连接到这个目录里：

    cd /d D:\Programs\opengrok-0.13-rc4\projects
mklink /J android D:\sources\android_5.1
mklink /J openjdk7 D:\sources\openjdk7复制代码

    这样就有一个叫 android 的工程，它实际对应 D:\sources\android_5.1 下的源码，一个叫 openjdk7 的工程，它实际对应 D:\sources\openjdk7 下的源码。

  8. 创建索引。

    使用 opengrok.jar 调用 ctags 来为源码创建索引。命令行：

    java -jar /path/to/opengrok.jar -P -S -v -s /path/to/source/root -d /path/to/data/root -W /path/to/configuration.xml复制代码

    -P 表示为 source root 目录下的每一个一级子目录生成一个工程。

    -S 表示搜索并添加 "external" source repositories。

    -v 表示打印操做的进度信息。

    -s 表示指定 source root。

    -d 表示指定 data root。

    -W 表示指定将配置写到该文件。

    还有更多配置选项可使用 java -jar /path/to/opengrok.jar 查看。

    好比我使用的完整命令行：

    java -jar D:\Programs\opengrok-0.13-rc4\lib\opengrok.jar -P -S -v -s D:\Programs\opengrok-0.13-rc4\projects -d D:\Programs\opengrok-0.13-rc4\data -W D:\Programs\opengrok-0.13-rc4\data\configuration.xml复制代码

    每次须要创建或更新索引的时候敲这么长一个命令固然很不爽，使用 doskey 或者 Cmder 里的 alias 命令将其 alias 为 opengrok-index 命令会省力很多，再不济把这命令存成个 bat 文件也行啊。

    为大型源码创建索引可能须要漫长的时间，这时候能够去干点别的事了。

  9. 启动 Tomcat，愉快地 RTFSC。

    D:\Programs\apache-tomcat-8.5.8\bin\catalina.bat start复制代码

    用你最爱的浏览器打开 http://localhost:8080/source/，而后就能愉快地跟 OpenGrok 玩耍了。

    当新添加了项目，或者现有项目有源码更新时，再次执行上一步的命令，就能增量更新索引了。

配置多项目

我曾经为如何在 OpenGrok 里配置多项目苦恼了很久——一开始我是把 Android 源码的根目录看成 source root 的，可想而知 OpenGrok 把 Android 分红了好多个子项目，而这时我也无法再添加新的工程了。

后来才发现建一个专用的 source root，而后把各类项目源码根目录软连接过来，让 OpenGrok 为 source root 下的每一个 symbol 一级子目录创建一个项目才是正确的使用方法。

Windows 下创建软连接的方法是使用 mklink /J android D:\sources\android_5.1，Mac OS X 和 Linux 下可使用 ln -s /path/to/source project_name。

折腾狂魔

在 Vim 里使用

没错，还有人作了支持在 Vim 里使用 OpenGrok 的插件，若是你是 Vim 控+折腾狂魔，能够一试，这里仅给出插件地址：

反正像我这种智商是折腾不动了，就安心在浏览器里用了。

在源码里作笔记

配合 Chrome 插件 Diigo，还能给源码加标签，写注释等等。

参考：www.zhihu.com/question/33…

后话

古人教会了咱们工欲善其事，必先利其器的智慧，但咱们也不能沉迷和徘徊于各类利器之间，选择同样本身感受最称手的工具，把它用熟练，少再在这上面花时间折腾，毕竟把有限的生命投入到无限的 RTFSC 才是正道不是么。

联系我们 沪ICP备2021010478号-7