Spring Boot not serving static content

Question

I can t get my Spring-boot project to serve static content   I ve placed a folder named static under src main resources  Inside it I have a folder named images  When I package the app and run it  it can t find the images I have put on that folder   I ve tried to put the static files in public  resources and META-INF resources but nothing works   If I jar -tvf app jar I can see that the files are inside the jar on the right folder   static images head png for example  but calling  http   localhost 8080 images head png  all I get is a 404  Any ideas why spring-boot is not finding this   I m using 1 1 4 BTW

User · Answer

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

@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.
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;
```
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.
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.

User · Answer

The configuration could be made as follows    Configuration  EnableWebMvc public class WebMvcConfig extends WebMvcAutoConfigurationAdapter       specific project configuration      Important here is that your WebMvcConfig may override addResourceHandlers method and therefore you need to explicitly invoke super addResourceHandlers registry   it is true that if you are satisfied with the default resource locations you don t need to override any method     Another thing that needs to be commented here is that those default resource locations   static   public   resources and  META-INF resources  will be registered only if there isn t already a resource handler mapped to       From this moment on  if you have an image on src main resources static images named image jpg for instance  you can access it using the following URL  http   localhost 8080 images image jpg  being the server started on port 8080 and application deployed to root context

User · Answer

Look for Controllers mapped to     or with no path mapped   I had a problem like this  getting 405 errors  and banged my head hard for days  The problem turned out to be a  RestController annotated controller that I had forgot to annotate with a  RequestMapping annotation  I guess this mapped path defaulted to     and blocked the static content resource mapping

User · Answer

I had a similar problem  and it turned out that the simple solution was to have my configuration class extend WebMvcAutoConfiguration    Configuration  EnableWebMvc  ComponentScan public class ServerConfiguration extends WebMvcAutoConfiguration      I didn t need any other code to allow my static content to be served  however  I did put a directory called public under src main webapp and configured maven to point to src main webapp as a resource directory  This means that public is copied into target classes  and is therefore on the classpath at runtime for spring-boot tomcat to find

User · Answer

Put static resources under the directory    src main resources static   add this property in application properties file  server servlet context-path  pdx   You can access from http   localhost 8080 pdx images image jpg

User · Answer

Unlike what the spring-boot states  to get my spring-boot jar to serve the content  I had to add specifically register my src main resources static content through this config class    Configuration public class StaticResourceConfiguration implements WebMvcConfigurer        private static final String   CLASSPATH RESOURCE LOCATIONS                  classpath  META-INF resources     classpath  resources                 classpath  static     classpath  public            Override     public void addResourceHandlers ResourceHandlerRegistry registry            registry addResourceHandler                     addResourceLocations CLASSPATH RESOURCE LOCATIONS

User · Answer

I was having this exact problem  then realized that I had defined in my application properties    spring resources static-locations file  var www static   Which was overriding everything else I had tried  In my case  I wanted to keep both  so I just kept the property and added   spring resources static-locations file  var www static classpath static   Which served files from src main resources static as localhost  port  file html   None of the above worked for me because nobody mentioned this little property that could have easily been copied from online to serve a different purpose     Hope it helps  Figured it would fit well in this long post of answers for people with this problem

User · Answer

In my case I have a spring boot application which is kind of mixing spring and jaxrs  So I have a java class which inherits from the class org glassfish jersey server ResourceConfig  I had to add this line to the constructor of that class so that the spring endpoints are still called  property ServletProperties FILTER FORWARD ON 404  true

User · Answer

There are 2 things to consider  Spring Boot v1 5 2 RELEASE -  1  Check all Controller classes for  EnableWebMvc annotation  remove it if there is any 2  Check the Controller classes for which annotation is used -  RestController or  Controller  Do not mix Rest API and MVC behaviour in one class  For MVC use  Controller and for REST API use  RestController  Doing above 2 things resolved my issue  Now my spring boot is loading static resources with out any issues   Controller    load index html    loads static files    Controller public class WelcomeController           inject via application properties      Value    welcome message Hello        private String message    Hello World         RequestMapping          public String home Map lt String  Object gt  model            model put  message   this message           return  index             index html   lt  DOCTYPE html gt   lt html xmlns th  http   www thymeleaf org  gt   lt head gt   lt title gt index lt  title gt   lt meta http-equiv  Content-Type  content  text html  charset UTF-8    gt         lt link rel  stylesheet less  th href     webapp assets theme siberia less    gt        lt  -- The app s logic -- gt       lt script type  text javascript  data-main   webapp app  th src     webapp libs require js   gt  lt  script gt       lt script type  text javascript  gt          require config               paths    text   webapp libs text                     lt  script gt         lt  -- Development only -- gt        lt script type  text javascript  th src     webapp libs less min js   gt  lt  script gt     lt  head gt   lt body gt    lt  body gt   lt  html gt

User · Answer

I was facing the same issue in spring boot 2 1 3 saying that resource not found 404  I removed below from applicatiion properties    spring resources add-mappings true  spring resources static-locations classpath static  spring mvc static-path-pattern        Removed   enableWebMVC and removed any WebMvcConfigurer overriding        EnableWebMvc   Also make sure you have  EnableAutoConfiguration in your config   And put all static resources into src main resources static and it just worked like magic finally

User · Answer

Had the same problem  using gradle and eclipse and spent hours trying to figure it out   No coding required  the trick is that you must use the menu option New- Source Folder  NOT New -  Folder  to create the static folder under src main resources   Don t know why this works  but did new -  source folder then i named the folder static  then source folder dialog gives an error for which you must check  Update exclusion filters in other source folders to solve nesting   The my new static folder I added index html and now it works

User · Answer

Given resources under src main resources static  if you add this code  then all static content from src main resources static will be available under        Configuration public class StaticResourcesConfigurer implements WebMvcConfigurer       public void addResourceHandlers final ResourceHandlerRegistry registry            registry addResourceHandler   resources      addResourceLocations  classpath  resources static

User · Answer

Just to add yet another answer to an old question    People have mentioned the  EnableWebMvc will prevent WebMvcAutoConfiguration from loading  which is the code responsible for creating the static resource handlers   There are other conditions that will prevent WebMvcAutoConfiguration from loading as well   Clearest way to see this is to look at the source   https   github com spring-projects spring-boot blob master spring-boot-project spring-boot-autoconfigure src main java org springframework boot autoconfigure web servlet WebMvcAutoConfiguration java L139-L141  In my case  I was including a library that had a class that was extending from WebMvcConfigurationSupport which is a condition that will prevent the autoconfiguration      ConditionalOnMissingBean WebMvcConfigurationSupport class    It s important to never extend from WebMvcConfigurationSupport   Instead  extend from WebMvcConfigurerAdapter   UPDATE   The proper way to do this in 5 x is to implement WebMvcConfigurer

User · Answer

using spring boot 2    i have a controller that maps to routes GetMapping     var       var1   var2       var1   var2   var3     and boom my app stop serving resources   i know it is not advisable to have such routes but it all depends on the app you are building  in my case  i have no choice but to have such routes   so here is my hack to make sure my app serve resources again  I simply have a controller that maps to my resources  since spring will match a direct route first before any that has variable  i decided to add a controller method that maps to  imgaes  name  and repeated same for other resources   GetMapping value     images  image    produces    MediaType IMAGE GIF VALUE  MediaType IMAGE JPEG VALUE  MediaType IMAGE PNG VALUE       public  ResponseBody     byte   getImage  PathVariable String image            ClassPathResource file   new ClassPathResource  static images     image           byte   bytes          try               bytes   StreamUtils copyToByteArray file getInputStream               catch  IOException e                throw new ResourceNotFoundException  file not found      image                     return bytes          and this solved my issue

User · Answer

Requests to     are evaluated to static locations configured in resourceProperties   adding the following on application properties  might be the only thing you need to do     spring resources static-locations classpath  myresources    this will overwrite default static locations  wich is   ResourceProperties CLASSPATH RESOURCE LOCATIONS      classpath  META-INF resources             classpath  resources     classpath  static     classpath  public        You might not want to do that and just make sure your resources end up in one of those default folders   Performing a request  If I would have example html stored on  public example html Then I can acces it like this    lt host gt   lt context-path if you have one gt  example html   If I would want another uri like  lt host gt   lt context-path gt  magico   for files in classpath  magicofiles   you need a bit more config   Configuration class MyConfigClass implements WebMvcConfigurer   Override public void addResourceHandlers ResourceHandlerRegistry registry        registry addResourceHandler   magico      addResourceLocations   magicofiles

User · Answer

I m using Spring Boot 2 2 and not getting any of my static content  I discovered two solutions that worked for me  Option  1 - Stop using  EnableWebMvc annotation This annotation disables some automatic configuration  including the part that automatically serves static content from commonly-used locations like  src main resources static  If you don t really need  EnableWebMvc  then just remove it from your  Configuration class  Option  2 - Implement WebMvcConfigurer in your  EnableWebMvc annotated class and implementaddResourceHandlers   Do something like this   EnableWebMvc  Configuration public class SpringMVCConfiguration implements WebMvcConfigurer         Override     public void addResourceHandlers ResourceHandlerRegistry registry            registry addResourceHandler  quot  js    quot   addResourceLocations  quot classpath  static js  quot            registry addResourceHandler  quot  css    quot   addResourceLocations  quot classpath  static css  quot            registry addResourceHandler  quot  vendor    quot   addResourceLocations  quot classpath  static vendor  quot            registry addResourceHandler  quot     quot   addResourceLocations  quot classpath  static  quot              Just remember that your code is now in charge of managing all static resource paths

User · Answer

Well sometimes is worth to check did you override the global mappings by some rest controller  Simple example mistake  kotlin     RestController   foo   class TrainingController         PostMapping     fun bazz  RequestBody newBody  CommandDto   CommandDto   return commandDto      In the above case you will get when you request for static resources         title   Method Not Allowed       status  405      detail   Request method  GET  not supported       path    index html      The reason for it could be that you wanted to map  PostMapping to  foo but forget about  RequestMapping annotation on the  RestController level  In this case all request are mapped to POST and you won t receive static content in this case

User · Answer

This solution works for me   First  put a resources folder under webapp WEB-INF  as follow structure  -- src   -- main     -- webapp       -- WEB-INF         -- resources           -- css           -- image           -- js           --       Second  in spring config file   Configuration  EnableWebMvc public class MvcConfig extends WebMvcConfigurerAdapter        Bean     public ViewResolver getViewResolver             InternalResourceViewResolver resolver   new InternalResourceViewResolver            resolver setPrefix   WEB-INF views             resolver setSuffix   html            return resolver              Override     public void configureDefaultServletHandling              DefaultServletHandlerConfigurer configurer            configurer enable                Override     public void addResourceHandlers ResourceHandlerRegistry registry            registry addResourceHandler   resource      addResourceLocations  WEB-INF resources               Then  you can access your resource content  such as http   localhost 8080 resource image yourimage jpg

User · Answer

FYI  I also noticed I can mess up a perfectly working spring boot app and prevent it from serving contents from the static folder  if I add a bad rest controller like so     RestController public class BadController        RequestMapping method  RequestMethod POST      public String someMethod  RequestParam value  date   required false String dateString  Model model           return  foo             In this example  after adding the bad controller to the project  when the browser asks for a file available in static folder  the error response is  405 Method Not Allowed     Notice paths are not mapped in the bad controller example

User · Answer

I am using 1 3 5 and host a bunch of REST-services via Jersey implementation  That worked fine until I decided to add a couple of HTMLs   js files  None of answers given on this forum helped me  However  when I added following dependency in my pom xml all the content in src main resources static was finally showing via browser    lt dependency gt   lt groupId gt org springframework boot lt  groupId gt   lt artifactId gt spring-boot-starter-web lt  artifactId gt   lt dependency gt    It seems spring-web   spring-webmvc is the important transitive dependency that makes spring boot auto config turn on

User · Answer

In case the issue surfaces when launching the application from within an IDE  i e  starting from Eclipse or IntelliJ Idea   and using Maven  the key to the solution is in the Spring-boot Getting Started documentation   If you are using Maven  execute  mvn package  amp  amp  java -jar target gs-spring-boot-0 1 0 jar  The important part of which is adding the package goal to be run before the application is actually started   Idea  Run menu  Edit Configrations     Add  and there select Run Maven Goal  and specify the package goal in the field

User · Answer

As said above  the file should be in  ClassPath static images name png    static or  public or  resources or  META-INF resources   This  ClassPath means main resources or main java dir   If your files are not in standard dirs  you can add the following configuration    Configuration  EnableWebSecurity public class SecurityConfig extends WebSecurityConfigurerAdapter     Override public void configure WebSecurity web  throws Exception       web ignoring   antMatchers   lib          like this     Autowired public void configureGlobal AuthenticationManagerBuilder auth  throws Exception                  etc

User · Answer

In my case  some static files were not served  like  woff fonts and some images  But css and js worked just fine   Update  A much better solution to make Spring Boot serve the woff fonts correctly is to configure the resource filtering mentioned in this answer  for example  note that you need both includes and excludes     lt resources gt       lt resource gt           lt directory gt src main resources lt  directory gt           lt filtering gt true lt  filtering gt           lt excludes gt               lt exclude gt static aui fonts    lt  exclude gt           lt  excludes gt       lt  resource gt       lt resource gt           lt directory gt src main resources lt  directory gt           lt filtering gt false lt  filtering gt           lt includes gt               lt include gt static aui fonts    lt  include gt           lt  includes gt       lt  resource gt   lt  resources gt    ----- Old solution  working but will corrupt some fonts  -----  Another solution was to disable suffix pattern matching with setUseSuffixPatternMatch false    Configuration public class StaticResourceConfig implements WebMvcConfigurer        Override     public void configurePathMatch PathMatchConfigurer configurer               disable suffix matching to serve  woff  images  etc          configurer setUseSuffixPatternMatch false             Credits   Abhiji did point me with 4  in the right direction

User · Answer

Did you check the Spring Boot reference docs       By default Spring Boot will serve static content from a folder called  static  or  public or  resources or  META-INF resources  in the classpath or from the root of the ServletContext     You can also compare your project with the guide Serving Web Content with Spring MVC  or check out the source code of the spring-boot-sample-web-ui project

User · Answer

I think the previous answers address the topic very well  However  I d add that in one case when you have Spring Security enabled in your application  you might have to specifically tell Spring to permit requests to other static resource directories like for example   static fonts    In my case I had   static css     static js     static images  permited by default   but  static fonts    was blocked by my Spring Security implementation   Below is an example of how I fixed this    Configuration  EnableWebSecurity public class WebSecurityConfig extends WebSecurityConfigurerAdapter              Override     protected void configure final HttpSecurity http  throws Exception           http authorizeRequests   antMatchers        fonts      permitAll              other security configuration rules

[spring] Spring Boot not serving static content

Examples related to spring

Examples related to spring-mvc

Examples related to spring-boot