SpringBoot的Properties定义属性在yml中无提示

问题描述:

SpringBoot通过@ConfigurationProperties增加配置后,在yml中对属性进行配置时无提示,不方便属性配置

原因分析:

生成的jar文件中没有spring-configuration-metadata.json,可能的原因:

  1. 未配置@EnableConfigurationProperties
  2. 未配置spring-boot-configuration-processor依赖
  3. 如果是使用idea,未配置使能注解处理器

解决方案:

  1. 未配置@EnableConfigurationProperties,需要在相应的配置类上增加注解,指定对应的配置类
@EnableConfigurationProperties(XxxProperties.class)
public class XxxAutoConfig {

    private XxxPropertiesproperties;
}

另外还有一种情况:如果之前是通过@Component使@ConfigurationProperties生效的,应去掉@Component改用@EnableConfigurationProperties
2. 未配置spring-boot-configuration-processor依赖问题,需要在项目中引入spring-boot-configuration-processor依赖,如下:

 <!--配置注解处理 @ConfigurationProperties annotation processing (metadata for IDEs) -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>
  1. 如果是使用idea需要配置使能注解处理器,确保Enable annotation processing勾选
    在这里插入图片描述

总结:

要想使用@ConfigurationProperties注解的配置属性在yml中输入时,idea有相应的提示,需要:

  1. 需要使用@EnableConfigurationProperties注解使其生效
  2. 配置spring-boot-configuration-processor依赖
  3. 使能idea注解处理器
    最终在jar中生成spring-configuration-metadata.json

参考:

https://blog.csdn.net/yuhan_0590/article/details/85100246

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值