SpringBoot静态资源映射

目录12 静态资源映射12.1 源码12.2 静态资源路径映射规则12.2.1 WebJars 映射规则/webjars/** 路径12.2.2 静态资源文件夹映射规则/** 路径12.2.3 欢迎页规则12 静态资源映射12.1 源码注代码是Springboot2.0.1的代码ConfigurationProperties(prefix spring.resources, ignoreUnknownFields false)public class ResourceProperties implements ResourceLoaderAware {//可以设置和静态资源有关的参数缓存时间等WebMvcAuotConfiguration Override public void addResourceHandlers(ResourceHandlerRegistry registry) { if (!this.resourceProperties.isAddMappings()) { logger.debug(Default resource handling disabled); return; } Integer cachePeriod this.resourceProperties.getCachePeriod(); if (!registry.hasMappingForPattern(/webjars/**)) { customizeResourceHandlerRegistration(registry.addResourceHandler(/webjars/**).addResourceLocations(classpath:/META‐INF/resources/webjars/).setCachePeriod(cachePeriod)); } String staticPathPattern this.mvcProperties.getStaticPathPattern(); //静态资源文件夹映射 if (!registry.hasMappingForPattern(staticPathPattern)) { customizeResourceHandlerRegistration(registry. addResourceHandler(staticPathPattern).addResourceLocations(this.resourceProperties.getStaticLocations()).setCachePeriod(cachePeriod)); } } / /配置欢迎页映射 Bean public WelcomePageHandlerMapping welcomePageHandlerMapping( ResourceProperties resourceProperties) { return new WelcomePageHandlerMapping(resourceProperties.getWelcomePage(), this.mvcProperties.getStaticPathPattern()); } //配置喜欢的图标 Configuration ConditionalOnProperty(value spring.mvc.favicon.enabled, matchIfMissing true) public static class FaviconConfiguration { private final ResourceProperties resourceProperties; public FaviconConfiguration(ResourceProperties resourceProperties) { this.resourceProperties resourceProperties; } Bean public SimpleUrlHandlerMapping faviconHandlerMapping() { SimpleUrlHandlerMapping mapping new SimpleUrlHandlerMapping(); mapping.setOrder(Ordered.HIGHEST_PRECEDENCE 1); //所有 **/favicon.ico mapping.setUrlMap(Collections.singletonMap(**/favicon.ico, faviconRequestHandler()); return mapping; } Bean public ResourceHttpRequestHandler faviconRequestHandler() { ResourceHttpRequestHandler requestHandler new ResourceHttpRequestHandler(); requestHandler.setLocations(this.resourceProperties.getFaviconLocations()); return requestHandler; } }12.2 静态资源路径映射规则12.2.1 WebJars 映射规则/webjars/** 路径WebJars 会将前端静态资源如 jQuery、Bootstrap 等打包成 Jar 包让 Java 项目可以通过 Maven 依赖引入。Spring Boot 对 WebJars 的映射规则是所有 /webjars/** 请求都会去 classpath:/META-INF/resources/webjars/ 下如下图找资源。在 pom.xml 中添加 jQuery 的 WebJars 依赖dependency groupIdorg.webjars/groupId artifactIdjquery/artifactId version3.3.1/version /dependency引入依赖后启动 Spring Boot 项目后在浏览器中访问 http://localhost:8080/webjars/jquery/3.3.1/jquery.js如果能成功打开 jQuery 的源码文件说明 WebJars 映射规则生效 ——Spring Boot 自动找到了 classpath:/META-INF/resources/webjars/jquery/3.3.1/jquery.js 这个资源。12.2.2 静态资源文件夹映射规则/** 路径Spring Boot 对普通静态资源如自定义的 js、css、html 等的映射规则是所有 /** 请求会依次去以下静态资源文件夹找资源优先级从左到右递减classpath:/META-INF/resources/classpath:/resources/classpath:/static/classpath:/public/注classpath指的是src/main/resources/验证在 src/main/resources 下创建不同的静态资源文件夹并分别放入同名文件 test.txt内容区分开方便验证优先级src/main/resources/META-INF/resources/test.txt内容写 META-INF/resourcessrc/main/resources/resources/test.txt内容写 resourcessrc/main/resources/static/test.txt内容写 staticsrc/main/resources/public/test.txt内容写 public步骤 2访问测试文件启动项目后在浏览器中访问 http://localhost:8080/test.txt最终会看到内容为 META-INF/resources 的文件 —— 这验证了静态资源文件夹的优先级顺序META-INF/resources 优先级最高。如果按优先级从高到低依次删除文件即可验证所有的优先级。步骤 3验证自定义静态资源访问再创建一个自定义的静态资源比如在 src/main/resources/static/ 下创建 myjs.js内容为 hellooooooo。访问 http://localhost:8080/myjs.js如果能看到源码说明 /** 映射规则生效Spring Boot 从 static 文件夹中找到了该资源。12.2.3 欢迎页规则Spring Boot 的欢迎页规则是访问 localhost:8080/ 时会自动找静态资源文件夹下的 index.html。优先级同12.2.2。验证步骤同12.2.2。启动项目后直接访问 http://localhost:8080/如果能看到index.html页面说明欢迎页规则生效 ——Spring Boot 自动找到了index.html。