静的コンテンツを提供するためのサーブレット

Question

2つの異なるコンテナー（TomcatとJetty）にwebappをデプロイしますが、静的コンテンツを提供するためのデフォルトのサーブレットは、使用するURL構造の処理方法が異なります（ details ）。

そのため、webappに小さなサーブレットを含めて、独自の静的コンテンツ（画像、CSSなど）を提供したいと考えています。サーブレットには次のプロパティが必要です。

• 外部依存関係なし
• シンプルで信頼性の高い
• If-Modified-Since ヘッダーのサポート（つまり、カスタム getLastModified メソッド）
• （オプション）gzipエンコーディング、etags、...のサポート.

そのようなサーブレットはどこかで利用できますか？私が見つけることができる最も近いものは 例4-1 サーブレットブックからです。

Update：使用したいURL構造-疑問に思っている場合-は単純に：

    <servlet-mapping>
            <servlet-name>main</servlet-name>
            <url-pattern>/*</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
            <servlet-name>default</servlet-name>
            <url-pattern>/static/*</url-pattern>
    </servlet-mapping>

したがって、staticパスに対するものでない限り、すべての要求はメインサーブレットに渡される必要があります。問題は、TomcatのデフォルトサーブレットはServletPathを考慮しないため（メインフォルダーで静的ファイルを検索する）、Jettyは（staticフォルダーを検索する）ことです。

Answer 1

私は自分のStaticServletを転がしてしまいました。 If-Modified-Since、gzipエンコーディングをサポートし、warファイルから静的ファイルも提供できるはずです。それはそれほど難しいコードではありませんが、まったく些細なことでもありません。

コードは利用可能です： StaticServlet.Java 。コメントしてください。

更新：Khurramは、ServletUtilsで参照されているStaticServletクラスについて尋ねます。これは、プロジェクトに使用した補助メソッドを備えた単純なクラスです。必要な唯一の方法はcoalesce（SQL関数 COALESCE と同じです）です。これはコードです：

public static <T> T coalesce(T...ts) {
    for(T t: ts)
        if(t != null)
            return t;
    return null;
}

Answer 2

私はわずかに異なる解決策を思いつきました。それは少しハックっぽいですが、ここにマッピングがあります：

<servlet-mapping>   
    <servlet-name>default</servlet-name>
    <url-pattern>*.html</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.jpg</url-pattern>
</servlet-mapping>
<servlet-mapping>
 <servlet-name>default</servlet-name>
    <url-pattern>*.png</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.css</url-pattern>
</servlet-mapping>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.js</url-pattern>
</servlet-mapping>

<servlet-mapping>
    <servlet-name>myAppServlet</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

これは基本的に、すべてのコンテンツファイルを拡張子によってデフォルトサーブレットにマッピングし、その他すべてを「myAppServlet」にマッピングするだけです。

JettyとTomcatの両方で動作します。

Answer 3

この場合、デフォルトのサーブレットを完全にカスタム実装する必要はありません。この単純なサーブレットを使用して、リクエストをコンテナの実装にラップできます。

package com.example;

import Java.io.*;

import javax.servlet.*;
import javax.servlet.http.*;

public class DefaultWrapperServlet extends HttpServlet
{   
    public void doGet(HttpServletRequest req, HttpServletResponse resp)
        throws ServletException, IOException
    {
        RequestDispatcher rd = getServletContext().getNamedDispatcher("default");

        HttpServletRequest wrapped = new HttpServletRequestWrapper(req) {
            public String getServletPath() { return ""; }
        };

        rd.forward(wrapped, resp);
    }
}

Answer 4

FileServlet を使用すると、ほとんどすべてのHTTP（etags、チャンクなど）をサポートするため、良い結果が得られました。

Answer 5

静的リソースサーブレットの抽象テンプレート

部分的に2007年から このブログ に基づいて、キャッシュ、ETag、If-None-MatchおよびIf-Modified-Since（ただし、Gzipと範囲のサポートはありません;単純に保つために、Gzipはフィルターを使用するか、コンテナー構成を介して実行できます）。

public abstract class StaticResourceServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;
    private static final long ONE_SECOND_IN_MILLIS = TimeUnit.SECONDS.toMillis(1);
    private static final String ETAG_HEADER = "W/\"%s-%s\"";
    private static final String CONTENT_DISPOSITION_HEADER = "inline;filename=\"%1$s\"; filename*=UTF-8''%1$s";

    public static final long DEFAULT_EXPIRE_TIME_IN_MILLIS = TimeUnit.DAYS.toMillis(30);
    public static final int DEFAULT_STREAM_BUFFER_SIZE = 102400;

    @Override
    protected void doHead(HttpServletRequest request, HttpServletResponse response) throws ServletException ,IOException {
        doRequest(request, response, true);
    }

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doRequest(request, response, false);
    }

    private void doRequest(HttpServletRequest request, HttpServletResponse response, boolean head) throws IOException {
        response.reset();
        StaticResource resource;

        try {
            resource = getStaticResource(request);
        }
        catch (IllegalArgumentException e) {
            response.sendError(HttpServletResponse.SC_BAD_REQUEST);
            return;
        }

        if (resource == null) {
            response.sendError(HttpServletResponse.SC_NOT_FOUND);
            return;
        }

        String fileName = URLEncoder.encode(resource.getFileName(), StandardCharsets.UTF_8.name());
        boolean notModified = setCacheHeaders(request, response, fileName, resource.getLastModified());

        if (notModified) {
            response.sendError(HttpServletResponse.SC_NOT_MODIFIED);
            return;
        }

        setContentHeaders(response, fileName, resource.getContentLength());

        if (head) {
            return;
        }

        writeContent(response, resource);
    }

    /**
     * Returns the static resource associated with the given HTTP servlet request. This returns <code>null</code> when
     * the resource does actually not exist. The servlet will then return a HTTP 404 error.
     * @param request The involved HTTP servlet request.
     * @return The static resource associated with the given HTTP servlet request.
     * @throws IllegalArgumentException When the request is mangled in such way that it's not recognizable as a valid
     * static resource request. The servlet will then return a HTTP 400 error.
     */
    protected abstract StaticResource getStaticResource(HttpServletRequest request) throws IllegalArgumentException;

    private boolean setCacheHeaders(HttpServletRequest request, HttpServletResponse response, String fileName, long lastModified) {
        String eTag = String.format(ETAG_HEADER, fileName, lastModified);
        response.setHeader("ETag", eTag);
        response.setDateHeader("Last-Modified", lastModified);
        response.setDateHeader("Expires", System.currentTimeMillis() + DEFAULT_EXPIRE_TIME_IN_MILLIS);
        return notModified(request, eTag, lastModified);
    }

    private boolean notModified(HttpServletRequest request, String eTag, long lastModified) {
        String ifNoneMatch = request.getHeader("If-None-Match");

        if (ifNoneMatch != null) {
            String[] matches = ifNoneMatch.split("\\s*,\\s*");
            Arrays.sort(matches);
            return (Arrays.binarySearch(matches, eTag) > -1 || Arrays.binarySearch(matches, "*") > -1);
        }
        else {
            long ifModifiedSince = request.getDateHeader("If-Modified-Since");
            return (ifModifiedSince + ONE_SECOND_IN_MILLIS > lastModified); // That second is because the header is in seconds, not millis.
        }
    }

    private void setContentHeaders(HttpServletResponse response, String fileName, long contentLength) {
        response.setHeader("Content-Type", getServletContext().getMimeType(fileName));
        response.setHeader("Content-Disposition", String.format(CONTENT_DISPOSITION_HEADER, fileName));

        if (contentLength != -1) {
            response.setHeader("Content-Length", String.valueOf(contentLength));
        }
    }

    private void writeContent(HttpServletResponse response, StaticResource resource) throws IOException {
        try (
            ReadableByteChannel inputChannel = Channels.newChannel(resource.getInputStream());
            WritableByteChannel outputChannel = Channels.newChannel(response.getOutputStream());
        ) {
            ByteBuffer buffer = ByteBuffer.allocateDirect(DEFAULT_STREAM_BUFFER_SIZE);
            long size = 0;

            while (inputChannel.read(buffer) != -1) {
                buffer.flip();
                size += outputChannel.write(buffer);
                buffer.clear();
            }

            if (resource.getContentLength() == -1 && !response.isCommitted()) {
                response.setHeader("Content-Length", String.valueOf(size));
            }
        }
    }

}

