java八股文面试[SpringBoot]——Spring Boot 有哪几种读取配置的方式

不念不忘少年蓝@ 2024-03-04 07:53 88阅读 0赞

**目录**

@PropertySource

@Value

@Environment

@ConfigurationProperties

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

--------------------

Spring Boot默认的配置文件有两种格式: application.properties 和 application.yml。 查找顺序是首先从application.**properties** 查找，

###### **@PropertySource** ######

@PropertySource注解用于指定**资源文件**读取的位置，它不仅能读取[properties][]文件，也能读取xml文件，并且通过YAML解析器，配合自定义PropertySourceFactory实现解析YAML文件。

@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);
        }
        
    }

**执行结果如下图所示：**

![8b3455689b0ab400e39635ad057482eb.png][]

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

@PropertySource(value = "dev.properties", **encoding = "utf-8"**)  
注意事项  
@PropertySource 注解默认是**只支持 properties** 格式配置文件的读取的。

###### **@Value** ######

使用 @Value 读取配置文件

这种方法适用于对象的**参数比较少**的情况

我们可以直接在对象的属性上使用 `@Value` 注解，同时以 `${}` 的形式传入配置文件中对应的属性。同时需要在该类的上方使用 `@Configuration`注解，将该类**作为配置**

具体使用方法如下，我们在 Spring Boot 配置文件 application.properties 添加以下内容：

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

使用 @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);
        }

**执行结果如下图所示：**

![b8551f332ff990330c00b32a74801939.png][]

###### **@Environment** ######

Environment 是 SpringCore 中的一个用于读取**配置文件**的类，将此类使用 @**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"));
        }
        
    }

**执行结果如下图所示：**

![46ff82ebb5bae3d5ce06cf86b6f153a2.png][]

###### **@ConfigurationProperties** ######

使用 @**ConfigurationProperties** 读取配置文件 如果对象的**参数比较多情况下**,推荐使用 @ConfigurationProperties 会更简单一些，不需要在每一个字段的上面的使用@Value注解。

@ConfigurationProperties注解声明当前类为配置读取类

prefix="rabbitmq" 表示读取**前缀**为rabbitmq的属性

@ConfigurationProperties 和 @Value 的使用略微不同，@Value 是读取单个配置项的，而@ConfigurationProperties 是读取**一组配置项**的，我们可以使用 @ConfigurationProperties 加实体类读取一组配置项，其中 prefix 表示读取一组配置项的根 name，相当于 **Java 中的类名**，最后再把此配置类，**注入**到某一个类中就可以使用了，如下代码所示：

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;
    }

@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);
        }
        
    }

**执行结果如下图所示：**

![0f3a5e4bd3fcdac318ab4ad78010eb13.png][]

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

我们还可以使用最原始的方式 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"));
        }
        
    }

**执行结果如下图所示：**

![d177dd813fa4a860b0b0d314e33b913f.png][]

知识来源：马士兵教育

[SpringBoot 读取配置文件的 5 种方法\_springboot 获取配置文件中的值\_ZwLemon的博客-CSDN博客][SpringBoot _ 5 _springboot _ZwLemon_-CSDN]

[properties]: https://so.csdn.net/so/search?q=properties&spm=1001.2101.3001.7020
[8b3455689b0ab400e39635ad057482eb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/04/2f90d040358c449d82f6e4950e00d56c.png
[b8551f332ff990330c00b32a74801939.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/04/a49b2a69088c45abb99e94a7313e9be6.png
[46ff82ebb5bae3d5ce06cf86b6f153a2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/04/1cdd92acec014a2ab07a4d49267e02d8.png
[0f3a5e4bd3fcdac318ab4ad78010eb13.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/04/4e2ebcf7a28a4202b8aca00ee9df1177.png
[d177dd813fa4a860b0b0d314e33b913f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/04/e3b69aefc2b9464097ba2af995e0c975.png
[SpringBoot _ 5 _springboot _ZwLemon_-CSDN]: https://blog.csdn.net/weixin_39157014/article/details/126526475