AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

SpringBoot的配置【配置文件、加载顺序、配置原理】（超详细）上

2022-06-09 565
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SpringBoot的配置【配置文件、加载顺序、配置原理】（超详细）

配置文件


SpringBoot使用一个全局的配置文件，配置文件名是固定的（application.properties或application.yml）。

配置文件的作用：修改SpringBoot自动配置的默认值，SpringBoot在底层都给我们自动配置好了。


以前的配置文件；大多都使用的是 xxxx.xml文件。

.yml是YAML语言的文件，以数据为中心，比json、xml等更适合作为配置文件。


配置例子:

YAML：


server:
  port: 8081

XML:


<server>
  <port>8081</port>
</server>

YAML语法


基本语法


使用缩进表示层级关系

缩进时不允许使用Tab键，只允许使用空格

缩进的空格数目不重要，只要相同层级的元素左侧对齐即可

大小写敏感

application.yml：


server:
  port: 8081
  path: /hello

值的写法


YAML 支持的三种数据结构：


字面量：单个的、不可再分的值

对象：键值对的集合

数组：一组按次序排列的值


字面量：普通的值（数字，字符串，布尔）


k: v：字面直接来写

字符串默认不用加上单引号或者双引号

“”：双引号：不会转义字符串里面的特殊字符

特殊字符会作为本身想表示的意思

name: "zhangsan \n lisi" 输出：zhangsan 换行 lisi

单引号：会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: 'zhangsan \n lisi' 输出：zhangsan \n lisi


对象、Map（属性和值）（键值对）


k: v 在下一行来写对象的属性和值的关系，注意缩进和空格。


对象还是k: v的方式


friends: 
  lastName: Keafmd
  age: 20

行内写法：


friends: {lastName: Keafmd,age: 18}

数组（List、Set）


用 - 值表示数组中的一个元素。


pets: 
  ‐ cat 
  ‐ dog 
  ‐ pig

行内写法：


pets: [cat,dog,pig]

配置文件值注入


代码演示

Person：


package com.keafmd.springboot.bean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * Keafmd
 *
 * @ClassName: Person
 * @Description:
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 12:47
 */
 /**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties :告诉SpringBoot将本类中的所有属性和配置文件相关的配置进行绑定
 * prefix = "person" ：配置文件中哪个属性进行一一映射
 *
 * 只有这个组件时容器中的组件吗，才能使用容器提供的功能
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birthday;
    private Map<String,Object> maps;
    private List<Object> lists;
    private 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 getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    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;
    }
    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birthday=" + birthday +
                ", maps=" + maps +
                ", lists=" + lists +
                ", dog=" + dog +
                '}';
    }
}

Dog：


package com.keafmd.springboot.bean;
/**
 * Keafmd
 *
 * @ClassName: Dog
 * @Description:
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 12:50
 */
