Сервлет для обслуживания статического контента
Я развертываю webapp на двух разных контейнерах (Tomcat и Jetty), но их сервлеты по умолчанию для обслуживания статического контента имеют другой способ обработки структуры URL, которую я хочу использовать (подробности).
поэтому я хочу включить небольшой сервлет в webapp, чтобы обслуживать свой собственный статический контент (изображения, CSS и т. д.). Сервлет должен иметь следующие свойства:
- нет внешних зависимостей
- простой и надежный
- поддержка
If-Modified-Since
заголовок (т. е. пользовательскийgetLastModified
способ) - (необязательно) поддержка кодировки gzip, etags,...
доступен ли где-нибудь такой сервлет? Ближайший я могу найти это 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>
поэтому все запросы должны быть передано Главному сервлету, если они не для static
путь. Проблема в том, что сервлет Tomcat по умолчанию не учитывает ServletPath (поэтому он ищет статические файлы в основной папке), в то время как Jetty делает (поэтому он выглядит в ).
15 ответов
Я придумал немного другое решение. Это немного 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>
это в основном просто сопоставляет все файлы содержимого по расширению сервлета по умолчанию, а все остальное - "myAppServlet".
он работает как на пристани, так и на Tomcat.
нет необходимости в полностью пользовательской реализации сервлета по умолчанию в этом случае вы можете использовать этот простой сервлет для переноса запроса на реализацию контейнера:
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);
}
}
У меня были хорошие результаты с FileServlet, поскольку он поддерживает почти все HTTP (etags,chunking и т. д.).
абстрактный шаблон для сервлета статического ресурса
частично на основе этот блог С 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><mime-type></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();
}
};
}
}
Я закончил сворачивать свой собственный StaticServlet
. Он поддерживает If-Modified-Since
, кодировка gzip, и она также должна иметь возможность обслуживать статические файлы из war-файлов. Это не очень сложный код, но и не совсем тривиальный.
код доступен: StaticServlet.java. Не стесняйтесь комментировать.
обновление: Хуррам спрашивает о ServletUtils
класс, на который ссылаются в StaticServlet
. Это просто класс со вспомогательными методами, которые я использовал для моего проект. Единственный метод, который вам нужен, это coalesce
(который идентичен функции SQL COALESCE
). Это код:
public static <T> T coalesce(T...ts) {
for(T t: ts)
if(t != null)
return t;
return null;
}
У меня была такая же проблема, и я решил ее, используя код "сервлета по умолчанию" из кодовой базы Tomcat.
http://svn.apache.org/repos/asf/tomcat/trunk/java/org/apache/catalina/servlets/DefaultServlet.java
на DefaultServlet - сервлет, который обслуживает статические ресурсы (jpg,html,css,gif и т. д.) В Tomcat.
этот сервлет очень эффективен и имеет некоторые свойства, определенные выше.
I подумайте, что этот исходный код-хороший способ запустить и удалить функциональность или depedencies, которые вам не нужны.
- ссылки на организацию.апаш.называющий.пакет ресурсов можно удалить или заменить на java.Ио.Код файла.
- ссылки на организацию.апаш.Каталина.пакет util-это только полезные методы/классы, которые можно дублировать в исходном коде.
- ссылки на организацию.апаш.Каталина.Класс Globals может быть встроенным или удаленный.
судя по приведенной выше информации, я думаю, что вся эта статья основана на прослушиваемом поведении в 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>
Edit: это допустимо только для спецификации сервлета 2.5 и выше.
Я нашел отличный учебник в интернете о некоторых обходных путях. Он прост и эффективен, я использовал его в нескольких проектах с подходом стилей REST urls:
http://www.kuligowski.pl/java/rest-style-urls-and-url-mapping-for-static-content-apache-tomcat,5
Я сделал это, расширив 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>
для обслуживания всех запросов из приложения Spring, а также / favicon.ico и файлы JSP из /WEB-INF/jsp/*, которые будут запрашивать Abstracturlbasedview этой весны, вы можете просто переназначить сервлет 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 url-pattern на стандартном сопоставлении для сервлета JSP, потому что шаблон пути '/ * ' сопоставляется перед проверкой любого сопоставления расширения. Сопоставление сервлета jsp с более глубокой папкой означает, что он сопоставлен первым. Совмещение '/фавикон.ico ' точно происходит до сопоставления паттернов пути. Более глубокие совпадения пути будут работать или точные совпадения, но никакие совпадения расширения не могут пройти мимо совпадения пути"/*". Сопоставление ' / ' с сервлетом по умолчанию не работает. Вы думаете, что точное " / "будет бить шаблон пути" / * " на springapp.
вышеуказанное решение фильтра не работает для пересылаемых / включенных запросов JSP из приложения. Чтобы заставить его работать, мне пришлось применить фильтр к springapp напрямую, и в этот момент сопоставление url-шаблонов было бесполезным, так как все запросы, которые идут в приложение, также идут в его фильтры. Поэтому я добавил сопоставление шаблонов в фильтр, а затем узнал о сервлете " jsp " и увидел, что он не удаляет префикс пути, как это делает сервлет по умолчанию. Это решило мою проблему, которая была не совсем такой же, но достаточно распространенной.
проверено на Tomcat 8.X: статические ресурсы работают нормально, если корневой сервлет сопоставлен с "".
Для сервлета 3.x это может быть сделано @WebServlet("")
использовать org.mortbay.пристань.обработчик.ContextHandler. Вам не нужны дополнительные компоненты, такие как StaticServlet.
на пристани домой,
$ КР контекстах
$ cp javadoc.в XML-статические.в 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>
задайте значение contextPath с префиксом URL и задайте значение resourceBase в качестве пути к файлу статического содержимого.
это сработало для меня.
см. статический файл в JSOS:http://www.servletsuite.com/servlets/staticfile.htm
статические файлы отдаются с помощью сервлета по умолчанию, и вы можете настроить отдельное расширение в интернете.в 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) файл будет отображаться как текст в браузере