搭建大型源码阅读环境——OpenGrok

搭建大型源码阅读环境——OpenGrok

1. 安装 JDK，并配置 JAVA_HOME 或者 JRE_HOME 环境变量为安装目录。
2. 下载 Tomcat，（点击此处去官网下载Tomcat），我下的免安装版的，解压到一个目录，如 D:\JAVA\apache-tomcat-8.5.77，并将此目录添加为 CATALINA_HOME 环境的用户变量。
3. 下载 Universal Ctags for Windows，将 ctags.exe 文件所在目录添加到 PATH 环境变量。
4. 下载 OpenGrok 的最新包（点击此处去官网下载OpenGrok），比如 opengrok-1.7.30.zip，解压到一个目录，如 D:\JAVA\opengrok-1.7.30。
5. 配置 data root：data root 用于放置生成的索引文件和配置信息，比如在 OpenGrok 目录下创建了一个 data 目录用作 data root，即 D:\JAVA\opengrok-1.7.30\data。
6. 将 OpenGrok 的 lib 目录里的 source.war 解压到 D:\JAVA\apache-tomcat-8.5.77\webapps\source
7. 执行命令，生成配置文件configuration.xml java -jar "D:\JAVA\opengrok-1.7.30\lib\opengrok.jar" -W "D:\JAVA\opengrok-1.7.30\data\configuration.xml" -c "D:\JAVA\ctags-20220214-x86\ctags.exe" -P -S -v -s "D:\seeyon\code\V8.2\apps-supervision" -d "D:\JAVA\opengrok-1.7.30\data"
8. 配置 WEB-INF\web.xml 文件的 CONFIGURATION 为上一步生成的 data 目录下的 configureation.xml，比如我的配置：

   <display-name>OpenGrok</display-name>
   <description>A wicked fast source browser</description>
   <context-param>
     <description>Full path to the configuration file where OpenGrok can read its configuration</description>
     <param-name>CONFIGURATION</param-name>
   	  <param-value>D:/JAVA/opengrok-1.7.30/data/configuration.xml</param-value>
   </context-param>
   

9. 配置 source root。可以让 OpenGrok 认为 source root 下的每个子文件夹是一个项目，所以我们利用这个特性来配置和阅读多个项目源码就好了。在 OpenGrok 下创建了一个子目录 D:\JAVA\opengrok-1.7.30\projects，然后将需要阅读的源码使用符号链接的方式链接到这个目录里

   cd /d D:\JAVA\opengrok-1.7.304\projects
   mklink /J android D:\sources\android_5.1
   mklink /J openjdk7 D:\sources\openjdk7
   

10. 并运行启动tomcat:bin\startup.bat，浏览器访问http://localhost:8080/source

参考https://zhuanlan.zhihu.com/p/24369747