WebMvcConfigurer 的 addResourceLocations

在 Spring Boot 的 addResourceLocations 方法中，file: 是一个 URL 前缀，用于指示资源的位置是本地文件系统路径。以下是详细解释：

一、file: 的作用

file: 是 Java 中用于表示本地文件系统的 URL 前缀。它告诉 Spring Boot，资源的位置是本地磁盘上的某个目录，而不是类路径（classpath:）或其他位置。

二、为什么需要 file:？

在 Spring Boot 中，addResourceLocations 方法需要明确的资源位置格式。file: 前缀用于区分以下几种常见的资源位置：

1. 本地文件系统路径：file:/path/to/directory/
2. 类路径资源：classpath:/static/
3. HTTP/HTTPS 资源：https://example.com/

如果不加 file:，Spring Boot 会默认将路径解析为类路径资源，从而导致无法正确找到文件。

三、示例说明

假设上传的文件存储在 uploads/avatars/ 目录下，以下是几种资源位置的写法：

1. 绝对路径（推荐）：

   registry.addResourceHandler("/image/useravatar/**")
           .addResourceLocations("file:/absolute/path/to/uploads/avatars/");
   

2. 相对路径：

   registry.addResourceHandler("/image/useravatar/**")
           .addResourceLocations("file:uploads/avatars/");
   

   • 相对路径是基于项目运行时的当前工作目录（通常是项目的根目录）。

3. 类路径资源：

   registry.addResourceHandler("/image/useravatar/**")
           .addResourceLocations("classpath:/static/avatars/");
   

四、file: 的注意事项

1. 路径分隔符
   • 在 Windows 系统中，路径分隔符为 \，但 file: 要求使用 /。
   • 示例：

   registry.addResourceHandler("/image/useravatar/**")
           .addResourceLocations("file:C:/path/to/uploads/avatars/");
   

2. 路径结尾斜杠
   • 确保路径以 / 结尾，否则 Spring Boot 可能无法正确解析。

3. 跨平台兼容性
   • 使用 Paths.get() 或 System.getProperty("user.dir") 动态获取路径，确保跨平台兼容性：

   String uploadDir = Paths.get("uploads/avatars").toAbsolutePath().toString();
   registry.addResourceHandler("/image/useravatar/**")
           .addResourceLocations("file:" + uploadDir + "/");
   

五、完整示例

以下是一个完整的 Spring Boot 配置示例：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.nio.file.Paths;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 获取上传目录的绝对路径
        String uploadDir = Paths.get("uploads/avatars").toAbsolutePath().toString();

        // 配置虚拟路径映射
        registry.addResourceHandler("/image/useravatar/**")
                .addResourceLocations("file:" + uploadDir + "/");
    }
}

六、总结

• file: 是用于指示本地文件系统路径的 URL 前缀。
• 在 Spring Boot 中，使用 file: 可以确保资源位置被正确解析为本地磁盘路径。
• 建议使用绝对路径，并确保路径以 / 结尾，以避免跨平台兼容性问题。

如果仍有疑问，可以提供更多上下文信息，我会进一步协助！