SpringBoot使用数据库配置自定义路径提供静态图片访问失败问题

常见排查步骤 #

• 检查资源路径协议前缀
  Spring Boot加载本地文件系统的静态资源时，要求路径必须携带file:协议前缀。你之前在properties中配置的路径是file:/Applications/MAMP/htdocs/reportMaker/template，但从数据库读取的路径只有绝对路径没有前缀，Spring会默认将其识别为类路径资源，无法匹配到本地文件。
• 检查路径结尾斜杠
  如果数据库存储的路径结尾没有/，Spring拼接资源路径时会出现错误，比如路径为/xxx/template，请求logo.png时会拼接为/xxx/templatelogo.png，导致资源找不到。
• 检查@EnableWebMvc注解副作用
  添加@EnableWebMvc会完全覆盖Spring Boot默认的MVC自动配置，默认的静态资源规则、消息转换器等配置都会失效。如果你没有完全自定义MVC配置的需求，直接移除该注解即可，Spring Boot会自动合并你自定义的资源规则与默认配置。
• 检查配置加载时机
  可以在代码中添加日志打印path变量的实际取值，确认StaticResourceConfiguration初始化时，数据库查询已经完成，没有出现因为数据源、DAO层未初始化完成导致path为空的问题。
• 检查目录访问权限
  确认Spring Boot应用运行的系统用户，对目标目录有可读权限，macOS/Linux环境下权限不足也会导致资源访问失败。

修复代码示例 #

@Configuration
public class StaticResourceConfiguration implements WebMvcConfigurer {

    @Autowired
    ConfigurationRepository confRepo;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        myConfiguration conf = confRepo.findByConfKey("downloadPath");
        String path =  conf.getConfValue();
        if(path !=null) {
            // 自动补全file协议前缀和结尾斜杠
            String finalResourcePath = "file:" + (path.endsWith("/") ? path : path + "/");
            registry.addResourceHandler("/resources/**")
                    .addResourceLocations(finalResourcePath);
        }
    }
}

内容的提问来源于stack exchange，提问作者Pickeroll