沒(méi)有需求，就沒(méi)有折騰

不過(guò)我還是喜歡折騰，只要有目的，就要嗨起來(lái)。

先說(shuō)一下背景。
某天，產(chǎn)品小伙伴過(guò)來(lái)提了一個(gè)需求：能不能把公司的需求文檔以列表的方式展示出來(lái)，當(dāng)開(kāi)發(fā)者需要哪個(gè)的時(shí)候，自己在目錄中尋找并點(diǎn)擊進(jìn)入（需要哪個(gè)點(diǎn)哪個(gè)，so easy），也就不用記錄那么多文檔url了。
另外說(shuō)明一下，公司的需求文檔是以文件夾和html組織形式部署在tomcat的，版本8，這是前提。
聽(tīng)完需求，格子的腦袋就開(kāi)始運(yùn)轉(zhuǎn)起來(lái)，這不是分分鐘能搞定的事嗎，袖子擼起來(lái)，說(shuō)做咱做。

眾(Java)所(程序猿)周知，一般訪問(wèn)Tomcat某個(gè)目錄時(shí)，如果沒(méi)有設(shè)置歡迎文件的話，是會(huì)報(bào)找不到的異常的（也就是傳說(shuō)中的404），如果你開(kāi)心的話，是可以設(shè)置歡迎文件來(lái)防止404，顯然這個(gè)方法是解決不了我們的需求的，確切來(lái)說(shuō)，是沒(méi)辦法簡(jiǎn)單解決。（如果非要解決，思路無(wú)非是這樣，設(shè)置歡迎文件，在歡迎文件里讀取當(dāng)前目錄，并將目錄下的子目錄遍歷作為列表展示給訪問(wèn)者，這里不做討論，愛(ài)咋咋地）

傳說(shuō)中的404

片頭結(jié)束，開(kāi)始正片，tomcat是提供目錄訪問(wèn)功能的，請(qǐng)不要眨眼觀看下列實(shí)驗(yàn)步驟。

1、在webapp下新建目錄，并啟動(dòng)tomcat

#目錄結(jié)構(gòu)
/webapps
    /zoro
        /dir1
        /dir2
        /dir3
        /dir4
        /dir5
        /dir6

#啟動(dòng)tomcat

#如果是Windows請(qǐng)執(zhí)行startup.bat
→startup.bat(雙擊運(yùn)行)

#如果是linux請(qǐng)執(zhí)行startup.sh
cd $CATALINA_BASE/bin
chmod *.sh (如果已賦權(quán)，請(qǐng)忽略)
./bin/startup.sh

接下來(lái)，訪問(wèn)http://localhost/zoro觀看效果，是不是看到了，甩手就是一個(gè)404

Tomcat原生404

2、修改tomcat配置

#編輯tomcat配置目錄下的web的xml文件
vim $CATALINA_BASE/conf/web.xml

#大概在100來(lái)行，可以看到如下一串神秘代碼
<servlet>
    <servlet-name>default</servlet-name>
    <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
        <init-param>
            <param-name>debug</param-name>
            <param-value>0</param-value>
        </init-param>
        <init-param>
            <param-name>listings</param-name>
            <param-value>false</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
</servlet>

把上面的listings的值改為true，然后重啟tomcat查看效果。

Tomcat原生列表目錄

是不是很丑，我也覺(jué)得很丑，對(duì)于我這種顏控來(lái)說(shuō)，簡(jiǎn)直不忍直視，看不下去了，那就開(kāi)始整容。

3、定制目錄列表

