Linux OpenGrok搭建

来源:https://www.cnblogs.com/zhiqinlin/p/18269163
-Advertisement-
Play Games

OpenGrok是一個源碼搜索及交叉引用查詢引擎,OpenGrok的引入可以幫助我們更好地在浩如煙海的源碼里找到自己需要的那坨代碼。 ...


目錄

一、目的

        Android源碼太龐大,涉及幾十個G、上千萬個文件,普通的IDE都無法完全載入全部代碼,更不用談搜索、索引,這對於Android源碼的學習、調試非常不利。
        OpenGrok是一個源碼搜索及交叉引用查詢引擎,OpenGrok的引入可以幫助我們更好地在浩如煙海的源碼里找到自己需要的那坨代碼。

二、環境

  1. 系統:Ubuntu 14.04
  2. CPU:13th Gen Intel(R) Core(TM) i5-13500

三、相關概念

3.1 OpenGrok

        OpenGrok為一個方便快速的源碼搜索及交叉引用查詢引擎。它以Java編寫,可用於源碼搜索、交叉引用查詢、以及源碼樹定位。它支持多種編碼語言和多種代碼版本控制引擎系統。

3.2 CTags

        CTags是一個在Linux系統中廣泛使用的工具,它可以幫助程式員更有效地瀏覽和管理大型代碼庫。CTags能夠創建一個索引文件,其中包含代碼庫中的函數、類、結構體等關鍵詞的位置信息。

3.3 Tomcat

        Tomcat是一個免費的開放源代碼的Web應用伺服器,屬於輕量級應用伺服器,由Apache軟體基金會(Apache Software Foundation)的Jakarta項目開發。 它是一個Servlet容器,同時也是JSP(Java Server Pages)的一個容器,支持最新的Servlet和JSP規範。Tomcat的設計目標是提供一個可靠且易於使用的Web應用伺服器,特別適用於中小型系統和併發訪問用戶不是很多的場合。由於其技術先進、性能穩定且免費,Tomcat深受Java愛好者的喜愛,並得到了部分軟體開發商的認可,成為比較流行的Web應用伺服器之一。

四、OpenGrok搭建

4.1 安裝jdk

sudo apt install openjdk-11-jdk

4.2 安裝ctags依賴

sudo apt install autoconf automake

4.3 安裝universal-ctags

4.3.1 下載universal-ctags

git clone https://github.com/universal-ctags/ctags.git

4.3.2 編譯&&安裝universal-ctags

cd ctags
./autogen.sh 
./configure
make
sudo make install

4.4 安裝Tomcat

4.4.1 下載&&解壓Tomcat

# http://tomcat.apache.org/
tar -xvf apache-tomcat-10.1.24.tar.gz 

4.4.2 啟動Tomcat

sh apache-tomcat-10.1.24/bin/startup.sh

4.4.3 驗證Tomcat

訪問:http://127.0.0.1:8080/

4.5 安裝OpenGrok

# https://github.com/oracle/opengrok
# https://github.com/oracle/opengrok/releases
tar -xvf opengrok-1.13.7.tar.gz 

4.6 基於Tomcat搭建OpnGrok服務

  1. 拷貝OpenGrok的源項目到Tomcat下。 Tomcat啟動後會自動解壓source.war,可以通過瀏覽器訪問:http://127.0.0.1:8080/source/
cp opengrok-1.13.7/lib/source.war apache-tomcat-10.1.24/webapps/ 
  1. 配置相關環境變數。
sudo vi ~/.bashrc
# opengrok
export JAVA_HOME=/usr
export OPENGROK_TOMCAT_BASE=/media/2TB/lzq/openGrok/apache-tomcat-10.1.24
export CATALINA_HOME=/media/2TB/lzq/openGrok/apache-tomcat-10.1.24
export OPENGROK_APP_SERVER=Tomcat
export OPENGROK_INSTANCE_BASE=/media/2TB/lzq/openGrok/opengrok-1.13.7
export LANG=zh_CN.UTF-8
  1. 使能環境變數
source ~/.bashrc
  1. 創建相關目錄
 mkdir opengrok-1.13.7/etc opengrok-1.13.7/src opengrok-1.13.7/data  opengrok-1.13.7/history
  1. 將待索引代碼拷貝到src目錄下。 建議創建一個軟鏈接,不然多一份代碼占用空間。
