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

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

2022-06-09 432
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 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
目录
相关文章
喜欢猪猪
|
3天前
|
XML Java 开发者
Spring Boot开箱即用可插拔实现过程演练与原理剖析
【11月更文挑战第20天】Spring Boot是一个基于Spring框架的项目，其设计目的是简化Spring应用的初始搭建以及开发过程。Spring Boot通过提供约定优于配置的理念，减少了大量的XML配置和手动设置，使得开发者能够更专注于业务逻辑的实现。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理，并通过Java代码手写模拟Spring Boot的启动过程，为开发者提供一个全面的理解。
喜欢猪猪
10 0
喜欢猪猪
|
4天前
|
Java 开发者 微服务
手写模拟Spring Boot自动配置功能
【11月更文挑战第19天】随着微服务架构的兴起，Spring Boot作为一种快速开发框架，因其简化了Spring应用的初始搭建和开发过程，受到了广大开发者的青睐。自动配置作为Spring Boot的核心特性之一，大大减少了手动配置的工作量，提高了开发效率。
喜欢猪猪
19 0
龙大吉
|
1月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目，定义`Book`实体类、`BookRepository`接口和`BookService`服务类，最后实现`BookController`控制器来处理HTTP请求，展示了从基础环境搭建到API测试的完整过程。
龙大吉
42 4
龙大吉
|
28天前
|
Java API 数据库
Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐
本文通过在线图书管理系统案例，详细介绍如何使用Spring Boot构建RESTful API。从项目基础环境搭建、实体类与数据访问层定义，到业务逻辑实现和控制器编写，逐步展示了Spring Boot的简洁配置和强大功能。最后，通过Postman测试API，并介绍了如何添加安全性和异常处理，确保API的稳定性和安全性。
龙大吉
35 0
聚优云惠
|
8天前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
聚优云惠
19 2
SpringBoot入门(7)- 配置热部署devtools工具
WangBai
|
7天前
|
Java Spring
SpringBoot自动装配的原理
在Spring Boot项目中，启动引导类通常使用`@SpringBootApplication`注解。该注解集成了`@SpringBootConfiguration`、`@ComponentScan`和`@EnableAutoConfiguration`三个注解，分别用于标记配置类、开启组件扫描和启用自动配置。
WangBai
42 17
刘大猫.
|
7天前
|
Java 数据库连接
SpringBoot配置多数据源实战
第四届光学与机器视觉国际学术会议(ICOMV 2025) 2025 4th International Conference on Optics and Machine Vision
刘大猫.
33 8
蓝易云
|
4天前
|
Java 数据库连接 数据库
springboot启动配置文件-bootstrap.yml常用基本配置
以上是一些常用的基本配置项，在实际应用中可能会根据需求有所变化。通过合理配置 `bootstrap.yml`文件，可以确保应用程序在启动阶段加载正确的配置，并顺利启动运行。
蓝易云
11 2
刘大猫.
|
16天前
|
Java Spring 容器
SpringBoot读取配置文件的6种方式，包括：通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式，包括：通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
刘大猫.
43 3
iamzfh
|
27天前
|
druid Java Maven
SpringBoot3.3.4配置Druid出现版本问题，导致后面属性爆红
【10月更文挑战第8天】
iamzfh
67 8

热门文章

最新文章

  • 1
    SpringBoot开发案例之整合Dubbo提供者(一)
  • 2
    保姆级教程——将springboot项目部署到阿里云服务器包含环境配置（小白包会）
  • 3
    springboot--SpringDataJPA生成表 crud数据
  • 4
    基于springboot的校园二手交易平台(程序+数据库+文档)
  • 5
    SpringBoot 集成cas5.3 实现自定义认证策略
  • 6
    SpringBoot升级到3.0
  • 7
    SpringBoot启动类的扫描注解的用法及冲突原则
  • 8
    最新版 springboot集成kafka
  • 9
    小白救星-SpringBoot最简教程05: 多环境切换
  • 10
    SpringBoot（四）：Spring常用注解
  • 1
    Spring cloud原理详解
    65
  • 2
    【JAVA进阶篇教学】第七篇：Spring中常用注解
    252
  • 3
    深入理解Spring Boot配置绑定及其实战应用
    69
  • 4
    深入理解Spring Boot启动流程及其实战应用
    190
  • 5
    Spring状态机的实现原理和业务场景
    153
  • 6
    在IntelliJ IDEA中通过Spring Boot集成达梦数据库：从入门到精通
    1401
  • 7
    Spring 事务
    47
  • 8
    Spring基础 SpringAOP
    43
  • 9
    使用Spring框架加速Java开发
    92
  • 10
    Spring日志框架
    43

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）
  • SpringBoot实战教程
  • SpringBoot快速掌握 - 核心技术
  • SpringBoot快速掌握 - 高级应用
  • Springboot项目云开发快速迁移
  • Spring Boot+Vue.js+FastDFS实现分布式图片服务器

    • 相关电子书

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

    • 相关实验场景

    更多
  • YML配置文件的常用属性
  • 从零搭建Spring Boot的Hello World
    • 下一篇
    阿里云OSS设置跨域访问