文章目录
- 1. 引入依赖
- 2. 开启 IDEA 配置
- 3. 使用 @ConfigurationProperties 自定义配置
- 4. 编译项目,自动生成 spring-configuration-metadata.json 文件
- 文件中的属性值介绍
- 5. 可以看到有提示了
官方文档:https://docs.spring.io/spring-boot/docs/2.2.2.RELEASE/reference/html/appendix-configuration-metadata.html#configuration-metadata-annotation-processor
1. 引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
2. 开启 IDEA 配置
在 idea 设置中搜索 Annotation Processors
,接下来勾住 Enable annonation processing
就完成了。
3. 使用 @ConfigurationProperties 自定义配置
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "self")
@Data
public class SelfConfiguration {
private String name;
private Integer age;
}
需要开启自动配置(@EnableConfigurationProperties
)和扫描包(@ConfigurationPropertiesScan
):
@SpringBootApplication
@EnableConfigurationProperties
@ConfigurationPropertiesScan("com")
public class SpringboottestApplication {
public static void main(String[] args) {
SpringApplication.run(SpringboottestApplication.class, args);
}
}
4. 编译项目,自动生成 spring-configuration-metadata.json 文件
配置元数据文件位于jar下面。 META-INF/spring-configuration-metadata.json
它们使用简单的 JSON 格式,其中的项目分类在 groups
或 properties
下,其他值提示分类在 hints
下
文件中的属性值介绍
-
name | String:
属性的全名。名称采用小写的周期分隔形式(例如server.address)。此属性是强制性的。 -
type | String:
属性的数据类型的完整签名(例如java.lang.String),但也是完整的泛型类型(例如java.util.Map)。
您可以使用此属性来指导用户可以输入的值的类型。为了保持一致性,通过使用其包装对应项(例如,boolean变为java.lang.Boolean)来指定基元的类型。
请注意,此类可能是一个复杂类型,它从Stringas绑定的值转换而来。如果类型未知,则可以省略。 -
description | String:
可以向用户显示的组的简短描述。如果没有可用的描述,则可以省略。建议描述为简短段落,第一行提供简明摘要。描述中的最后一行应以句点(.)结尾。 -
sourceType | String:
贡献此属性的源的类名称。例如,如果属性来自带注释的类@ConfigurationProperties,则此属性将包含该类的完全限定名称。如果源类型未知,则可以省略。
defaultValue | Object | 默认值,如果未指定属性,则使用该值。如果属性的类型是数组,则它可以是值数组。如果默认值未知,则可以省略。 -
deprecation | Object
-
level | String
弃用级别,可以是warning(默认)或error。当属性具有warning弃用级别时,它仍应绑定在环境中。但是,当它具有error弃用级别时,该属性不再受管理且不受约束。 -
reason | String
该属性被弃用的原因的简短描述。如果没有可用的原因,可以省略。建议描述为简短段落,第一行提供简明摘要。描述中的最后一行应以句点(.)结尾。 -
replacement | String
替换此不推荐使用的属性的属性的全名。如果此属性没有替换,则可以省略。
-
示例:从 mybatis-spring-boot-starter 里粘出来的一部分
{
"properties": [
{
"sourceType": "org.apache.ibatis.session.Configuration",
"defaultValue": "org.apache.ibatis.scripting.xmltags.XMLLanguageDriver",
"name": "mybatis.configuration.default-scripting-language",
"description": "A default LanguageDriver class.",
"type": "java.lang.Class<? extends org.apache.ibatis.scripting.LanguageDriver>",
"deprecation": {
"reason": "Because when this configuration property is used, there is case that custom language driver cannot be registered correctly.",
"replacement": "mybatis.default-scripting-language-driver"
}
}
]
}