Spring Boot中如何将单个类路径资源暴露为可Web访问资源？

针对将类路径资源/src/main/resources/source_dir/source_file.yaml暴露为URL http://localhost:8080/target_dir/target_file.yaml的需求，推荐以下几种优雅的实现方式：

方法一：通过@GetMapping直接返回资源 #

这是最简洁直接的方式，无需转发逻辑，直接读取类路径资源并返回，映射关系清晰明确。

import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ResourceMappingController {

    @GetMapping(value = "/target_dir/target_file.yaml", produces = MediaType.parseMediaType("text/yaml"))
    public Resource getRenamedYaml() {
        return new ClassPathResource("source_dir/source_file.yaml");
    }
}

说明：返回Resource对象后，Spring会自动处理资源的输出；指定text/yaml的MediaType可以让浏览器正确识别文件类型，也可根据需求替换为APPLICATION_OCTET_STREAM_VALUE。

方法二：自定义资源处理器映射 #

适合需要在配置类中统一管理资源映射规则的场景，通过注册SimpleUrlHandlerMapping实现单个资源的重命名映射，无需编写控制器。

import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;

import javax.annotation.PostConstruct;
import java.util.Collections;

@Configuration
public class CustomResourceConfig implements WebMvcConfigurer {

    private final SimpleUrlHandlerMapping urlHandlerMapping;

    public CustomResourceConfig(SimpleUrlHandlerMapping urlHandlerMapping) {
        this.urlHandlerMapping = urlHandlerMapping;
    }

    @PostConstruct
    public void registerSingleResourceMapping() {
        ResourceHttpRequestHandler resourceHandler = new ResourceHttpRequestHandler();
        // 设置资源根路径为类路径根目录
        resourceHandler.setLocations(Collections.singletonList(new ClassPathResource("")));
        resourceHandler.setResourceChain(true);

        // 绑定目标URL到源资源路径
        urlHandlerMapping.setUrlMap(Collections.singletonMap(
                "/target_dir/target_file.yaml",
                resourceHandler
        ));
        // 设置优先级，确保该映射优先于默认静态资源规则
        urlHandlerMapping.setOrder(-1);
    }
}

补充：不推荐的转发方式（仅作参考） #

如果依赖现有静态资源配置，可先映射源目录到临时路径再转发，但这种方式冗余且不够优雅，仅作为备选方案：

1. 配置静态资源临时映射：

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class TempResourceConfig implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/temp/**")
                .addResourceLocations("classpath:/source_dir/");
    }
}

2. 编写转发控制器：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class ForwardController {
    @GetMapping("/target_dir/target_file.yaml")
    public String forwardToSource() {
        return "forward:/temp/source_file.yaml";
    }
}

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