opengrok是一个开源的查看代码的工具,当需要索引的源码量较大时,相比起sourceinsight要好很多,这篇文章就介绍一下opengrok的安装,及如何建立工程代码的索引.
附上官网地址opengrok
需要提前安装的环境
1.Java1.8
2.Tomcat(8.x及以上版本)
3.Ctags
这几个软件的安装就不再赘述,都很简单. 单独说一下ctags,由于官网下载下来的是源码,因此需要编译.编译方法如下:
./configure
make
sudo make install
主要介绍opengrok的安装
1,将下载好的opengrok解压到指定的目录下,这里为/home/lht/opengrok.
2,在安装的目录下建立目录etc目录用来存放配置文件(如果不创建,后面执行命令会自动创建),同时建立src目录用来存放需要索引的代码(如果不创建,可以指定在其他路径).
3,配置环境变量,如下:
export JAVA_HOME=/home/lht/jdk/jdk1.8.0_144
export PATH=$JAVA_HOME/bin:$PATH
export OPENGROK_INSTANCE_BASE=/home/lht/opengrok
export OPENGROK_TOMCAT_BASE=/home/lht/tomcat
4,部署web application:
cd /home/lht/opengrok/bin
./OpenGrok deploy
5,运行tomcat,浏览器访问:http://localhost:8080/source. 如果能正常显示opengrok的页面则表明配置成功.此时,会在tomcat的webapps目录下生成source目录.
6,tomcat启动后不要关闭,接下来建立代码索引(两种方法):
./OpenGrok index
这样会默认给/home/lht/opengrok/src下的代码建立索引
./OpenGrok index <absolute_path_to_your_SRC_ROOT>
这样会指定需要建立索引的代码的路径.源码较大时执行时间会比较长.
7,重启启tomcat,浏览器访问http://localhost:8080/source,将会看到索引的源码.
致此,已经可以成功地浏览和查找源码啦,赶紧试试吧!!!
