美文网首页
windows搭建opengrok工具

windows搭建opengrok工具

作者: heavenjackson | 来源:发表于2017-09-08 12:22 被阅读0次

    opengrok是一个开源的查看代码的工具,当需要索引的源码量较大时,相比起sourceinsight要好很多,这篇文章就介绍一下opengrok的安装,及如何建立工程代码的索引.
    附上官网地址opengrok

    需要提前安装的环境

    1.Java1.8
    2.Tomcat(8.x及以上版本)
    3.Ctags

    这几个软件的安装就不再赘述,都很简单.

    主要介绍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源码.源码较大时执行时间会比较长.
    6,命令执行完后,需要修改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,将会看到索引的源码.

    致此,已经可以成功地浏览和查找源码啦,赶紧试试吧!!!

    另外,相关的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
    

    相关文章

      网友评论

          本文标题:windows搭建opengrok工具

          本文链接:https://www.haomeiwen.com/subject/xepgjxtx.html