【SpringBoot】配置相关

最新推荐文章于 2023-07-04 15:21:06 发布

编程芝士

最新推荐文章于 2023-07-04 15:21:06 发布

阅读量328

点赞数

分类专栏： SpringBoot

本文为博主原创文章，欢迎大家进行转载，转载时请在文章显著位置注明原文标题及链接，否则将追究其法律责任。邮箱：zzuliwenlong@126.com

本文链接：https://blog.csdn.net/zzu_seu/article/details/106477537

版权

SpringBoot 专栏收录该内容

8 篇文章 1 订阅

订阅专栏

1. 配置文件

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

application.properties
application.yml
application.yaml

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

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>

2.YAML语法：

1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；

以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
    port: 8081
    path: /hello

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

2、值的写法

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

k: v：字面直接来写；

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

“”：双引号；会将双引号字符串里面的特殊字符进行转义；

name: "zhangsan \n lisi"；

输出：

zhangsan 
 lisi

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

name: ‘zhangsan \n lisi’

输出：

zhangsan \n  lisi

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

k: v：在下一行来写对象的属性和值的关系；注意缩进

对象还是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

数组（List、Set）：

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

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

3、配置文件值注入

配置文件

application.yaml

server:
  port: 80

person:
  lastname: zhangsan
  age: 18
  boss: false
  birth: 2000/01/01
  maps: {key1: val1,k2: val2,key3: vels}
  list:
    - laoqi
    - zhaosi
  dog:
    name: papa
    age: 3

javaBean：

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@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;

我们可以导入配置文件处理器，以后编写配置就有提示了：

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

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

将配置文件由yaml改成properties：

调整后：

#配置person值
person.last-name=张三
person.age=18
person.birth=2020/01/02
person.boss=false
person.maps.key1=val1
person.maps.key2=val2
person.list=a,b,c
person.dog.name=papa
person.dog.age=3

在这里插入图片描述
解决方法：
在配置文件的最上方增加：

server.tomcat.uri-encoding=UTF-8

然后修改如下选项：
在这里插入图片描述

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

可以使用@Value代替@ConfigurationProperties：

@Component //加入容器
//@ConfigurationProperties(prefix = "person")
public class Person {
	//从配置文件中获取姓名
    @Value("${person.last-name}")
    private String lastName;
    @Value("#{22+1}")//将配置文件中的age值覆盖了
    private Integer age;
    @Value("true")
    private Boolean boss;
    @Value("2020/01/01")
    private Date birth;
    private Map<String, String> maps;
    private List<String> list;
    private Dog dog;
}

在这里插入图片描述

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

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

两种注解的选择：

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

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

3、配置文件注入值数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

   //lastName必须是邮箱格式
    @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

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

4、@PropertySource&@ImportResource&@Bean

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

注解的作用是加载指定的配置文件，值可以是数组，也就是可以加载多个配置文件。
因为所有的配置内容都写在全局配置文件红可能太大，所以可以将person类的配置单独写一个配置文件。
springboot默认加载的配置文件名是application，如果配置文件名不是这个是不会被容器加载的。

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;

person.properties

server.tomcat.uri-encoding=UTF-8

person.last-name=里斯
person.age=18
person.birth=2020/01/02
person.boss=false
person.maps.key1=val1
person.maps.key2=val2
person.list=a,b,c
person.dog.name=papa
person.dog.age=3

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

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

编写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/beans http://www.springframework.org/schema/beans/spring-beans.xsd">


        <bean id="helloService" class="com.lwl.springboot01_hello.service.HelloService"></bean>

</beans>

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

@ImportResource(locations = {"classpath=bean.xml"})
@SpringBootApplication
public class Springboot01HelloApplication {

    public static void main(String[] args) {
        SpringApplication.run(Springboot01HelloApplication.class, args);
    }

}

但是在实际开发中，给容器添加组件不使用上面的这种方法，也就是不会新建一个xml文件然后导入，而是这样：
SpringBoot推荐给容器中添加组件的方式：使用全注解的方式，也就是使用配置类。

1、编写配置类使用 @Configuration注解标明该类的功能与Spring配置文件一样。

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

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

4、配置文件占位符

随机数

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

占位符获取之前配置的值，如果没有可以使用:指定默认值

server:
  port: 80

person:
  lastname: 张三${random.uuid}
  age: ${random.int}
  boss: false
  birth: 2000/01/01
  maps: {key1: val1,k2: val2,key3: vels}
  list:
    - laoqi
    - zhaosi
  dog:
    name: ${person.lastname:lala}'s dog
    age: 3
    # 如果小狗的名字中没有获取到person.lastname，就使用lala作为person.lastname

在这里插入图片描述

5、Profile

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

多Profile文件

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml
例如：

application-dev.properties
application-prod.properties

在这里插入图片描述
启动后默认使用application.properties或application.yaml的配置，可以在主配置文件中指定激活哪个配置文件：

在这里插入图片描述

yml支持多文档块方式

每个文档块使用 --- 分割


server:
  port: 8081
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  profiles: dev


---

server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

在这里插入图片描述

激活指定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
在这里插入图片描述

6、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件，将会按照下面路径的顺序进行扫描：


file: ./config/

    file: ./

        classpath: /config/

            classpath: /        -->first load ↑

优先级由高到底，高优先级的配置会覆盖低优先级的配置(优先级低的先加载）；

SpringBoot会从这四个位置全部加载主配置文件，互补配置；
互补配置：低优先级中与高优先级不冲突的部分也会被配置进去。

加载顺序，后加载的配置会覆盖先加载的：
在这里插入图片描述

我们还可以通过spring.config.location来改变默认的配置文件位置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；

java -jar xxx.jar --spring.config.location=xxxx

项目根路径下的配置文件maven编译时不会打包过去，需要修改pom：

        <resources>
            <resource>
                <directory>.</directory>
                <filtering>true</filtering>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.yaml</include>
                </includes>
            </resource>
        </resources>

7、外部配置加载顺序

SpringBoot也可以从以下位置加载配置；优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置

1.命令行参数

所有的配置都可以在命令行上进行指定

java -jar xxxx.jar --server.port=8087 --server.context-path=/abc

多个配置用空格分开； --配置项=值

2.来自java:comp/env的JNDI属性

3.Java系统属性（System.getProperties()）

4.操作系统环境变量

5.RandomValuePropertySource配置的random.*属性值

== 由jar包外向jar包内进行寻找 ==

优先加载带profile

6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

再来加载不带profile

8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件

9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件

10.@Configuration注解类上的@PropertySource

11.通过SpringApplication.setDefaultProperties指定的默认属性

所有支持的配置加载来源；

参考官方文档

参考：SpringBoot笔记

编程芝士

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
打赏
0
评论
【SpringBoot】配置相关

配置文件SpringBoot使用一个全局的配置文件，配置文件名是固定的；application.propertiesapplication.ymlapplication.yaml配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好；YAML（YAML Ain’t Markup Language） YAML A Markup Language：是一个标记语言 YAML isn’t Markup Language：不是一
复制链接

扫一扫