SpringBoot（配置绑定）

65 阅读 0 评论 43 点赞

我是靠谱客的博主美好秀发，最近开发中收集的这篇文章主要介绍SpringBoot（配置绑定），觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

所谓“配置绑定”就是把配置文件中的值与 JavaBean 中对应的属性进行绑定。通常，我们会把一些配置信息（例如，数据库配置）放在配置文件中，然后通过 Java 代码去读取该配置文件，并且把配置文件中指定的配置封装到 JavaBean（实体类）中。

SpringBoot 提供了以下 2 种方式进行配置绑定：

使用 @ConfigurationProperties 注解
使用 @Value 注解

@ConfigurationProperties

将配置文件中配置的每一个属性的值，映射到这个组件中，告诉springboot将本类中所有的属性和配置文件中相关的配置进行绑定

注意：

只有在容器中的组件，才会拥有 SpringBoot 提供的强大功能。如果我们想要使用 @ConfigurationProperties 注解进行配置绑定，那么首先就要保证该对 JavaBean 对象在 IoC 容器中，所以需要用到 @Component 注解来添加组件到容器中。
参数 prefix = "person"：将配置文件中的person下面的所有属性一一对应

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

@Component //注册bean
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

    public Person(String name, Integer age, Boolean happy, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
        this.name = name;
        this.age = age;
        this.happy = happy;
        this.birth = birth;
        this.maps = maps;
        this.lists = lists;
        this.dog = dog;
    }

    public Person() {
    }

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

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

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

    public Boolean getHappy() {
        return happy;
    }

    public void setHappy(Boolean happy) {
        this.happy = happy;
    }

    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;
    }
}

配置文件除了yml还有properties， properties配置文件在写中文的时候，会乱码，需要将IDEA中设置编码格式为UTF-8（settings-->FileEncodeings）

@Value

当我们只需要读取配置文件中的某一个配置时，可以通过 @Value 注解获取。

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

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

@Component
public class Person {
    @Value("${person.lastName}")
    private String lastName;
    @Value("${person.age}")
    private Integer age;
    @Value("${person.boss}")
    private Boolean boss;
    @Value("${person.birth}")
    private Date birth;

    private Map<String, Object> maps;
    private List<Object> lists;
    private Dog dog;

    public Person() {

    }

    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;
    }

    public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
        this.lastName = lastName;
        this.age = age;
        this.boss = boss;
        this.birth = birth;
        this.maps = maps;
        this.lists = lists;
        this.dog = dog;
    }

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

@Value 与 @ConfigurationProperties 对比

@Value 和 @ConfigurationProperties 注解都能读取配置文件中的属性值并绑定到 JavaBean 中，但两者存在以下不同。

1. 使用位置不同

@ConfigurationProperties：标注在 JavaBean 的类名上；
@Value：标注在 JavaBean 的属性上。

2. 功能不同

@ConfigurationProperties：用于批量绑定配置文件中的配置；（只需要写一次）
@Value：只能一个一个的指定需要绑定的配置。（需要每个字段都添加）

3. 松散绑定支持不同

@ConfigurationProperties：支持松散绑定（松散语法），例如实体类 Person 中有一个属性为 lastName，那么配置文件中的属性名支持以下写法：

person.firstName
person.first-name
person.first_name
PERSON_FIRST_NAME

@Vaule：不支持松散绑定。

4. SpEL 支持不同

@ConfigurationProperties：不支持 SpEL 表达式; 不支持JSR303数据校验
@Value：支持 SpEL 表达式。支持JSR303数据校验

5. 复杂类型封装

@ConfigurationProperties：支持所有类型数据的封装，例如 Map、List、Set、以及对象等；
@Value：只支持基本数据类型的封装，例如字符串、布尔值、整数等类型。

6. 应用场景不同

@Value 和 @ConfigurationProperties 两个注解之间，并没有明显的优劣之分，它们只是适合的应用场景不同而已。

若只是获取配置文件中的某项值，则推荐使用 @Value 注解；
若专门编写了一个 JavaBean 来和配置文件进行映射，则建议使用 @ConfigurationProperties 注解。

多环境配置及配置文件位置

配置文件能够创建的不同位置。
1.file:./config/【优先级最高】
2.file:./【优先级第二】
3.classpath:/config/【类路径下的config，优先级第三】
4.classpath:/【直接在类路径，优先级第四】
【类路径：java或者resources目录】

选择读取配置文件，多文件

新建三个文件：application.properties、application-test.properties【代表测试环境】、application-dev.properties【代表生产环境】
在application.properties文件，中spring.profiles.active，只需要加dev、或者test就可以读取不同的配置文件。

#springboot的多环境配置，可以选择任意激活那一个配置文件
spring.profiles.active=test

选择读取配置文件，单文件

单文件读取不同环境配置。

参考文章：Spring Boot配置绑定

JSR 303学习文章： JSR 303 注解及使用方法_Lycode-CSDN博客_jsr303注解

最后

以上就是美好秀发为你收集整理的SpringBoot（配置绑定）的全部内容，希望文章能够帮你解决SpringBoot（配置绑定）所遇到的程序开发问题。

如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。

本图文内容来源于网友提供，作为学习参考使用，或来自网络收集整理，版权属于原作者所有。

本文分类：spring boot
浏览次数：65 次浏览
发布日期：2024-08-27 19:05:01
本文链接：https://www.kaopuke.com/article/k-p-k_13_u_7_o_14_f0_14_j_18_0.html

Convert理解_第一弹：HttpMessageConverter,GenericConverter,Converter,Formatter一、 HttpMessageConverter二、GenericConverter Converter三、Formatter四、自定义转换器/格式化器五、Convert/Format机制与HttpMessageConverter的关系

SpringBoot（配置绑定）

概述

@ConfigurationProperties

@Value

@Value 与 @ConfigurationProperties 对比

多环境配置及配置文件位置

选择读取配置文件，多文件

选择读取配置文件，单文件

最后

评论列表共有 0 条评论

发表评论取消回复

SpringBoot（配置绑定）

概述

@ConfigurationProperties

@Value

@Value 与 @ConfigurationProperties 对比

多环境配置及配置文件位置

选择读取配置文件，多文件

选择读取配置文件，单文件

最后

相关文章

评论列表共有 0 条评论

发表评论 取消回复

发表评论取消回复