简述配置文件

SpringBoot使用一个全局的配置文件,配置文件名是固定的,也就是下面这两种:

  • application.properties
  • application.yml

作用:修改SpringBoot自动配置的默认值,SpringBoot在底层都给我们自动配置好。

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

YAML:以数据为中心,比json、xml等更适合做配置文件。

YAML:配置服务器端口

server:
port: 8081

XML: 配置服务器端口

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

YAML语法

基本语法

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

空格的缩进来控制层级关系。只要是左对齐的一列数据,都是同一个层级的,如下:

server:
  port: 8081
  path: /hello

属性和值也是大小写敏感

值的写法

字面量:普通的值(数字,字符串,布尔):

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]

配置文件的注入

配置文件

moti:
  student-name: 莫提
  boy: true
  birthday: 1999/07/29
  classes: [语文,数学,英语]
  family:
    father: xxx
    mother: yyy
  dog: {dogName: 汪汪汪,age: 2}

使用properties配置文件替换yml文件

# 使用.properties配置文件
moti.student-name=莫提
moti.birthday=1999/07/29
moti.classes=语文,数学,英语
moti.boy=true
moti.family.father=xxx
moti.family.mother=yyy
moti.dog.dogName=汪汪汪
moti.dog.age=2

JavaBean

/**
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
 *      prefix = "person":配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
 *
 */
@Component
@ConfigurationProperties(prefix = "moti")
public class Student {
    //字符串类型
    private String studentName;
    //布尔类型
    private boolean isBoy;
    //日期类型
    private Date birthday;
    //数组类型
    private String[] classes;
    //Map类型
    private Map<String,String> family;
    //引用类型
    private Dog dog;

   ...
   get和set方法,toString方法

导入配置文件处理器,以后编写配置就有提示了

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

效果

Student{studentName='莫提', isBoy=true, birthday=Thu Jul 29 00:00:00 CST 1999, classes=[语文, 数学, 英语], family={father=xxx, mother=yyy}, dog=Dog{dogName='汪汪汪', age=2}}

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

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

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

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

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

配置文件注入值数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //lastName必须是邮箱格式
    @Email
    private String lastName;

    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

@PropertySource

作用: 加载指定的配置文件,缓解全局配置文件的压力

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {
    //lastName必须是邮箱格式
    @Email
    private String lastName;

    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

@ImportResource

作用: 导入Spring的配置文件,让配置文件里面的内容生效

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

@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
@ImportResource(locations = {"classpath:beans.xml"})
public class SpringBootConfigApplication {

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

}

beans.xml:位于resources文件夹下

<?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="dog" class="com.moti.springbootconfig.domain.Dog"></bean>

</beans>

SpringBoot推荐给容器中添加组件的方式;推荐使用全注解的方式替换上述beans.xml

  1. 配置类@Configuration——>Spring配置文件
  2. 使用@Bean给容器中添加组件
/**
 * 指明当前类是一个配置类;就是来替代之前的Spring配置文件
 */
@Configuration
public class BeanConfiguration {

    /**
     * 将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
     * @return
     */
    @Bean
    public Dog dogBean(){
        return new Dog();
    }
}

测试方法

@SpringBootTest
class SpringBootConfigApplicationTests {

    @Autowired
    Student student;

    @Autowired
    ApplicationContext ioc;
    @Test
    void contextLoads() {
        System.out.println(student);
    }

    @Test
    void test(){
        boolean result = ioc.containsBean("dogBean");
        System.out.println(result);
    }
}

随机数

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

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

 person.last-name=张三${random.uuid}
 person.age=${random.int}
 person.birth=2017/12/15
 person.boss=false
 person.maps.k1=v1
 person.maps.k2=14
 person.lists=a,b,c
 person.dog.name=${person.hello:hello}_dog
 person.dog.age=15

Profile

1、多Profile文件

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

默认使用application.properties的配置;

2、yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: prod #激活哪个文档块
​
---
server:
  port: 8083
spring:
  profiles: dev

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

3、激活指定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

配置文件加载位置

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

优先级由高到底,高优先级的配置会覆盖低优先级的配置;

SpringBoot会从这四个位置全部加载主配置文件;互补配置

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

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

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

外部配置加载顺序

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

1.命令行参数

所有的配置都可以在命令行上进行指定, 多个配置用空格分开; –配置项=值

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.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指定的默认属性

所有支持的配置加载来源,参考官方文档

Spring Boot 自动配置



配置文件到底能写什么?怎么写?配置文件能配置的属性参照

SpringBoot启动的时候加载主配置类,开启了自动配置功能@EnableAutoConfiguration

精髓:

1)、SpringBoot启动会加载大量的自动配置类

2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;

3)、我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)

4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值;

xxxxAutoConfigurartion:自动配置类;

给容器中添加组件

xxxxProperties:封装配置文件中相关属性

细节:

@Conditional派生注解(Spring注解版原生的@Conditional作用)

作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;

@Conditional扩展注解作用(判断是否满足当前指定条件)
@ConditionalOnJava系统的java版本是否符合要求
@ConditionalOnBean容器中存在指定Bean;
@ConditionalOnMissingBean容器中不存在指定Bean;
@ConditionalOnExpression满足SpEL表达式指定
@ConditionalOnClass系统中有指定的类
@ConditionalOnMissingClass系统中没有指定的类
@ConditionalOnSingleCandidate容器中只有一个指定的Bean,或者这个Bean是首选Bean
@ConditionalOnProperty系统中指定的属性是否有指定的值
@ConditionalOnResource类路径下是否存在指定资源文件
@ConditionalOnWebApplication当前是web环境
@ConditionalOnNotWebApplication当前不是web环境
@ConditionalOnJndiJNDI存在指定项

自动配置类必须在一定的条件下才能生效;

我们怎么知道哪些自动配置类生效;

==我们可以通过启用 debug=true属性;来让控制台打印自动配置报告==,这样我们就可以很方便的知道哪些自动配置类生效;

=========================
AUTO-CONFIGURATION REPORT
=========================


Positive matches:(自动配置类启用的)
-----------------

  DispatcherServletAutoConfiguration matched:
     - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
     - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
       
   
Negative matches:(没有启动,没有匹配成功的自动配置类)
-----------------

  ActiveMQAutoConfiguration:
     Did not match:
        - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

  AopAutoConfiguration:
     Did not match:
        - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)
       
最后修改日期:2020-07-13

作者

留言

撰写回覆或留言

发布留言必须填写的电子邮件地址不会公开。