Spring Boot静态资源的正确配置姿势

2023-04-28 05:25:24

Spring Boot静态资源配置详解

简介

在 Spring Boot 中，静态资源是指那些在服务器启动后就不会再变化的文件，例如 HTML、CSS、JavaScript 和图片。正确配置静态资源对于构建健壮且用户友好的 Web 应用程序至关重要。

配置静态资源的方式

Spring Boot 提供了多种配置静态资源的方法：

使用 @SpringBootApplication 注解

@SpringBootApplication
public class App {
    // ...
}

在 @SpringBootApplication 注解中，可以通过 spring.web.resources.static-locations 属性指定静态资源的路径。

使用 WebMvcConfigurerAdapter 接口

public class WebMvcConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");
    }
}

此方法允许您使用 addResourceHandler 方法添加资源处理器，将特定 URL 路径映射到静态资源的物理位置。

使用 ResourceHandlerRegistry 接口

ResourceHandlerRegistry registry = new ResourceHandlerRegistry();
registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/");

此方法与使用 WebMvcConfigurerAdapter 类似，但直接使用 ResourceHandlerRegistry 接口来创建资源处理器。

使用 WebServerFactoryCustomizer 接口

public class WebServerFactoryCustomizer implements WebServerFactoryCustomizer {
    @Override
    public void customize(ConfigurableWebServerFactory factory) {
        factory.setDocumentRoot(new File("static"));
    }
}

此方法允许您设置服务器的文档根目录，其中包含所有静态资源。

代码示例

下面是一个使用 @SpringBootApplication 注解配置静态资源的示例：

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
    
    @Value("${spring.web.resources.static-locations}")
    private String staticLocations;
}

通过设置 spring.web.resources.static-locations 属性，我们可以指定静态资源的路径。在上面的示例中，staticLocations 变量将包含逗号分隔的静态资源路径列表。

常见问题解答

静态资源的类型有哪些？
- HTML、CSS、JavaScript、图片和其他不会随用户请求而变化的文件。
如何确保静态资源不被缓存？
- 使用 Cache-Control 和 Expires HTTP 头部，并定期更新文件的时间戳。
如何为静态资源配置不同的缓存策略？
- 使用 ResourceChainFilter 或 CachingHttpHeadersFilter 配置不同的缓存策略。
如何优化静态资源的性能？
- 使用内容分发网络 (CDN)，压缩和捆绑资源，以及使用浏览器缓存。
如何处理 404 Not Found 错误？
- 配置默认的错误处理页面，并考虑使用 ErrorController 处理异常。