【Java】如何从JAR包外部读取配置文件

Java Spring

发布日期: 2025-02-24

更新日期: 2025-02-25

文章字数: 887

阅读时长: 3 分

阅读次数:

问题背景

在Java应用程序中，尤其是Spring框架中，通常需要读取配置文件来管理应用的各种参数。将配置文件打包到JAR中虽然方便，但在某些情况下，我们可能希望从JAR包外部读取配置文件，以便于在不重新打包的情况下进行配置修改。

解决方案

1. 使用`@PropertySource`注解

Spring提供了@PropertySource注解，可以方便地从外部文件加载属性。以下是一个示例：

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Configuration
@PropertySource("file:${config.path}/application.properties")
public class AppConfig {

    @Value("${app.name}")
    private String appName;

    public String getAppName() {
        return appName;
    }
}

在这个例子中，${config.path}是一个系统环境变量，指向外部配置文件的路径。

2. 使用`Environment`接口

Spring的Environment接口也可以用来读取外部配置文件。以下是一个示例：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class ConfigReader {

    @Autowired
    private Environment env;

    public String getAppName() {
        return env.getProperty("app.name");
    }
}

3. 通过命令行参数传递配置文件路径

在启动JAR时，可以通过命令行参数传递配置文件路径。例如：

java -jar myapp.jar --config.path=/path/to/config

然后在代码中使用@Value注解读取：

@Value("${config.path}")
private String configPath;

4. 使用`ResourceLoader`读取文件

如果需要读取非属性文件的配置文件，可以使用ResourceLoader：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.Resource;
import org.springframework.core.io.ResourceLoader;
import org.springframework.stereotype.Component;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;

@Component
public class FileReader {

    @Autowired
    private ResourceLoader resourceLoader;

    public void readFile(String filePath) throws IOException {
        Resource resource = resourceLoader.getResource("file:" + filePath);
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(resource.getInputStream()))) {
            String line;
            while ((line = reader.readLine()) != null) {
                System.out.println(line);
            }
        }
    }
}

实际应用示例

1. Controller层使用

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConfigController {

    @Autowired
    private ConfigReader configReader;

    @GetMapping("/app-name")
    public String getAppName() {
        return configReader.getAppName();
    }
}

2. 测试验证

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class ConfigReaderTest {

    @Autowired
    private ConfigReader configReader;

    @Test
    public void testGetAppName() {
        String appName = configReader.getAppName();
        System.out.println("应用名称: " + appName);
    }
}