Spring boot 文件配置详解及使用

作者: 程序媛马小兮 | 来源:发表于2019-11-12 19:55 被阅读0次

    Spring Boot 是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。SpringBoot通过集成大量的框架使得依赖包的版本冲突,以及引用的不稳定性等问题得到了很好的解决。

    1.Spring Boot配置文件

    当我们构建完Spring Boot项目后,会在resources目录下给我们一个默认的全局配置文件 application.properties,这是一个空文件,因为Spring Boot在底层已经把配置都给我们自动配置好了,当在配置文件进行配置时,会修改SpringBoot自动配置的默认值。

    配置文件名是固定的

    application.properties

    但我们可以修改为

    application.yml

    这两个文件本质是一样的,区别只是其中的语法略微不同。

    Properties简介

    properties文件大家经常用,这里就简单介绍一下。其语法结构形如:key=value。注意中文乱码问题,需要转码成ASCII。具体如下所示:

    userinfo.account=itdragonBlog

    userinfo.age=25

    userinfo.active=true

    userinfo.created-date=2018/03/31 16:54:30

    userinfo.map.k1=v1

    userinfo.map.k2=v2

    userinfo.list=one,two,three

    userinfo.position.name=Java架构师

    userinfo.position.salary=19999.99

    从配置文件中取值注入到实体类中,和YAML是一样的。

    import org.springframework.boot.context.properties.ConfigurationProperties;

    import org.springframework.stereotype.Component;

    import java.util.Date;

    import java.util.List;

    import java.util.Map;

    /**

    * 用户信息

    * @ConfigurationProperties : 被修饰类中的所有属性会和配置文件中的指定值(该值通过prefix找到)进行绑定

    */

    @Component

    @ConfigurationProperties(prefix = "userinfo")

    public class UserInfo {

    private String account;

    private Integer age;

    private Boolean active;

    private Date createdDate;

    private Map map;

    private List list;

    private Position position;

    // 省略getter,setter,toString方法

    }

    2.值的写法

    application.properties 配置文件比较简单,形式如下

    key = value

    application.yml 配置文件使用YMAL语言,YMAL不是如XML般的标记语言,更适合作为配置文件。

    下面说下对于不同类型(字符串、数组)如何去规范书写。

    2.1 数字,字符串,布尔

    1、直接写

    name=zhangsan

    2、双引号

    不会转义字符串里面的特殊字符,特殊字符会作为本身想表示的意思

    name: "zhangsan \n lisi"

    输出:

    zhangsan

    lisi

    3、单引号

    会转义特殊字符,特殊字符最终只是一个普通的字符串数据

    name: ‘zhangsan \n lisi’

    输出:

    zhangsan \n lisi

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

    例如配置类中的字段为

    Map maps;

    yml配置文件中,行内写法

    person.maps: {key1: value1,key2: value2}

    需要注意:号后的空格,或者

    person:

    maps:

    key: value

    properties配置文件中

    person.maps.key=value

    2.3 数组(List、Set)

    yml配置文件中

    person:

    list:

    - 1

    - 2

    - 3

    行内写法

    person:

    list: [1,2,3]

    properties配置文件中

    person.list[0]=1

    person.list[1]=2

    person.list[2]=3

    3.自定义配置属性

    Spring Boot提供自定义配置组件,拿前面举例的属性来写一个规范的配置文件

    @Component // 或者@Configuration

    @ConfigurationProperties(prefix = "person")

    public class Person {

    private Map maps;

    private List list;

    private String name;

    public Map getMaps() {

    return maps;

    }

    public void setMaps(Map maps) {

    this.maps = maps;

    }

    public List getList() {

    return list;

    }

    public void setList(List list) {

    this.list = list;

    }

    public String getName() {

    return name;

    }

    public void setName(String name) {

    this.name = name;

    }

    }

    @ConfigurationProperties 注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。

    prefix = "person":声明配置前戳,将该前戳下的所有属性进行映射。

    @Component 或者@Configuration:将该组件加入Spring Boot容器,只有这个组件是容器中的组件,配置才生效。

    4.自定义配置文件

    除了在默认的application文件进行属性配置,我们也可以自定义配置文件,例如新建 peoson.properties ,配置内容如下

    person.mail=yster@foxmail.com

    然后在配置类中使用@PropertySource注解注入该配置文件

    @Configuration

    @ConfigurationProperties(prefix = "person")

    @PropertySource(value = "classpath:person.properties")

    public class Person {

    private String mail;

    public String getMail() {

    return mail;

    }

    public void setMail(String mail) {

    this.mail = mail;

    }

    }

    测试@PropertySource注解不支持注入yml文件。

    扩展:@ImportResource:该注解导入Spring的xml配置文件,让配置文件里面的内容生效。例如:@ImportResource(locations = {"classpath:beans.xml"})

    5.多配置文件

    5.1 多Profile文件

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

    默认使用application.properties的配置

    5.2 yml支持多文档块方式

    通过---可以把一个yml文档分割为多个,并可以通过 spring.profiles.active 属性指定使用哪个配置文件

    server:

    port: 8081

    spring:

    profiles:

    active: prod #指定使用哪个环境

    ---

    server:

    port: 8083

    spring:

    profiles: dev #指定属于哪个环境

    ---

    server:

    port: 8084

    spring:

    profiles: prod #指定属于哪个环境

    5.3 激活指定profile

    无论是使用上述多文档块的方式,还是新建application-dev.yml文件,都可以在配置文件中指定 spring.profiles.active=dev 激活指定的profile,或者

    1、使用命令行:

    java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev

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

    2、虚拟机参数:

    -Dspring.profiles.active=dev

    6.配置文件加载位置

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

    –file:./config/

    –file:./

    –classpath:/config/

    –classpath:/

    优先级由高到底,高优先级的配置会覆盖低优先级的配置;SpringBoot会从这四个位置全部加载主配置文件。

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

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

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

    相关文章

      网友评论

        本文标题:Spring boot 文件配置详解及使用

        本文链接:https://www.haomeiwen.com/subject/zfaqictx.html