Spring Boot呼び出しSOAP Webサービス
Spring Bootプロジェクトでは、残されたSOAP Webサービスを呼び出す方法が簡単で、spring-boot-starter-web-servicesを導入するだけです.
WebServiceTemplate
WebServiceTemplateを使用してSOAP Serviceを呼び出します.WebServiceTemplateは、sendSourceAndReceive、marshalSendAndReceive、sendAndReceiveの3つの呼び出し方法を提供します.sendSourceAndReceiveメソッドはXMLメッセージを直接送信および受信する.marshalSendAndReceiveメソッドは、結果を送信、受信するオブジェクトであり、構成されたMarshallerとUnmarshallerによって自動的に変換されます.sendAndReceiveは、より下位レベルの操作をサポートします.
marshalSendAndReceiveはよく使われる方法です.wsdlファイルを読むことで、Webサービスでサポートされている方法とパラメータを知ることができます.また、SoapUIツールを使用してrequest、response XMLを生成し、SOAP Domainオブジェクトを手動で作成することもできます.より簡単な方法はmaven-jaxb 2-pluginプラグインを使用して自動的に生成することです.
maven-jaxb2-plugin
以上のように構成すると、wsdlファイルはresources/wsdlフォルダに格納され、mavenコンパイル時に指定パッケージでpackage-infoを含むすべてのWebサービスメソッドに関連するstubクラスが生成する.JAva、ObjectFactory、request、response、XML注記が構成されています.package-info.java
ObjectFactory
RequestRequestクラス名はWebサービスメソッド名、属性はWebサービスパラメータに対応します.
Response
牛刀小試
WebServiceTemplateBuildeとJaxb 2 marshallerの構成:
Webサービスの呼び出し:
リファレンスドキュメント
Spring Boot Reference GuideSpring Boot SOAP Client – WebServiceTemplate Example
org.springframework.boot
spring-boot-starter-web-services
WebServiceTemplate
WebServiceTemplateを使用してSOAP Serviceを呼び出します.WebServiceTemplateは、sendSourceAndReceive、marshalSendAndReceive、sendAndReceiveの3つの呼び出し方法を提供します.sendSourceAndReceiveメソッドはXMLメッセージを直接送信および受信する.marshalSendAndReceiveメソッドは、結果を送信、受信するオブジェクトであり、構成されたMarshallerとUnmarshallerによって自動的に変換されます.sendAndReceiveは、より下位レベルの操作をサポートします.
package org.iata.caims.service.ws;
import org.springframework.boot.webservices.client.WebServiceTemplateBuilder;
import org.springframework.stereotype.Service;
import org.springframework.ws.client.core.WebServiceTemplate;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import java.io.StringReader;
@Service
public class MyService {
private static final String DEFAULT_URI = "http://localhost:8080/HelloService";
private static final String MESSAGE = "" +
"
" +
" COCO
" +
" ";
private final WebServiceTemplate webServiceTemplate;
public MyService(WebServiceTemplateBuilder webServiceTemplateBuilder) {
this.webServiceTemplate = webServiceTemplateBuilder.setDefaultUri(DEFAULT_URI).build();
}
public void sendSourceAndReceive() {
StreamSource source = new StreamSource(new StringReader(MESSAGE));
StreamResult result = new StreamResult(System.out);
webServiceTemplate.sendSourceAndReceiveToResult(source, result);
}
public Object marshalSendAndReceive(String uri, Object requestPayload) {
return this.webServiceTemplate.marshalSendAndReceive(uri, requestPayload);
}
}
marshalSendAndReceiveはよく使われる方法です.wsdlファイルを読むことで、Webサービスでサポートされている方法とパラメータを知ることができます.また、SoapUIツールを使用してrequest、response XMLを生成し、SOAP Domainオブジェクトを手動で作成することもできます.より簡単な方法はmaven-jaxb 2-pluginプラグインを使用して自動的に生成することです.
maven-jaxb2-plugin
org.jvnet.jaxb2.maven2
maven-jaxb2-plugin
0.14.0
generate
org.itrunner.ws
${project.basedir}/src/main/java
${project.basedir}/src/main/resources/wsdl
*.wsdl
以上のように構成すると、wsdlファイルはresources/wsdlフォルダに格納され、mavenコンパイル時に指定パッケージでpackage-infoを含むすべてのWebサービスメソッドに関連するstubクラスが生成する.JAva、ObjectFactory、request、response、XML注記が構成されています.package-info.java
@javax.xml.bind.annotation.XmlSchema(namespace = "http://webservice.itrunner.org", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
package org.iata.caims.service.test;
ObjectFactory
import javax.xml.bind.annotation.XmlRegistry;
@XmlRegistry
public class ObjectFactory {
/**
* Create a new ObjectFactory that can be used to create new instances of schema derived classes for package: org.itrunner.ws
*/
public ObjectFactory() {
}
/**
* Create an instance of {@link SayHello }
*/
public SayHello createSayHello() {
return new SayHello();
}
/**
* Create an instance of {@link SayHelloResponse }
*/
public SayHelloResponse createSayHelloResponse() {
return new SayHelloResponse();
}
}
RequestRequestクラス名はWebサービスメソッド名、属性はWebサービスパラメータに対応します.
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"in0"
})
@XmlRootElement(name = "sayHello")
public class SayHello {
@XmlElement(required = true, nillable = true)
protected String in0;
/**
* Gets the value of the in0 property.
*
* @return possible object is {@link String }
*/
public String getIn0() {
return in0;
}
/**
* Sets the value of the in0 property.
*
* @param value allowed object is {@link String }
*/
public void setIn0(String value) {
this.in0 = value;
}
}
Response
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "", propOrder = {
"out"
})
@XmlRootElement(name = "sayHelloResponse")
public class SayHelloResponse {
@XmlElement(required = true, nillable = true)
protected String out;
/**
* Gets the value of the out property.
*
* @return possible object is {@link String }
*/
public String getOut() {
return out;
}
/**
* Sets the value of the out property.
*
* @param value allowed object is {@link String }
*/
public void setOut(String value) {
this.out = value;
}
}
牛刀小試
WebServiceTemplateBuildeとJaxb 2 marshallerの構成:
import org.springframework.boot.webservices.client.HttpWebServiceMessageSenderBuilder;
import org.springframework.boot.webservices.client.WebServiceTemplateBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.oxm.jaxb.Jaxb2Marshaller;
import org.springframework.ws.client.core.WebServiceTemplate;
import static java.time.Duration.ofSeconds;
@Configuration
public class Config {
@Bean
public WebServiceTemplate webServiceTemplate(WebServiceTemplateBuilder builder) {
return builder.messageSenders(new HttpWebServiceMessageSenderBuilder().setConnectTimeout(ofSeconds(60)).setReadTimeout(ofSeconds(60)).build()).build();
}
@Bean
public Jaxb2Marshaller jaxb2Marshaller() {
Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
marshaller.setContextPath("org.itrunner.ws");
return marshaller;
}
}
Webサービスの呼び出し:
import org.springframework.boot.webservices.client.WebServiceTemplateBuilder;
import org.springframework.oxm.jaxb.Jaxb2Marshaller;
import org.springframework.stereotype.Service;
import org.springframework.ws.client.core.WebServiceTemplate;
@Service
public class HelloService {
private static final String DEFAULT_URI = "http://localhost:8080/HelloService";
private final WebServiceTemplate webServiceTemplate;
public HelloService(WebServiceTemplateBuilder webServiceTemplateBuilder, Jaxb2Marshaller jaxb2Marshaller) {
this.webServiceTemplate = webServiceTemplateBuilder.setDefaultUri(DEFAULT_URI)
.setMarshaller(jaxb2Marshaller).setUnmarshaller(jaxb2Marshaller).build();
}
public SayHelloResponse sayHello(SayHello request) {
return (SayHelloResponse) this.webServiceTemplate.marshalSendAndReceive(request);
}
}
リファレンスドキュメント
Spring Boot Reference GuideSpring Boot SOAP Client – WebServiceTemplate Example