静的リソースを表す以下のインターフェースと一緒に使用します。

interface StaticResource {

    /**
     * Returns the file name of the resource. This must be unique across all static resources. If any, the file
     * extension will be used to determine the content type being set. If the container doesn't recognize the
     * extension, then you can always register it as <code>&lt;mime-type&gt;</code> in <code>web.xml</code>.
     * @return The file name of the resource.
     */
    public String getFileName();

    /**
     * Returns the last modified timestamp of the resource in milliseconds.
     * @return The last modified timestamp of the resource in milliseconds.
     */
    public long getLastModified();

    /**
     * Returns the content length of the resource. This returns <code>-1</code> if the content length is unknown.
     * In that case, the container will automatically switch to chunked encoding if the response is already
     * committed after streaming. The file download progress may be unknown.
     * @return The content length of the resource.
     */
    public long getContentLength();

    /**
     * Returns the input stream with the content of the resource. This method will be called only once by the
     * servlet, and only when the resource actually needs to be streamed, so lazy loading is not necessary.
     * @return The input stream with the content of the resource.
     * @throws IOException When something fails at I/O level.
     */
    public InputStream getInputStream() throws IOException;

}

必要なのは、指定された抽象サーブレットから拡張し、javadocに従ってgetStaticResource()メソッドを実装するだけです。

