脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot配置文件值和环境变量

SpringBoot获取配置文件值和环境变量的方式

 更新时间：2026年04月29日 08:38:17   作者：北风toto  
本文介绍了SpringBoot配置文件的基础知识、使用@Value和@ConfigurationProperties注入配置值、使用Environment接口获取环境变量、配置文件的Profile支持、高级用法如条件化配置和配置刷新机制、以及配置的最佳实践建议,需要的朋友可以参考下

1. 配置文件基础

Spring Boot 支持多种格式的配置文件：

  • application.properties
  • application.yml
  • application.yaml

配置文件默认加载顺序：

  1. file:./config/ (项目根目录下的config子目录)
  2. file:./ (项目根目录)
  3. classpath:/config/ (resources/config目录)
  4. classpath:/ (resources目录)

2. 使用 @Value 注解获取配置值

2.1 基本用法

@Component
public class ConfigService {
    
    // 获取普通配置值
    @Value("${app.name}")
    private String appName;
    
    // 设置默认值
    @Value("${server.port:8080}")
    private int port = 8080;
    
    // 获取布尔值
    @Value("${app.enabled:true}")
    private boolean enabled;
    
    // 获取列表值
    @Value("${app.tags:java,spring}")
    private List<String> tags;
    
    // 获取数组值
    @Value("${app.servers}")
    private String[] servers;
    
    public void printConfig() {
        System.out.println("App Name: " + appName);
        System.out.println("Port: " + port);
        System.out.println("Enabled: " + enabled);
        System.out.println("Tags: " + Arrays.toString(tags.toArray()));
        System.out.println("Servers: " + Arrays.toString(servers));
    }
}

2.2 配置示例 (application.yml)

app:
  name: MySpringBootApplication
  enabled: true
  tags: java,spring,boot
  servers: 
    - server1
    - server2
    - server3
server:
  port: 8080

3. 使用 @ConfigurationProperties 批量注入

3.1 创建配置类

@ConfigurationProperties(prefix = "app")
@Component
public class AppProperties {
    
    private String name;
    private boolean enabled;
    private String version;
    private Database database;
    private List<String> features;
    private Map<String, String> properties;
    
    // 内部类定义嵌套配置
    public static class Database {
        private String url;
        private String username;
        private String password;
        private int maxConnections;
        
        // getter 和 setter 方法
        public String getUrl() { return url; }
        public void setUrl(String url) { this.url = url; }
        
        public String getUsername() { return username; }
        public void setUsername(String username) { this.username = username; }
        
        public String getPassword() { return password; }
        public void setPassword(String password) { this.password = password; }
        
        public int getMaxConnections() { return maxConnections; }
        public void setMaxConnections(int maxConnections) { this.maxConnections = maxConnections; }
    }
    
    // getter 和 setter 方法
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    
    public boolean isEnabled() { return enabled; }
    public void setEnabled(boolean enabled) { this.enabled = enabled; }
    
    public String getVersion() { return version; }
    public void setVersion(String version) { this.version = version; }
    
    public Database getDatabase() { return database; }
    public void setDatabase(Database database) { this.database = database; }
    
    public List<String> getFeatures() { return features; }
    public void setFeatures(List<String> features) { this.features = features; }
    
    public Map<String, String> getProperties() { return properties; }
    public void setProperties(Map<String, String> properties) { this.properties = properties; }
}

3.2 启用配置属性

在主类或配置类上添加注解：

