Einführung in Methoden zur Erweiterung der Unterstützung für XML-Anfragen und -Antworten in Spring Boot

Dieser Artikel bietet Ihnen eine Einführung in die Methoden zur Erweiterung der XML-Anfrage- und Antwortunterstützung in Spring Boot. Ich hoffe, dass er für Sie hilfreich ist.

In allen vorherigen Spring Boot-Tutorials haben wir nur die Anforderungs- und Antwortverarbeitung für HTML- und JSON-Formate erwähnt und verwendet. Wie kann man also Anfragen im XML-Format schnell in Objekte im Controller packen und ein Objekt im XML-Format zurückgeben?

Implementierungsprinzip: Nachrichtenkonverter (Nachrichtenkonverter)

Bevor wir die obige Frage erweitern, müssen wir zunächst wissen, dass die Implementierung der Verarbeitung von HTTP-Anforderungen in Spring Boot Spring MVC verwendet. In Spring MVC gibt es ein Konzept des Nachrichtenkonverters, das hauptsächlich für die Verarbeitung von Anforderungsdaten in verschiedenen Formaten und deren Konvertierung in Objekte verantwortlich ist, um ein besseres Programmiererlebnis zu ermöglichen.

Die HttpMessageConverter-Schnittstelle ist in Spring MVC definiert und abstrahiert die Art, Beurteilung und Funktionsweise des Nachrichtenkonverters beim Lesen und Schreiben. Konkret können Sie die folgende Definition sehen:

public interface HttpMessageConverter<T> {

    boolean canRead(Class<?> clazz, [@Nullable](https://my.oschina.net/u/2896689) MediaType mediaType);

    boolean canWrite(Class<?> clazz, [@Nullable](https://my.oschina.net/u/2896689) MediaType mediaType);

    List<MediaType> getSupportedMediaTypes();

    T read(Class<? extends T> clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException;

    void write(T t, [@Nullable](https://my.oschina.net/u/2896689) MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException;

}

Wie wir Wie Sie alle wissen, gibt es für HTTP-Anfragen Content-Type verschiedene Formatdefinitionen. Wenn Sie die Nachrichtenkonvertierung im XML-Format unterstützen möchten, müssen Sie den entsprechenden Konverter verwenden. Spring MVC verfügt standardmäßig bereits über eine Reihe von von Jackson implementierten Konvertern, MappingJackson2XmlHttpMessageConverter.

Erweiterte Implementierung

Schritt 1: Einführung des XML-Nachrichtenkonverters

In herkömmlichen Spring-Anwendungen können wir die Implementierung der Nachrichtenkonvertierung für Daten im XML-Format durch die folgende Konfiguration hinzufügen:

@Configuration
public class MessageConverterConfig1 extends WebMvcConfigurerAdapter {
    [@Override](https://my.oschina.net/u/1162528)
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        Jackson2ObjectMapperBuilder builder = Jackson2ObjectMapperBuilder.xml();
        builder.indentOutput(true);
        converters.add(new MappingJackson2XmlHttpMessageConverter(builder.build()));
    }
}

In der Spring Boot-Anwendung müssen Sie nicht so mühsam sein wie oben. Sie müssen nur die Abhängigkeit jackson-dataformat-xml hinzufügen, und Spring Boot führt automatisch die Implementierung von MappingJackson2XmlHttpMessageConverter ein:

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

Gleichzeitig, um XML-Daten zu konfigurieren Die Anmerkungen, die zur Aufrechterhaltung der Beziehung zwischen Objektattributen verwendet werden, befinden sich ebenfalls in den oben genannten Abhängigkeiten, sodass diese Abhängigkeit ebenfalls erforderlich ist.

Schritt 2: Definieren Sie die Beziehung zwischen dem Objekt und Unter ihnen: @Data, @NoArgsConstructor, @AllArgsConstructor sind Annotationen für Lombok zur Vereinfachung des Codes, die hauptsächlich zum Generieren von Get-, Set- und Konstruktorfunktionen verwendet werden. Die Annotationen @JacksonXmlRootElement und @JacksonXmlProperty werden verwendet, um die Korrespondenz zwischen Objektattributen in XML aufrechtzuerhalten.

Das oben konfigurierte Benutzerobjekt, das XML-Beispiel, das zugeordnet werden kann, ist wie folgt (Sie können die obige XML verwenden, um die Schnittstelle später anzufordern):

@Data
@NoArgsConstructor
@AllArgsConstructor
@JacksonXmlRootElement(localName = "User")
public class User {

    @JacksonXmlProperty(localName = "name")
    private String name;
    @JacksonXmlProperty(localName = "age")
    private Integer age;

}

Schritt 3: Erstellen Sie eine Schnittstelle zu XML-Anfragen empfangen

Nachdem Sie das zu konvertierende Objekt fertiggestellt haben, können Sie eine Schnittstelle zum Empfangen von XML und zum Zurückgeben von XML schreiben, z. B.:

<User>
    <name>aaaa</name>
    <age>10</age>
</User>

Starten Sie abschließend die Spring Boot-Anwendung und probieren Sie diese Schnittstelle aus Über Anforderungstools wie POSTMAN können Sie sehen, dass die XML-Datei angefordert und der verarbeitete XML-Inhalt zurückgegeben wird. (

Fallcode

)

Das obige ist der detaillierte Inhalt vonEinführung in Methoden zur Erweiterung der Unterstützung für XML-Anfragen und -Antworten in Spring Boot. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!