记录Spring Boot应用程序的配置

Question

我有一个Spring Boot应用程序，它支持可以使用应用程序设置的各种配置属性。yaml、环境变量或系统属性。目前，确定支持哪些属性的唯一方法是询问其他开发人员或深入了解属性对象的代码。有没有比这更好的方法来生成某种形式的文档？我搜索了一下，却找不到任何答案，似乎没有人在记录他们的配置，或者是以特别的手动方式进行。理想情况下，通过属性配置的bean将具有Javadoc样式的注释，它们将由Spring工具扫描，并生成一个HTML或标记文档，其中包含所有支持的属性和从Javadoc样式的注释中提取的描述。

Answer 1

您可以尝试使用Spring Boot配置处理器生成配置元数据文件，如spring文档中所述。Spring随后将生成一个名为Spring配置元数据的文件。json，其中将包括所有@ConfigurationProperties类的所有字段。如果proeprites类中的字段用Javadoc注释进行了注释，那么这个注释也将包含在JSON中。在IntelliJ中，如果显示配置属性的描述，则该注释将显示在弹出窗口中。

但是，这只适用于带有@ConfigurationProperties注释的类。这意味着，通过直接向类注入Spring@Value注释（例如@Value（${myapp.my setting}”）来获取配置属性的类，这种方法不起作用。但据我所知，这可能是一种方法，可以让你自动最大限度地利用Spring。