- ubuntu12.04环境下使用kvm ioctl接口实现最简单的虚拟机
- Ubuntu 通过无线网络安装Ubuntu Server启动系统后连接无线网络的方法
- 在Ubuntu上搭建网桥的方法
- ubuntu 虚拟机上网方式及相关配置详解
CFSDN坚持开源创造价值,我们致力于搭建一个资源共享平台,让每一个IT人在这里找到属于你的精彩世界.
这篇CFSDN的博客文章详解如何为SpringBoot项目中的自定义配置添加IDE支持由作者收集整理,如果你对这篇文章有兴趣,记得点赞哟.
代码是写给人看的,不是写给机器看的,只是顺便计算机可以执行而已 ——《计算机程序的构造和解释(SICP)》 导言 。
在我们的项目里经常会出现需要添加自定义配置的应用场景,例如某个开关变量,在测试环境打开,在生产环境不打开,通常我们都会使用下面的代码来实现,然后在Spring Boot配置文件中添加这个key和Value 。
Application.java
application.properties 。
或者是没有使用@Value而直接在XML中使用我们配置的属性值 。
application.xml 。
这样的代码和配置在Spring Boot项目中可以正常启动并读取配置,但是在我们的IDE中却不会为我们提示配置的类型和代码补全。当我们有新同事到来,或者是需要为配置文件添加新的环境的支持的时候,我们很容易会把配置文件的Key拼错,或者Value的值与我们的变量类型并不兼容(实际上真的发生过这样的问题导致项目启动失败).
但是在我们使用Spring Boot提供的配置的时候,IDE总是能为我们自动补全,告诉我们这个配置的变量类型,甚至是给我们把这个配置的描述显示出来.
我们是否也可以为我们自己写的配置添加这样的IDE支持呢?
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支持内容请搜索我以前的文章或继续浏览下面的相关文章希望大家以后多多支持我! 。
原文链接:https://segmentfault.com/a/1190000039254401 。
最后此篇关于详解如何为SpringBoot项目中的自定义配置添加IDE支持的文章就讲到这里了,如果你想了解更多关于详解如何为SpringBoot项目中的自定义配置添加IDE支持的内容请搜索CFSDN的文章或继续浏览相关文章,希望大家以后支持我的博客! 。
SpringBoot-Admin 服务监控 简单介绍 Spring Boot Actuator 是 Spring Boot 自带的一个功能模块, 提供了一组已经开箱即用的生产环境下常用
我想查找通过关键字匹配字段 nameEnglish 或 nameChinese 的模型列表。我花了一个多小时谷歌搜索但我做不到。请帮忙。 Springboot Mongo 入门示例 https://s
(请注意:在调查 this issue 时,我更好地发现了我在此处介绍的问题根源) 我对 Hibernate 和 SpringBoot 非常陌生。我的项目涉及一个搜索引擎,其中索引(javafx 客户
我最近有一个 Web 应用程序从 springboot 升级到 springboot 2。当我将其部署到 Tomcat 8 时,它似乎启动了,但没有完全启动。 在 localhost.2019-09-
我是 Spring boot 的新手...我在运行 Controller 时遇到问题, Description: Field todoService in com.springboot.todoCon
我有一个SpringBoot应用程序,它使用以下配置与PostgreSQL通信,通过AWS Beanstrik部署:。在我将AWS Aurora证书更新为rds-ca-ecc384-g1之前,一切都很
一、介绍 在实际的软件系统开发过程中,由于业务的需求,在代码层面实现数据的脱敏还是远远不够的,往往还需要在数据库层面针对某些关键性的敏感信息,例如:身份证号、银行卡号、手机号、工资等信息进行加密存储
Selenium Selenium是一个用于Web应用程序自动化测试的开源工具套件。它主要用于以下目的: 浏览器自动化:Selenium能够模拟真实用户在不同浏览器(如Chrome、Fire
一、简介 在实际的项目开发过程中,经常需要用到邮件通知功能。例如,通过邮箱注册,邮箱找回密码,邮箱推送报表等等,实际的应用场景非常的多。 早期的时候,为了能实现邮件的自动发送功能,通常会使用 Ja
SpringBoot:基于redis自定义注解实现后端接口防重复提交校验 一、添加依赖 org.springframework.boot spring
SpringBoot:使用Jackson完成全局序列化配置 一、测试准备 com.fasterxml.jackson.core jackson-cor
springboot:整合rocketmq 一、简易消息操作 生产者整合mq 导入依赖 org.springframework.boot
springboot:常用注解 一、spring常用注解 包扫描+组件标注注解 @Component:泛指各种组件 @Controller、@Service、@Repository都可以称为@Comp
我们经常需要在两个系统之间进行一些数据的交互,这时候我们就需要开发数据交互接口。 一般来说,遇到比较多的接口有HTTP接口、WebService接口、FTP文件传输。今天我要来学习一下在SpringB
背景 近期项目上线,甲方要求通过安全检测才能进行验收,故针对扫描结果对系统进行了一系列的安全加固,本文对一些常见的安全问题及防护策略进行介绍,提供对应的解决方案 跨站脚本攻击 XSS常发生于论坛评论等
1.排除 Spring-boot-starter 默认的日志配置 将原本的 spring-boot-starter 改为 org.springframework.boot
springboot:解决跨域问题 一、跨域简介 URL的组成: // 协议 + 域名(子域名 + 主域名) + 端口号 + 资源地址 http://www.baidu.com:8080/ 只要协
一、自定义Starter 的思路: 创建一个Maven工程,创建三个模块 一个模块为demo-app,一个模块为demo-module,一个模块为demo-module-springboot-star
1.pom.xml 4.0.0 org.springframework.boot spring-boot-starter-parent
1.pom.xml 4.0.0 org.springframework.boot spring-boot-starter-parent
我是一名优秀的程序员,十分优秀!