ファイルシステムから提供される具体的な例：

ローカルディスクファイルシステムからの/files/foo.extなどのURLを介して提供する具体的な例を次に示します。

@WebServlet("/files/*")
public class FileSystemResourceServlet extends StaticResourceServlet {

    private File folder;

    @Override
    public void init() throws ServletException {
        folder = new File("/path/to/the/folder");
    }

    @Override
    protected StaticResource getStaticResource(HttpServletRequest request) throws IllegalArgumentException {
        String pathInfo = request.getPathInfo();

        if (pathInfo == null || pathInfo.isEmpty() || "/".equals(pathInfo)) {
            throw new IllegalArgumentException();
        }

        String name = URLDecoder.decode(pathInfo.substring(1), StandardCharsets.UTF_8.name());
        final File file = new File(folder, Paths.get(name).getFileName().toString());

        return !file.exists() ? null : new StaticResource() {
            @Override
            public long getLastModified() {
                return file.lastModified();
            }
            @Override
            public InputStream getInputStream() throws IOException {
                return new FileInputStream(file);
            }
            @Override
            public String getFileName() {
                return file.getName();
            }
            @Override
            public long getContentLength() {
                return file.length();
            }
        };
    }

}

データベースから提供される具体的な例：

以下は、/files/foo.extプロパティを持つエンティティを返すEJBサービス呼び出しを介してデータベースからbyte[] contentなどのURLを介してサービスを提供する具体例です。

@WebServlet("/files/*")
public class YourEntityResourceServlet extends StaticResourceServlet {

    @EJB
    private YourEntityService yourEntityService;

    @Override
    protected StaticResource getStaticResource(HttpServletRequest request) throws IllegalArgumentException {
        String pathInfo = request.getPathInfo();

        if (pathInfo == null || pathInfo.isEmpty() || "/".equals(pathInfo)) {
            throw new IllegalArgumentException();
        }

        String name = URLDecoder.decode(pathInfo.substring(1), StandardCharsets.UTF_8.name());
        final YourEntity yourEntity = yourEntityService.getByName(name);

        return (yourEntity == null) ? null : new StaticResource() {
            @Override
            public long getLastModified() {
                return yourEntity.getLastModified();
            }
            @Override
            public InputStream getInputStream() throws IOException {
                return new ByteArrayInputStream(yourEntityService.getContentById(yourEntity.getId()));
            }
            @Override
            public String getFileName() {
                return yourEntity.getName();
            }
            @Override
            public long getContentLength() {
                return yourEntity.getContentLength();
            }
        };
    }

}

Answer 6

これを試して

<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.js</url-pattern>
    <url-pattern>*.css</url-pattern>
    <url-pattern>*.ico</url-pattern>
    <url-pattern>*.png</url-pattern>
    <url-pattern>*.jpg</url-pattern>
    <url-pattern>*.htc</url-pattern>
    <url-pattern>*.gif</url-pattern>
</servlet-mapping>    

編集：これは、サーブレット2.5仕様以上でのみ有効です。

Answer 7

上記のサンプル情報から判断すると、この記事全体はTomcat 6.0.29以前のバグのある動作に基づいていると思います。 https://issues.Apache.org/bugzilla/show_bug.cgi?id=50026 を参照してください。 Tomcat 6.0.30にアップグレードすると、（Tomcat | Jetty）間の動作がマージされます。

Answer 8

同じ問題が発生し、Tomcatコードベースの「デフォルトサーブレット」のコードを使用して解決しました。

http://svn.Apache.org/repos/asf/Tomcat/trunk/Java/org/Apache/catalina/servlets/DefaultServlet.Java

DefaultServlet は、Tomcatの静的リソース（jpg、html、css、gifなど）を提供するサーブレットです。

このサーブレットは非常に効率的で、上で定義したプロパティがいくつかあります。

このソースコードは、不要な機能や依存関係を開始および削除するための良い方法だと思います。

• Org.Apache.naming.resourcesパッケージへの参照は、削除するか、Java.io.Fileコードで置き換えることができます。
• Org.Apache.catalina.utilパッケージへの参照は、ソースコードで複製できるユーティリティメソッド/クラスのみであることが適切です。
• Org.Apache.catalina.Globalsクラスへの参照はインライン化または削除できます。