public class Dog {
    private String name;
    private Integer age;
    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;
    }
    @Override
    public String toString() {
        return "Dog{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

application.yml：


person:
  lastName: Keafmd
  age: 18
  boss: false
  birthday: 2020/02/02
  maps: {k1: v1,k2: v2}
  lists:
    - lisi
    - zhaoliu
    - Keafmd
    - xiaolan
  dog:
    name: 二狗
    age: 2

测试代码：


package com.keafmd.springboot;
import com.keafmd.springboot.bean.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
/**
 * SpringBoot单元测试
 * 可以再测试期间很方便的类似编码一样进行自动注入等容器
 */
@SpringBootTest
class SpringBoot02ConfigApplicationTests {
    @Autowired
    Person person;
    @Test
    public void contextLoads() {
        System.out.println(person);
    }
}

运行结果：


Person{lastName='Keafmd', age=18, boss=false, birthday=Sun Feb 02 00:00:00 CST 2020, maps={k1=v1, k2=v2}, lists=[lisi, zhaoliu, Keafmd, xiaolan], dog=Dog{name='二狗', age=2}}

导入配置文件处理器，使编写配置有提示


注意：我们可以在pom.xml中导入配置文件处理器，以后编写配置就有提示了。


<!--导入配置文件处理器，配置文件进行绑定就会有提示-->
<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-configuration-processor</artifactId>
     <optional>true</optional>
</dependency>

properties配置文件在idea中默认utf-8可能会乱码


把application.yml的person注释掉，在application.properties文件中进行编写。


application.properties：


# 配置person的值
person.last-name=张三
person.age=18
person.boss=false
person.birthday=2022/02/02
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=二狗
person.dog.age=3

我们再次运行测试代码会发现，会出现中文乱码的情况。


解决办法：

0.png

设置好再次运行测试代码

运行结果：


Person{lastName='张三', age=18, boss=false, birthday=Sun Feb 02 00:00:00 CST 2020, maps={k1=v1, k2=v2}, lists=[a, b, c], dog=Dog{name='二狗', age=3}}

@Value获取值和@ConfigurationProperties获取值比较

image.png

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

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

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


application.properties：


# 配置person的值
person.last-name=张三
person.age=18
person.boss=false
person.birthday=2022/02/02
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=二狗
person.dog.age=3

Person：（部分代码，get和set以及toString不展示了）


package com.keafmd.springboot.bean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * Keafmd
 *
 * @ClassName: Person
 * @Description:
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 12:47
 */
/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties :告诉SpringBoot将本类中的所有属性和配置文件相关的配置进行绑定
 * prefix = "person" ：配置文件中哪个属性进行一一映射
 *
 * 只有这个组件时容器中的组件吗，才能使用容器提供的功能
 */
@Component
//@ConfigurationProperties(prefix = "person")
public class Person {
    /**
     * <bean class = "Person">
     *     <property name = "lastName" value = "字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * </bean>
     */
    @Value("${person.last-name}")
    private String lastName;
    @Value("#{11*2}")
    private Integer age;
    @Value("true")
    private Boolean boss;
    private Date birthday;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

运行测试代码的运行结果：


Person{lastName='张三', age=22, boss=true, birthday=null, maps=null, lists=null, dog=null}

属性名匹配规则（Relaxed binding）


– person.firstName：使用标准方式

– person.first-name：大写用-

– person.first_name：大写用_

– PERSON_FIRST_NAME：

• 推荐系统属性使用这种写法


配置文件注入值数据校验


@Value 不支持数据校验。


需要先在pom.xml引入校验的依赖：


<!--引入校验-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

Person：（部分代码，get和set以及toString不展示了）


package com.keafmd.springboot.bean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * Keafmd
 *
 * @ClassName: Person
 * @Description:
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 12:47
 */
/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties :告诉SpringBoot将本类中的所有属性和配置文件相关的配置进行绑定
 * prefix = "person" ：配置文件中哪个属性进行一一映射
 *
 * 只有这个组件时容器中的组件吗，才能使用容器提供的功能
 */
@Component
@ConfigurationProperties(prefix = "person")
@Validated //校验
public class Person {
    /**
     * <bean class = "Person">
     *     <property name = "lastName" value = "字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * </bean>
     */
    //@Value("${person.last-name}")
    //lastName必须是邮箱格式
    @Email
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;
    private Date birthday;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

运行测试类的结果：

11.png


@PropertySource&@ImportResource&@Bean


@PropertySource：加载指定的配置文件

person.properties：


person.last-name=Keafmd-person
person.age=18
person.boss=false
person.birthday=2022/02/02
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=二狗
person.dog.age=3

我们想加载这个配置文件的内容，就必须用 @PropertySource指定配置文件


package com.keafmd.springboot.bean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;
import javax.validation.constraints.Email;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * Keafmd
 *
 * @ClassName: Person
 * @Description:
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 12:47
 */
/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties :告诉SpringBoot将本类中的所有属性和配置文件相关的配置进行绑定
 * prefix = "person" ：配置文件中哪个属性进行一一映射
 *
 * 只有这个组件时容器中的组件吗，才能使用容器提供的功能
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated //校验
public class Person {
    /**
     * <bean class = "Person">
     *     <property name = "lastName" value = "字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * </bean>
     */
    //@Value("${person.last-name}")
    //lastName必须是邮箱格式
    //@Email
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;
    private Date birthday;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

运行测试类的测试结果：


Person{lastName='Keafmd-person', age=18, boss=false, birthday=Wed Feb 02 00:00:00 CST 2022, maps={k1=v1, k2=v2}, lists=[a, b, c], dog=Dog{name='二狗', age=3}}

注意：需要把application.properties和application.yml里的person注释掉。


@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效，使用@Bean给容器中添加组件


Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别。

如果想让Spring的配置文件生效，加载进来，需要把@ImportResource标注在一个配置类上。


@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效

创建一个Spring的配置文件beans.xml：


<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    <bean id="helloService" class="com.keafmd.springboot.service.HelloService">
    </bean>
</beans>

创建一个helloService：


package com.keafmd.springboot.service;
/**
 * Keafmd
 *
 * @ClassName: HelloService
 * @Description:
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 15:59
 */
public class HelloService {
}

先测试下容器中有没有helloService：


package com.keafmd.springboot;
import com.keafmd.springboot.bean.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
/**
 * SpringBoot单元测试
 * 可以再测试期间很方便的类似编码一样进行自动注入等容器
 */
@SpringBootTest
class SpringBoot02ConfigApplicationTests {
    @Autowired
    Person person;
    @Autowired
    ApplicationContext ioc;
    @Test
    public void testHelloService(){
        Boolean b = ioc.containsBean("helloService");
        System.out.println(b);
    }
    @Test
    public void contextLoads() {
        System.out.println(person);
    }
}

运行testHelloService的测试结果：


false

此时说明配置文件并没有生效。


我们把@ImportResource标注在主配置类上。


SpringBoot02ConfigApplication ：


package com.keafmd.springboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;
@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
public class SpringBoot02ConfigApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBoot02ConfigApplication.class, args);
    }
}

再次运行测试方法：


true


00.png

但是在实际开发中我们会采用一种更合适的方法，SpringBoot推荐给容器中添加组件的方式是推荐使用全注解的方式。接下来把@ImportResource(locations = {"classpath:beans.xml"})注释掉，创建一个配置类MyAppConfig 。


1、创建配置类，使用 @Configuration ------>Spring配置文件

2、使用 @Bean给容器中添加组件


==MyAppConfig： ==


package com.keafmd.springboot.config;
import com.keafmd.springboot.service.HelloService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
 * Keafmd
 *
 * @ClassName: MyAppConfig
 * @Description: 配置类
 * @author: 牛哄哄的柯南
 * @date: 2021-02-23 16:06
 */
/**
 * @Configuration: 指明当前类是配置类,替代之前的Spring配置文件
 * 在配置文件中用<bean></bean>标签添加组件
 */
@Configuration
public class MyAppConfig {
    //将方法的返回值添加到容器中，容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService(){
        System.out.println("配置类@Bean给容器添加组件了。。。");
        return new HelloService();
    }
}

