源码阅读环境OpenGrok搭建

工欲善其事,必先利其器。

导语

阅读源码最常见操作的就是在函数/方法的调用与定义之间跳转,对于只有大部分源码来说,都可以通过ctags+vim获得比较好的体验,但对于Android源码这样10G多的大型项目,这种方法就捉襟见肘了,更不必说对高度定制化的搜索需求(如查找某个文件的某个方法)的支持。

OpenGrok其实就是一个搜索引擎,只不过不同于Google、Baidu面向的是网页,OpenGrok面向的是源码,通过建立索引,OpenGrok可以帮助我们更好地在浩如烟海的源码里找到自己需要的那部分。

环境搭建

环境搭建的繁琐程度和最终的便利性成反比,把源码解压出来,随便装一个文本编辑器就可以开始阅读源码了,但是如果你真的这样做就会发现即使查找某个函数/方法的声明都极其耗时,所以希望读者接下来可以保持耐心,因为环境搭建对于源码阅读来说是一件一劳永逸的事情。

对于自学能力强者,建议直接看官方文档:How to setup OpenGrok · oracle/opengrok Wiki

网页浏览器+Servlet

什么要网页浏览器?因为OpenGrok本质是一个建立和处理索引的工具,就像ctags一样,我们一般用的编辑器Vim其实充当了一个显示代码的前端的作用,这个里的网页浏览器其实功能就和Vim类似,用来显示代码。Vim能够直接解析ctags工具生成的tags文件,但网页浏览器却不能,所以需要一个Servlet(服务器端),用来处理查找方法、跳转到方法声明之类的操作所产生的请求,这里我们选择tomcat,版本要求8+。安装过程如下:

sudo apt-get install tomcat8 
sudo /etc/init.d/tomcat8 restart 

打开http://localhost:8080/看到类似下面的网页说明成功了:

最后下载OpenGrok,并把source.war这个文件放在Tomcat的webapp目录下:

sudo cp ~/下载/opengrok-1.1-rc41/lib/source.war /var/lib/tomcat8/webapps

此时http://localhost:8080/source/应该就能访问了,但是可能会报一些错误,只要不是404就不要慌,继续配置。

JDK1.8+

官方明确要求JDK1.8及以上版本,如果版本低会报

An error occurred at line: 55 in the jsp file: /menu.jspf
'<>' operator is not allowed for source level below 1.7

之类的错误,如何安装JDK的教程很多,不做赘述。

通过java -versionjavac -version可以查看版本。

ctags

必须是universal-ctags,否则后面建立索引的时候会报错:

严重: Exception running indexer
    org.opengrok.indexer.index.IndexerException: Didn't find Universal Ctags
    at org.opengrok.indexer.index.Indexer.prepareIndexer(Indexer.java:888)
    at org.opengrok.indexer.index.Indexer.main(Indexer.java:298)

一般通过apt-get安装的都是exuberant-ctags,要注意:

sudo apt-get install tags[TAB]
exuberant-ctags               geany-plugin-ctags            libparse-exuberantctags-perl

可以直接下载universal-ctags的源码来编译安装:

# prepare
sudo apt-get remove ctags
sudo apt-get autoremove
sudo apt-get install autoconf
sudo apt-get install automake

git clone https://github.com/universal-ctags/ctags.git
cd ctags
./autogen.sh 
./configure
make
sudo make install

其他

足够的硬盘空间。

导入源码

管理源码

OpenGrok会通过一个目录存放所有需要被索引的工程,通过一个目录存放索引,对于需要建立索引的源码,为了不影响其他操作,我们可以建立一个目录opengrok-workspace(名字自定义,下同),将源码放在project目录下,索引放在data目录下。但这样直接移动源码实在不够优雅,其实project目录存在的意义是让OpenGrok知道哪些工程需要被索引,所以我们只需建立一个软链接(Windows下的快捷方式)就行了,这里我为Android源码、Vim源码和Git源码建立了软链接,表示我需要索引这三个工程:

cd ~/opengrok-workspace/project
ln -s ~/SourceCode/Android_6.0/mydroid/ Android6.0
ln -s ~/SourceCode/git/ git
ln -s ~/SourceCode/vim/ vim

