如何使用SpringBoot访问静态资源

发布时间：2021-09-29 16:32:25 作者：柒染
来源：亿速云阅读：396

# 如何使用SpringBoot访问静态资源

## 前言

在现代Web应用开发中，静态资源（如HTML、CSS、JavaScript、图片等）的处理是基础且重要的功能。SpringBoot通过自动配置为我们提供了简洁高效的静态资源访问方案。本文将详细介绍SpringBoot中静态资源的默认配置、自定义配置方法以及常见问题的解决方案。

## 一、SpringBoot默认静态资源处理

### 1. 默认静态资源目录

SpringBoot默认会从以下位置查找静态资源（按优先级排序）：

```java
classpath:/META-INF/resources/
classpath:/resources/
classpath:/static/ 
classpath:/public/

实际项目中，我们通常将静态文件放在src/main/resources/static/目录下。例如：

src/
└── main/
    └── resources/
        ├── static/
        │   ├── css/style.css
        │   ├── js/app.js
        │   └── images/logo.png
        └── application.properties

2. 默认访问路径

静态资源会自动映射到/**路径下。例如： - style.css可通过http://localhost:8080/css/style.css访问 - logo.png可通过http://localhost:8080/images/logo.png访问

3. 欢迎页机制

SpringBoot会自动查找以下位置的index.html作为欢迎页： 1. 配置的静态资源路径 2. 如果使用模板引擎（如Thymeleaf），则查找templates/index.html

二、自定义静态资源配置

1. 通过配置文件修改

在application.properties或application.yml中：

# 修改静态资源路径（多个路径用逗号分隔）
spring.web.resources.static-locations=classpath:/custom-static/

# 修改静态资源URL前缀
spring.mvc.static-path-pattern=/assets/**

# 缓存控制（开发时可禁用）
spring.web.resources.cache.period=3600
spring.web.resources.cache.use-last-modified=true

2. 通过Java配置类修改

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/files/**")
                .addResourceLocations("classpath:/files/", "file:/opt/uploads/")
                .setCacheControl(CacheControl.maxAge(1, TimeUnit.HOURS));
    }
}

3. 外部目录映射

如果需要访问文件系统中的静态资源：

# Windows示例
spring.web.resources.static-locations=file:C:/uploads/,classpath:/static/

# Linux/Mac示例
spring.web.resources.static-locations=file:/opt/uploads/,classpath:/static/

三、特殊静态资源处理

1. Favicon处理

SpringBoot会自动查找以下位置的favicon.ico： 1. 配置的静态资源路径 2. 根目录（classpath:/）

建议尺寸：16x16或32x32像素

2. WebJars资源

通过Maven引入前端库：

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

访问路径：/webjars/jquery/3.6.0/jquery.js

四、与模板引擎配合使用

Thymeleaf示例

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <link th:href="@{/css/style.css}" rel="stylesheet"/>
</head>
<body>
    <img th:src="@{/images/logo.png}" alt="Logo"/>
    <script th:src="@{/js/app.js}"></script>
</body>
</html>

五、常见问题解决方案

1. 静态资源404错误

检查文件是否在正确的目录
检查是否有@EnableWebMvc注解（会禁用自动配置）
检查自定义配置是否覆盖了默认配置

2. 缓存问题

开发阶段建议禁用缓存：

spring.web.resources.cache.period=0

3. 跨域访问

@Configuration
public class CorsConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowedMethods("GET");
    }
}

六、最佳实践建议

目录结构规范：
- CSS文件放在/static/css/
- JavaScript放在/static/js/
- 图片放在/static/images/
版本控制：

<link href="/css/style.css?v=1.0.1" rel="stylesheet">

CDN加速：

# 生产环境配置
spring.web.resources.chain.strategy.content.enabled=true
spring.web.resources.chain.strategy.content.paths=/**

性能优化：
- 启用Gzip压缩
- 合理设置缓存时间
- 使用HTTP/2

七、测试验证方法

直接浏览器访问静态资源URL
单元测试示例：

@SpringBootTest
@AutoConfigureMockMvc
class StaticResourceTests {
    
    @Autowired
    private MockMvc mockMvc;
    
    @Test
    void testStaticResource() throws Exception {
        mockMvc.perform(get("/css/style.css"))
               .andExpect(status().isOk())
               .andExpect(content().contentType("text/css"));
    }
}

结语

SpringBoot的静态资源处理机制既简单又灵活，通过合理的配置可以满足各种项目需求。掌握这些知识后，开发者可以更专注于业务逻辑的实现，而无需在基础配置上花费过多时间。建议根据实际项目需求选择合适的配置方案，并遵循最佳实践以保证应用性能。