使用Java类加载SpringBoot、SpringCloud配置文件

SpringBoot配置加载优化

最新推荐文章于 2025-03-31 15:46:02 发布

原创最新推荐文章于 2025-03-31 15:46:02 发布 · 631 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#Java #工具类 #配置文件

Java 同时被 3 个专栏收录

11 篇文章

订阅专栏

工具类

5 篇文章

订阅专栏

配置文件

1 篇文章

订阅专栏

本文介绍在SpringBoot项目中如何优化配置文件加载过程，通过使用@ConfigurationProperties注解和层级类结构，实现对复杂配置文件的简洁高效加载。

我们都知道平常在使用SpringBoot和SpringCloud的时候，如果需要加载一两个配置文件的话我们通常使用@Value("${属性名称}")注解去加载。但是如果配置文件属性特别多的时候使用这种方式就显得特别的不友好了。

比如说，我们要加载下方这个名为application.yml的配置文件。

kafka:
  brokerAddress: 110.35.113.62:9092,123.27.143.72:9095,180.17.133.52:9096

  smsTopic: testTopic
  smsCosumeGroup: testTopicGroup

  timerTaskTopic: timerTopic
  timerTaskGroup: timerGroup

  jvmNumbers: 3



  security:
       authentication:
          jwt:
              secret: 0550224055e1848081dba46d8ad325f503fa141b
              tokenValidityInSeconds: 86400

此时我们有两种方式来简化这个加载方式

1

这种方式呢，是同过层层嵌套的方式一层一层的按照配置文件属性的方式来进行注入的。大家只要把这个类跟上方提供的配置文件进行对比就会明白它的方式了。（注意，下方的所有属性因为篇幅问题没有增加get、set方法，实际使用过程中请自行添加）

@ConfigurationProperties(prefix = "application", ignoreUnknownFields = false)
public class ApplicationProperties1 {

    private final Security security = new Security();

    private final Kafka kafka = new Kafka();

    public static class Kafka {
        private String brokerAddress;
        private String smsTopic;
        private String smsCosumeGroup;
        private String timerTaskTopic;
        private String timerTaskGroup;
        private String jvmNumbers;
    }

    public static class Security {

        private final Authentication authentication = new Authentication();

        public static class Authentication {

            private final Jwt jwt = new Jwt();

            public static class Jwt {

                private String secret;

                private long tokenValidityInSeconds;
               
            }
        }
    }
    
}

2

这种方式就是以指定的配置前缀为依据去取配置（同上没有写get、set方法）

例如：kafka的配置可以这样来

@Configuration
@ConfigurationProperties(prefix = "kafka",ignoreUnknownFields = false)
@PropertySource(value = { "classpath:application.yml" },ignoreResourceNotFound=false)
public class ApplicationProperties {
    
        private String brokerAddress;
        private String smsTopic;
        private String smsCosumeGroup;
        private String timerTaskTopic;
        private String timerTaskGroup;
        private String jvmNumbers;
}

而Security的配置这样来

@Configuration
@ConfigurationProperties(prefix = "security.authentication.jwt",ignoreUnknownFields = false)
@PropertySource(value = { "classpath:application.yml" },ignoreResourceNotFound=false)
public class ApplicationProperties {

    private String secret;

    private long tokenValidityInSeconds;
}