OpenGrok源码搜索引擎搭建

最新推荐文章于 2024-07-25 16:08:05 发布
最新推荐文章于 2024-07-25 16:08:05 发布
阅读量600 收藏 1
点赞数
分类专栏： linux

声明

版权声明：博文为原创内容，可以转载或引用，但须在明显位置标明原文作者和出处，未经同意不得擅自修改本文内容！博客地址：http://blog.csdn.net/luzhenrong45

1. OpenGrok简介

有些情况下，我们需要在GB级别甚至几十GB级别且随时不断更新的大型代码（比如Android源码）里面搜索阅读源码，那么我们自然而然会有以下一些基本的需求：

  • 能够快速搜索代码
  • 代码可存放于本地/服务器
  • 代码之间可以跳转
  • 跨平台
  • 易于维护 
    …

显然SourceInsight、ctags、grep等工具在这些场景下就不太适合，于是有了OpenGrok这类代码搜索引擎。

先看看维基百科对OpenGrok的介绍：

OpenGrok is a source code search and cross reference engine. It helps programmers to search, cross-reference and navigate source code trees. —— [ 维基百科]

大概的意思是说，OpenGrok是一个快速、便于使用的源代码搜索与对照引擎。它能够帮助我们搜索,对照,定位我们的源代码树。

OpenGrok 应该算是我目前所知道的最好用的代码搜索、浏览工具了。由于OpenGrok是基于数据库的搜索，在代码量巨大的情况下（比如整份Android源码），搜索速度比sourceinsight要快速得多。另外，OpenGrok还是OpenSolaris操作系统源文件浏览和搜索的工具。一直以来，我都是使用OpenGrok来搜索阅读Android系统的源代码。

目前网络上已经有使用OpenGrok对Android源码进行索引的搜索引擎，地址：http://androidxref.com 
OpenGrok官方主页请参照：http://opengrok.github.io/OpenGrok/

闲话少说，下面记录一下OpenGrok的搭建过程。

2. OpenGrok安装

首先附上opengrok和tomcat的下载链接：

opengrok-0.12.1.5.tar.gz 链接：http://pan.baidu.com/s/1qXGE1pa 密码：xysf 
apache-tomcat-7.0.40.tar.gz 链接：http://pan.baidu.com/s/1pLuCcaR 密码：fisr

2.1 安装 exuberant-ctags


sudo apt-getinstall exuberant-ctags 

2.2 安装 JDK

Ubuntu系统环境下JDK的安装可以参考以前的博文 Linux下安装配置JDK6，OpenGrok 0.12以后的版本，官网宣称已经不支持JDK6，这里可以安装更高版本的，比如JDK7，安装方式是一致的。（不过貌似我用JDK6也是用得好好的…）

2.3 安装Web服务器—-Tomcat

OpenGrok是一个Web系统，因此要共享OpenGrok搜索引擎，需要安装Web服务器，这里使用Tomcat。Tomcat的安装可以直接使用命令安装, 也可以选择手动下载配置。

命令安装方式为： 

sudo apt-get install tomcat6 

由于后面Opengrok需要配置多个工程，需要修改到tomcat一些相关的参数，为了方便，这里选择手动下载安装包配置安装tomcat的方式。

