代碼瀏覽工具OpenGrok

代碼瀏覽工具OpenGrok

---

OpenGrok是一款強大的跨平臺代碼閱讀工具，許多在線源碼查看網站都是使用它來搭建的，比如著名的Android在線源碼查看網站androidxref.

OpenGrok特性

OpenGrok 提供如下特性：

• 1.快速搜索代碼的引擎

  搜索全文、定義、符號、文件路徑和修改歷史

  搜索任意指定子目錄（分層搜索）

  增量更新索引文件

• 2.支持類似 Google 的查詢語法，比如 path:Makefile defs:target

  搜索日期範圍內修改的文件

  支持使用通配符搜索，如 * 表示多個字符，? 表示單個字符

  在搜索結果中展示匹配行

• 3.一個 Web 只讀版的版本歷史查看界面

  文件的修改日誌

  文件在兩個版本間的 diff

  文件夾的歷史記錄

• 4.帶語法高亮的交叉引用顯示，可以使用 CSS 自定義樣式

  可以開發插件支持新的語言和版本控制系統

  已經支持的語言： Supported Languages and Formats

  已經支持的版本控制系統：Supported Revision Control Systems

在macOS平臺搭建OpenGrok

安裝

1.安裝tomcat

$ brew install tomcat

2.安裝ctags

$ brew install ctags

3.安裝OpenGrok

$ wget -O - http://java.net/projects/opengrok/downloads/download/opengrok-0.12.1.tar.gz | tar xvz

開啓tomcat

方法1：cd到tomcat所在目錄，然後執行命令，

$ catalina start 
$ open http://localhost:8080/source

方法2：下載macOS下的GUI程序TomcatController
配置tomcat所在目錄。

開啓openGrok項目

openGrok其實就是一個webapp

導入項目

比如導入ffmpeg，在opengrok目錄下創建一個local_src文件夾，把ffmpeg文件夾通過軟引用的方式鏈到local_src下的src目錄，這樣就能讓opengrok找到ffmpeg的代碼了。

建立索引

打開瀏覽器

訪問 http://localhost:8080/source 就能看到代碼了。

---

參考

http://blog.simplypatrick.com/2015/01/16/opengrok-on-mac-osx/

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

https://github.com/OpenGrok/OpenGrok/wiki/Features

http://bytesthink.com/blog/?p=184