Answer 9

いくつかの回避策に関する素晴らしいチュートリアルをウェブ上で見つけました。シンプルで効率的です。私はREST urlsスタイルアプローチでいくつかのプロジェクトで使用しました。

http://www.kuligowski.pl/Java/rest-style-urls-and-url-mapping-for-static-content-Apache-Tomcat,5

Answer 10

これを行うには、Tomcat DefaultServlet （ src ）を拡張し、getRelativePath（）メソッドをオーバーライドします。

package com.example;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import org.Apache.catalina.servlets.DefaultServlet;

public class StaticServlet extends DefaultServlet
{
   protected String pathPrefix = "/static";

   public void init(ServletConfig config) throws ServletException
   {
      super.init(config);

      if (config.getInitParameter("pathPrefix") != null)
      {
         pathPrefix = config.getInitParameter("pathPrefix");
      }
   }

   protected String getRelativePath(HttpServletRequest req)
   {
      return pathPrefix + super.getRelativePath(req);
   }
}

...そして、これが私のサーブレットマッピングです

<servlet>
    <servlet-name>StaticServlet</servlet-name>
    <servlet-class>com.example.StaticServlet</servlet-class>
    <init-param>
        <param-name>pathPrefix</param-name>
        <param-value>/static</param-value>
    </init-param>       
</servlet>

<servlet-mapping>
    <servlet-name>StaticServlet</servlet-name>
    <url-pattern>/static/*</url-pattern>
</servlet-mapping>  

Answer 11

Tomcat 8.xのチェック済み：ルートサーブレットが「」にマップされている場合、静的リソースは正常に機能します。サーブレット3.xの場合は、@WebServlet("")で実行できます。

Answer 12

SpringのAbstractUrlBasedViewが要求する/favicon.icoおよび/ WEB-INF/jsp/*からのJSPファイルだけでなく、Springアプリからのすべてのリクエストに対応するには、jspサーブレットとデフォルトサーブレットを再マッピングします。

  <servlet>
    <servlet-name>springapp</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>jsp</servlet-name>
    <url-pattern>/WEB-INF/jsp/*</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>/favicon.ico</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>springapp</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>

拡張マッピングがチェックされる前にパスパターン「/ *」が一致するため、jspサーブレットの標準マッピングで* .jsp url-patternに依存することはできません。 jspサーブレットをより深いフォルダーにマッピングすると、最初に一致することを意味します。 「/favicon.ico」のマッチングは、パスパターンマッチングの前に正確に行われます。より深いパス一致は機能しますが、完全一致は機能しますが、拡張子の一致は「/ *」パス一致を超えることはできません。 「/」をデフォルトのサーブレットにマッピングしても機能しないようです。正確な「/」は、springappの「/ *」パスパターンに勝ると思います。

上記のフィルターソリューションは、アプリケーションからの転送/インクルードされたJSP要求に対しては機能しません。それを機能させるには、springappにフィルターを直接適用する必要がありました。その時点で、アプリケーションに送信されるすべてのリクエストはそのフィルターにも送信されるため、urlパターンマッチングは役に立ちませんでした。そこで、フィルターにパターンマッチングを追加し、「jsp」サーブレットについて学習しましたが、デフォルトサーブレットのようにパスプレフィックスが削除されないことがわかりました。それは私の問題を解決しました。

Answer 13

静的ファイルはデフォルトのサーブレットによって提供され、web.xmlで個別の拡張子を設定できます

<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>*.js</url-pattern>
    <url-pattern>*.css</url-pattern>
</servlet-mapping>

ファイルが* .js、*。cssではなく、ブラウザで表示する場合は、mime-mappingを構成する必要があります

<mime-mapping>
  <extension>wsdl</extension>
  <mime-type>text/xml</mime-type>
</mime-mapping>

（たとえば、wsdl）ファイルはブラウザにテキストとして表示されます

Answer 14

Org.mortbay.jetty.handler.ContextHandlerを使用します。 StaticServletのような追加のコンポーネントは必要ありません。

桟橋の家で、

$ cdコンテキスト

$ cp javadoc.xml static.xml

$ vi static.xml

...

<Configure class="org.mortbay.jetty.handler.ContextHandler">
<Set name="contextPath">/static</Set>
<Set name="resourceBase"><SystemProperty name="jetty.home" default="."/>/static/</Set>
<Set name="handler">
  <New class="org.mortbay.jetty.handler.ResourceHandler">
    <Set name="cacheControl">max-age=3600,public</Set>
  </New>
 </Set>
</Configure>

ContextPathの値をURLプレフィックスで設定し、resourceBaseの値を静的コンテンツのファイルパスとして設定します。

それは私のために働いた。