目前,配置属性注释处理器从类的字段中获取属性描述。这不适用于记录,因为它们没有字段。如果我们能够设计一些其他方式从记录来源获取属性描述,那就太好了。目前,您必须使用额外的元数据。
@param
一种可能是从记录级 javadoc 中读取s:
/**
* @param someProperty An example property to be described in the metadata.
*/
@ConfigurationProperties(prefix = "record")
public record MyRecordProperties(String someProperty) { }
在此示例中,我们已经生成了元数据someProperty
:
{
"name": "record.some-property",
"type": "java.lang.String",
"sourceType": "com.example.recordconfigpropstest.MyRecordProperties"
}
我们的目标是description
:
{
"name": "record.some-property",
"type": "java.lang.String",
"description": "An example property to be described in the metadata.",
"sourceType": "com.example.recordconfigpropstest.MyRecordProperties"
}