SpringBoot读取外部配置文件的方法

小咪咪 2023-02-14 13:13 2阅读 0赞

![format_png][]

点击上方「蓝字」关注我们

![format_png 1][]

![format_png 2][]

##  ##

1.SpringBoot配置文件

SpringBoot使用一个以application命名的配置文件作为默认的全局配置文件。支持properties后缀结尾的配置文件或者以yml/yaml后缀结尾的YAML的文件配置。

以设置应用端口为例

properties文件示例(application.properties)：

server.port=80

YAML文件示例(application.yml)：

server:
      port: 80

#### 在properties和yml/yaml配置文件同时存在的情况下, 在同一目录下，properties配置优先级 > YAML(YML)配置优先级 ####

#     #

##  ##

2.配置文件目录

SpringBoot配置文件可以放置在多种路径下，不同路径下的配置优先级有所不同。

可放置目录(优先级从高到低)

./config/ (当前项目路径config目录下);
    ./ (当前项目路径下);
    classpath:/config/ (类路径config目录下);
    classpath:/ (类路径config下).

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

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

我们可以从ConfigFileApplicationListener这类便可看出，其中DEFAULT\_SEARCH\_LOCATIONS属性设置了加载的目录：

private static final String DEFAULT_SEARCH_LOCATIONS = "classpath:/,classpath:/config/,file:./,file:./config/";

接着getSearchLocations方法中去逗号解析成Set，其中内部类Loader负责这一配置文件的加载过程，

包括加载profile指定环境的配置，以application+’-’+name格式的拼接加载。

### 多种目录配置同时存在情况 ###

接下来还是以端口配置为例

在resources/目录下配置文件设置端口为8888;
    在resources/config目录下配置文件设置端口为9999;
    在项目路径下配置文件设置端口为6666;
    在项目路径config目录下配置文件设置端口为7777;

![format_png 3][]\]

最终运行结果：

Tomcat started on port(s): 7777 (http) with context path '/beedo'
    Started BeedoApplication in 4.544 seconds (JVM running for 5.335)

通过控制变量法得以论证  
**其优先级由高到底，高优先级的配置会覆盖低优先级的配置**

#     #

##  ##

3.自定义配置属性

SpringBoot提供了许多的配置，但通常情况我们需要自定义自己的配置应用自己的系统中，如你需要配置一个默认的用户名密码做为系统的登录用。  
首先创建一个实体类，作为配置注入用，并使用**@ConfigurationProperties注解进行批量注入， 也可以使用Spring底层注解@Value("$\{user.username\}")**的方式一个一个注入达到同意的效果

@Component
    @ConfigurationProperties(prefix = "user")
    public class Login{
        private String username;
        private String password;
        ...
    }

或者@Value写法

@Component
    public class Login{
        
        private String username;
        private String password;
        ...
    }

配置文件写法

# yml文件写法
    user:
        username: admin
        password: 123
    
    # properties写法
    login.username=admin
    login.password=123

编写一个junit测试用例，看看配置的值是否正常注入：

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class DeployApplicationTests {
        @Autowired
        private Login login;
        @Test
        public void contextLoads() {
            System.out.println(login);
        }
    }

从输出结果上看，值已正常注入  
Login\{username=‘admin’, password=‘123’\}

### @ConfigurationProperties与@Value两种注解对比 ###

<table> 
 <thead> 
  <tr> 
   <th>比较项</th> 
   <th>@ConfigurationProperties</th> 
   <th>@Value</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>全量注入</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>松散绑定(Relaxed Binding)</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
  <tr> 
   <td>SpEL</td> 
   <td>不支持</td> 
   <td>支持</td> 
  </tr> 
  <tr> 
   <td>JSR303</td> 
   <td>支持</td> 
   <td>不支持</td> 
  </tr> 
 </tbody> 
</table>

