[Java知识库]Spring Boot（六）--------Web开发、静态资源导入

Spring Boot（六）--------Web开发、静态资源导入

13、Web开发

13.1 简介

• jar：webapp
• Spring Boot帮助我们自动装配
• xxxxAutoConfiguration：向容器中自动配置组件
• xxxxProperties：自动配置类，装配配置文件中自定义的一些内容
• 思考：Spring Boot到底帮我们配置了什么？能否进行修改？哪些可以修改？能否扩展？

13.2 使用Spring Boot的步骤

• 创建一个Spring Boot应用，选择我们需要的模块，Spring Boot会默认将我们需要的模块自动配置好
• 手动在配置文件中配置部分配置项目，就可以运行起来了
• 专注编写代码业务，不需要考虑各种配置

14、静态资源处理

14.1 静态资源映射规则

• 新建一个SpringBoot项目，写一个测试用的controller，运行成功
• 在SpringBoot项目中，SpringMVC的所有web配置都在WebMvcAutoConfiguration这个配置类中
• 在其中找到WebMvcAutoConfigurationAdapter，其中放了很多关于SpringMVC的配置，在其中找到一个名为addResourceHandlers()的方法，用于添加资源处理
• 自动配置文件在WebMvcProperties中

public void addResourceHandlers(ResourceHandlerRegistry registry) {
    if (!this.resourceProperties.isAddMappings()) {
        //禁用默认资源处理
        logger.debug("Default resource handling disabled");
    } else {
        this.addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");
        this.addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
            registration.addResourceLocations(this.resourceProperties.getStaticLocations());
            if (this.servletContext != null) {
                ServletContextResource resource = new ServletContextResource(this.servletContext, "/");
                registration.addResourceLocations(new Resource[]{resource});
            }
        });
    }
}

• 比如所有的/webjars/** ， 都需要去 classpath:/META-INF/resources/webjars/ 找对应的资源

14.2 什么是webjars

• Webjars本质就是以jar包的方式引入我们的静态资源 ， 我们以前要导入一个静态资源文件，直接导入即可

• 官网：WebJars - Web Libraries in Jars

14.3 第一种访问静态资源的方法

• 不常用

• 要使用JQuery我们需要引入对应版本的pom依赖

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>3.5.1</version>
</dependency>

• 查看目录结构，可以访问jquery.js文件

• 访问的只要是静态资源，Spring Boot就会去对应的路径寻找对应资源

• 测试访问：localhost:8080/webjars/jquery/3.5.1/jquery.js

• 可以访问到相应js文件下的东西

14.4 第二种访问静态资源的方式

• 查看方法getStaticLocations()

public String[] getStaticLocations() {
    return this.staticLocations;
}

//点击staticLocations，可以找到对应值
this.staticLocations = CLASSPATH_RESOURCE_LOCATIONS;

//其中CLASSPATH_RESOURCE_LOCATIONS;
//找到具体的对应路径
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = new String[]{"classpath:/META-INF/resources/", "classpath:/resources/", "classpath:/static/", "classpath:/public/"};

• 访问/**就可以访问到resources文件夹下的东西
• 综上，得出结论可以存放静态资源的四个位置为

"classpath:/META-INF/resources/", 
"classpath:/resources/",
"classpath:/static/",
"classpath:/public/"

• 建立对应文件夹，其中都可以存放静态资源文件

• 其中"classpath:/META-INF/resources/"，为第一种方式中webjars中的路径

• 这三个文件夹的优先级：resources>static>public

14.5 自定义静态资源路径

• 可以通过配置文件来指定，哪些文件夹是我们需要放静态资源的，这种情况下官方定义的静态资源文件夹就失效了

spring.resources.static-locations=classpath:/coding/

14.6 总结

• 在SpringBoot中，我们可以使用一下方式处理静态资源

  • webjars------访问方式：localhost:8080/webjars/
  • 文件夹：public，static，/**（根目录下），resources----------访问方式：localhost:8080/

• 优先级：resources>static（默认使用）>public

15、首页处理

15.1 首页探究

• 继续分析源码，找到一个首页映射方法

@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,
                                                           FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
    WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
        new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),
        this.mvcProperties.getStaticPathPattern());
    welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
    welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());
    return welcomePageHandlerMapping;
}

• 找到getWelcomePage()方法

private Resource getWelcomePage() {
    for (String location : this.resourceProperties.getStaticLocations()) {
        Resource indexHtml = getIndexHtml(location);
        if (indexHtml != null) {
            return indexHtml;
        }
    }
    ServletContext servletContext = getServletContext();
    if (servletContext != null) {
        return getIndexHtml(new ServletContextResource(servletContext, SERVLET_LOCATION));
    }
    return null;
}

• 找到其中的getIndexHtml()方法

private Resource getIndexHtml(String location) {
    return getIndexHtml(this.resourceLoader.getResource(location));
}

• 关于首页，静态资源文件夹下所有index.html页面，会被/**映射，即在任意资源目录下的index.html，访问localhost:8080，直接显示首页

• 注：在templates目录下的所有页面，只能通过controller来跳转

15.2 首页图标设置(2.2.0+版本)

• 将选好的图片改为.ico后缀，一般命名为favicon.ico，将其放在resources文件夹下的static文件夹下
• 在首页index.html中设置

<link rel="icon" href="/favicon.ico">

• 测试，如果失败可以清楚浏览器缓存后再试