Spring Boot项目中yaml和properties配置文件的异同,@ConfigurationProperties和@Value的差别

本文介绍了yaml和properties配置文件在Spring Boot项目中的异同,强调了yaml的简洁语法和对特殊字符的处理方式。同时,探讨了@ConfigurationProperties与@Value注解在处理配置时的不同,包括松散绑定、SpEL表达式支持以及复杂类型的封装和数据校验。在使用上,@Value适用于临时获取配置值,而@ConfigurationProperties适合用于与JavaBean映射。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

yaml和properties配置文件的异同

yaml是现在比较流行的一种配置文件,它比xml更适合做配置文件,主要表现在文件中属性的配置更简洁,少了各种标签的书写。

server:
  port: 8081

person:
  last-name: zs
  age: 25
  boss: true
  birth: 2017/12/12
  maps: {k1: v1,k2: v2,k3: v3,k4: v4}
  lists:
    - lisi
    - zhangliu
  dog:
    name: 小狗
    age: 3

yaml的基本语法比较简单,注意空格的缩进即可,语法中不许有Tab键,在同一列的属性是同一级别的变量。大小写敏感,k: v(:后要有一个空格)
需要特别注意的一点是单引号和双引号的差别。

yaml中单引号和双引号

语法规定,yaml中的字符串默认不需要加上单引号要或者双引号;

“”(双引号):不会转义字符串中的特殊字符;特殊字符会作为自身想表示的意思进行输出。
例如:name: “zhangsan \n lisi”:输出结果:zhangsan 换行 lisi

‘’(单引号):会转义字符串中的特殊字符;特殊字符会作为普通字符串进行输出。
例如:name: ‘zhangsan \n lisi’:输出结果:zhangsan \n lisi

@ConfigurationProperties和@Value的差别

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

松散绑定:例如lastName变量如果和last-name效果等同的话就是松散绑定,否则就不是松散绑定。

SpEL:在@Value(“#{11*2}”)中是可以成功给对应变量赋值为22的,但是在@ConfigurationProperties 注解下,在配置文件中书写SpEL表达式就不会被识别。
复杂类型封装

package com.springboot.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @Value("${person.last-name}")
    private String name;
    @RequestMapping("/hello")
    public String sayHello(){
        return "Hello " + name;
    }
}

JSR303数据校验

package com.springboot.bean;


import org.hibernate.validator.constraints.Email;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import java.util.Date;
import java.util.List;
import java.util.Map;

/**
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @ConfigurationProperties: 告诉spring boot将本类中的所有属性和配置文件中相关的配置进行绑定
 *
 * 只有这个组件是容器中的组件,才能使用容器提供的@ConfigurationProperties功能
 */

@Component
@ConfigurationProperties(prefix = "person")//告诉spring boot该类在配置文件中的前缀是什么

@Validated//说明以下数据需要数据校验
public class Person {
    @Email//lastName的值必须符合电子邮件的基本格式,否则会报错
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String, Object> maps;
    private List<Object> lists;
    private  Dog dog;

    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

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

    public Boolean getBoss() {
        return boss;
    }

    public void setBoss(Boolean boss) {
        this.boss = boss;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getLists() {
        return lists;
    }

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }
}

代码中的:
@Validated//说明以下数据需要数据校验
@Email//lastName的值必须符合电子邮件的基本格式,否则会报错
这些在@Value中就不能被识别。。

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

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

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

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值