美文网首页
SpringBoot的常用配置

SpringBoot的常用配置

作者: david161 | 来源:发表于2022-06-09 15:28 被阅读0次

    application.properties配置文件

    ֵ使用Spring Initializ方式构建Spring Boot项目时,会在resource目录下自动生成一个空的application.properties文件。 Spring Boot项目启动时会自动加载application.properties文件。
    我们可以在application.properties文件中定义Spring Boot项目的相关属性,当然,这些相关属性可以是系统属性、环境变量、命令参数等信息,也可以是自定义配置文件名称和位置。

    server.port=8081
    spring.datasource.driver-class-name=com.mysql.jdbc.Driver
    spring.config.additional-location=
    spring.config.location=
    spring.config.name=application
    

    这里通过一个案例来了解application.properties配置文件:

    两个实体类实现

    我们在com.david包下面创建pojo包,并在改包下创建两个实体类Pet和Person。
    Person类实现
    @ConfigurationProperties(prefix = "person")注解的作用是将配置文件中以 person开头的属性值通过setXX()方法注入到实体类对应属性中
    @Component注解的作用是将当前注入属性值的Person类对象作为Bean组件放到Spring容器中,只有这样才能被@ConfigurationProperties注解进行赋值

    package com.david.pojo;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    import java.util.Arrays;
    import java.util.List;
    import java.util.Map;
    
    @Component
    @ConfigurationProperties(prefix = "person") //将配置文件中以person开头的属性注入到该类中
    public class Person {
    
    
        private int id;            //id
        private String name;      //名称
        private List hobby;       //爱好
        private String[] family; //家庭成员
        private Map map;
        private Pet pet;          //宠物
    
        @Override
        public String toString() {
            return "Person{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    ", hobby=" + hobby +
                    ", family=" + Arrays.toString(family) +
                    ", map=" + map +
                    ", pet=" + pet +
                    '}';
        }
    
        public int getId() {
            return id;
        }
    
        public void setId(int id) {
            this.id = id;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public List getHobby() {
            return hobby;
        }
    
        public void setHobby(List hobby) {
            this.hobby = hobby;
        }
    
        public String[] getFamily() {
            return family;
        }
    
        public void setFamily(String[] family) {
            this.family = family;
        }
    
        public Map getMap() {
            return map;
        }
    
        public void setMap(Map map) {
            this.map = map;
        }
    
        public Pet getPet() {
            return pet;
        }
    
        public void setPet(Pet pet) {
            this.pet = pet;
        }
    }
    

    Pet类实现

    package com.david.pojo;
    
    public class Pet {
    
        private String type; //类型
        private String name; //名字
    
        @Override
        public String toString() {
            return "Pet{" +
                    "type='" + type + '\'' +
                    ", name='" + name + '\'' +
                    '}';
        }
    
        public String getType() {
            return type;
        }
    
        public void setType(String type) {
            this.type = type;
        }
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    }
    

    在application.properties配置文件中,添加对Person类属性的配置

    person.id=1
    person.name=tom
    person.hobby=吃饭,睡觉,打豆豆
    person.family=father,mother
    person.map.k1=v1
    person.map.k2=v2
    person.pet.type=dog
    person.pet.name=旺财
    

    编写application.properties配置文件时,由于要配置的Person对象属性是我们自定义的,SpringBoot无法自动识别,所以不会有任何书写提示。
    在实际开发中,为了出现代码提示的效果方便配置,在使用@ConfigurationProperties注解进行配置文件属性值注入时,可以在pom.xml文件中添加一个SpringBoot提供的配置处理器依赖:

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

    在pom.xml中添加上述配置依赖后,需要重新启动才能生效。

    application.yaml配置文件

    yaml文件语法简介

    YAML文件格式是Spring Boot支持的一种JSON超集文件格式,相较于传统的Properties配置文件,YAML文件以数据为核心,是一种更为直观且容易被电脑识别的数据序列化格式。application.yml配置文件的工作原理和application.properties是一样的,只不过yaml格式配置文件看起来更简洁一些。
    1)YAML文件的扩展名可以使用.yml或者.yaml。
    2)application.yml文件使用"key:(空格) value"格式配置属性,使用缩进控制层级关系
    这里,针对不同数据类型的类型值,介绍一下YAML
    1)value值为普通数据类型(例如数字、字符串、布尔等)
    当YAML配置文件中配置的属性值为普通数据类型时,可用直接配置对应的属性值,同时对应字符串类型的属性值,不需要额外添加引号,示例代码如下:

    server:
     port: 8081
     path: /hello
    

    上述代码用于配置server的port和path属性,port和path属于一个级别
    2)value值为数组或单列集合类型时,主要有两种书写方式:缩进式写法和行内式写法。
    其中缩进式写法还有两种表示形式,示例代码如下:

    person:
      hobby:
        - play
        - read
        - sleep
    

    或者使用如下示例形式:

    person:
      hobby:
        play,
        read,
        sleep
    

    上述代码中,在YAML配置文件中通过两种缩进式写法对person对象的单列集合(或数组)类型的爱好hobby赋值为play,read和sleep。其中一种形式为"-(空格)属性值",另一种形式为多个属性值之前加英文逗号分隔

    person:
      hobby: [play,read,sleep]
    

    通过上述示例对比发现,YAML配置文件的行内式写法更加简明、方便。另外,包含属性值的中括号"[]"还可以进一步省略,在进行属性值赋值时,程序会自动匹配和校对。
    3)value值为Map集合和对象
    当YAML配置文件中配置的属性值为Map集合或对象类型时,YAML配置文件格式同样可以分为两种书写方式,缩进式写法和行内式写法。
    其中,缩进式写法的示例代码如下:

    person:
      map:
        k1: v1
        k2: v2
    

    对应的行内式写法示例代码如下:

    person:
      map: {k1: v1,k2: v2}
    

    在YAML配置文件中,配置的属性值为Map集合或对象类型时,缩进式写法的形式按照YAML文件格式编写即可,而行内式写法的属性值要用大括号"{}"包含。

    yaml文件示例

    我们在resources目录下新建一个application.yaml配置文件,在该配置文件中编写为Person类设置的配置属性

    # 对实体对象person进行属性配置
    person:
     id: 1
     name: lucy
     hobby: [吃饭,睡觉,打豆豆 ]
     family: [father,mother]
     map: {k1: v1,k2: v2}
     pet: {type: dog,name: 旺财}
    

    相关文章

      网友评论

          本文标题:SpringBoot的常用配置

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