cp -r xxx opengrok-1.13.7/src/ 
  1. 生成索引 (之後每次在src目錄下有更新需要重新索引)。在opengrok-1.13.7/data/下會有相關索引信息,也是很占空間,此過程費時,這台拖拉機索引一次用了6天(粗略估算了一下,一分鐘僅能掃描100個文件)。
java -jar opengrok-1.13.7/lib/opengrok.jar -P -S -v -s opengrok-1.13.7/src -d opengrok-1.13.7/data -H --repository  opengrok-1.13.7/history -W opengrok-1.13.7/etc/configuration.xml
  1. 配置configuration.xml路徑。 索引生成後,會生成opengrok-1.13.7/etc/configuration.xml文件,需要讓tomcat下的項目引用該配置。
# apache-tomcat-10.1.24/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>/media/2TB/lzq/openGrok/opengrok-1.13.7/etc/configuration.xml</param-value>
</context-param>
  1. 驗證功能。 啟動tomcat,同時瀏覽器訪問http://127.0.0.1:8080/source/, 大功告成。

五、相關問題

5.1 TomCat訪問source異常404?

        一開始我下載apache-tomcat-9.0.89,然後http://127.0.0.1:8080/source/, 一直出現404。經歷一系列各種亂七八糟的調試後,始終起不來。
        後面更新apache-tomcat-10.1.24,完美。原因不明。

5.2 OpenGrok沒有projects選擇項?

        我最開始在opengrok-1.13.7/src/下創建了UIS7870文件夾,然後生成索引的目標目錄是指向:opengrok-1.13.7/src/,導致projects僅有UIS7870,故不顯示(具體可參考configuration.xml & apache-tomcat-10.1.24/webapps/source/menu.jspf);
        後續將目標索引目錄修改成opengrok-1.13.7/src/UI7870/即可。

5.3 如何修改Tomcat埠?

  • 將server埠修改為8006
  • 將HTTP埠修改為8085
  • 將AJP埠修改為8010
# sudo cat apache-tomcat-10.1.24/conf/server.xml
<Server port="8006" shutdown="SHUTDOWN">
 
<Connector port="8085" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />
 
<Connector protocol="AJP/1.3"
               address="::1"
               port="8010"
               redirectPort="8443" />

六、參考資料

  1. OpenGrok搭建
    https://blog.csdn.net/weixin_39577288/article/details/120565619
  2. OpenGrok介紹
    https://www.jianshu.com/p/3371d3b213d2

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Percona Toolkit 神器全攻略(配置類) Percona Toolkit 神器全攻略系列共八篇,前文回顧: 前文回顧 Percona Toolkit 神器全攻略 Percona Toolkit 神器全攻略(實用類) 全文約定:$為命令提示符、greatsql>為GreatSQL資料庫提示 ...
  • 使用Percona Toolkit的pt-duplicate-key-checker工具時,偶爾會遇到"Error checking xxx: Wide character in print at /usr/bin/pt-duplicate-key-checker line 5248."這類錯誤。如 ...
  • 1.前言 因為小程式是由js代碼編寫的,我js學得不是特別的好,所以,剛開始以為js跟java一行,一行一行的執行,後面才發現,完全不是,所以有時候,我們在獲取用戶信息和openId的時候,要向後臺發送請求,所以有時有可能請求還沒有返回數據,小程式這邊已經賦值了,只能得到一個undifine,很桑心 ...
  • UINavigationController 是 iOS 中用於管理視圖控制器層次結構的一個重要組件,通常用於實現基於堆棧的導航。它提供了一種用戶界面,允許用戶在視圖控制器之間進行層次化的導航,例如從列表視圖到詳細視圖。 UINavigationController 的主要功能 管理視圖控制器堆棧: ...
  • UITabBarController 是 iOS 中用於管理和顯示選項卡界面的一個視圖控制器。它允許用戶在多個視圖控制器之間進行切換,每個視圖控制器對應一個選項卡。 主要功能 管理多個視圖控制器: UITabBarController 管理一個視圖控制器數組,每個視圖控制器對應一個選項卡。 顯示選項 ...
  • 在MVC模型中,V指view,負責用戶界面的顯示、處理用戶輸入,並將輸入傳遞給控制器。C是指ViewController,充當模型和視圖之間的中介。控制器接收用戶輸入,處理用戶請求,並將結果傳遞給視圖以更新顯示。本文詳細介紹在iOS開發中UIView與UIViewController的生命周期。 U ...
  • 目錄前言一、Jetpack Compose 中處理嵌套滾動的思想二、Modifier.nestedScroll2.1 NestedScrollConnection2.2 NestedScrollDispatcher三、實操講解3.1 父組件消費子組件給過來的事件——NestedScrollConne ...
  • 目錄一、點按手勢1.1 Modifier.clickable1.2 Modifier.combinedClickable二、滾動手勢2.1 滾動修飾符 Modifier.verticalScorll / Modifier.horizontalScorll2.2 可滾動修飾符 Modifier.scr ...
