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

方式一:@Value

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

配置文件

yml 复制代码
user:
  name: Manaphy
  age: 19
  sex: male
java 复制代码
@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

配置文件

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

JavaBean

java 复制代码
/**
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @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层

java 复制代码
@RestController
public class PersonController {
    @Autowired
    private Person person;

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

运行结果如下

我们可以导入配置文件处理器,以后编写配置就有提示了

xml 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

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

java 复制代码
/**
 * 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数据校验 支持 不支持
复杂类型封装 支持 不支持

配置文件yml还是properties他们都能获取到值;

如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;

如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties。

相关推荐
-兰天白云-3 分钟前
java转pdf工具对比
java
大麦若叶茶7 分钟前
每天学习一点点之进程与线程、并行与并发
后端
咸虾米13 分钟前
在uniCloud云对象内使用unipay的微信退款出现错误“uniPayCo.refund Error: token校验未通过”的解决方案
前端·后端
云胡14 分钟前
Mybatis Plus 自定义 SQL
后端
浮生若梦l16 分钟前
在 Spring Boot 项目里,MYSQL中json类型字段使用
spring boot·mysql·json
钡铼技术ARM工业边缘计算机36 分钟前
TI AM62x异构处理器边缘计算网关重构储能 EMS 智能化管理新生态
后端
bobz96538 分钟前
compile libvirt
后端
BillKu40 分钟前
Java中List的forEach用法详解
java·windows·list
重生之后端学习43 分钟前
苍穹外卖-day03
java·开发语言·数据库·spring boot·mysql·spring·tomcat
星星电灯猴1 小时前
iOS App安全实战:借助Ipa Guard提升应用抗逆向能力的开发者实用指南
后端