效果如下:

~/opengrok-workspace/project $ ls
Android6.0  git  vim

这样我们不想索引某个项目只需要移除他的软链接(几kb)就行了,而不必移动项目本身(动辄几G)。

参数配置

强烈建议通过java -jar ~/Install/opengrok-1.1-rc41/lib/opengrok.jar -h查看每一个参数的意义,比如我最终的命令是下面这样:

java -jar ~/Install/opengrok-1.1-rc41/lib/opengrok.jar -P -S -v -s ~/opengrok-workspace/project -d ~/opengrok-workspace/data -I *.java -I *.c -I *.h -I *.cpp -W ~/opengrok-workspace/configuration.xml

其中-s表明项目地址,-d表明索引输出地址,-W表明配置输出地址,都是必须的。对于Git和Vim不要-I参数可能都没有问题,但对于Android源码,如果不要这个参数产生的索引就会不可用,因为.jar.so等文件都无法建立索引,所以这里我指定了只对Java和C、C++相关的文件建立索引,不仅建立速度更快,占用空间也更小。

Tomcat配置

最后,去/var/lib/tomcat8/webapps/source/WEB-INF目录配置CONFIGURATION参数,让服务器端知道索引在哪:

......
    <context-param>
        <description>Full path to the configuration file where OpenGrok can read its configuration</description>
        <param-name>CONFIGURATION</param-name>
        <param-value>/home/zhaoyu/opengrok-workspace/configuration.xml</param-value>
    </context-param>
......

按照上面的命令重启Tomcat服务器端使新的配置生效,最后大功告成:

总结

本文只是介绍了环境的基本搭建流程,OpenGrok支持高度定制,这里只使用了最基本的参数。此外,前端和服务器端也可以根据自己的喜好定制,例如asenac/vim-opengrokjdevera/vim-opengrok-search都在尝试把Vim作为浏览代码的前端,当然在Chrome里面装个vimium也能获得类似的体验。

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏张首富-小白的成长历程

Rsync小规模备份

某公司里有一台web服务器,里面的数据很重要,但是如果硬盘坏了,数据就会丢失,现在领导要求你把数据在其他机器上做一个周期性定时备份。要求如下:

1252
来自专栏Alice

iOS开发多线程在实际项目中的运用

        同一时间,CPU只能处理一条线程,也就是只有一条线程在工作。所谓多线程并发(同时)执行,

852
来自专栏零基础使用Django2.0.1打造在线教育网站

零基础使用Django2.0.1打造在线教育网站(十四):用户密码找回

努力与运动兼备~~~有任何问题可以加我好友或者关注微信公众号,欢迎交流,我们一起进步!

2571
来自专栏杨龙飞前端

渐进增强 VS 优雅降级

2114
来自专栏数据之美

shell 学习笔记(19)

声明:转载需署名出处,严禁用于商业用途! 1801.关于 nohup 后台运行的问题: nohup就是拒绝hup信号,没什么其他用途, 如...

2255
来自专栏Jerry的SAP技术分享

使用SAP云平台的destination消费Internet上的OData service

通过SAP云平台上的destination我们可以消费Internet上的OData service或者其他通过HTTP方式暴露出来的服务。

4044
来自专栏运维前线

Xen 虚拟机重命名

xen虚拟机配置文件目录 /etc/libvirt/libxl xen rename guest [root@xen-1 libxl]# virsh list ...

2245
来自专栏自由而无用的灵魂的碎碎念

网页中meta标签的使用

最近,看《Mastering Integrated HTML and CSS》时,在"为适应搜索引擎而调整网站"一节简要介绍了<meta>标签。不过,介绍比较粗...

1122
来自专栏中国Android研究院

Flutter开发环境搭建

对于上文Android Studio✗部分,只需要在AndroidStudio中的Plugin中安装Flutter插件即可。 对于'Some android l...

1063
来自专栏蓝天

Linux系统命令Top/free的使用及参数详解

top [-] [d delay] [q] [c] [S] [s] [i] [n]

1052

扫码关注云+社区