Zugriff auf Spring Configuration Eigenschaften Metadaten über Code API

Question

Ich habe vor kurzem gelernt, dass es für Spring möglich ist, die spring-configuration-metadata.json Datei zu generieren und auch eine additional-spring-configuration-metadata.json Datei zu erstellen.

Ist es möglich, nativ auf diese Informationen über Spring zuzugreifen und beispielsweise Hilfemeldungen auszudrucken, die aus dieser JSON-Datei extrahiert wurden? Ich habe nichts dergleichen in der Spring documentation erwähnt. Soweit ich das beurteilen kann, sind Konfigurationsklassen POJOs, denen in den tatsächlich injizierten Objekten keine Spring-Metadaten zugeordnet sind.

Sagen, ich habe die folgende Klasse:

package test; 

import org.springframework.boot.context.properties.ConfigurationProperties; 

@ConfigurationProperties(prefix = "myConfig") 
public class MyConfig 
{ 
    /** 
    * myField description. 
    */ 
    private int myField = 3; 

    public int setMyField(int i){ myField = i; } 
    public int getMyField(){ return myField; } 
} 

Und dies wird die folgenden Metadaten erzeugen:

{ 
    "groups": [{ 
    "name": "myConfig", 
    "type": "test.MyConfig", 
    "sourceType": "test.MyConfig" 
    }], 
    "properties": [ 
    { 
     "name": "myConfig", 
     "type": "java.lang.Integer", 
     "description": "myField description.", 
     "sourceType": "test.MyConfig", 
     "defaultValue": 3 
    } 
    ], 
    "hints": [] 
} 

Idealerweise würde ich einen Weg MyConfig.getMyField().getDescription() und "myField description", dass die Rückkehr hat zu schreiben. Ich möchte auch in der Lage sein, zusätzliche Metadaten in JSON hinzuzufügen und sie auf ähnliche Weise abzurufen.

Answer 1

Spring Boot wird mit einem separaten Modul geliefert, das genau das tut. Es wird intern für Tools verwendet, die die Konsistenz der Metadaten überprüfen. Dies ist auch die Grundlage der STS-Unterstützung.

Überprüfen Sie das Projekt spring-boot-configuration-metadata.

Wenn Sie diese zu Ihrem Projekt hinzufügen, können Sie ganz einfach eine Sammlung von Schlüsseln in der aktuellen Classpath definiert bauen:

Resource[] resources = new PathMatchingResourcePatternResolver() 
    .getResources("classpath*:META-INF/spring-configuration-metadata.json"); 
ConfigurationMetadataRepositoryJsonBuilder builder = ConfigurationMetadataRepositoryJsonBuilder.create(); 
for (Resource resource : resources) { 
    try (InputStream in = resource.getInputStream()) { 
     builder.withJsonResource(in); 
    } 
} 
ConfigurationMetadataRepository repository = builder.build();