10分钟搞定 SpringBoot 如何优雅读取配置文件？

柔情只为你懂 2023-07-04 06:27 42阅读 0赞

> 本文以及收录自springboot-guide(不只是SpringBoot还有Spring重要知识点),地址：[https://github.com/Snailclimb/springboot-guide][https_github.com_Snailclimb_springboot-guide] 。让你学习 Spring 变的更加容易！如果觉得不错的话，欢迎去点个 Star!

很多时候我们需要将一些常用的配置信息比如阿里云 oss 配置、发送短信的相关信息配置等等放到配置文件中。

下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。

`application.yml` 内容如下：

wuhan2020: 2020年初武汉爆发了新型冠状病毒，疫情严重，但是，我相信一切都会过去！武汉加油！中国加油！
    
    my-profile:
      name: Guide哥
      email: koushuangbwcx@163.com
    
    library:
      location: 湖北武汉加油中国加油
      books:
        - name: 天才基本法
          description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。
        - name: 时间的秩序
          description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。
        - name: 了不起的我
          description: 如何养成一个新习惯？如何让心智变得更成熟？如何拥有高质量的关系？ 如何走出人生的艰难时刻？

### 1.通过 `@value` 读取比较简单的配置信息 ###

使用 `@Value("${property}")` 读取比较简单的配置信息：

@Value("${wuhan2020}")
    String wuhan2020;

> **需要注意的是** **`@value`****这种方式是不被推荐的，Spring 比较建议的是下面几种读取配置信息的方式。**

### 2.通过`@ConfigurationProperties`读取并与 bean 绑定 ###

> **`LibraryProperties`** **类上加了** **`@Component`** **注解，我们可以像使用普通 bean 一样将其注入到类中使用。**

import lombok.Getter;
    import lombok.Setter;
    import lombok.ToString;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.stereotype.Component;
    
    import java.util.List;
    
    @Component
    @ConfigurationProperties(prefix = "library")
    @Setter
    @Getter
    @ToString
    class LibraryProperties {
        private String location;
        private List<Book> books;
    
        @Setter
        @Getter
        @ToString
        static class Book {
            String name;
            String description;
        }
    }

这个时候你就可以像使用普通 bean 一样，将其注入到类中使用：

package cn.javaguide.readconfigproperties;
    
    import org.springframework.beans.factory.InitializingBean;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    /**
     * @author shuang.kou
     */
    @SpringBootApplication
    public class ReadConfigPropertiesApplication implements InitializingBean {
    
        private final LibraryProperties library;
    
        public ReadConfigPropertiesApplication(LibraryProperties library) {
            this.library = library;
        }
    
        public static void main(String[] args) {
            SpringApplication.run(ReadConfigPropertiesApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() {
            System.out.println(library.getLocation());
            System.out.println(library.getBooks());    }
    }

控制台输出：

湖北武汉加油中国加油
    [LibraryProperties.Book(name=天才基本法, description........]

### 3.通过`@ConfigurationProperties`读取并校验 ###

我们先将`application.yml`修改为如下内容，明显看出这不是一个正确的 email 格式：

my-profile:
      name: Guide哥
      email: koushuangbwcx@

> **`ProfileProperties`** **类没有加** **`@Component`** **注解。我们在我们要使用****`ProfileProperties`** **的地方使用****`@EnableConfigurationProperties`****注册我们的配置 bean：**

import lombok.Getter;
    import lombok.Setter;
    import lombok.ToString;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    import org.springframework.validation.annotation.Validated;
    
    import javax.validation.constraints.Email;
    import javax.validation.constraints.NotEmpty;
    
    /**
    * @author shuang.kou
    */
    @Getter
    @Setter
    @ToString
    @ConfigurationProperties("my-profile")
    @Validated
    public class ProfileProperties {
       @NotEmpty
       private String name;
    
       @Email
       @NotEmpty
       private String email;
    
       //配置文件中没有读取到的话就用默认值
       private Boolean handsome = Boolean.TRUE;
    
    }

具体使用：

package cn.javaguide.readconfigproperties;
    
    import org.springframework.beans.factory.InitializingBean;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.context.properties.EnableConfigurationProperties;
    
    /**
     * @author shuang.kou
     */
    @SpringBootApplication
    @EnableConfigurationProperties(ProfileProperties.class)
    public class ReadConfigPropertiesApplication implements InitializingBean {
        private final ProfileProperties profileProperties;
    
        public ReadConfigPropertiesApplication(ProfileProperties profileProperties) {
            this.profileProperties = profileProperties;
        }
    
        public static void main(String[] args) {
            SpringApplication.run(ReadConfigPropertiesApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() {
            System.out.println(profileProperties.toString());
        }
    }

因为我们的邮箱格式不正确，所以程序运行的时候就报错，根本运行不起来，保证了数据类型的安全性：

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'my-profile' to cn.javaguide.readconfigproperties.ProfileProperties failed:
    
        Property: my-profile.email
        Value: koushuangbwcx@
        Origin: class path resource [application.yml]:5:10
        Reason: must be a well-formed email address

我们把邮箱测试改为正确的之后再运行，控制台就能成功打印出读取到的信息：

ProfileProperties(name=Guide哥, email=koushuangbwcx@163.com, handsome=true)

### 4.`@PropertySource`读取指定 properties 文件 ###

import lombok.Getter;
    import lombok.Setter;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.PropertySource;
    import org.springframework.stereotype.Component;
    
    @Component
    @PropertySource("classpath:website.properties")
    @Getter
    @Setter
    class WebSite {
        @Value("${url}")
        private String url;
    }

使用：

@Autowired
    private WebSite webSite;
    
    System.out.println(webSite.getUrl());//https://javaguide.cn/

### 5.题外话:Spring 加载配置文件的优先级 ###

Spring 读取配置文件也是有优先级的，直接上图：

![read-config-properties-priority.jpg][]

更对内容请查看官方文档：https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html\#boot-features-external-config

> 本文源码：https://github.com/Snailclimb/springboot-guide/tree/master/source-code/basis/read-config-properties

### 开源项目推荐 ###

作者的其他开源项目推荐：

1.  [JavaGuide][]：【Java学习 面试指南】 一份涵盖大部分Java程序员所需要掌握的核心知识。
2.  [springboot-guide][https_github.com_Snailclimb_springboot-guide] : 适合新手入门以及有经验的开发人员查阅的 Spring Boot 教程（业余时间维护中，欢迎一起维护）。
3.  [programmer-advancement][] : 我觉得技术人员应该有的一些好习惯！
4.  [spring-security-jwt-guide][] :从零入门 ！Spring Security With JWT（含权限验证）后端部分代码。

### 公众号 ###

![20200209112004509.png][]

[https_github.com_Snailclimb_springboot-guide]: https://github.com/Snailclimb/springboot-guide
[read-config-properties-priority.jpg]: https://my-blog-to-use.oss-cn-beijing.aliyuncs.com/2019-11/read-config-properties-priority.jpg
[JavaGuide]: https://github.com/Snailclimb/JavaGuide
[programmer-advancement]: https://github.com/Snailclimb/programmer-advancement
[spring-security-jwt-guide]: https://github.com/Snailclimb/spring-security-jwt-guide
[20200209112004509.png]: https://img-blog.csdnimg.cn/20200209112004509.png