SpringBoot配置文件

拼搏现实的明天。 2021-06-24 16:10 502阅读 0赞

## 配置文件分类 ##

SpringBoot为我们提供了一些默认的配置项，但在开发的时候我们经常需要自己手动配置一些参数，SpringBoot为我们提供了配置文件供开发者进行配置。配置文件有两种，一种是properties格式配置文件，另外一种是yml格式配置文件下，项目默认创建properties格式配置文件，二选一即可。

## application.properties ##

基本可以将所有支持spring boot相关技术的配置文件都统一配置到application.properties里面，如果你想添加或修改一些配置的话，直接操作application.properites即可，比如在该配置文件中添加：

#修改内置tomcat端口号
    server.port=8080
    #设置项目上下文
    server.servlet.context-path=/myspringboot

## application.yml ##

spring boot支持的另外一种配置文件的格式是yml类型的，编写的yml配置文件时候要注意缩进，冒号后面要有空格，如果yml和properties两个配置文件都存在的话，properties优先级高。下面是yml中的格式，类似一棵树形结构，整体看上去要比properties简洁一些。

server:
      servlet:
        context-path: /myspringboot
      port: 9090

## 多环境配置 ##

在实际工作中通常会有多个环境，例如开发环境，测试环境，生产环境，每个环境都有自己独特的配置内容，这样可以创建多个配置文件用来区分。比如创建下面配置文件：

开发环境：application-dev.properties
    测试环境：application-test.properties
    生产环境：application-online.properties

如果想要使用开发环境的配置文件，只需要在application.properties文件中添加下面内容：

spring.profiles.active=dev

这样就激活了application-dev.properties配置文件，激活之后当前的application配置文件中的内容如果跟激活中的相同，则会被后者覆盖掉。

## 自定义配置 ##

在spring boot的配置文件中可以添加自定义的一些内容，在这里为了避免乱码，我们先统一将编码设置为UTF-8，然后再设置自定义内容。

#字符编码位置要放到下面中文的上面，下面是指定字符编码
    spring.http.encoding.charset=UTF-8
    spring.http.encoding.enabled=true
    spring.http.encoding.force=true
    #自定义配置
    school.name=阳光中学
    school.address=北京中关村
    school.age=10

**读取方式一**  
使用@value注解，创建controller：

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    @Controller
    public class SchoolController {
    
        @Value("${school.name}")
        private String name;
    
        @Value("${school.address}")
        private String address;
    
        @Value("${school.age}")
        private int age;
    }

**读取方式二**  
单独编写一个配置类：

import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    import org.lombok.Data;
    
    @Component
    @ConfigurationProperties(prefix = "school")//前缀，对应的是配置文件中的school
    @Data  //lombok注解一键生成getter/setter/toString/equals方法
    public class SchoolInfo {
    
        private String name;//对应的配置文件中的name
    
        private String address;
    
        private int age;
    }

## 外部配置 ##

如果要编写很多自定义配置到application.properties中的话，就会导致该配置文件冗余了，此时我们可以自己定义一个配置文件将自定义配置写到这个配置文件中。比如在resources目录下创建一个school.properties的配置文件：

school.name=深圳第一中学
    school.address=深圳
    school.age=10

在之前的SchoolInfo类上加入@PropertySource注解：

/**
     * 读取自定义配置文件
     */
    @Component
    @PropertySource(value = "classpath:school.properties")//指定外部配置文件的名字
    @ConfigurationProperties(prefix = "school")//前缀，这里是配置文件中的school
    public class SchoolInfo {
    
        private String name;//对应配置文件中的name
    
        private String address;
    
        private int age;
    }

将之前application.properties文件中的自定义配置删除，此时再运行，即可从外部自定义配置文件读取配置项了。