Windows搭建opengork源码阅读环境
Android源码的代码量比较庞大，有时候很难在其中找到自己需要的东西，opengork提供了一个在线源码快速搜索代码的引擎，带语法高亮的交叉引用显示，在代码间自由跳转，免费，开源，运行流畅，功能强大。参考网站：http://aosp.opersys.com/
关于OpenGrok
OpenGrok：https://oracle.github.io/opengrok/
Requirements:
- Java 11 or later
- A servlet container like GlassFish or Tomcat (10.x or later) also running with Java version as specified above
- Universal ctags
相关下载
我的搭建环境配置
Java17 + Tomcat 10.0.11 + ctags 5.9.0 + opengrok 1.7.18
Java17：https://www.oracle.com/java/technologies/downloads/#jdk17-windows x64 Installer
Tomcat：https://tomcat.apache.org/download-10.cgi 64-bit Windows zip
ctags：https://github.com/universal-ctags/ctags-win32/releases ctags-2021-09-18_p5.9.20210912.0-26-g9f18bdc6-x64.zip
opengork：https://github.com/oracle/opengrok/releases opengrok-1.7.18.tar.gz
搭建步骤
1.安装JDK并配置环境变量
#安装下载的文件，按步骤点击完成即可
#配置环境变量
1.新建 JAVA_HOME 值为 C:\Program Files\Java\jdk-17
2.新建 CLASSPATH 值为 .:%JAVA_HOME%\lib;
3.修改Path 添加 ;%JAVA_HOME%\bin
#验证java环境
PS C:\Users\fangjian> java -version
java version "17" 2021-09-14 LTS
Java(TM) SE Runtime Environment (build 17+35-LTS-2724)
Java HotSpot(TM) 64-Bit Server VM (build 17+35-LTS-2724, mixed mode, sharing)
PS C:\Users\fangjian> javac -version
javac 17
2.配置Tomcat环境
#解压下载的文件apache-tomcat-10.0.11-windows-x64.zip
#配置环境变量
新建 CATALINA_HOME 值为 D:\Users\apache-tomcat-10.0.11
#启动Tomcat
C:\Users\fangjian>D:\Users\apache-tomcat-10.0.11\bin\catalina.bat start
或者双击D:\Users\apache-tomcat-10.0.11\bin\startup.bat即可
#使用opengork时都是需要启动Tomcat的，不要关闭，Tomcat是个web服务器
输入网址： http://localhost:8080/
若出现Apache Tomcat介绍页面，则Tomcat环境配置成功
3.配置ctags环境
#解压下载的文件即可 （建议将解压目录简化如ctags59，否则会出现环境变量配置问题）
#配置环境变量
修改 Path 添加 ;D:\Users\ctags59
#检查ctags环境
C:\Users\fangjian>ctags --version
Universal Ctags 5.9.0(9f18bdc6), Copyright (C) 2015 Universal Ctags Team
Universal Ctags is derived from Exuberant Ctags.
Exuberant Ctags 5.8, Copyright (C) 1996-2009 Darren Hiebert
Compiled: Sep 18 2021, 01:07:02
URL: https://ctags.io/
Optional compiled features: +win32, +wildcards, +regex, +gnulib_regex, +intern
al-sort, +unix-path-separator, +iconv, +option-directory, +xpath, +json, +intera
ctive, +yaml, +case-insensitive-filenames, +packcc, +optscript
4.配置opengork环境
#解压下载的文件即可
#在opengrok的安装目录下，新建data和source两个文件夹，source目录用于放需要浏览的源码，data目录用于放置opengrok生成的索引数据
#将需要建立索引的源代码拷贝到source目录下
#建立索引，生成configuration.xml
java -Xmx524m -jar "D:\Users\opengrok-1.7.18\lib\opengrok.jar" -W "D:\Users\opengrok-1.7.18\data\configuration.xml" -P -S -v -s "D:\Users\opengrok-1.7.18\source" -d "D:\Users\opengrok-1.7.18\data"
#把opengrok安装目录下的\lib\source.war文件，解压到tomcat安装目录下的webapps\目录下
jar -xvf source.war 或使用第三方解压工具
#修改webapps\source\WEB-INF\web.xml，搜索CONFIGURATION关键字下的xml路径，修改成data目录下生成索引的configuration.xml的绝对路径
<context-param>
<description>Full path to the configuration file where OpenGrok can read its configuration</description>
<param-name>CONFIGURATION</param-name>
<param-value>D:\Users\opengrok-1.7.18\data\configuration.xml</param-value>
</context-param>
#运行Tomcat,访问地址：http://localhost:8080/source，就可以看到界面了
相关参考
https://geek-docs.com/personal/obama/windows-setup-opengrok.html
https://mazhuang.org/2016/12/14/rtfsc-with-opengrok/
Linux搭建opengork：https://developer.aliyun.com/article/742660