SpringBoot 读取配置文件的 5 种方法！

男娘i 2024-04-08 10:16 51阅读 0赞

![a7c7984f488bc4b958bfe9489b124e83.jpeg][]

作者 | 磊哥

来源 | Java面试真题解析（ID：aimianshi666）

转载请联系授权（微信ID：GG\_Stone）

Spring Boot 中读取配置文件有以下 5 种方法：

1.  使用 @Value 读取配置文件。
2.  使用 @ConfigurationProperties 读取配置文件。
3.  使用 Environment 读取配置文件。
4.  使用 @PropertySource 读取配置文件。
5.  使用原生方式读取配置文件。

它们的具体使用方法如下，为了方便测试，我们在 Spring Boot 配置文件 application.properties 添加以下内容：

profile.name=Spring Boot Profile
    profile.desc=Spring Boot Profile Desc.

### 1.使用 @Value 读取配置文件 ###

使用 @Value 可以读取单个配置项，如下代码所示：

@SpringBootApplication
    public class DemoApplication implements InitializingBean {
        @Value("${profile.name}")
        private String name;
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() throws Exception {
            System.out.println("My Profile Name：" + name);
        }
    }

以上程序的执行结果如下图所示：![29597ae46ae5a5392f515e2818b73bd1.png][]

### 2.使用 @ConfigurationProperties 读取配置文件 ###

@ConfigurationProperties 和 @Value 的使用略微不同，@Value 是读取单个配置项的，而 @ConfigurationProperties 是读取一组配置项的，我们可以使用 @ConfigurationProperties 加实体类读取一组配置项，如下代码所示：

import lombok.Data;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    @Component
    @ConfigurationProperties(prefix = "profile")
    @Data
    public class Profile {
        private String name;
        private String desc;
    }

其中 prefix 表示读取一组配置项的根 name，相当于 Java 中的类名，最后再把此配置类，注入到某一个类中就可以使用了，如下代码所示：

@SpringBootApplication
    public class DemoApplication implements InitializingBean {
        @Autowired
        private Profile profile;
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() throws Exception {
            System.out.println("Profile Object:" + profile);
        }
    }

以上程序的执行结果如下图所示：![4d2c396e5c887c2d235dd9ae3a473d73.png][]

### 3.使用 Environment 读取配置文件 ###

Environment 是 Spring Core 中的一个用于读取配置文件的类，将此类使用 @Autowired 注入到类中就可以使用它的 getProperty 方法来获取某个配置项的值了，如下代码所示：

import org.springframework.beans.factory.InitializingBean;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.core.env.Environment;
    
    @SpringBootApplication
    public class DemoApplication implements InitializingBean {
    
        @Autowired
        private Environment environment;
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() throws Exception {
            System.out.println("Profile Name：" + environment.getProperty("profile.name"));
        }
    }

以上程序的执行结果如下图所示：![19c15e2278c5381343312141d5991ecc.png][]

### 4.使用 @PropertySource 读取配置文件 ###

使用 @PropertySource 注解可以用来指定读取某个配置文件，比如指定读取 application.properties 配置文件的配置内容，具体实现代码如下：

@SpringBootApplication
    @PropertySource("classpath:application.properties")
    public class DemoApplication implements InitializingBean {
        @Value("${profile.name}")
        private String name;
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() throws Exception {
            System.out.println("Name：" + name);
        }
    }

以上程序的执行结果如下图所示：![e4d0c5d42f528e336c3aa90408f0cb71.png][]

#### 中文乱码 ####

如果配置文件中出现中文乱码的情况，可通过指定编码格式的方式来解决中文乱码的问题，具体实现如下：

@PropertySource(value = "dev.properties", encoding = "utf-8")

#### 注意事项 ####

@PropertySource 注解默认是只支持 properties 格式配置文件的读取的。

### 5.使用原生方式读取配置文件 ###

我们还可以使用最原始的方式 Properties 对象来读取配置文件，如下代码所示：

import org.springframework.beans.factory.InitializingBean;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    import java.io.IOException;
    import java.io.InputStreamReader;
    import java.nio.charset.StandardCharsets;
    import java.util.Properties;
    
    @SpringBootApplication
    public class DemoApplication implements InitializingBean {
    
        public static void main(String[] args) {
            SpringApplication.run(DemoApplication.class, args);
        }
    
        @Override
        public void afterPropertiesSet() throws Exception {
            Properties props = new Properties();
            try {
                InputStreamReader inputStreamReader = new InputStreamReader(
                        this.getClass().getClassLoader().getResourceAsStream("application.properties"),
                        StandardCharsets.UTF_8);
                props.load(inputStreamReader);
            } catch (IOException e1) {
                System.out.println(e1);
            }
            System.out.println("Properties Name：" + props.getProperty("profile.name"));
        }
    }

以上程序的执行结果如下图所示：![5ab162be50655552914045d32379429b.png][]

### 总结 ###

在 Spring Boot 中读取配置文件有以下 5 种方法：

1.  使用 @Value 读取配置文件。
2.  使用 @ConfigurationProperties 读取配置文件。
3.  使用 @PropertySource 读取配置文件。
4.  使用 Environment 读取配置文件。
5.  使用原生方式读取配置文件。

其中最常用的是前 3 种，如果读取某一个配置项可使用 @Value，如果读取一组配置项可使用 @ConfigurationProperties，如果要指定读取某一个具体的配置文件可使用 @PropertySource 来指定。

> 是非审之于己，毁誉听之于人，得失安之于数。
> 
> 公众号：Java面试真题解析
> 
> 面试合集：https://gitee.com/mydb/interview

![9afe1c75b2d4148679ba8e17235ae817.gif][]

往期推荐

![f7e067222bb6ff3ffebfdfa50e1a9158.jpeg][]

面试突击74：properties和yml有什么区别？

![793ea448572d18911a49de0b45bda80b.jpeg][]

面试突击73：IoC 和 DI 有什么区别？

![e1c66098ed63d0922a3ff466e24dfc4d.jpeg][]

面试突击72：输入URL之后会执行什么流程？

![9e14f56f2c85e8e61701d36d6735cb7a.gif][]

[a7c7984f488bc4b958bfe9489b124e83.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/dcf39005ad9e46e5826ebb097d831ceb.jpeg
[29597ae46ae5a5392f515e2818b73bd1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/6f2173cd17fc4162bb38975eecc9f8ca.png
[4d2c396e5c887c2d235dd9ae3a473d73.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/bfc7872925a5444dbfa34f7b72d80762.png
[19c15e2278c5381343312141d5991ecc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/dd111300c84246f998202fb0d52b0fc2.png
[e4d0c5d42f528e336c3aa90408f0cb71.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/76966fcaf45c42069ce6f5850a4cb7f2.png
[5ab162be50655552914045d32379429b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/0ebe00b8e4074d209e7a570f55231cca.png
[9afe1c75b2d4148679ba8e17235ae817.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/f543b1a516284c46a298835dff1b4154.gif
[f7e067222bb6ff3ffebfdfa50e1a9158.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/d7da04ce9eaf4299b1e6e8a8cfeea8e9.jpeg
[793ea448572d18911a49de0b45bda80b.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/9a41f3546c1141f888c6ea3b256b88e7.jpeg
[e1c66098ed63d0922a3ff466e24dfc4d.jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/0d2bc5ab680e467cb92d800b0f572ab7.jpeg
[9e14f56f2c85e8e61701d36d6735cb7a.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/08/97327b7c7cc344e89ee4e292e0a9aec1.gif