详解如何为SpringBoot项目中的自定义配置添加IDE支持

导言

代码是写给人看的,不是写给机器看的,只是顺便计算机可以执行而已 ——《计算机程序的构造和解释(SICP)》 导言

在我们的项目里经常会出现需要添加自定义配置的应用场景,例如某个开关变量,在测试环境打开,在生产环境不打开,通常我们都会使用下面的代码来实现,然后在Spring Boot配置文件中添加这个key和Value

Application.java:

application.properties

或者是没有使用@Value而直接在XML中使用我们配置的属性值

application.xml

这样的代码和配置在Spring Boot项目中可以正常启动并读取配置,但是在我们的IDE中却不会为我们提示配置的类型和代码补全。当我们有新同事到来,或者是需要为配置文件添加新的环境的支持的时候,我们很容易会把配置文件的Key拼错,或者Value的值与我们的变量类型并不兼容(实际上真的发生过这样的问题导致项目启动失败)。

但是在我们使用Spring Boot提供的配置的时候,IDE总是能为我们自动补全,告诉我们这个配置的变量类型,甚至是给我们把这个配置的描述显示出来。

我们是否也可以为我们自己写的配置添加这样的IDE支持呢?

配置项元数据(Configuration Metadata)

Spring Boot的Jar文件包含元数据文件,这些文件提供了我们所需要的配置属性的详细信息。IDE通过读取这些元数据文件,然后在使用application.properties或application.yml的时候提供上下文信息和代码补全。 那么只要知道如何编写并存放配置项元数据信息文件,我们也可以让IDE知道如何为我们的自定义配置提供上下文信息。

元数据格式

Spring Boot项目的配置项元数据文件都放在META-INF/spring-configuration-metadata.json中。下图是当我们配置好Spring Boot项目后默认使用的Spring Boot自动配置的配置项元数据存放的位置

配置项元数据文件按照groups, properties和hints组织。properties下的每个property都是程序中需要使用的配置项的key值,比如server.port是服务启动后的端口号。而我们可以将一些property按照某些规则组合起来,这个组合就是group(通常我们并不需要为properties组织对应的group)。而hints是为我们的配置项提供额外的信息,比如时区time.zone支持Asia/Shanghai,我们可以为它提供"Asia/Shanghai"的hint。

properties的参数

名称 类型 描述
name String 属性的全名。名称是小写字母以句点分割。此属性是必须的
type String 属性的数据类型的完整签名(java.lang.String),如果是范型的话还应当包含完整的范型参数(java.util.List<java.lang.String>)。为了保证一致性,需要使用包装类型来替代基本类型。此属性不是必须的,但是无法得到类型诊断的支持。

hints的参数

名称 类型 描述
name String 该提示所引用的属性的全称,和properties的name参数相同。此属性是必须的
values ValueHint[] ValueHint对象定义的有效值列表。每个条目都定义该值,并且可以具有描述

ValueHint的参数

名称 类型 描述
value Object property给定的类型的有效值,如果property的类型是数组,那么它也可以是值的数组。此属性是必须的。如果是Map类型的属性,可以使用.keys和.values来指定对应的有效值。
description String 和properties的description相同,提示给用户的简短描述。此属性不是必须的。