一周排行
    -Advertisement-
    Play Games
  • 通過WPF的按鈕、文本輸入框實現了一個簡單的SpinBox數字輸入用戶組件並可以通過數據綁定數值和步長。本文中介紹了通過Xaml代碼實現自定義組件的佈局,依賴屬性的定義和使用等知識點。 ...
  • 以前,我看到一個朋友在對一個系統做初始化的時候,通過一組魔幻般的按鍵,調出來一個隱藏的系統設置界面,這個界面在常規的菜單或者工具欄是看不到的,因為它是一個後臺設置的關鍵界面,不公開,同時避免常規用戶的誤操作,它是作為一個超級管理員的入口功能,這個是很不錯的思路。其實Winform做這樣的處理也是很容... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他的程式每次關閉時就會自動崩潰,一直找不到原因讓我幫忙看一下怎麼回事,這位朋友應該是第二次找我了,分析了下 dump 還是挺經典的,拿出來給大家分享一下吧。 二:WinDbg 分析 1. 為什麼會崩潰 找崩潰原因比較簡單,用 !analyze -v 命 ...
  • 在一些報表模塊中,需要我們根據用戶操作的名稱,來動態根據人員姓名,更新報表的簽名圖片,也就是電子手寫簽名效果,本篇隨筆介紹一下使用FastReport報表動態更新人員簽名圖片。 ...
  • 最新內容優先發佈於個人博客:小虎技術分享站,隨後逐步搬運到博客園。 創作不易,如果覺得有用請在Github上為博主點亮一顆小星星吧! 博主開始學習編程於11年前,年少時還只會使用cin 和cout ,給單片機點點燈。那時候,類似async/await 和future/promise 模型的認知還不是 ...
  • 之前在阿裡雲ECS 99元/年的活動實例上搭建了一個測試用的MINIO服務,以前都是直接當基礎設施來使用的,這次準備自己學一下S3相容API相關的對象存儲開發,因此有了這個小工具。目前僅包含上傳功能,後續計劃開發一個類似圖床的對象存儲應用。 ...
  • 目錄簡介快速入門安裝 NuGet 包實體類User資料庫類DbFactory增刪改查InsertSelectUpdateDelete總結 簡介 NPoco 是 PetaPoco 的一個分支,具有一些額外的功能,截至現在 github 星數 839。NPoco 中文資料沒多少,我是被博客園群友推薦的, ...
  • 前言 前面使用 Admin.Core 的代碼生成器生成了通用代碼生成器的基礎模塊 分組,模板,項目,項目模型,項目欄位的基礎功能,本篇繼續完善,實現最核心的模板生成功能,並提供生成預覽及代碼文件壓縮下載 準備 首先清楚幾個模塊的關係,如何使用,簡單畫一個流程圖 前面完成了基礎的模板組,模板管理,項目 ...
  • 假設需要實現一個圖標和文本結合的按鈕 ,普通做法是 直接重寫該按鈕的模板; 如果想作為通用的呢? 兩種做法: 附加屬性 自定義控制項 推薦使用附加屬性的形式 第一種:附加屬性 創建Button的附加屬性 ButtonExtensions 1 public static class ButtonExte ...
  • 在C#中,委托是一種引用類型的數據類型,允許我們封裝方法的引用。通過使用委托,我們可以將方法作為參數傳遞給其他方法,或者將多個方法組合在一起,從而實現更靈活的編程模式。委托類似於函數指針,但提供了類型安全和垃圾回收等現代語言特性。 基本概念 定義委托 定義委托需要指定它所代表的方法的原型,包括返回類 ...