spring mvc how to bypass DispatcherServlet for *.html files?

Question

web.xml fragment

<!-- Handles all requests into the application -->
<servlet>
    <servlet-name>Spring MVC Dispatcher Servlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/spring/app-config.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>Spring MVC Dispatcher Servlet</servlet-name>
    <url-pattern>/*</url-pattern>
</servlet-mapping>

It works fine but I'd like to NOT let the Dispatcher Servlet handle *.html requests. How do I I do that? Thanks.

This may be of some help: http://stackoverflow.com/questions/1234298/can-springmvc-be-configured-to-process-all-requests-but-exclude-static-content-d — AHungerArtist, Dec 13 '10 at 22:35
@AHungerArtist Thanks for the link. I found much better answer in there. — Sanghyun Lee, Aug 12 '11 at 07:53

score 24 · Answer 1 · answered May 07 '12 at 07:41

24

In Spring MVC 3.x there is the default servlet handler to take care of this problem.

just add this to the Spring XML config:

<mvc:default-servlet-handler/>

answered May 07 '12 at 07:41

Lari Hotari

5,190
1
36
43

Great. I remember this config but I can't remember exactly the code. Thank you. – bnguyen82 Jul 11 '13 at 03:13
You saved my day. Thank You – Bhaskara Nov 21 '15 at 21:55

score 5 · Accepted Answer · answered Dec 14 '10 at 01:17

Map it on a more specific url-pattern.

<servlet-mapping>
    <servlet-name>Spring MVC Dispatcher Servlet</servlet-name>
    <url-pattern>/spring/*</url-pattern>
</servlet-mapping>

Create a Filter which is mapped on /*.

<filter-mapping>
    <filter-name>Your Dispatcher Filter</filter-name>
    <url-pattern>/*</url-pattern>
<filter-mapping>

Which does the following in doFilter() method.

String uri = ((HttpServletRequest) request).getRequestURI();
if (uri.endsWith(".html")) {
    chain.doFilter(request, response); // Just let it go (assuming that files are in real not placed in a /spring folder!)
} else {
    request.getRequestDispatcher("/spring" + uri).forward(request, response); // Pass to Spring dispatcher servlet.
}

This almost works for me... using getRequestURI will return a path including the context-path. Assuming your context is /ctx, a request to /ctx/foo will be dispatched to /ctx/spring/ctx/foo I think getServletPath() + getPathInfo() (if pathInfo != null) works better — VoidPointer, Jan 20 '11 at 13:38

score 2 · Answer 3 · edited Mar 09 '14 at 06:43

2

<url-pattern>/*</url-pattern>

Can catch like /index , /*.html , /*.jsp ...,and give to DispatcherServlet.

<url-pattern>/</url-pattern>

Only Can catch /index,/main ... , without suffix.

edited Mar 09 '14 at 06:43

Andrei

42,814
35
154
218

answered Mar 09 '14 at 06:27

zll

21
3

Wow, simplest of all. – Aakash Apr 02 '17 at 10:03

score 2 · Answer 4 · answered Jan 22 '15 at 13:13

Lari's solution (above) is great, and worked for me, but you have to be very careful with the order in which you write the instruction, it has to be in the begining of the document!!!

In my case was something like:

<mvc:annotation-driven />
<mvc:default-servlet-handler/>

<context:annotation-config />
<context:component-scan base-package="org.civitana.controller" />

nickdos · Answer 5 · 2010-12-15T22:21:22.417

Try adding this to your Spring XML config:

<!-- This will override the default DefaultAnnotationHandlerMapping that is created,
  -  and not map file extensions automagically -->
<bean class="org.springframework.web.servlet.mvc.annotation.DefaultAnnotationHandlerMapping">
    <property name="useDefaultSuffixPattern" value="false"/>
</bean>

This will prevent Spring from automatically mapping requests with .html to your controller. E.g. @RequestMapping(value = "/products/widgets", method = RequestMethod.GET) would normally trap a URI of /products/widgets.html as well as /products/widgets. Adding the above XML forces exact matching of URI patterns by Spring (only the latter will match).

spring mvc how to bypass DispatcherServlet for *.html files?

5 Answers5

Linked