Spring @Environment 典型用法实战指南

Spring框架的@Environment接口是访问应用环境配置的核心入口，它统一管理了属性文件、系统变量、命令行参数、JNDI等多种配置源。本文将深入解析@Environment的核心用法，并通过实际案例演示如何高效利用它管理配置。

1. @Environment 核心功能

Environment 接口提供以下关键能力：

多配置源统一访问：合并application.properties、系统环境变量、JVM参数等。
Profile 管理：动态识别当前激活的Profile（如dev/test/prod）。
类型安全配置：支持直接注入属性值到字段或方法参数。

2. 基础用法示例

2.1 注入 Environment 对象

通过@Autowired直接注入：

@RestController
public class ConfigController {
    @Autowired
    private Environment env;

    @GetMapping("/server-port")
    public String getServerPort() {
        return env.getProperty("server.port"); // 读取配置
    }
}

2.2 快速获取属性

使用getProperty()方法，支持默认值：

String timeout = env.getProperty("http.timeout", "5000"); // 默认5000ms

2.3 检查配置是否存在

if (env.containsProperty("security.token.secret")) {
    // 安全配置存在时才初始化
}

3. 实战案例

案例1：动态切换数据库配置

场景：根据Profile加载不同的数据源配置。

步骤：

配置application-dev.properties和application-prod.properties：

   # dev环境
   spring.datasource.url=jdbc:h2:mem:testdb
   # prod环境
   spring.datasource.url=jdbc:mysql://prod-db:3306/app

通过Environment判断当前环境：

   @Service
   public class DatabaseService {
       @Autowired
       private Environment env;

       public void initDataSource() {
           if (env.acceptsProfiles("dev")) {
               System.out.println("使用H2内存数据库");
           } else if (env.acceptsProfiles("prod")) {
               System.out.println("连接生产MySQL数据库");
           }
       }
   }

案例2：注入配置到Bean

使用@Value结合Environment实现类型安全注入：

@Component
public class EmailService {
    @Value("${email.smtp.host}")
    private String smtpHost;

    @Value("${email.retry.count:3}") // 默认3次
    private int retryCount;
}

案例3：校验必填配置

在应用启动时检查关键配置：

@Configuration
public class AppConfig implements InitializingBean {
    @Autowired
    private Environment env;

    @Override
    public void afterPropertiesSet() {
        Assert.notNull(env.getProperty("api.key"), "API密钥未配置！");
    }
}

4. 高级技巧

4.1 监听配置变更（Spring Cloud）

在Spring Cloud中，配合@RefreshScope实现动态更新：

@RefreshScope
@RestController
public class DynamicConfigController {
    @Value("${feature.enabled}")
    private boolean featureEnabled;
}

通过/actuator/refresh端点触发配置热更新。

4.2 自定义PropertySource

扩展配置源（如从数据库读取）：

public class DatabasePropertySource extends PropertySource<Map<String, String>> {
    public DatabasePropertySource() {
        super("dbConfig", loadConfigFromDatabase());
    }

    @Override
    public String getProperty(String key) {
        return this.source.get(key);
    }
}

注册到Environment：

env.getPropertySources().addLast(new DatabasePropertySource());

5. 总结

场景	推荐用法
基础配置读取	`env.getProperty("key")`
多环境隔离	`env.acceptsProfiles("dev")`
类型安全注入	`@Value("${property}")`
动态配置更新	`@RefreshScope` + Spring Cloud
自定义配置源	扩展`PropertySource`