再次运行测试方法：

112.png



文章标签：
Java
容器
搜索推荐
Spring
数据格式
JSON
XML
关键词：
spring Boot配置原理
Spring Boot配置文件原理
Spring Boot原理
Spring Boot配置配置文件
spring Boot配置加载顺序
牛哄哄的柯南8151
目录
相关文章
爱吃烤鸡翅的酸菜鱼
|
1月前
|
人工智能 Java 开发者
【Spring】原理解析：Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念，自动检测项目依赖并根据这些依赖自动装配相应的Bean，从而解放开发者从繁琐的配置工作中解脱出来，专注于业务逻辑实现。
爱吃烤鸡翅的酸菜鱼
678 0
星兽
|
3月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解，它通过@Import导入配置选择器，加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories，改用新格式的.imports文件进行配置。
星兽
783 0
星兽
|
3月前
|
Java Spring
Spring Boot配置的优先级？
在Spring Boot项目中，配置可通过配置文件和外部配置实现。支持的配置文件包括application.properties、application.yml和application.yaml，优先级依次降低。外部配置常用方式有Java系统属性（如-Dserver.port=9001）和命令行参数（如--server.port=10010），其中命令行参数优先级高于系统属性。整体优先级顺序为：命令行参数 &gt; Java系统属性 &gt; application.properties &gt; application.yml &gt; application.yaml。
星兽
689 0
凉凉心.
|
10天前
|
JavaScript Java Maven
【SpringBoot（二）】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理！
SpringBoot专栏第二章，从本章开始正式进入SpringBoot的WEB阶段开发，本章先带你认识yaml配置文件和资源的路径配置原理，以方便在后面的文章中打下基础
凉凉心.
126 3
凉凉心.
|
10天前
|
XML Java 应用服务中间件
【SpringBoot（一）】Spring的认知、容器功能讲解与自动装配原理的入门，带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章，讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门，还有其他常用的Springboot注解！如果想要了解SpringBoot，那么就进来看看吧！
凉凉心.
121 2
云流雨洄
|
1月前
|
缓存 Java 应用服务中间件
Spring Boot配置优化：Tomcat+数据库+缓存+日志，全场景教程
本文详解Spring Boot十大核心配置优化技巧，涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置，结合代码示例与通俗解释，助你轻松掌握高并发场景下的性能调优方法，适用于实际项目落地。
云流雨洄
280 4
HELLO程序员
|
1月前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载，提升应用的灵活性与可配置性。本文深入解析其用法与优势，并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
HELLO程序员
107 0
探索Spring Boot的@Conditional注解的上下文配置
蓝易云
|
2月前
|
安全 算法 Java
在Spring Boot中应用Jasypt以加密配置信息。
通过以上步骤，可以在Spring Boot应用中有效地利用Jasypt对配置信息进行加密，这样即使配置文件被泄露，其中的敏感信息也不会直接暴露给攻击者。这是一种在不牺牲操作复杂度的情况下提升应用安全性的简便方法。
蓝易云
784 10
dx3g7i7yqefri
|
Java 应用服务中间件 Maven
传统maven项目和现在spring boot项目的区别
Spring Boot：传统 Web 项目与采用 Spring Boot 项目区别
dx3g7i7yqefri
667 0
传统maven项目和现在spring boot项目的区别
TwcatL_tree
|
XML Java 数据库连接
创建springboot项目的基本流程——以宠物类别为例
创建springboot项目的基本流程——以宠物类别为例
TwcatL_tree
220 0
创建springboot项目的基本流程——以宠物类别为例