(1). 首先到Tomcat官网(http://tomcat.apache.org/ )下载相应的安装包, 比如我下载的是 apache-tomcat-7.0.70.tar.gz

(2). 解压到某一目录下(比如我的是/home/lzr/opengrok-laolu/tomcat), 然后进入Tomcat的bin目录，启动Tomcat服务 

cd /home/lzr/opengrok-laolu/tomcat/bin 
sudo ./startup.sh 

注：startup.sh为启动Tomcat服务脚本，如果需要停止Tomcat服务，则执行同目录下的 shutdown.sh脚本即可。

(3). 检查Tomcat是否安装成功 
打开浏览器，访问地址:http://localhost:8080，如果能够显示以下的欢迎页面说明Tomcat配置成功。 
3

2.4 安装 OpenGrok

(1). 首先到OpenGrok官网下载相应的安装包, 比如我下载的是 opengrok-0.11.1.tar.gz

(2). 解压opengrok-0.11.1.tar.gz 到某一目录下(比如我的是/home/lzr/opengrok-laolu/opengrok), 然后进入opengrok目录，拷贝lib目录下的source.war文件到tomcat的webapps文件夹中


cd /home/lzr/opengrok-laolu/opengrok/lib 
cp source.war /home/lzr/opengrok-laolu/tomcat/webapps/ 

source.war会自动解压成source目录，里面即为OpenGrok的默认配置参数。 
打开浏览器，访问地址:http://localhost:8080/source/，可以看到OpenGrok的默认搜索页面，由于还没有建立源码索引，此时还不能搜索源码。

(3). OpenGrok开始deploy部署 
OpenGrok可执行文件位于bin目录下，执行时带deploy参数即可开始部署 

cd path_to_opengrok_bin # path_to_opengrok_bin指的是opengrok的bin目录 
./OpenGrok deploy 

(4). OpenGrok建立index索引 
deploy之后，就可以开始为源代码建立OpenGrok索引了，这是OpenGrok与源代码之间真正的建立起联系，索引建 

cd path_to_opengrok_bin # path_to_opengrok_bin指的是opengrok的bin目录 
./OpenGrok index [path_to_src_code] # path_to_src_code指的是需要建立索引的源码路径 

建立index的时间比较长，视源码大小而定，比如Android4.4的源码，使用本人的机器建立index大约耗时1小时。 
index建立结束后，默认的OpenGrok配置就算完成了，重新访问地址:http://localhost:8080/source/，便可以发现Opengrok搜索界面右侧，已经出现了Android4.4的源码，这个时候也可以进行搜索了：

4

比如在framework目录下搜索一下Android的恢复出厂设置API rebootWipeUserData，可以看出搜索结果秒出 
2 
如果平时使用过程中只需要搜索一个project的源码，那么，做完以上操作就可以了，接下来的可以不看。

3. OpenGrok多项目索引配置

3.1 OpenGrok默认安装的缺陷

按照以上默认的OpenGrok安装方法，会存在一些缺陷，比如：

  • OpenGrok只能索引一个project，无法同时索引多个project
  • project名称默认指定为”source”,不够个性化
  • index过程中会生成好几个数据目录,比如data, log, etc…, 而且这些目录居然是存放在源码目录下的，与源码目录混淆（而且个人感觉这样不好，破坏了原来相对比较独立的源码目录） 
    …

由于我在平时的学习开发过程中，经常需要接触不同的Android源代码，比如RK3288的Android4.4和Android5.1源代码，因此有索引多个project的需求。

3.2 OpenGrok多项目索安装配置

如果需要使用OpenGrok配置索引多个project, 就需要对OpenGrok进行一定的定制修改了。发现网上的教程大多是鱼龙混杂，试了几个都是不靠谱的，遇到了好些问题，折腾了好几天，这才搞定。之所以写这篇博文，其实也纯粹是为了记录OpenGrok多项目索引配置安装方法！

先上一下效果图, OpenGrok同时配置了两个project，一个是rk3288 android4.4源码，另外一个是android5.1源码，两个project是独立的，因此在OpenGrok使用过程互相不冲突。并且，两个project index过程中生成的数据是放在指定的目录下的，与源码目录隔离开来！

1

下面介绍一下多项目索引配置方法:

(1). Android源码目录： 

/home/lzr/android/source/firefly-rk3288/firefly-rk3288-kitkat (RK3288 Android4.4源码) 
/home/lzr/android/source/firefly-rk3288/firefly-rk3288-lollipop (RK3288 Android5.1源码) 

src_projects

(2) Opengrok 索引过程生成的数据目录放到指定目录,与源码隔离开来 

/home/lzr/opengrok-laolu/source/firefly-rk3288/firefly-rk3288-kitkat (Android4.4索引数据存放目录) 
/home/lzr/opengrok-laolu/source/firefly-rk3288//firefly-rk3288-lollipop (Android5.1索引数据存放目录) 

opengrok_projects

(3) 修改OpenGrok脚本

前面说到，在默认的OpenGrok 脚本中，不支持除了source以外的webapp名字。因此，需要修改一下这个脚本以增加对其他的webapp name的支持。 
OpenGrok增加一个新的环境变量OPENGROK_WEBAPP_NAME。如果没有在外部定义，则还是使用默认的 “source” 

OPENGROK_INSTANCE_BASE=”${OPENGROK_INSTANCE_BASE:-/var/opengrok}” 
+++ OPENGROK_WEBAPP_NAME="${OPENGROK_WEBAPP_NAME:-source}" 
LOGGER_CONFIG_FILE=”logging.properties” 

在启动 Java -jar opengrok.jar的时候加入 -w参数 

StdInvocation() 
{ 
${DO} ${JAVA} ${JAVA_OPTS} ${PROPERTIES} \ 
${LOGGER_PROPERTIES} \ 
... 
${MAX_INDEXED_WORDS} ${SKIN} ${LEADING_WILDCARD} \ 
${READ_XML_CONF} \ 
-W ${XML_CONFIGURATION} \ 
${WEBAPP_CONFIG} \ 
-s ${SRC_ROOT} -d ${DATA_ROOT} \ 
+++ -w ${OPENGROK_WEBAPP_NAME} \ 
"${@}" 
} 

(4). 为不同的project建立index (重点)

Android4.4 Kitkat: 

export OPENGROK_INSTANCE_BASE="/home/lzr/opengrok-laolu/source/firefly-rk3288/firefly-rk3288-kitkat" #这是生成源码数据库文件的路径，非源码路径 
export OPENGROK_WEBAPP_NAME="firefly-rk3288-kitkat" #自定义webapp name 
export OPENGROK_TOMCAT_BASE="/home/lzr/opengrok-laolu/apache-tomcat-7.0.40" #改成自己的tomcat路径 
/home/lzr/opengrok-laolu/opengrok/bin/OpenGrok deploy #不要加sudo,否则环境变量找不到 
/home/lzr/opengrok-laolu/opengrok/bin/OpenGrok index /home/lzr/android/source/firefly-rk3288/firefly-rk3288-kitkat #不要加sudo,否则环境变量找不到 

Android5.1 Lollipop: 

export OPENGROK_INSTANCE_BASE="/home/lzr/opengrok-laolu/source/firefly-rk3288/firefly-rk3288-lollipop" 
export OPENGROK_WEBAPP_NAME="firefly-rk3288-lollipop" #自定义webapp name 
/home/lzr/opengrok-laolu/opengrok/bin/OpenGrok deploy 
/home/lzr/opengrok-laolu/opengrok/bin/OpenGrok index /home/lzr/android/source/firefly-rk3288/firefly-rk3288-lollipop 

建立完各个projects的index, 工作便完成90%以上了

(5) source.war分别重命名为firefly-rk3288-kitkat.war, firefly-rk3288-lollipop.war，拷贝至tomcat webapps目录 

cd /home/lzr/opengrok-laolu/ 
cp opengrok/lib/source.war tomcat/webapps/firefly-rk3288-kitkat.war 
cp opengrok/lib/source.war tomcat/webapps/firefly-rk3288-lollipop.war 

于是，会自动生成firefly-rk3288-kitkat，firefly-rk3288-lollipop两个目录

(6) 修改每个project目录WEB-INF/web.xml 
原始的web.xml里面，param-name为”CONFIGURATION”的配置项里，param-value的值为 
“/var/opengrok/etc/configuration.xm”, 如下所示： 

<param-name>CONFIGURATION</param-name> 
<param-value>/var/opengrok/etc/configuration.xml</param-value> 

可以看到，OpenGrok默认寻找的index配置路径为/var/opengrok，因此，需要修改为我们的指定index路径: 
也就是说，需要将param-value里面的值修改为/home/lzr/opengrok-laolu/source/firefly-rk3288/firefly-rk3288-kitkat/etc/configuration.xml 
（lollipop同理进行修改）

(7) 重启Tomcat

/home/lzr/opengrok-laolu/tomcat/bin
sudo ./shutdown.sh
sudo ./startup.sh
  • 1
  • 2
  • 3

大功告成，OpenGrok安装搭建结束！

Android4.4 Opengrok搜索: http://localhost:8080/firefly-rk3288-kitkat/ 
Android5.1 Opengrok搜索: http://localhost:8080/firefly-rk3288-lollipop/

剩下一些事儿

  1. 设置Tomcat开机自启动 
    从前面的介结可以知道，tomcat服务是通过startup.sh脚本启动的，每次重启，都需要重新执行startup.sh脚本才能使用tomcat服务，比较繁琐。可以需要设置一下Tomcat开机自启动。 
    参考Linux下Tomcat开机自动启动

参考文章：

工具之OpenGrok的搭建方法

OpenGrok中多项目配置方法

Linux下Tomcat开机自动启动

very_on
关注
专栏目录
10分钟搭建OpenGrok代码搜索引擎
Vegile的博客
06-16 5591
系统 Ubuntu 16.04.2 LTS  ，安装包https://github.com/OpenGrok/OpenGrok/releases/download/1.1-rc3/opengrok-1.1-rc3.tar.gz 步骤： 1。安装tomcat8  $ sudo apt-get install exuberant-ctags tomcat8 $
搜索引擎源码
10-20
此为搜索引擎源码，专门是针对个人网页上的搜索，让其他用户进来搜索需要的内容很方便
分享88个搜索链接PHP源码，总有一款适合你
最新发布
zdh13370188237的博客
07-25 1161
下载地址转换网站源码 php版 v1.0 将迅雷、旋风、快车专用链转换成真实链接工具。PhpSou 开源php搜索引擎 体验版 v3.0 UTF8 (整合sphinx)汉狐php搜索引擎(Hanfox Search Engine) v1.0。搜啊聚合搜索SOOUA（元搜索引擎(仿百度)） v10.0 PHP版。UrlWorker 网址工匠（网址缩短程序）php版 v1.0。优客365网址导航管理系统(全能版) php版 v1.0。iWebDir网站分类目录管理源码 PHP版 v1.0。
搜索引擎源代码
dmz1981的专栏
04-01 843
https://svn.apache.org/repos/asf/incubator/lucene.net/site/docs/2.0/ 
搭建Opengrok看源码文件.zip
07-27
1. **Opengrok**：这是主要的代码搜索引擎，版本为1.2.6，对应的文件是`opengrok-1.2.6.tar.gz`。解压该文件后，我们将配置并运行Opengrok服务。 2. **Apache Tomcat**：作为Opengrok的Web服务器，用于展示搜索结果...
Ubuntu平台搭建代码浏览工具OpenGrok
09-03
OpenGrok是一款开源的、强大的源代码搜索引擎，它能帮助开发人员快速定位和理解项目中的代码，提高工作效率。下面将详细介绍如何在Ubuntu系统上安装和配置OpenGrok。 首先，确保你的Ubuntu系统已经更新到最新版本。...
opengrok工具
04-04
OpenGrok 是一款开源的源代码搜索引擎和导航工具，专为软件开发者设计，能够帮助他们快速、高效地在大量源代码中查找、理解和定位代码。这款工具支持多种编程语言，包括 Java, C, C++, Python 等，并且可以与版本...
Android下的配置管理之道之OpenGrok代码索引环境搭建
马哥私房菜
09-07 3552
1 OpenGrok介绍 OpenGrok 是一个快速, 便于使用的源码搜索引擎与对照引擎, 它能够帮助我们快速的搜索、定位、对照代码树. 接下来就具体讲解一下 OpenGrok 的安装及使用. 2 安装OpenGrok 所需依赖Requirements You need the following: JDK 1.8 or higher OpenGrok '''binar...
简单搜索引擎源码
02-27
一个简单但是功能齐全的搜索引擎 实现热词推荐 分类等功能
简易的搜索引擎源码
09-07
从asp网络编程从入门到精通的书本上拷贝来的源码
搜索引擎源码商业原版(PHP+MYSQL)
06-04
运行install.php安装带有蜘蛛管理后台，登陆跟后台一样，蜘蛛软件也是一样操作,可在本地操作。
搜索引擎源码，搜猫完整版
10-26
搜猫是一家专业开发搜索引擎系统的公司团队,其产品涉及到行业垂直搜索引擎源码,站内搜索引擎源码,仿百度谷歌搜索引擎源码等
网盘搜索引擎源码
01-11
网盘搜索引擎，用于搜索各类文件、资源 适合菜鸟选手，很好用的一个系统
搭建OpenGrok 快速索引android源码
shi_xin的专栏
07-20 1121
openggrok可以快速浏览源码，查找相关文件及函数等。 代码再服务器，本地使用opengrok搜索。 搭建环境等都在服务器进行。 代码再云上，所以各种配置也在云上配置，pc上拿到个地址，索引既可以了。 tomcat 下载： 参考一：Linux下使用Tomcat教程(一) Tomcat官网：Tomcat 下载到存放代码的服务器上。 开启服务 zip文件解压: 授予可执行权限：cd到bin目录下，然后执行授权： 开启服务： 看到服务开启了。 本地查看是否开启成功： 打开地址 http://se
android源码opengrok,搭建OpenGrok 快速索引android源码
weixin_39687990的博客
05-29 672
openggrok可以快速浏览源码，查找相关文件及函数等。代码再服务器，本地使用opengrok搜索。搭建环境等都在服务器进行。注意：一下配置均在服务器进行，打开网址均在本地进行。代码再云上，所以各种配置也在云上配置，pc上拿到个地址，索引既可以了。tomcat下载：参考一：Linux下使用Tomcat教程(一)Tomcat官网：Tomcat下载到存放代码的服务器上。开启服务zip文件解压:授予可...
源码搜索引擎
didi4find的专栏
08-14 705
源码搜索引擎 1.Ohloh http://code.ohloh.net/ Ohloh Code是最大且非常全面的源码搜索引擎，根据FOSS目录来看，其拥有超过10亿行代码且在不断更新，它不仅是免费的，而且还可以通过社区进行免费编辑。通过搜索可以索引到所有的文本文件，并且对43种编程语言都带有语法提示功能。此外，搜索语法非常灵活，可以为你查找到各种不同类型的类。搜索引擎目前不支持正则表达式。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值