松散绑定：驼峰命名(userName)、横干拼接(user-name)、下划线（user_name）之间可以互相识别绑定称为做松散绑定
    JSR303：通过@Email，@Nullable，@Digits 等等注解进行邮箱、判空、数字格式等等数据的校验，更多相关内容请参考IBM的中文文档：https://www.ibm.com/developerworks/cn/java/j-lo-jsr303/index.html
    @ConfigurationProperties通常用于将配置全量注入某个类中；
    @Value通常用于注入某一些特定配置值中；

**使用@ConfigurationProperties方式可以进行配置文件与实体字段的自动映射，但需要字段必须提供set方法才可以，而使用@Value注解修饰的字段不需要提供set方法**

### 自定义配置提示 ###

在编写配置时，你会发现自定义配置没有提示，让你在使用自定义配置时变的很麻烦，其实SpringBoot早已为我们准备好了提示的需要，只需要用引入相关依赖即可有提示。  
在没有加入依赖时idea会有如下提示：

![format_png 4][]

添加依赖，该idea提示便消失，编写自定义配置时也有相应提示：

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

需要运行一下

#     #

##  ##

4.指定配置文件

通常情况下我们将配置配置在application开头的主配置文件中，这样随着项目的增大配置项的增多会使文件变得非常臃肿，其实SpringBoot早已考虑到了该问题，SpringBoot提供了**@PropertySource和@ImportResource**两个注解用于加载外部配置文件使用。

*  @PropertySource通常用于属性加载配置文件，注意@PropertySource注解不支持加载yaml文件，支持properties文件。
 *  @ImportResource通常用于加载Spring的xml配置文件

## @PropertySource使用 ##

### 装配properties配置文件 ###

在sources/config下创建一个yaml文件命名为user.properties内容与上方user的配置一样

![format_png 5][]

Login类可如下写法

@PropertySource(value = {"classpath:config/user.properties"})
    @Component
    @ConfigurationProperties(prefix = "user")
    public class Login{
        private String username;
        private String password;
        ...
    }

运行一下，同样能达到加载配置效果

**同时加载多个配置问题**  
细心的你，会发现@PropertySource注解中属性value为一个数组，如果同时加载多个配置文件，并且不同配置文件中对同一个属性设置了不同的值，那么Spring会识别哪一个呢?  
带着疑问，我们可以通过控制变量法进行测试，具体过程再在赘述。

@PropertySource(value = {"classpath:config/user1.properties","classpath:config/user2.properties"})

结论：**Spring加载顺序为从左到右顺序加载，后加载的会覆盖先加载的属性值。**

### 装配yaml配置文件 ###

如果你有强迫症，一定想加载yaml配置文件，那么可以通过**PropertySourcesPlaceholderConfigurer类来加载yaml文件**，将原来的user.properties改成user.yaml，Bean配置类中加入如下代码，Login配置类和一开始的方式一致。

@Bean
    public static PropertySourcesPlaceholderConfigurer loadProperties() {
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean();
        //yaml.setResources(new FileSystemResource("classpath:config/user.yml"));//File路径引入
        yaml.setResources(new ClassPathResource("config/user.yml"));//class路径引入
        configurer.setProperties(yaml.getObject());
        return configurer;
    }

运行一下，仍然可以能达到加载配置效果的

## @ImportResource使用 ##

SpringBoot提出零xml的配置，因此SpringBoot默认情况下时不会识别项目中Spring的xml配置文件。为了能够加载xml的配置文件，SpringBoot提供了@ImportResource注解该注解可以加载Spring的xml配置文件，通常加于启动类上。

@ImportResource(value = {"classpath:/beans.xml"})
    @SpringBootApplication(scanBasePackages = {"team.seagull.client"})
    public class DeployApplication {
        public static void main(String[] args) {
            SpringApplication.run(DeployApplication.class, args);
        }
    }

##     ##

##  ##

其他问题

idea使用*.properties文件出现中文乱码问题？  
idea对*.properties默认编码为GBK，通常我们项目为UTF-8编码，这样程序在读取时就会出现乱码问题；  
解决方法：idea 中 打开如下选项File->Sttings->Editor->FileEncodings

