Spring Boot测试环境下如何访问resources目录文件？Bazel测试报错求助

文件products.yml位于src/test/resources/configs/目录下，已在Spring Boot的application.yml中配置：

spring:
  config:
    import:
      - optional:configtree:src/test/resources/configs/

尝试在配置类中通过@Value注解获取文件路径：

@Configuration
public class ProductConverterConfiguration {

    @Value("${products}") 
    private String productsYamlFile;

    @PostConstruct
    public void init() {
        System.out.println("Got the file as: " + productsYamlFile);
    }
}

运行Bazel测试时，Spring Boot无法识别该文件，抛出空指针异常；使用绝对路径可正常运行，但需要相对路径以适配部署环境。

1. 修正Config Tree的使用逻辑 #

Config Tree的作用是加载目录下的配置内容并展开为键值对，而非直接指向文件路径。${products}不会返回products.yml的路径，而是会解析该文件内的配置项。如果要获取文件路径，改用以下方式：

通过ResourceLoader加载类路径资源 #

直接利用Spring的ResourceLoader读取类路径下的文件，无需依赖Config Tree：

@Configuration
public class ProductConverterConfiguration {

    private final ResourceLoader resourceLoader;

    // 构造注入ResourceLoader
    public ProductConverterConfiguration(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @PostConstruct
    public void init() throws IOException {
        Resource resource = resourceLoader.getResource("classpath:configs/products.yml");
        String filePath = resource.getFile().getAbsolutePath();
        System.out.println("Got the file as: " + filePath);
    }
}

这种方式依赖Spring的类路径扫描，只要Bazel正确打包资源文件即可正常加载。

2. 调整Bazel测试的资源配置 #

Bazel默认可能未将src/test/resources下的文件正确加入类路径，需修改BUILD文件确保测试目标包含资源：

java_test(
    name = "your-test-target",
    srcs = glob(["**/*.java"]),
    resources = glob(["src/test/resources/**/*"]),
    resource_strip_prefix = "src/test/resources",
    # 其他必要配置：deps、runtime_deps等
)

resource_strip_prefix会移除src/test/resources前缀，使资源在类路径下以configs/products.yml的路径被访问。

3. 用环境变量传递适配性路径 #

如果需要通过配置项传递路径，可结合环境变量实现多环境适配：

• 在application.yml中配置默认路径：

products: ${PRODUCTS_YAML_PATH:classpath:configs/products.yml}

• 在Bazel的BUILD文件中给测试目标设置环境变量：

java_test(
    name = "your-test-target",
    # 其他配置
    env = {
        "PRODUCTS_YAML_PATH": "src/test/resources/configs/products.yml",
    },
)

• 配置类中结合ResourceLoader处理路径：

@Configuration
public class ProductConverterConfiguration {

    private final ResourceLoader resourceLoader;
    @Value("${products}")
    private String productsPath;

    public ProductConverterConfiguration(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @PostConstruct
    public void init() throws IOException {
        Resource resource = resourceLoader.getResource(productsPath);
        String filePath = resource.getFile().getAbsolutePath();
        System.out.println("Got the file as: " + filePath);
    }
}

4. 避免直接依赖文件路径（推荐） #

如果只是要读取products.yml的配置内容，优先用@ConfigurationProperties绑定配置，无需关心文件路径：

• 创建配置类绑定yml内容：

@ConfigurationProperties(prefix = "products")
public class ProductProperties {
    private List<Product> items;

    // getter、setter
    public static class Product {
        private String id;
        private String name;
        // getter、setter
    }
}

• 在主配置类中启用配置绑定：

@Configuration
@EnableConfigurationProperties(ProductProperties.class)
public class ProductConverterConfiguration {

    private final ProductProperties productProperties;

    public ProductConverterConfiguration(ProductProperties productProperties) {
        this.productProperties = productProperties;
    }

    @PostConstruct
    public void init() {
        System.out.println("Loaded products: " + productProperties.getItems());
    }
}

这种方式由Spring自动处理配置加载，只要Bazel正确打包资源，测试和部署环境均可正常运行。

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