全面了解opengrok

一、opengrok搭建

opengrok是一个用于代码搜索和跟踪的工具，它可以让开发者更加方便地查找代码。在使用opengrok之前，需要先进行搭建。

1、安装JDK及Tomcat。

yum install java-1.8.0-openjdk java-1.8.0-openjdk-devel -y
wget http://mirrors.tuna.tsinghua.edu.cn/apache/tomcat/tomcat-9/v9.0.33/bin/apache-tomcat-9.0.33.tar.gz
tar -xzvf apache-tomcat-9.0.33.tar.gz
mv apache-tomcat-9.0.33 /usr/local/tomcat9

2、下载opengrok。

wget https://github.com/oracle/opengrok/releases/download/1.3.6/opengrok-1.3.6.tar.gz
tar -xzvf opengrok-1.3.6.tar.gz

3、配置环境变量。

export PATH=/root/opengrok-1.3.6/bin:$PATH
export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.242.b08-0.el8_1.x86_64

二、opengrok使用

opengrok提供了web界面和命令行界面两种搜索方式，可以方便地进行代码搜索。以下是opengrok常用命令：

1、生成索引。

OpenGrok index path-to-source-files

其中，path-to-source-files为需要进行索引的代码源文件目录。

2、启动服务。

/OpenGrok start

三、opengrok权限

很多时候，我们需要对opengrok进行权限的设置，以保证代码的安全性。opengrok提供了基于用户认证和授权的权限管理机制，可以对不同用户进行赋予不同权限。

1、创建用户。

htpasswd -c /usr/local/tomcat9/conf/opengrok-users admin

2、修改opengrok配置文件。

JAVA_OPTS="${JAVA_OPTS} -Djava.util.logging.config.file=/opengrok-1.3.6/doc/logging.properties -Dorg.apache.tomcat.util.digester.PROPERTY_SOURCE=com.wadpam.grok.config.PropCtx -Dcom.wadpam.grok.config.trust_store=/usr/local/tomcat9/conf/truststore.jks -Duser.password.file=/usr/local/tomcat9/conf/opengrok-users -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true -Dorg.apache.tomcat.util.http.parser.HttpParser.requestTargetAllow=@[]"

四、opengrok中文搜索

当代码中存在中文时，opengrok默认无法进行中文搜索。为了解决这个问题，我们可以对opengrok进行相应的配置。

1、安装IKAnalyzer。

wget https://github.com/wks/ik-analyzer/archive/master.zip
unzip master.zip
cd ik-analyzer-master/
mvn clean package assembly:assembly -Dmaven.test.skip=true
cp target/ik-analyzer-1.0.0.jar /usr/local/lib/

2、修改opengrok配置文件。

GRASSROOTS_BIN=${OPENGROK_PREFIX}/bin/indexer
GRASSROOTS_LIB=${OPENGROK_PREFIX}/lib/
GRASSROOTS_GLOBAL_LIB=${OPENGROK_PREFIX}/lib/
GRASSROOTS_JAR=${OPENGROK_PREFIX}/lib/opengrok.jar
GRASSROOTS_JAVA=${JAVA_HOME}/bin/java
GRASSROOTS_JAVAC=${JAVA_HOME}/bin/javac
GRASSROOTS_ENCODING=UTF-8
GRASSROOTS_EXEC_PREFIX=/opengrok-1.3.6
GRASSROOTS_DISTRIBUTION_NAME=output
GRASSROOTS_EDICTS_FILE=${OPENGROK_PREFIX}/config/edicts.xml

analysis.analyzerprovider=org.apache.lucene.analysis.commongrams.CommonGramsAnalyzerProvider
analysis.collapseWhiteSpace=true

analysis.analyzerprovider.mycn=org.apache.lucene.analysis.cn.smart.HsSearchAnalyzerProvider
analysis.analyzer.mycn=cn.ikan.analysis.IkanAnalyzer
analysis.analyzer.latin=mycp
analysis.analyzer.thai=myth

writer.flushrate=1024

五、opengrok配置多个项目

我们可以使用opengrok同时进行多个项目的搜索，只需要进行相应配置即可。

1、创建指向代码目录的软链接。

ln -s /path-to-project1 /path-to-opengrok/source/project1
ln -s /path-to-project2 /path-to-opengrok/source/project2

2、修改opengrok配置文件。

OPENGROK_INSTANCE_BASE=/opengrok-1.3.6
OPENGROK_WAR_TARGET=/usr/local/tomcat9/webapps

JAVA_OPTS="${JAVA_OPTS} -Dorg.opensolaris.opengrok.history.CachingRepository=false -Dcom.sun.jersey.spi.container.ContainerRequestFilters=org.opensolaris.opengrok.web.filter.AllowGoogleCodeSearchFilter"

export OPENGROK_TOMCAT_BASE=/usr/local/tomcat9
export OPENGROK_INSTANCE_BASE=/opengrok-1.3.6
export OPENGROK_DATA_ROOT=/opengrok-1.3.6/data
export OPENGROK_LIBS=$OPENGROK_INSTANCE_BASE/lib
export OPENGROK_DISTRIBUTION_BASE=$OPENGROK_INSTANCE_BASE/lib

export PATH=$JAVA_HOME/bin:$PATH:/usr/local/gtags-6.5.6/bin

export SRC_ROOT=/path-to-opengrok

export JSP_COMPILER_LIST=""
export JSP_COMPILER=""
java -jar $OPENGROK_HOME/lib/opengrok.jar -s /path-to-opengrok/source -ownertag=MyOrganization -ctags /usr/local/ctags/bin/ctags -c /usr/local/gtags-6.5.6/bin/gtags -v -W /usr/local/tomcat9/webapps/config/configuration.xml -P -S -G -H -D /opengrok-1.3.6 -U http://localhost:8080/source -T -P -m 10 -U http://localhost:8080/source -k /usr/bin/skas

六、opengrok通过网页下载本地

opengrok支持从网页直接下载代码到本地，方便开发者进行本地修改。

1、启动opengrok服务。

/OpenGrok start

2、打开网页，进入搜索页面，在搜索结果列表找到需要下载的文件。

3、点击文件名旁的下载按钮即可把该文件下载到本地。

七、opengrok js

opengrok提供了一套可以自定义界面的js文件，可以让开发者更加方便地进行页面定制化。

1、在opengrok配置文件中，添加js文件目录。

COMMON_DEFAULT=//'.$SERVER'].'/js/common_default.js
COMMON=//'.$SERVER'].'/js/common.js

2、在对应的js文件中进行相应的修改和定制。

八、opengrok docker

如果觉得手动配置opengrok有些麻烦，我们可以选择使用docker进行快速部署。

1、拉取opengrok镜像。

docker pull oracle/opengrok:1.3.6

2、启动opengrok容器。

docker run --rm -d --name opengrok -p 8080:8080 oracle/opengrok:1.3.6

3、进入容器，进行如下操作。

docker exec -it opengrok bash
sudo -u dev ./OpenGrok index /src

4、打开网页，进行访问。