spring boot自定义配置文件并且提示

村口老师傅

已于 2022-07-04 23:32:31 修改

阅读量2.3k

点赞数 2

CC 4.0 BY-SA版权

于 2022-01-07 16:51:56 首次发布

本文链接：https://blog.youkuaiyun.com/Session_s/article/details/122367050

SpringCloud 专栏收录该内容

6 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中创建并管理自定义配置文件，以解决配置过多导致的application.properties文件臃肿问题。通过添加spring-boot-configuration-processor依赖并配置maven插件，可以生成配置元数据，使自定义配置文件在IDE中得到提示。同时，展示了创建一个配置类JWTConfig来绑定my-config.yml文件，确保配置生效，并验证了配置提示的正确性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringBoot项目中配置文件是必不可少的，随着配置的大量增加，如果将所有的配置都放在框架自带的application.properties文件中，就会导致该过度臃肿且分类不够明确，为解决这一问题，我们常常需要自定义配置文件，此时就会带来一个问题，那就是自定配置文件无法被框架所识别（如果被识别，配置文件会带有一个小绿色的叶子），框架无法识别也就是导致输入配置时，没有相应的提示。

1、添加依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

配置spring-boot-maven-plugin以防止repackage目标将依赖项添加到 jar 中：

<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.springframework.boot</groupId>
                            <artifactId>spring-boot-configuration-processor</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2、添加配置文件`my-config.yml`

jwt:
  algorithm: HS256
  expires: 2

并创建一个对应的类：
创建这个类不是必须，我这里只是想说明，自己写的配置类，也可以被提示，并不仅仅只提示spring框架的配置。

@Data
@Configuration
@ConfigurationProperties(prefix = "jwt", ignoreUnknownFields = true)
@PropertySource("classpath:my-config.yml")
public class JWTConfig {
   /** 加密方式 */
   String algorithm;

   /** 过期时间，单位分钟 */
   long expires;
}