用于提供静态内容的 Servlet

https://stackoverflow.com/questions/132052

02-07-2019
|

题

我在两个不同的容器（Tomcat 和 Jetty）上部署了一个 web 应用程序，但它们用于提供静态内容的默认 servlet 有不同的方式来处理我想要使用的 URL 结构（细节).

因此，我希望在 web 应用程序中包含一个小 servlet，以提供其自己的静态内容（图像、CSS 等）。Servlet 应具有以下属性：

无外部依赖
简单可靠
支持 If-Modified-Since 标题（即风俗 getLastModified 方法）
（可选）支持 gzip 编码、etags...

这样的 servlet 在某处可用吗？我能找到的最接近的是示例4-10 来自servlet 书。

更新： 我想使用的 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>

因此，所有请求都应该传递到主 servlet，除非它们是针对 static 小路。问题是 Tomcat 的默认 servlet 不考虑 ServletPath（因此它在主文件夹中查找静态文件），而 Jetty 则考虑（因此它在 static 文件夹）。

解决方案 5

我最终推出了自己的 StaticServlet. 。它支持 If-Modified-Since, ，gzip 编码，它也应该能够从 war 文件提供静态文件。这不是非常困难的代码，但也不是完全微不足道的。

代码可用：静态Servlet.java. 。欢迎发表评论。

更新： 胡拉姆询问有关 ServletUtils 中引用的类 StaticServlet. 。它只是一个带有我在项目中使用的辅助方法的类。您需要的唯一方法是 coalesce （与 SQL 函数相同 COALESCE）。这是代码：

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

其他提示

我想出了一个稍微不同的解决方案。这有点 hack-ish，但这是映射：

<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>

这基本上只是通过扩展名将所有内容文件映射到默认 servlet，并将其他所有内容映射到“myAppServlet”。

它适用于 Jetty 和 Tomcat。

在这种情况下，不需要完全自定义默认 servlet 的实现，您可以使用这个简单的 servlet 将请求包装到容器的实现中：


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);
    }
}

我取得了很好的成绩文件服务程序, ，因为它支持几乎所有的 HTTP（etag、分块等）。

静态资源 Servlet 的抽象模板

部分基于这个博客从 2007 年开始，这是一个现代化且高度可重用的 servlet 抽象模板，它可以正确处理缓存， ETag, If-None-Match 和 If-Modified-Since （但没有 Gzip 和 Range 支持；只是为了简单起见；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;

}

您所需要的只是从给定的抽象 servlet 进行扩展并实现 getStaticResource() 根据javadoc的方法。

从文件系统提供服务的具体示例：

这是一个具体的例子，它通过像这样的 URL 提供服务 /files/foo.ext 从本地磁盘文件系统：

@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();
            }
        };
    }

}

从数据库提供的具体示例：

这是一个具体的例子，它通过像这样的 URL 提供服务 /files/foo.ext 通过 EJB 服务调用从数据库中返回您的实体 byte[] content 财产：

@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();
            }
        };
    }

}

从上面的示例信息来看，我认为整篇文章都是基于 Tomcat 6.0.29 及更早版本中的错误行为。看 https://issues.apache.org/bugzilla/show_bug.cgi?id=50026. 。升级到 Tomcat 6.0.30 并且 (Tomcat|Jetty) 之间的行为应该合并。

尝试这个

<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>

编辑：这仅对 servlet 2.5 规范及更高版本有效。

我遇到了同样的问题，我通过使用 Tomcat 代码库中的“默认 servlet”的代码解决了它。

http://svn.apache.org/repos/asf/tomcat/trunk/java/org/apache/catalina/servlets/DefaultServlet.java

这默认Servlet 是 Tomcat 中提供静态资源（jpg、html、css、gif 等）的 servlet。

该 servlet 非常高效，并且具有您上面定义的一些属性。

我认为这个源代码是启动和删除不需要的功能或依赖项的好方法。

对 org.apache.naming.resources 包的引用可以删除或替换为 java.io.File 代码。
对 org.apache.catalina.util 包的引用可能只是可以在源代码中复制的实用方法/类。
可以内联或删除对 org.apache.catalina.Globals 类的引用。

我在网上找到了关于一些解决方法的很棒的教程。它简单高效，我在几个项目中使用了 REST url 样式方法：

http://www.kuligowski.pl/java/rest-style-urls-and-url-mapping-for-static-content-apache-tomcat,5

我通过扩展 tomcat 来做到这一点默认Servlet (源代码）并重写 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>
    <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>

要满足来自 Spring 应用程序以及 Spring 的 AbstractUrlBasedView 将请求的 /favicon.ico 和 /WEB-INF/jsp/* 中的 JSP 文件的所有请求，您只需重新映射 jsp servlet 和默认 servlet 即可：

  <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 servlet 标准映射上的 *.jsp url 模式，因为在检查任何扩展名映射之前会匹配路径模式“/*”。将 jsp servlet 映射到更深的文件夹意味着首先匹配它。匹配“/favicon.ico”恰好发生在路径模式匹配之前。更深层次的路径匹配或精确匹配都可以，但没有扩展名匹配可以使其超过“/*”路径匹配。将“/”映射到默认 servlet 似乎不起作用。您可能认为确切的“/”会击败 springapp 上的“/*”路径模式。

上述过滤器解决方案不适用于来自应用程序的转发/包含的 JSP 请求。为了使其工作，我必须直接将过滤器应用于 springapp，此时 url 模式匹配毫无用处，因为所有发送到应用程序的请求也会发送到其过滤器。因此，我向过滤器添加了模式匹配，然后了解了“jsp”servlet，并发现它不会像默认 servlet 那样删除路径前缀。这解决了我的问题，虽然不完全相同但很常见。

检查 Tomcat 8.x：如果根 servlet 映射到“”，则静态资源可以正常工作。对于 servlet 3.x 可以通过以下方式完成 @WebServlet("")

使用 org.mortbay.jetty.handler.ContextHandler。您不需要像 StaticServlet 这样的额外组件。

在码头的家里，

$ cd 上下文

$ cp javadoc.xml static.xml

$ vi 静态.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>

使用您的 URL 前缀设置 contextPath 的值，并将 resourceBase 的值设置为静态内容的文件路径。

这对我有用。

参见JSOS中的StaticFile： http://www.servletsuite.com/servlets/staticfile.htm

许可以下： CC-BY-SA 和归因

不隶属于 StackOverflow