Spring Boot自定义配置的提示

使用Spring Boot的时候,填写配置信息(application.properties或application.yml)时,会出现提示。这种方式IDE也可以检查配置是否正确,对用户非常友好。本文介绍如何实现自定义配置的提示

添加自定义配置类


使用注解@ConfigurationProperties

@Component
@ConfigurationProperties(prefix = "blog")
public class BlogProperty {
    /**
     * blog's title
     */
    private String title;
    private String author;
    private boolean gender;
    private String national;
}

添加注解处理器

为配置类BlogProperty添加注解@ConfigurationProperties后,IDEA会出现红色提示Spring Boot Configuration Annotation Processor not found in classpath,这是因为还需要为注解配置处理器

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

编译生成提示文件

  • 上一步添加注解处理器后,还是会出现绿色提示 Re-run Spring Boot Configuration Annotation Processor to update generated metadata。该提示只是告诉我们去重新编译Spring Boot这样就可以更新生成的metadata文件,直接隐藏即可
  • 生成的文件如下classes/META-INF/spring-configuration-metadata.json
{
  "groups": [
    {
      "name": "blog",
      "type": "com.tenmao.property.BlogProperty",
      "sourceType": "com.tenmao.property.BlogProperty"
    }
  ],
  "properties": [
    {
      "name": "blog.author",
      "type": "java.lang.String",
      "sourceType": "com.tenmao.property.BlogProperty"
    },
    {
      "name": "blog.gender",
      "type": "java.lang.Boolean",
      "sourceType": "com.tenmao.property.BlogProperty",
      "defaultValue": false
    },
    {
      "name": "blog.national",
      "type": "java.lang.String",
      "sourceType": "com.tenmao.property.BlogProperty"
    },
    {
      "name": "blog.title",
      "type": "java.lang.String",
      "description": "blog's title",
      "sourceType": "com.tenmao.property.BlogProperty"
    }
  ],
  "hints": []
}
  • 很容易明白name, type, sourceType是如何从配置类生成的
  • 其中配置类中的注解会变成json中的description

使用

配置提示

手动修改

在自动生成的结果中再进行手动修改,比如为blog.national提供枚举值

"hints": [
  {
    "name": "blog.national",
    "values": [
      {
        "value": "China",
        "description": "People's Republic of China"
      },
      {
        "value": "Japan",
        "description": "Japan in Asia"
      }
    ]
  }
]

枚举值

误解

  • 很多地方都说需要在Spring Boot启动类上配置@EnableConfigurationProperties:实际上并不需要

参考

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏程序员的成长之路

CentOS服务器,Nginx+Tomcat 上部署javaEE项目,负载均衡

1、我在根目录下建立了webapps文件夹用于放置项目文件:/webapps,我的项目文件是VindicateWallProj;

12530
来自专栏大白技术控的技术自留地

微软XAML Studio - WPF, Sliverlight, Xamarin, UWP等技术开发者的福音

最近又在继续倒腾WPF的项目,继续使用Caliburn.Micro和Xceed来堆代码。每次调试xaml上的binding,都有种要疯的赶脚。

19370
来自专栏大嘴说编程

EasyUI使用笔记——Datagrid的高级用法(1)

接上一篇[EasyUI使用笔记——Datagrid的使用及排序],在footer处有添加、修改和删除这几个操作。

11420
来自专栏网站建设、网站制作专栏

PageAdmin建站系统模板制作教程1:Razor简介

在学习PageAdmin cms建站系统的网站模板制作前,请确保您是前端人员,或者有基本的html,css和Javascript(或jquery)基础。

16610
来自专栏huginn

让所有网页变成RSS —— Huginn

下面开始举例子。我们现在要把我的博客 http://walkginkgo.com/转换成 RSS。

62830
来自专栏程序员的成长之路

Java 程序员都应该去使用一下这款强大的国产工具类库

它会转义文本中的HTML字符为安全的字符,这样比较安全。另外,HtmlUtil 还提供了以下方法,有兴趣的朋友可以去试一下。

19930
来自专栏程序员的成长之路

Java爬取并下载酷狗TOP500歌曲

来源:my.oschina.net/gllfeixiang/blog/2995570?p=1

17630
来自专栏大嘴说编程

.net下发送Email的Helper类一、适用场景二、代码三、调用方法四、结束

前段时间因为业务需要自动给客户发送支持HTML格式的而且带附件的Email,而且使用的还是Office365邮箱,就抽时间看了一下这方面的内容,并写了这个帮助类...

11320
来自专栏大嘴说编程

EasyUI使用笔记——Datagrid的使用及排序

Datagrid的使用: 添加一个table,其中class设置为easyui-datagrid,在data-options中设置datagrid的参数,我这里...

28240
来自专栏程序员的成长之路

使用hexo+github搭建免费个人博客详细教程

新建一个名为你的用户名.github.io的仓库,比如说,如果你的github用户名是test,那么你就新建test.github.io的仓库(必须是你的用户名...

15510

扫码关注云+社区

领取腾讯云代金券

年度创作总结 领取年终奖励