@SpringBootApplication
@EnableConfigurationProperties(AppProperties.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

或者在 application.yml 中配置：

app:
  name: MyApplication
  enabled: true
  version: 1.0.0
  features:
    - feature1
    - feature2
    - feature3
  properties:
    key1: value1
    key2: value2
  database:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: password
    max-connections: 100

4. 使用 Environment 接口

@Service
public class EnvironmentService {
    
    @Autowired
    private Environment environment;
    
    public void getEnvironmentValues() {
        // 获取配置值
        String appName = environment.getProperty("app.name");
        String port = environment.getProperty("server.port");
        String defaultPort = environment.getProperty("server.port", "8080");
        
        // 获取特定类型的值
        Integer serverPort = environment.getProperty("server.port", Integer.class, 8080);
        Boolean debugMode = environment.getProperty("debug", Boolean.class, false);
        
        // 检查属性是否存在
        if (environment.containsProperty("app.name")) {
            System.out.println("App name exists: " + appName);
        }
        
        // 获取所有活跃的配置文件
        String[] activeProfiles = environment.getActiveProfiles();
        String[] defaultProfiles = environment.getDefaultProfiles();
        
        System.out.println("Active profiles: " + Arrays.toString(activeProfiles));
        System.out.println("Default profiles: " + Arrays.toString(defaultProfiles));
    }
}

5. 获取环境变量

5.1 直接获取系统环境变量

@Component
public class SystemEnvService {
    
    public void getSystemEnvironment() {
        // 方式1：通过 System.getenv()
        String homeDir = System.getenv("HOME");
        String path = System.getenv("PATH");
        String userName = System.getenv("USER");
        
        // 方式2：通过 Environment 接口
        Environment env = new StandardEnvironment();
        String homeFromEnv = env.getProperty("HOME");
        
        // 方式3：通过 @Value 注解
        @Value("${HOME:#{null}}") // 注意：环境变量通常不以 $ 开头
        private String homePath;
        
        System.out.println("Home directory: " + homeDir);
        System.out.println("PATH: " + path);
        System.out.println("User: " + userName);
    }
}

5.2 通过 Environment 获取环境变量

@Service
public class EnvVariableService {
    
    @Autowired
    private Environment environment;
    
    public void getEnvironmentVariables() {
        // 获取环境变量（注意：环境变量名通常大写）
        String dbHost = environment.getProperty("DB_HOST");
        String dbPort = environment.getProperty("DB_PORT");
        String secretKey = environment.getProperty("SECRET_KEY");
        
        // 设置默认值
        String dbHostWithDefault = environment.getProperty("DB_HOST", "localhost");
        
        System.out.println("DB Host: " + dbHost);
        System.out.println("DB Port: " + dbPort);
        System.out.println("Secret Key: " + secretKey);
    }
}

6. 配置文件的 Profile 支持

6.1 不同环境的配置文件

  • application.yml (默认配置)
  • application-dev.yml (开发环境)
  • application-test.yml (测试环境)
  • application-prod.yml (生产环境)

6.2 使用 Profile 的配置类

@Configuration
@Profile("dev")
public class DevConfig {
    
    @Bean
    public String devDatabaseUrl() {
        return "jdbc:h2:mem:devdb";
    }
}

@Configuration
@Profile("!dev") // 非开发环境
public class ProdConfig {
    
    @Bean
    public String prodDatabaseUrl() {
        return "jdbc:mysql://prod-server:3306/proddb";
    }
}

7. 高级用法：条件化配置

7.1 使用 @ConditionalOnProperty

@Configuration
public class ConditionalConfig {
    
    @Bean
    @ConditionalOnProperty(name = "app.feature.enabled", havingValue = "true", matchIfMissing = false)
    public FeatureService featureService() {
        return new FeatureServiceImpl();
    }
    
    @Bean
    @ConditionalOnProperty(name = "app.cache.type", havingValue = "redis", matchIfMissing = false)
    public CacheService redisCacheService() {
        return new RedisCacheService();
    }
    
    @Bean
    @ConditionalOnProperty(name = "app.cache.type", havingValue = "memory", matchIfMissing = true)
    public CacheService memoryCacheService() {
        return new MemoryCacheService();
    }
}

8. 配置验证

8.1 添加验证注解

@ConfigurationProperties(prefix = "app")
@Component
@Validated
public class ValidatedAppProperties {
    
    @NotBlank(message = "应用名称不能为空")
    private String name;
    
    @Min(value = 1, message = "端口号必须大于0")
    @Max(value = 65535, message = "端口号不能超过65535")
    private int port;
    
    @Pattern(regexp = "^\\d+\\.\\d+\\.\\d+$", message = "版本号格式不正确，应为 x.y.z 格式")
    private String version;
    
    @AssertTrue(message = "应用必须启用才能正常工作")
    private boolean enabled;
    
    // getter 和 setter 方法...
}

9. 实际应用示例

9.1 完整的服务类

@Service
@Slf4j
public class ConfigurationManager {
    
    @Value("${app.name:DefaultApp}")
    private String appName;
    
    @Value("${app.version:1.0.0}")
    private String appVersion;
    
    @Autowired
    private Environment environment;
    
    @Autowired
    private AppProperties appProperties;
    
    public void displayAllConfigs() {
        log.info("=== 应用配置信息 ===");
        log.info("App Name: {}", appName);
        log.info("App Version: {}", appVersion);
        
        log.info("=== 通过 Environment 获取 ===");
        log.info("Server Port: {}", environment.getProperty("server.port"));
        log.info("Active Profiles: {}", Arrays.toString(environment.getActiveProfiles()));
        
        log.info("=== 通过 @ConfigurationProperties 获取 ===");
        log.info("App Properties Name: {}", appProperties.getName());
        log.info("App Properties Enabled: {}", appProperties.isEnabled());
        log.info("Database URL: {}", appProperties.getDatabase().getUrl());
        
        log.info("=== 环境变量示例 ===");
        log.info("JAVA_HOME: {}", System.getenv("JAVA_HOME"));
        log.info("OS: {}", System.getProperty("os.name"));
    }
    
    public String getProperty(String key) {
        return environment.getProperty(key);
    }
    
    public String getProperty(String key, String defaultValue) {
        return environment.getProperty(key, defaultValue);
    }
    
    public <T> T getProperty(String key, Class<T> targetType, T defaultValue) {
        return environment.getProperty(key, targetType, defaultValue);
    }
}

10. 最佳实践建议

10.1 配置命名规范

# 推荐的命名方式
my-app:
  service:
    timeout: 30s
    retry-count: 3
  database:
    connection-timeout: 20s
    pool-size: 10
# 避免驼峰命名（虽然也支持）
myAppServiceTimeout: 30s

10.2 安全敏感配置

// 对于密码等敏感信息，建议使用配置解密
@ConfigurationProperties(prefix = "app.security")
@Component
public class SecurityProperties {
    
    private String encryptedPassword;
    
    // 不直接暴露密码字段，而是提供解密方法
    public String getDecryptedPassword() {
        // 实现解密逻辑
        return decrypt(encryptedPassword);
    }
    
    private String decrypt(String encryptedValue) {
        // 解密实现
        return encryptedValue; // 简化示例
    }
}

11. 配置刷新机制

对于需要动态刷新的配置，可以结合 Spring Cloud Config 或使用 @RefreshScope：

@RestController
@RefreshScope
public class ConfigController {
    
    @Value("${app.message:Hello Default}")
    private String message;
    
    @GetMapping("/message")
    public String getMessage() {
        return message;
    }
}

12、环境变量

程序启动时的命令行参数

  • java设置方式
java -jar app.jar --jasypt.encryptor.password=salt

IDEA设置方式

读取方式

System.getenv(jasypt.encryptor.password);

程序启动时的应用环境变量

  • java启动设置方式
java -jar app.jar -Djasypt.encryptor.password=salt

IDEA设置方式

读取方式

System.getProperty(jasypt.encryptor.password);

总结

Spring Boot 提供了多种灵活的方式来获取配置值和环境变量：

  1. @Value: 适用于简单的单个值注入
  2. @ConfigurationProperties: 适用于复杂对象的批量配置
  3. Environment: 适用于程序化访问配置值
  4. Profile: 适用于不同环境的差异化配置
  5. 条件化配置: 适用于基于条件的配置加载

以上就是SpringBoot获取配置文件值和环境变量的方式的详细内容，更多关于SpringBoot配置文件值和环境变量的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

相关文章

  • 空指针HttpSession异常之SpringBoot集成WebSocket的方法

    空指针HttpSession异常之SpringBoot集成WebSocket的方法

    文章介绍了在Spring Boot中集成WebSocket时遇到的HttpSession为空的问题,并探讨了三种解决方法,方法一涉及域名配置,方法二通过监听创建Session,而方法三是从request中获取session并存入数据,感兴趣的朋友一起看看吧
    2025-01-01
  • IDEA一致卡在build时间过长问题解决

    IDEA一致卡在build时间过长问题解决

    有很多小伙伴在起项目的时候巨慢,特别影响开发效率,本文主要介绍了IDEA一致卡在build时间过长问题解决,具有一定的参考价值,感兴趣的可以了解一下
    2024-06-06
  • 详解mall整合SpringBoot+MyBatis搭建基本骨架

    详解mall整合SpringBoot+MyBatis搭建基本骨架

    这篇文章主要介绍了详解mall整合SpringBoot+MyBatis搭建基本骨架，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • Yml转properties文件工具类YmlUtils的详细过程(不用引任何插件和依赖)

    Yml转properties文件工具类YmlUtils的详细过程(不用引任何插件和依赖)

    这篇文章主要介绍了Yml转properties文件工具类YmlUtils（不用引任何插件和依赖）,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2021-08-08
  • Java调用DeepSeek api实现方法记录

    Java调用DeepSeek api实现方法记录

    这篇文章主要介绍了如何在Java中调用DeepSeek API,包括在官网获取APIKeys、创建API请求工具类以及处理返回结果的步骤,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-02-02
  • Java模拟新浪微博登陆抓取数据

    Java模拟新浪微博登陆抓取数据

    本文主要介绍了Java模拟新浪微博登陆抓取数据的实现方法。具有很好的参考价值，下面跟着小编一起来看下吧
    2017-02-02
  • Struts2 OGNL表达式实例详解

    Struts2 OGNL表达式实例详解

    这篇文章主要介绍了Struts2 OGNL表达式实例详解，相关实例代码，需要的朋友可以参考。
    2017-09-09
  • 深入解析Java的Hibernate框架中的持久对象

    深入解析Java的Hibernate框架中的持久对象

    Hibernate的持久对象在数据库数据操作中有着重要作用,这里我们就来深入解析Java的Hibernate框架中的持久对象,首先必须从理解持久化对象的生命周期开始:
    2016-07-07
  • Java计算百分比的各种方法总结

    Java计算百分比的各种方法总结

    这篇文章主要给大家介绍了关于Java计算百分比的各种方法,要计算百分比并保留两位小数,首先需要明确计算公式和java语言的数学计算方法,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-06-06
  • Java使用BigDecimal进行运算封装的实际案例

    Java使用BigDecimal进行运算封装的实际案例

    今天小编就为大家分享一篇关于Java使用BigDecimal进行运算封装的实际案例，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
    2018-12-12

最新评论