用了这么久的SpringBoot,是时候来弄清楚它的配置文件了

本文深入解析SpringBoot配置机制,涵盖配置文件格式、YAML语法、属性注入、环境配置及加载位置,助您掌握核心配置技巧。

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

1、配置文件

SpringBoot使用一个全局的配置文件,配置文件名是固定的

  • application.properties
  • application.yml

配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;
配置文件的位置:src/main/resources目录或者类路径/config下
   yml是YAML(YAML Ain’t Markup Language)语言的文件,以数据为中
心,比json、xml等更适合做配置文件
YAML(YAML Ain’t Markup Language):

  • YAML A Markup Language:是一个标记语言
  • YAML isn’t Markup Language:不是一个标记语言;

标记语言:
以前的配置文件;大多都使用的是 xxxx.xml文件;
YAML:以数据为中心,比json、xml等更适合做配置文件;
YAML:配置例子

server:
	port: 8081

XML:配置例子

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

properties:配置例子

server.port=8081

2、YAML语法

2.1、YAML基本语法

  • 使用缩进表示层级关系
  • 缩进时不允许使用Tab键,只允许使用空格。
  • 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
  • 大小写敏感

k:(空格)v :表示一对键值对(空格必须有);
空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的

server:
    port: 8081
    path: /hello

属性和值也是大小写敏感;

2.2、值的写法

2.2.1、 字面量

字面量是指所见即所得的普通值如:数字,字符串,布尔,此时使用k: v:字面直接来写;
   注意:字符串默认不用加上单引号或者双引号;

  • “”:双引号;转义字符会按照原有的含义,进行转义
    name: “zhangsan \n lisi”:输出;zhangsan 换行 lisi
  • ‘’:单引号;转义字符最终只是一个字面量的字符串数据
    name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi

2.2.2、对象、Map(属性和值)(键值对)

k: v:在下一行来写对象的属性和值的关系;注意缩进
对象还是k: v的方式

friends:
	lastName: zhangsan        
	age: 20

行内写法:

friends: {lastName: zhangsan,age: 18}

2.2.3、数组(List、Set):

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

pets:
 ‐ cat
 ‐ dog
 ‐ pig

行内写法

pets: [cat,dog,pig]

2.2.4、多类型组合表示:

javaBean:
在这里插入图片描述
yml表示:
在这里插入图片描述

3、配置文件@ConfigurationProperties 值注入

javaBean如下:

/**
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
 *      prefix = "person":配置文件中哪个下面的所有属性进行一一映射
 *		默认从全局配置文件中获取值
 *	
 * @Component:只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
 */
@Component
@ConfigurationProperties(prefix = "person")
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;

配置文件如下:

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      ‐ lisi
      ‐ zhaoliu
    dog:
      name: 小狗
      age: 12

要实现配置文件注入值时,可以导入如下配置文件处理器,以后编写配置就有提示了

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

4、配置文件@Value 值注入

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

在这里插入图片描述
松散绑定(松散语法)即不止有下面所诉的标准方式:
    属性名匹配规则(Relaxed binding)

  • person.firstName:使用标准方式
  • person.first-name:大写用-
  • person.first_name:大写用_
  • PERSON_FIRST_NAME:推荐系统属性使用这种写法

值注入方法小结:如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;
如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties;

5、@PropertySource&@ImportResource&@Bean

5.1、@PropertySource:加载指定的配置文件;

/**
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
 *      prefix = "person":配置文件中哪个下面的所有属性进行一一映射
 *
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值;
 *  @PropertySource可以获取指定的非全局配置文件的值
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")

5.2、@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;

Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上

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

不推荐自己编写如下Spring的配置文件:

<?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/beanshttp://www.springframework.org/schema/beans/spring‐beans.xsd">
       
    <bean id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
</beans>

5.3、@Bean:SpringBoot推荐使用的全注解方式

SpringBoot推荐给容器中添加组件的方式;推荐使用全注解的方式
1、配置类@Configuration------>Spring配置文件
2、使用@Bean给容器中添加组件

/**
 * @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {
    //将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

6、配置文件占位符

6.1、随机数

配置文件中可以使用随机数
r a n d o m . v a l u e 、 {random.value}、 random.value{random.int}、${random.long}
r a n d o m . i n t ( 10 ) 、 {random.int(10)}、 random.int(10){random.int[1024,65536]}

6.2、占位符获取之前配置的值,如果没有可以是用:指定默认值

  • 可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。
  • ${person.hello:默认值}来指定找不到属性时的默认值
person.last‐name=张三${random.uuid}
person.age=${random.int}
# 引用+默认值法
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

7、Profile对不同环境提供不同配置功能的支持

Profile是Spring对不同环境提供不同配置功能的支持,可以通过激活、
指定参数等方式快速切换环境

7.1、多Profile文件

格式:application-{profile}.properties/yml:
          • application-dev.properties、application-prod.properties
我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml
默认使用application.properties的配置;

7.2、多profile文档块模式:

yml支持多文档块方式,运用如下:

server:
  port: 8081
spring:
  profiles:
    active: prod
‐‐‐
server:
  port: 8083
spring:
  profiles: dev
‐‐‐
server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

7.3、激活方式:

  • 命令行 --spring.profiles.active=dev
  • 配置文件 spring.profiles.active=dev
  • jvm参数 –Dspring.profiles.active=dev

激活指定profile步骤
1、在配置文件中指定 spring.profiles.active=dev
2、命令行:
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;
可以直接在测试的时候,配置传入命令行参数
3、虚拟机参数;
-Dspring.profiles.active=dev

8、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文

–file:./config/
–file:./
–classpath:/config/
–classpath:/
优先级由高到底,高优先级的配置会覆盖低优先级的配置;从这四个位置全部加载主配置文件;互补配置;

springboot 启动会扫描以下位置的applicati全部加载主配置文件;互补配置;

9、配置文件乱码问题

依照下图调整
在这里插入图片描述

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值