将GBK修改为UTF-8并勾选  
Transparent native-to ascill conversion(在运行的时候转换成ascii码)

![format_png 6][]

●[http协议无状态中的 "状态" 到底指的是什么？！][http_ _]

●[用Nginx实现接口慢查询并可示化展示TOP 20][Nginx_TOP 20]

●[MySQL 加锁和死锁解析][MySQL]

●[如果是MySQL引起的CPU消耗过大，你会如何优化？][MySQL_CPU]

![format_png 7][]

“**在看**”的永远18岁~

![format_png 8][]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9TbFE1SG1aZ2pmYUNpYXFHdzRDcFNrWXMxems3U2tKWXdxZm1pYnBRM3E2UHd0UFNwVGliRHNReHdYTmliRWFCN0NVNFZWWGVyV01vY1NVbjhydDVROU54OXcvNjQw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy80cVo2QUJMZHZJeXZHWFNBWERxZUhHSFk3Z1FlR1ByYWd2eVhGNkxpYnVtZ1kyVlJ1TFZqWDdiMHdYTG1MRnV6Z2s0QmQzUW9IYVlEUFNKdUlNNTdJT2cvNjQw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy94aWNXWVRTSUN6UnZkZENLUEl1bFplR2J0c3RET3o2V0dwNW1RTTNWWWI5WmhxUzZuMGNvMk9SNWxENUlTOGswVG84aWNJRXNWWUxISUx1bGlhdlJRUXRYZy82NDA?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy94aWNXWVRTSUN6UnZkZENLUEl1bFplR2J0c3RET3o2V0dPWGRuMXQwN0hvaWJ0WmdlRVpWMG94VEVKd2liUEF4MmxxVXVpYXRXUFZLVk9pY1V4OWtuZkdIcHVnLzY0MA?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnZkZENLUEl1bFplR2J0c3RET3o2V0dMVVo3MWNuOElaN1ZXaGFqODdiaWM5UTY0cldTYkM4RFVMdm5QSnhpYXpFU2JsYWpXSXhoaWIyVncvNjQw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnZkZENLUEl1bFplR2J0c3RET3o2V0c0RjVCZVZ0bXhMZW9RTDhBeXlMOGRGUkJNczNEbk82RUFsemY0RXpVYWhVckpOODNwRnpJaGcvNjQw?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9wNldsMkxETVFsSEM2cERYeVFSYVdqbFdSNVBJaHVrSVVHVjFuZks2SDlxdEhab3huWHRWZGV6dG9GZXhrYWV2dWRtWjFNYlY5cVdOWlRYaWFvcEx5b1EvNjQw?x-oss-process=image/format,png
[http_ _]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f324cb337a32779b9bbbf9b7c73af27bc3bf1f4081c49551f501e776c0ec3afbb483236f&idx=1&mid=2247484957&scene=21&sn=e829dced4c676360c41617b2c6debe40#wechat_redirect
[Nginx_TOP 20]: https://blog.csdn.net/u012811805/article/details/106309235
[MySQL]: https://blog.csdn.net/u012811805/article/details/106294139
[MySQL_CPU]: https://blog.csdn.net/u012811805/article/details/106271361
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnZ6aGRLck1pY1NQSWliZzhQRWJPa2E4bmpjOHJFZmFLa09YTHAyd21wckxpY0JRaWNYMWlhdVFzWEdTTDlpYXhreFZTb3RQQ2F2U2hva1NvVHcvNjQw?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9iOTZDaWJDdDcwaWFhQkFpY0ROQ1NzNkgwTzBTQkdTQUxmbkJhRGFlRVYxUncwc05JOHVvUE10bktTSEJabW9RMTVjMGtLbWtkRjVpYXpmcWVqYWljN3hIOThnLzY0MA?x-oss-process=image/format,png