这里只展示了我们常用的参数,关于配置项元数据文件格式的详细信息可以看Spring Boot的官方文档 (https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-configuration-metadata.html#configuration-metadata-format

为自定义配置编写配置项元数据

接下来我们将对值、数组场景编写对应的配置项元数据,并为这些配置项添加提示(Talk is cheap,show me the code)

在IDE中实际使用的效果

不过这种方式虽然好,但是需要我们写很多的JSON配置来告诉IDE该如何进行代码补全和附加上下文信息,配置和代码还是处于分离的状态, 如果能通过写一个配置类,直接通过这个类和它的注释 就能为我们做到IDE支持就好了——Spring Boot开发者也是这么想的。

为代码自动生成配置项元数据

首先我们要改掉随处使用@Value的习惯,使用专门的数据类来存放我们的配置项

接下来我们创建一个Bean,让Spring Boot容器来接管这个类的实例

通过@ConfigurationProperties注解,Spring就会自动将配置注入到我们的配置Bean中,但是此时IDE还无法识别我们添加的自动配置,我们需要添加Spring Boot的注解处理器(annotation processor,从Java 1.6开始支持的特性)

添加注解处理器后重新编译,我们就会在target目录下看到自动生成的META-INF/spring-configuration-metadata.json

里面的内容基本就是我们之前自己手动输入的内容,只是受于Java代码表达信息的局限性,没有办法生成hints信息。其中sourceType和sourceMethod属性还可以帮助IDE跳转到我们声明这个配置的类和方法

如果我们想要让我们使用代码生成的配置类也能添加提示的话,可以在我们的META-INF目录下添加additional-spring-configuration-metadata.json文件,将hints写到这个文件里面

这样Spring Boot在编译的时候就会将我们的提示信息合并到配置信息元数据文件里面了

虽然这些工作不会增加代码的运行效率,但是让我们的配置集中起来并有IDE的加成,会让我们更改配置的时候更加有信心。正如开头所说的, 代码是写给人看的,不是写给机器看的,只是顺便计算机可以执行而已。

到此这篇关于详解如何为SpringBoot项目中的自定义配置添加IDE支持的文章就介绍到这了,更多相关SpringBoot 添加IDE支持内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

时间: 2021-02-22

Springboot在IDEA热部署的配置方法

1 pom.xml文件 注:热部署功能spring-boot-1.3开始有的 <!--添加依赖--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <!-- optional=true,依赖不会传递,该项目依赖devtools:之后依赖myboot项目的项目如果想要使用d

intellij IDEA配置springboot的图文教程

IntelliJ IDEA 简介 IDEA 全称 IntelliJ IDEA,是java语言开发的集成环境,IntelliJ在业界被公认为最好的java开发工具之一,尤其在智能代码助手.代码自动提示.重构.J2EE支持.各类版本工具(git.svn.github等).JUnit.CVS整合.代码分析. 创新的GUI设计等方面的功能可以说是超常的.IDEA是JetBrains公司的产品,这家公司总部位于捷克共和国的首都布拉格,开发人员以严谨著称的东欧程序员为主.它的旗舰版本还支持HTML,CSS,

SpringBoot 添加JSP 支持并附带在IDEA下创建JSP文件【测试无误】

1添加 maven依赖 <!-- tomcat , jsp 的支持 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> </dependency> <dependency> <groupId>org.apache.tomcat.

IDEA SpringBoot项目配置热更新的步骤详解(无需每次手动重启服务器)

IDEA SpringBoot项目配置热更新的步骤 1.在pom.xml中添加依赖: <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency> 2.在pom.xml中添加插件: <

springboot项目idea热部署的教程详解

1.添加依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> <scope>true</scope> </dependency> 2.开启自动编译 3.ctrl+shifi+alt

关于在IDEA中SpringBoot项目中activiti工作流的使用详解

记录一下工作流的在Springboot中的使用,,顺便写个demo,概念,什么东西的我就不解释了,如有问题欢迎各位大佬指导一下. 1.创建springboot项目后导入依赖 <dependency> <groupId>org.activiti</groupId> <artifactId>activiti-spring-boot-starter-basic</artifactId> <version>6.0.0</version&

PyCharm配置anaconda环境的步骤详解

PyCharm是一款很好用很流行的python编辑器.Anaconda是专注于数据分析的Python发行版本,包含了conda.Python等190多个科学包及其依赖项.Anaconda通过管理工具包.开发环境.Python版本,大大简化了你的工作流程. 不仅可以方便地安装.更新.卸载工具包,而且安装时能自动安装相应的依赖包,同时还能使用不同的虚拟环境隔离不同要求的项目.anaconda自带集成开发环境spyder.有些人不喜欢spyder的风格. 个人感觉其提示功能也不及PyCharm.如果能

Intellij IDEA 配置Subversion插件实现步骤详解

Intellij IDEA 配置Subversion插件实现步骤详解 在使用Intellij的过程中,突然发现svn不起效了,在VCS–>Checkout from Version Control中也未发现Subversion这一项.如下图: 一.原因查找 经过分析是因为插件被禁用或移除导致此功能失效. 二.解决方案 打开Settings,Plugins,搜索Subversion,在筛选出结果的方框上打勾,即可启动插件.如下图: 三.使用方法 点击VCS–>Enable Version -.-

使用git迁移Laravel项目至新开发环境的步骤详解

对于如何创建一个Laravel项目,相信对新接触Laravel的朋友并不存在太多的问题,但是今天我们要来看一下如何将已有的Laravel项目迁移(复制)到新的开发环境. 我们需要用到的工具是git,如果你不知道git是什么,这里有一个传送门,看完之后再回来: http://github.com 简单说来,git就是Github开发的VCS(Version Control System),即版本控制系统.如果你使用过SVN,那么你应该很清楚版本控制是什么. 本文的示例环境是Ubuntu 16.04

vue实现的多页面项目如何优化打包的步骤详解

遇到的问题 在多页面框架打包的过程中会,随着业务的增加页面越来越多,使用的三方包也会越来越多,但并不是所有页面都会使用到三方插件,使用webpack打包会让所有的三方包打包到一起,会导致vendor.js(三方包打包后的文件)越来越大,即使没使用过三方插件的页面也会引入,页面加载会越来越慢. 如何优化 使用cdn引入,这种就每次新建一个页面的时候手动通过cdn的方式引入,但是并不是特别好的方式,还需要手动加入. 就是使用splitChunks分割三方包,将三方包单独打包出来,根据页面的依赖情况自

微信Android热更新Tinker使用详解(星空武哥)

Tinker是什么 Tinker是微信官方的Android热补丁解决方案,它支持动态下发代码.So库以及资源,让应用能够在不需要重新安装的情况下实现更新.当然,你也可以使用Tinker来更新你的插件. 它主要包括以下几个部分: gradle编译插件: tinker-patch-gradle-plugin 核心sdk库: tinker-android-lib 非gradle编译用户的命令行版本: tinker-patch-cli.jar 为什么使用Tinker 当前市面的热补丁方案有很多,其中比较

CentOS安装配置MySQL8.0的步骤详解

前言 这里记录下在CentOS 上,安装配置MySQL的步骤: 正文 下载yum源的安装包 yum localinstall https://repo.mysql.com//mysql80-community-release-el7-1.noarch.rpm 安装 yum install mysql-community-server 启动服务 service mysqld start 查看状态 service mysqld status 查看初始密码 grep 'temporary passwo

Nginx部署https网站并配置地址重写的步骤详解

Nginx是一款高性能的网站服务器和反向代理服务器,同时也是一个IMAP.POP3.SMTP等邮件代理服务器:nginx可以作为一个网站服务器进行网站的发布处理,另外nginx可以作为反向代理实现负载均衡的.本文介绍如何在centos6.9环境中,利用Nginx部署https网站,并配置地址重写. 1.环境准备:centos6.9主机一台,关闭防火墙和Selinux 安装依赖包:yum -y install openssl-devel  pcre-devel gcc 创建nginx用户: use