跨模块Maven项目中的资源文件访问：最佳实践与解决方案

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.company.project</groupId>
        <artifactId>project</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <artifactId>project-algo</artifactId>
    <packaging>jar</packaging>

    <dependencies>
        <!-- 现有依赖 -->
        <dependency>
            <groupId>com.company.project</groupId>
            <artifactId>project-base</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- 添加对 project-config 模块的依赖 -->
        <dependency>
            <groupId>com.company.project</groupId>
            <artifactId>project-config</artifactId>
            <version>${project.version}</version>
        </dependency>

        <!-- Jackson YAML 数据绑定库 -->
        <dependency>
            <groupId>com.fasterxml.jackson.dataformat</groupId>
            <artifactId>jackson-dataformat-yaml</artifactId>
            <version>2.13.0</version> <!-- 请使用最新稳定版本 -->
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.13.0</version> <!-- 请使用最新稳定版本 -->
        </dependency>
    </dependencies>
</project>

project-config
└── src
    └── main
        └── resources
            └── application_config.yaml

<!-- project-config/pom.xml -->
<project>
    ...
    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
            </resource>
            <resource>
                <directory>configs</directory> <!-- 将 configs 目录也作为资源目录打包 -->
                <includes>
                    <include>**/*.yaml</include>
                </includes>
            </resource>
        </resources>
    </build>
    ...
</project>

package com.company.project.util.io;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
import java.io.IOException;
import java.io.InputStream;
import java.util.Objects; // 导入 Objects 类

public class YamlReader {

    // 假设 ConfigParent 是一个接口或抽象类，用于泛型约束
    // public static class ConfigParent {} 

    public static <C> C readConfiguration(Class<C> configClass, String yamlFileName) throws IOException {
        InputStream inputStream = null;
        try {
            // 使用 ClassLoader 从 classpath 加载资源
            // 文件名应为相对于 classpath 根目录的路径，例如 "application_config.yaml"
            // 如果文件在 project-config/src/main/resources/config/application_config.yaml，则路径为 "config/application_config.yaml"
            inputStream = YamlReader.class.getClassLoader().getResourceAsStream(yamlFileName);

            // 检查资源是否找到
            if (inputStream == null) {
                throw new IOException("Resource not found on classpath: " + yamlFileName);
            }

            YAMLMapper mapper = new YAMLMapper();
            mapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
            mapper.enable(DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY);

            return mapper.readValue(inputStream, configClass);
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    // 记录关闭流时的异常
                    System.err.println("Error closing input stream: " + e.getMessage());
                }
            }
        }
    }

    // 示例用法（在 AlgorithmTest 中调用）
    // 假设您有一个 ConfigParent 的实现类 MyConfig
    // public static class MyConfig extends ConfigParent { ... }

    // public static void main(String[] args) throws IOException {
    //     MyConfig config = readConfiguration(MyConfig.class, "application_config.yaml");
    //     System.out.println("Config loaded: " + config);
    // }
}

package com.company.project;

import com.company.project.util.io.YamlReader;
import org.junit.jupiter.api.Test;
import java.io.IOException;

// 假设您有一个配置类，例如
class MyApplicationConfig {
    public String setting1;
    public int value2;
    // ... 其他字段
}

public class AlgorithmTest {

    @Test
    void testReadApplicationConfig() throws IOException {
        // 假设 application_config.yaml 位于 project-config 的 src/main/resources 根目录
        MyApplicationConfig config = YamlReader.readConfiguration(MyApplicationConfig.class, "application_config.yaml");

        // 进行断言或使用配置
        System.out.println("Loaded config setting1: " + config.setting1);
        System.out.println("Loaded config value2: " + config.value2);
        // Assertions.assertNotNull(config);
        // Assertions.assertEquals("expectedValue", config.setting1);
    }
}