学习Springboot——@PropertySource加载配置文件

た入场券 2023-10-05 08:01 118阅读 0赞

在我们使用Springboot框架的时候，大家都会发现Springboot底层已经帮我们完成了大部分的配置，我们可以通过修改Springboot全局配置文件的方式来是实现我们想要的效果。

而全局配置文件有两种格式:**application.yml**(**application.yaml**是同一种)或者是**application.properties**。Springboot在运行的时候会自动的识别这两个配置文件并进行加载。

### 如果说我们创建一个自定义的Springboot配置文件，但是Springboot却无法识别我们自定义的配置文件，那该怎么办? ###

### 答:可以使用@PropertySource注解。 ###

1.我们创建一个自定义的Springboot全局配置文件。

# 我们自定义一个配置文件，然后让我们自定义的一个配置类来把这个配置文件中的值注入
    test.id=1
    test.name=2

2.创建一个实体类，用于接收我们自定义配置文件中的属性值

public class MyProperties {
        
        private int id;
        private String name;
    
        public int getId() {
        
            return id;
        }
    
        public void setId(int id) {
        
            this.id = id;
        }
    
        public String getName() {
        
            return name;
        }
    
        public void setName(String name) {
        
            this.name = name;
        }
    
        @Override
        public String toString() {
        
            return "MyProperties{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

3.这时候如果像把指定的自定义配置文件中的属性值加载注入到实体类中，就可以使用@PropertySource注解，在这个注解放在类上。

@Configuration//使当前类成为一个配置类
    @PropertySource("classpath:test.properties")//加载指定的Springboot核心配置文件
    @EnableConfigurationProperties(MyProperties.class)//开启配置类的属性注入功能
    @ConfigurationProperties(prefix = "test")//把指定的配置文件中前缀为test的值注入到该类的属性中
    public class MyProperties {
        
        private int id;
        private String name;
    
        public int getId() {
        
            return id;
        }
    
        public void setId(int id) {
        
            this.id = id;
        }
    
        public String getName() {
        
            return name;
        }
    
        public void setName(String name) {
        
            this.name = name;
        }
    
        @Override
        public String toString() {
        
            return "MyProperties{" +
                    "id=" + id +
                    ", name='" + name + '\'' +
                    '}';
        }
    }

可能有人就要问了，为什么需要加上@EnableConfigurationProperties呢，而我上一篇介绍[@ConfigurationProperties注解][ConfigurationProperties]的时候却没有使用这个注解呢？  
:**因为这个实体类使用了@Configuration注解，成为了一个配置类。而配置类必须使用@EnableConfigurationProperties注解开启配置类注入功能，不然无法注入。**

**如果我们不使用@Configuration注解的话，只是使用@Component注解架子啊到容器中的话，就可以不使用@EnableConfigurationProperties注解**。

[ConfigurationProperties]: https://editor.csdn.net/md/?articleId=107902066