【springboot笔记】二、配置文件

二、配置文件

1、配置文件

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

application.rpoperties

application.yml

配置文件的作用:修改Spring Boot自动配置的默认值;Spring Boot在底层都给我们配置好

yml是YAML(YAML Aint Markup Language)的缩写,一种专门用来写配置文件的语言,是一种标记语言。以前的配置文件,大多是xxxx.xml文件,yml以数据为中心,比json、xml更适合做配置文件

ymal:

server:
   port: 8080

xml:

<server>
   <port>8080></port>
</server>

2、YAML语法

1、基本语法

key: value 表示一对键值对(冒号后面必须有空格);以空格的缩进来控制层级关系;只要是左对齐的一列数据都是同一个层级的;属性和也是大小心敏感;

server:
    port: 8081
    path: /hello

2、值的写法

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

k: v 字面直接来写;

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

“”:双引号不会转义字符串里面的特殊字符,即特殊字符作为本身想表示的意思(\n输出为:换行)

‘’:单引号会转义特殊字符,最终只是一个普通的字符串输出(\n输出为:\n)

对象、Map(属性和值,即键值对)

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

   friends:
       lastName: zhangsan
       age: 20

行内写法

  friends:{lastName: zhangsan,age: 18}

数组(List、Set)

用短横线-、值表示数组中的一个元素

 pets:
   - cat
   - dog
   - piggy

行内写法

 pets:[cat,dog]

3、获取文件值注入

配置文件

person:
   lastName: zhangsan
   age: 20
   boss: false
   birth: 2017/12/12
   maps: {k1: v1,k2: 12}
   lists:
      - lisi
      - wangwu
   dog:
      name: 小狗
      age: 2

javaBean

//将配置文件中配置的每一个属性的值,映射到这个组件中
@ConfigurationProperties(prefix="person")    //告诉springboot将本类中所有属性和配置文件中相关的配置进行绑定,prefix表示将配置文件中哪个属性进行一一映射
@Component                                  //只有这个组件时容器中的组件,才能使用容器提供的功能
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>

ps:若输出的中文是乱码则设置将项目编码设为UTF-8

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

@Value

功能上:一个个指定

松散绑定(松散语法):不支持

SpEL(spring表达式语言):支持

JSP303数据校验:不支持

复杂类型封装:不支持

@ConfigurationProperties

功能上:批量注入配置文件中的属性

松散绑定(松散语法):

SpEL(spring表达式语言):不支持

JSP303数据校验:支持

复杂类型封装:支持

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

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

如果说,我们专门编写了JavaBean来和配置文件进行映射,使用@ConfigurationProperties

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

//将配置文件中配置的每一个属性的值,映射到这个组件中
@ConfigurationProperties(prefix="person")    //告诉springboot将本类中所有属性和配置文件中相关的配置进行绑定,prefix表示将配置文件中哪个属性进行一一映射
@Component                                   //只有这个组件是容器中的组件,才能使用容器提供的功能
@Validated                                   //数据校验
public class Person {

    //@Value("${person.last-name}")
    @Email//lastName必须是邮箱格式
    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

@propertySource:加载指定的配置文件

//将配置文件中配置的每一个属性的值,映射到这个组件中
//@ConfigurationProperties(prefix="person")    //告诉springboot将本类中所有属性和配置文件中相关的配置进行绑定,prefix表示将配置文件中哪个属性进行一一映射
@ConfigurationProperties(prefix="person")  //默认从全局配置文件中获取值
@Component                                   //只有这个组件是容器中的组件,才能使用容器提供的功能
//@Validated                                   //数据校验

@PropertySource(value = {"classpath:person.properties"})  //加载类路径下的内容
public class Person {

    //@Value("${person.last-name}")
    //@Email//lastName必须是邮箱格式
    private String lastName;
    private Integer age;
    //@Value("true")
    private Boolean boss;
    private Date birth;
    //@Value("${person.maps}")
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

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

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

想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上

@ImportResource(locations = {"classpath:beans.xml"})   //导入Spring的配置文件
@SpringBootApplication
public class SpringBoot02ConfigApplication {

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

}

现在不来编写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.squash.springboot.service.HelloService"></bean>
</beans>

SpringBoot推荐给容器添加组件的方式:推荐使用全注解的方式

  1. 配置类=====Spring配置文件

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

    /*

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

5、配置文件占位符

1、随机数

random.value

{random.int}

${random.long}

random.int(10)

{random.int[1024,65536]}

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

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

6、Profile

1、多profile文件

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

默认使用application.properties的配置

2、yml支持多文档块方式

port: 8080
spring:
  profiles:
    active: dev
---
server:
  port: 8083
spring:
  profiles: dev
---
server:
  port: 8084
spring:
  profiles: prod

3、激活指定profile

  1. 在配置文件中指定要激活的配置文件spring.profiles.active=dev

  2. 命令行:(cmd运行jar包是在java -jar jar包名 后输入命令

    –spring.profiles.active=dev

可以直接在测试的时候传入命令行参数

3、虚拟机参数:

 --DSpring.profiles.active=dev

7、配置文件加载位置

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

  • file:…/config/
  • file:…/
  • classpath:/config/
  • classpath:/

优先级由高到低,高优先级的配置会覆盖低优先级的配置;Spring Boot会从这四个位置全部加载主配置文件;会形成互补配置

我们也可以通过配置spring.config.location来改变默认配置文件位置,项目打包后,我们可以通过命令行参数的形式,启动项目的时候来指定配置文件的新位置,指定配置文件和默认加载的这些配置文件共同起作用形成互补配置

8、外部配置加载顺序

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

  1. 命令行参数

     java -jar  jar包名  --server.port=8081 --server.context-path=/abc
    
  2. 来自java:comp/env的JNDI属性

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

  4. 操作系统环境变量

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

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

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

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

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

  10. @Configuration注解类上的@PropertySource

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

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

9、自动配置原理

配置文件能配置的属性参照官方文档

自动配置原理:

  1. SpringBoot启动的时候加载主配置类,开启了自动配置功能**@EnableAutoConfigration**
  2. @EnableAutoConfigration作用:利用EnableAutoConfigrationImportSelector给容器导入一些组件,根据当前不同的条件判断,决定这个配置类是否生效;一旦这个配置类生效,这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties类中获取的,这些类里面的每一个属性又是和配置文件绑定的

SpringBoot精髓:

  1. SpringBoot启动会加载大量的自动配置类
  2. 我们看我们需要的功能有没有SpringBoot默认写好的自动配置类
  3. 我们再来看这个自动配置类到底配置了哪些组件(只要有我们要用的组件,我们就不需要再来配置了)
  4. 给容器中自动配置类添加组件的时候,会从properties中获取某些属性,我们就可以在配置文件中指定这些属性的值

xxxAutoConfigration:自动配置类,给容器中添加组件

xxxProperties:封装配置文件相关属性

自动配置类必须在一定条件下才能生效,我们可以通过启用debug=true属性,来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置类生效

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值