Spring Boot not serving static content

by

Not to raise the dead after more than a year, but all the previous answers miss some crucial points:

  1. @EnableWebMvc on your class will disable org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration. That’s fine if you want complete control but otherwise, it’s a problem.

  2. There’s no need to write any code to add another location for static resources in addition to what is already provided. Looking at org.springframework.boot.autoconfigure.web.ResourceProperties from v1.3.0.RELEASE, I see a field staticLocations that can be configured in the application.properties. Here’s a snippet from the source:

    /**
 * Locations of static resources. Defaults to classpath:[/META-INF/resources/,
 * /resources/, /static/, /public/] plus context:/ (the root of the servlet context).
 */
private String[] staticLocations = RESOURCE_LOCATIONS;

  3. As mentioned before, the request URL will be resolved relative to these locations. Thus src/main/resources/static/index.html will be served when the request URL is /index.html. The class that is responsible for resolving the path, as of Spring 4.1, is org.springframework.web.servlet.resource.PathResourceResolver.

  4. Suffix pattern matching is enabled by default which means for a request URL /index.html, Spring is going to look for handlers corresponding to /index.html. This is an issue if the intention is to serve static content. To disable that, extend WebMvcConfigurerAdapter (but don’t use @EnableWebMvc) and override configurePathMatch as shown below:

    @Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    super.configurePathMatch(configurer);

    configurer.setUseSuffixPatternMatch(false);
}

IMHO, the only way to have fewer bugs in your code is not to write code whenever possible. Use what is already provided, even if that takes some research, the return is worth it.

Edit July 2021:

  1. WebMvcConfigurerAdapter has been deprecated since Spring 5. Implement WebMvcConfigurer and annotate with @Configuration.

More Related Contents:

  1. What is difference between @RequestBody and @RequestParam?
  2. Spring Boot Security CORS
  3. Spring boot – Not a managed type
  4. ApplicationContextException: Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean
  5. Spring Boot CORS filter – CORS preflight channel did not succeed
  6. Spring catch all route for index.html
  7. Enable HAL serialization in Spring Boot for custom controller method
  8. How to handle HTTP OPTIONS requests in Spring Boot?
  9. How to use LocalDateTime RequestParam in Spring? I get “Failed to convert String to LocalDateTime”
  10. Spring MVC Annotated Controller Interface with @PathVariable
  11. Configure Multiple MongoDB repositories with Spring Data Mongo
  12. CSS not loading in Spring Boot
  13. Spring – How to stream large multipart file uploads to database without storing on local file system [duplicate]
  14. Configure spring boot to redirect 404 to a single page app [duplicate]
  15. What is the difference between ApplicationContext and WebApplicationContext in Spring MVC?
  16. @Service are constructed twice
  17. java.lang.ClassNotFoundException: org.springframework.web.servlet.DispatcherServlet
  18. How do I get the Session Object in Spring?
  19. Environment Specific application.properties file in Spring Boot application [closed]
  20. Spring Security exclude url patterns in security annotation configurartion
  21. Spring Security 3.2 CSRF support for multipart requests
  22. List as form backing object using Spring 3 MVC, correct syntax?
  23. Spring Boot and custom 404 error page
  24. spring boot war without tomcat embedded
  25. Multipart File upload Spring Boot
  26. Added Springfox Swagger-UI and it’s not working, what am I missing?
  27. Changing default welcome-page for spring-boot application deployed as a war
  28. How to re-create database before each test in Spring?
  29. How to allow a User only access their own data in Spring Boot / Spring Security?
  30. Understanding contexts in Spring MVC

Leave a Comment