springboot对静态资源的映射规则

最新推荐文章于 2022-05-31 16:38:31 发布

小小辉先生

最新推荐文章于 2022-05-31 16:38:31 发布

阅读量296

点赞数

CC 4.0 BY-SA版权

分类专栏：笔记文章标签： spring boot java

本文链接：https://blog.youkuaiyun.com/Modesty_Boy/article/details/107034788

笔记专栏收录该内容

18 篇文章

订阅专栏

本文详细解析了Spring Boot中静态资源的映射规则，包括/webjars/**的资源定位，/**的全局映射，欢迎页的处理以及favicon.ico的查找路径。通过示例展示了如何访问这些静态资源，并提到了webjars的官方映射规则和实际应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

文章目录

源码解析

源码解析

静态资源的设置

 public void addResourceHandlers(ResourceHandlerRegistry registry) {
            if (!this.resourceProperties.isAddMappings()) {
                logger.debug("Default resource handling disabled");
            } else {
                Integer cachePeriod = this.resourceProperties.getCachePeriod();
                if (!registry.hasMappingForPattern("/webjars/**")) {
                    this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{"/webjars/**"}).addResourceLocations(new String[]{"classpath:/META-INF/resources/webjars/"}).setCachePeriod(cachePeriod));
                }

                String staticPathPattern = this.mvcProperties.getStaticPathPattern();
                if (!registry.hasMappingForPattern(staticPathPattern)) {
                    this.customizeResourceHandlerRegistration(registry.addResourceHandler(new String[]{staticPathPattern}).addResourceLocations(this.resourceProperties.getStaticLocations()).setCachePeriod(cachePeriod));
                }

            }
        }

修改静态资源的有关参数

//可以设置和静态资源有关的参数，缓存时间等
@ConfigurationProperties(
    prefix = "spring.resources",
    ignoreUnknownFields = false
)
public class ResourceProperties implements ResourceLoaderAware {

1）、所有 /webjars/** ，都去 classpath:/META-INF/resources/webjars/ 找资源；
webjars：以jar包的方式引入静态资源；
wenjars官方映射规则
jar包查看及访问示例:
localhost:8080/webjars/jquery/3.3.1/jquery.js 在这里插入图片描述
2）、"/**" 访问当前项目的任何资源，都去（静态资源的文件夹）找映射

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]
{"classpath:/META-INF/resources/", "classpath:/resources/", 
"classpath:/static/", "classpath:/public/"};

“/”：当前项目的根路径
localhost:8080/abc === 去静态资源文件夹里面找abc
没去处理，就会去这些路径找静态资源

3）、欢迎页；静态资源文件夹下的所有index.html页面；被"/**"映射；
localhost:8080/ 找index页面


private WelcomePageHandlerMapping(Resource welcomePage, String staticPathPattern) {
            if (welcomePage != null && "/**".equals(staticPathPattern)) {
                logger.info("Adding welcome page: " + welcomePage);
                ParameterizableViewController controller = new ParameterizableViewController();
                controller.setViewName("forward:index.html");
                this.setRootHandler(controller);
                this.setOrder(0);
            }

        }

4）、所有的 **/favicon.ico 都是在静态资源文件下找；

		//配置自己喜欢的图标
		@Bean
        @ConditionalOnMissingBean({RequestContextListener.class,
         RequestContextFilter.class})
        public static RequestContextFilter requestContextFilter() {
            return new OrderedRequestContextFilter();
        }

        @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(-2147483647);
                mapping.setUrlMap(Collections.singletonMap("**/favicon.ico", this.faviconRequestHandler()));
                return mapping;
            }

            @Bean
            public ResourceHttpRequestHandler faviconRequestHandler() {
                ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
                requestHandler.setLocations(this.resourceProperties.getFaviconLocations());
                return requestHandler;
            }
        }