SpringBoot从配置文件中获取属性的方法

news2024/11/28 12:32:41

方式一：@Value

基本类型属性注入，直接在字段上添加@Value("\${xxx.xxx}")即可．注意这里用的是$，而不是＃，@Value注入的属性，一般其他属性没有关联关系。

配置文件

user:
  name: Manaphy
  age: 19
  sex: male

@RestController
public class ConfigPropertiesController {
    @Value("${user.name}")
    private String name;
    @Value("${user.age}")
    private Integer age;
    @Value("${user.sex}")
    private String sex;

    @GetMapping("/user")
    public String getUser() {
        return "{name:" + name + ",age:" + age + ",sex:" + sex + "}";
    }
}

方式二：@ConfigurationProperties

配置文件

person:
  lastName: hello
  age: 18
  boss: false
  birth: 2017/12/12
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - wangwu
  dog:
    name: 小狗
    age: 12

JavaBean

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
 * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能
 */
@Component
@ConfigurationProperties(prefix = "person")
@Data
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;

}

@Data
class Dog {
    private String name;
    private Integer age;
}

Controller层

@RestController
public class PersonController {
    @Autowired
    private Person person;

    @GetMapping("/person")
    public Person getPerson() {
        return person;
    }
}

运行结果如下

在这里插入图片描述
我们可以导入配置文件处理器，以后编写配置就有提示了

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

注意：使用@ConfigurationProperties注入属性时如果只给属性提供get方法，会报错

例

/**
 * yml配置
 */
sms:
  region-id: cn-shanghai
  access-key-id: 123
  access-key-secret: 123
  sign-name: 叮咚买菜
  

/**
 * 实体类
 */
@Getter
@Component
@ConfigurationProperties(prefix = "sms")
public class SmsProperties {
    private String regionId;

    private String accessKeyId;

    private String accessKeySecret;
}


/*
报错
Description:

Failed to bind properties under 'sms' to com.example.producer.producerdemo.util.SmsProperties:

    Property: sms.access-key-id
    Value: 123
    Origin: class path resource [application.yml] - 51:18
    Reason: java.lang.IllegalStateException: No setter found for property: access-key-id

Action:

Update your application's configuration
*/

@Value和@ConfigurationProperties比较

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持