windows搭建opengrok工具

老匹夫 2019-11-20

展開全文

opengrok是一個開源的查看代碼的工具,當(dāng)需要索引的源碼量較大時,相比起sourceinsight要好很多,這篇文章就介紹一下opengrok的安裝,及如何建立工程代碼的索引.
附上官網(wǎng)地址opengrok

需要提前安裝的環(huán)境

這幾個軟件的安裝就不再贅述,都很簡單.

主要介紹opengrok的安裝

1,將下載好的opengrok解壓到指定的目錄下,這里為D:\opengrok.
2,在安裝的目錄下建立目錄data目錄用來存放配置文件(可以在其他路徑),同時建立source目錄用來存放需要索引的代碼(可以在其他路徑).
3,將opengrok\lib目錄下的source.war拷貝到tomcat安裝目錄下的webapps下.
4,運行tomcat,瀏覽器訪問:http://localhost:8080/source. 如果能正常顯示opengrok的頁面則表明配置成功.此時,會在tomcat的webapps目錄下生成source目錄.
5,在dos命令行輸入:

java -jar D:\opengrok\lib\opengrok.jar -W D:\opengrok\data\configuration.xml -c D:\ctags58\ctags.exe -P -S -v -s Z:\source -d D:\opengrok\data

以上命令中,Z:\source即為需要索引的source源碼.源碼較大時執(zhí)行時間會比較長.
6,命令執(zhí)行完后,需要修改tomcat下的webapps\source\WEB-INF\web.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:\opengrok\data\configuration.xml</param-value>
</context-param>
<context-param>    
  <param-name>SRC_ROOT</param-name>  
  <param-value>Z:\source</param-value>  
</context-param>  
<context-param>  
  <param-name>DATA_ROOT</param-name>  
  <param-value>D:\opengrok\data</param-value>    
</context-param>

7,再次開啟tomcat,瀏覽器訪問http://localhost:8080/source,將會看到索引的源碼.

致此,已經(jīng)可以成功地瀏覽和查找源碼啦,趕緊試試吧!!!

另外,相關(guān)的option可以參見man說明
比較重要的-i選項,可以指定需要忽略的文件或文件夾,比如不需要索引*.html這類文件,不需要包含目錄test_dir,可以如下:

java -jar D:\opengrok\lib\opengrok.jar -W D:\opengrok\data\configuration.xml -c D:\ctags58\ctags.exe -P -S -v -s Z:\source -d D:\opengrok\data -i *.html -i d:test_dir