Spring Boot实战小技巧（四）：从配置文件获取配置值的方式

使用Spring Boot时，可将变量的值写在properties或yml配置文件中，通过读取配置文件中的键值对获取，方便灵活修改服务配置。Spring Boot读取配置值的方式很多，常见的有3种：使用@Value注解、使用@ConfigurationProperties注解和通过Environment对象获取。

下面将通过代码示例依次介绍3种方法，properties文件中的配置如下：

spring.redis.host=localhost
spring.redis.port=6379
spring.redis.password=123456
spring.cache.redis.time-to-live=600000
person.name=Tom
person.age=30

方法1 使用@Value注解
创建变量时，加上@Value注解，即可直接读取配置文件中相应键值，为该变量赋值。示例如下：

@Value("${spring.cache.redis.time-to-live}")
private Long timeToLive;

此方式使用时有一定风险，若配置项的类型不是String，则配置文件中该项的值不能为空。因为程序读取配置文件中值的类型为String，赋值前再转换为变量定义的类型，此时可能会出现异常。例如在本文示例中，若配置文件中未赋值，则空值转为Long类型会出现空指针异常。

方法2 使用@ConfigurationProperties注解
创建实体类时，加上使用@ConfigurationProperties注解，可读取配置文件中符合约束条件的键值对，为类属性赋值。示例如下：

@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String name;

    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

用@ConfigurationProperties注解将前缀为person的配置项的值取出，赋予Person类中字段名相同的属性，之后直接调用获取属性值的函数，即可获取配置文件中的值。
此方法同样存在方法1中的问题。

方法3 通过Environment对象获取
通过注入获取Environment对象，然后再根据字段名获取定义在配置文件的属性值。示例如下：

@Autowired
private Environment environment;

@Bean
public LettuceConnectionFactory redisConnectionFactory() {
	RedisStandaloneConfiguration redisConf = new RedisStandaloneConfiguration();
	redisConf.setHostName(environment.getProperty("spring.redis.host"));
	redisConf.setPort(Integer.parseInt(environment.getProperty("spring.redis.port")));
	redisConf.setPassword(RedisPassword.of(environment.getProperty("spring.redis.password")));
	return new LettuceConnectionFactory(redisConf);
}

此方法的好处是可以在获取配置值的代码段加上try{}catch{}语句，避免程序抛出异常。