热门文章

最新文章

  • 1
    SpringBoot集成RocketMq
  • 2
    SpringBoot整合MQTT实战：基于EMQX实现双向设备通信
  • 3
    基于springboot的美食文化和旅游推广系统
  • 4
    基于springboot的大学公文收发管理系统
  • 5
    基于springboot的考研互助小程序
  • 6
    SpringBoot接口安全：限流、重放攻击、签名机制分析
  • 7
    SpringBoot从0-1集成Graalvm
  • 8
    基于springboot的母婴健康交流系统
  • 9
    基于springboot的摄影器材租赁回收系统
  • 10
    基于springboot的健康饮食营养管理系统
  • 1
    Spring AOP 简介
    121
  • 2
    springboot+vue垃圾分类网站（源码+文档）
    246
  • 3
    springboot+jsp商务安全邮箱（源码+文档）
    86
  • 4
    springboot+vue点餐平台网站(java源码+文档)
    96
  • 5
    springboot+vue在线动漫信息平台（源码+文档）
    262
  • 6
    springboot+vue幼儿园管理系统（源码+文档）
    322
  • 7
    springboot+vue影城管理系统（源码+文档）
    142
  • 8
    springboot+vue学生毕业离校系统（源码+说明文档）
    102
  • 9
    springboot+vue人职匹配推荐系统（源码+文档）
    175
  • 10
    springboot+vue论坛管理系统（源码+文档）
    325

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移

    • 相关电子书

    更多
  • 云栖社区特邀专家徐雷Java Spring Boot开发实战系列课程（第20讲）：经典面试题与阿里等名企内部招聘求职面试技巧
  • 微服务架构模式与原理Spring Cloud开发实战
  • 阿里特邀专家徐雷Java Spring Boot开发实战系列课程（第18讲）：制作Java Docker镜像与推送到DockerHub和阿里云Docker仓库
    • 下一篇
    阿里云无影云电脑免费使用_免费申请教程