Spring Boot - benutzerdefinierte Variablen in Application.properties

Question

Ich habe Spring Boot-Client, der eine erholsame API verbraucht. Statt die IP-Adresse der REST-API in der Java-Klasse fest zu codieren, gibt es einen Schlüsseleintrag in der application.properties, die ich verwenden kann?

Und wenn nicht, kann ich einen benutzerdefinierten Eintrag erstellen?

Dank

Answer 1

Die Infrastruktur, die Spring Boot verwendet, kann in Ihrem eigenen Projekt auf die gleiche Weise verwendet werden. Sie haben in @zmitrok eine Antwort zu einer Warnung "unbekannte Eigenschaft" kommentiert. Das liegt daran, dass Ihre Property keine Metadaten enthält, sodass die IDE nichts davon weiß.

Ich würde Ihnen dringend raten nicht @Value zu verwenden, wenn Sie können, da es eher begrenzt ist im Vergleich zu dem, was Angebote Frühlings-Boot (@Value ist eine Funktion, Spring Framework).

starten, indem Sie einige POJO für Ihre IP-Erstellung:

@ConfigurationProperties("app.foo") 
public class FooProperties { 

    /** 
    * IP of foo service used to blah. 
    */ 
    private String ip = 127.0.0.1; 

    // getter & setter 
} 

Dann haben Sie zwei Möglichkeiten

1. Put @Component auf FooProperties und die Verarbeitung von Konfigurationseigenschaften ermöglichen durch Zugabe von @EnableConfigurationProperties auf einem Ihrer @Configuration Klasse (dieser letzte Schritt ist nicht mehr erforderlich ab Spring Boot 1.3.0.M3)
2. Lassen Sie FooProperties als i s und fügen Sie @EnableConfigurationProperties(FooProperties.class) zu irgendeiner Ihrer Klasse hinzu, die eine Frühlings-Bohne automatisch für Sie verursacht.

Sobald Sie das getan haben, app.foo.ip in application.properties verwendet werden können, und Sie können @AutowiredFooProperties im Code für den Wert der Immobilie

@Component 
public MyRestClient { 

    private final FooProperties fooProperties; 

    @Autowired 
    public MyRestClient(FooProperties fooProperties) { ... } 

    public callFoo() { 
     String ip = this.fooProperties.getIp(); 
     ... 
    } 

} 

Gut aussehen, damit Ihre Schlüssel immer noch gelb ist in Ihrem IDE. Der letzte Schritt ist add an extra dependency that will look your code and generate the relevant meta-data at build time. Fügen Sie folgendes zu Ihrem pom.xml

<dependency> 
    <groupId>org.springframework.boot</groupId> 
    <artifactId>spring-boot-configuration-processor</artifactId> 
    <optional>true</optional> 
</dependency> 

Und voilà, Ihr Schlüssel erkannt wird, haben Sie javadoc und die IDE gibt Ihnen den Standardwert (den Wert, den Sie auf dem Feld initialisiert). Sobald Sie das haben, können Sie einen beliebigen Typ verwenden, den der Konvertierungsservice behandelt (d. H. URL), und das Javadoc auf dem Feld wird verwendet, um die Dokumentation für Ihre Schlüssel zu generieren.

Sie können auch eine JSR-303 Constraint-Validierung auf Ihrem Feld hinzufügen (z. B. eine Regex, um zu überprüfen, ob es sich um eine gültige IP handelt).

Überprüfen Sie this sample project und the documentation für weitere Details.

Answer 2

Sie können Ihre eigenen Einträge in die application.properties hinzufügen. So stellen Sie sicher, dass der Eigenschaftsname nicht mit den gemeinsamen Eigenschaften bei http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#common-application-properties

Answer 3

Statt hartzucodieren die IP aufgelistet kollidiert in die Properties-Datei, können Sie die Anwendung mit

-Dmy.property=127.127.10.20

und Frühlings-Boot starten automatisch abholen mit

@Value("${my.property}") 
private String myProperty;