在web.xml的90幾行(上面那串神秘代碼之上），有這樣一些注釋

<!-- ================== Built In Servlet Definitions ==================== -->


  <!-- The default servlet for all web applications, that serves static     -->
  <!-- resources.  It processes all requests that are not mapped to other   -->
  <!-- servlets with servlet mappings (defined either here or in your own   -->
  <!-- web.xml file).  This servlet supports the following initialization   -->
  <!-- parameters (default values are in square brackets):                  -->
  <!--                                                                      -->
  <!--   debug               Debugging detail level for messages logged     -->
  <!--                       by this servlet.  [0]                          -->
  <!--                                                                      -->
  <!--   fileEncoding        Encoding to be used to read static resources   -->
  <!--                       [platform default]                             -->
  <!--                                                                      -->
  <!--   input               Input buffer size (in bytes) when reading      -->
  <!--                       resources to be served.  [2048]                -->
  <!--                                                                      -->
  <!--   listings            Should directory listings be produced if there -->
  <!--                       is no welcome file in this directory?  [false] -->
  <!--                       WARNING: Listings for directories with many    -->
  <!--                       entries can be slow and may consume            -->
  <!--                       significant proportions of server resources.   -->
  <!--                                                                      -->
  <!--   output              Output buffer size (in bytes) when writing     -->
  <!--                       resources to be served.  [2048]                -->
  <!--                                                                      -->
  <!--   readonly            Is this context "read only", so HTTP           -->
  <!--                       commands like PUT and DELETE are               -->
  <!--                       rejected?  [true]                              -->
  <!--                                                                      -->
  <!--   readmeFile          File to display together with the directory    -->
  <!--                       contents. [null]                               -->
  <!--                                                                      -->
  <!--   sendfileSize        If the connector used supports sendfile, this  -->
  <!--                       represents the minimal file size in KB for     -->
  <!--                       which sendfile will be used. Use a negative    -->
  <!--                       value to always disable sendfile.  [48]        -->
  <!--                                                                      -->
  <!--   useAcceptRanges     Should the Accept-Ranges header be included    -->
  <!--                       in responses where appropriate? [true]         -->
  <!--                                                                      -->
  <!--  For directory listing customization. Checks localXsltFile, then     -->
  <!--  globalXsltFile, then defaults to original behavior.                 -->
  <!--                                                                      -->
  <!--   localXsltFile       Make directory listings an XML doc and         -->
  <!--                       pass the result to this style sheet residing   -->
  <!--                       in that directory. This overrides              -->
  <!--                       contextXsltFile and globalXsltFile[null]       -->
  <!--                                                                      -->
  <!--   contextXsltFile     Make directory listings an XML doc and         -->
  <!--                       pass the result to this style sheet which is   -->
  <!--                       relative to the context root. This overrides   -->
  <!--                       globalXsltFile[null]                           -->
  <!--                                                                      -->
  <!--   globalXsltFile      Site wide configuration version of             -->
  <!--                       localXsltFile. This argument must either be an -->
  <!--                       absolute or relative (to either                -->
  <!--                       $CATALINA_BASE/conf or $CATALINA_HOME/conf)    -->
  <!--                       path that points to a location below either    -->
  <!--                       $CATALINA_BASE/conf (checked first) or         -->
  <!--                       $CATALINA_HOME/conf (checked second).[null]    -->
  <!--                                                                      -->
  <!--   showServerInfo      Should server information be presented in the  -->
  <!--                       response sent to clients when directory        -->
  <!--                       listings is enabled? [true]                    -->

上述來(lái)源：tomcat官網(wǎng)

看完上面的文檔，應(yīng)該對(duì)定制自己的目錄列表有一些思路了。
定制目錄列表需要自己定義globalXsltFile/contextXsltFile/localXsltFile，tomcat提供了定制的example。
話不多說(shuō)，動(dòng)手吧，如果諸位看官需要對(duì)所有目錄進(jìn)行同樣的定制，那么可以采用globalXsltFile，如果跟格子一樣，只需要特定目錄下的，那么建議采用localXstlFile，先用tomcat提供的示例看下效果。
在特定目錄下（格子這里是$CALINA_BASE/webapps/zoro）下新建文件zoro.xslt(or .xsl后綴名要對(duì)),然后把下面的代碼拷貝進(jìn)去~

<?xml version="1.0" encoding="UTF-8"?>

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
  version="3.0">

  <xsl:output method="html" html-version="5.0"
    encoding="UTF-8" indent="no"
    doctype-system="about:legacy-compat"/>

  <xsl:template match="listing">
   <html>
    <head>
      <title>
        Sample Directory Listing For
        <xsl:value-of select="@directory"/>
      </title>
      <style>
        h1 {color : white;background-color : #0086b2;}
        h3 {color : white;background-color : #0086b2;}
        body {font-family : sans-serif,Arial,Tahoma;
             color : black;background-color : white;}
        b {color : white;background-color : #0086b2;}
        a {color : black;} HR{color : #0086b2;}
        table td { padding: 5px; }
      </style>
    </head>
    <body>
      <h1>Sample Directory Listing For
            <xsl:value-of select="@directory"/>
      </h1>
      <hr style="height: 1px;" />
      <table style="width: 100%;">
        <tr>
          <th style="text-align: left;">Filename</th>
          <th style="text-align: center;">Size</th>
          <th style="text-align: right;">Last Modified</th>
        </tr>
        <xsl:apply-templates select="entries"/>
        </table>
      <xsl:apply-templates select="readme"/>
      <hr style="height: 1px;" />
      <h3>Apache Tomcat/<version-major-minor/></h3>
    </body>
   </html>
  </xsl:template>


  <xsl:template match="entries">
    <xsl:apply-templates select="entry"/>
  </xsl:template>

  <xsl:template match="readme">
    <hr style="height: 1px;" />
    <pre><xsl:apply-templates/></pre>
  </xsl:template>

  <xsl:template match="entry">
    <tr>
      <td style="text-align: left;">
        <xsl:variable name="urlPath" select="@urlPath"/>
        <a href="{$urlPath}">
          <pre><xsl:apply-templates/></pre>
        </a>
      </td>
      <td style="text-align: right;">
        <pre><xsl:value-of select="@size"/></pre>
      </td>
      <td style="text-align: right;">
        <pre><xsl:value-of select="@date"/></pre>
      </td>
    </tr>
  </xsl:template>

</xsl:stylesheet>

保存上面文件后，修改web.xml的神秘代碼

 <servlet>
    <servlet-name>default</servlet-name>
    <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
        <init-param>
            <param-name>debug</param-name>
            <param-value>0</param-value>
        </init-param>
        <init-param>
            <param-name>listings</param-name>
            <param-value>true</param-value>
        </init-param>
        <!--看這里-->
        <init-param>
            <param-name>localXsltFile</param-name>
            <param-value>zoro.xslt</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

重啟tomcat，看效果

Tomcat目錄定制示例

是不是好了一些了，但是還是一般般，畢竟是官網(wǎng)提供的示例，也沒(méi)辦法漂亮到哪里去，不過(guò)定制的方法已經(jīng)提供，剩下的就是html美化了，各位可以自行發(fā)揮。

格子這邊用bootstrap的表格改了一版，如圖

基于Bootstrap美化的定制目錄

5、再啰嗦幾句

在進(jìn)行定制化的時(shí)候，難免有些特殊需求，雖然繁瑣但是還是可以實(shí)現(xiàn)的。
比如格子這邊需要對(duì)目錄進(jìn)行截取，可以在xslt文件中，利用substring函數(shù)來(lái)實(shí)現(xiàn)

 <xsl:variable name="urlPath" select="substring(@urlPath,12)"/>

當(dāng)然，還有很多其他的函數(shù)，或者通過(guò)java/javasrcipt方式來(lái)擴(kuò)展，畢竟不是本文主題，不做贅述，需要的自行百度。

寫(xiě)在最后

好久沒(méi)寫(xiě)博客了，求捧場(chǎng)，求點(diǎn)贊，求夸獎(jiǎng)。

yeah