概述
OpenGrok一個快速、便於使用的源代碼搜索與對照引擎。它幫助你搜索,對照,定位你的源代碼樹。它能夠明白各種程序文件格式和版本控制歷史記錄。
應用場景:
- 全工程搜索:十幾G的代碼量,搜索速度很快
- 查看版本控制記錄
應用依賴:
- linux服務器:公共服務器,或者PC上面的虛擬機
安裝源碼
下面的源碼經過更新,支持快捷方便的創建opengrok的環境。
驗證環境:ubuntu 18.04
安裝影響:
- 刪除了原始root下的java環境,替換為當前軟件包的java版本
git clone https://gitee.com/whilewell/tools-opengrok.git
源碼結構
源碼中的腳本均在后續的安裝和使用過程中會用到
.
├── ctags # 基礎工具ctags
├── data # 生成索引安裝位置
├── etc # 生成web配置
├── gen_code_index.sh # 創建代碼索引腳本
├── index # 源碼存放位置
├── install.sh # 軟件包安裝腳本
├── jdk-17.0.1 # java工具
├── opengrok-1.7.21 # opengrok工具
├── apache-tomcat-10.0.12 # tomcat軟件包,提供web服務
├── down_tomcat.sh # 關閉tomcat腳本
└── up_tomcat.sh # 開啟tomcat腳本
安裝使用
步驟1:安裝源碼(必選)
執行install.sh腳本
步驟2:放置源碼(必選)
在源碼放入大index目錄下
步驟3:啟動tomcat(必選)
執行up_tomcat.sh腳本
步驟4:創建索引(必選)
執行gen_code_index.sh腳本
步驟5:訪問opengrok(必選)
等待步驟4
完成,完成后訪問http://${hostip}:8080/source
, 其中hostip
要根據實際情況進行輸入
步驟6:增加代碼索引(可選)
增加代碼或更新代碼后,重新執行步驟4
適用場景:
- 在index下面增加代碼目錄
- 更新index下面原有代碼
參考
Opengrok環境搭建--閱讀Android源碼_Blues Feng的博客-程序員宅基地 - 程序員宅基地 (cxyzjd.com)