WebServiceTemplate 是 Spring-WS 中客戶端 Web 服務訪問的核心類。它包含傳送 Source 物件，以及接收響應訊息作為 Source 或 Result 的方法。此外，它可以在透過傳輸傳送物件之前將物件 marshalling 到 XML，並將任何響應 XML 再次 unmarshalling 為物件。

<beans>

    <bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>

    <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
        <constructor-arg ref="messageFactory"/>
        <property name="defaultUri" value="http://example.com/WebService"/>
    </bean>

</beans>

<bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
    <constructor-arg ref="messageFactory"/>
    <property name="messageSender">
        <bean class="org.springframework.ws.transport.http.HttpComponentsMessageSender">
            <property name="credentials">
                <bean class="org.apache.http.auth.UsernamePasswordCredentials">
                    <constructor-arg value="john:secret"/>
                </bean>
            </property>
        </bean>
    </property>
    <property name="defaultUri" value="http://example.com/WebService"/>
</bean>

<beans>

    <bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>

    <bean id="connectionFactory" class="org.apache.activemq.ActiveMQConnectionFactory">
        <property name="brokerURL" value="vm://?broker.persistent=false"/>
    </bean>

    <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
        <constructor-arg ref="messageFactory"/>
        <property name="messageSender">
            <bean class="org.springframework.ws.transport.jms.JmsMessageSender">
                <property name="connectionFactory" ref="connectionFactory"/>
            </bean>
        </property>
        <property name="defaultUri" value="jms:RequestQueue?deliveryMode=NON_PERSISTENT"/>
    </bean>

</beans>

<beans>

    <bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>

    <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
        <constructor-arg ref="messageFactory"/>
        <property name="messageSender">
            <bean class="org.springframework.ws.transport.mail.MailMessageSender">
                <property name="from" value="Spring-WS SOAP Client &lt;[email protected]&gt;"/>
                <property name="transportUri" value="smtp://client:[email protected]"/>
                <property name="storeUri" value="imap://client:[email protected]/INBOX"/>
            </bean>
        </property>
        <property name="defaultUri" value="mailto:[email protected]?subject=SOAP%20Test"/>
    </bean>

</beans>

<beans>

    <bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory"/>

    <bean id="connection" class="org.springframework.ws.transport.xmpp.support.XmppConnectionFactoryBean">
        <property name="host" value="jabber.org"/>
        <property name="username" value="username"/>
        <property name="password" value="password"/>
    </bean>

    <bean id="webServiceTemplate" class="org.springframework.ws.client.core.WebServiceTemplate">
        <constructor-arg ref="messageFactory"/>
        <property name="messageSender">
            <bean class="org.springframework.ws.transport.xmpp.XmppMessageSender">
                <property name="connection" ref="connection"/>
            </bean>
        </property>
        <property name="defaultUri" value="xmpp:[email protected]"/>
    </bean>

</beans>

WebServiceTemplate 包含許多傳送和接收 Web 服務訊息的便利方法。有些方法接受並返回 Source，有些則返回 Result。此外，還有將物件 marshalling 到 XML 和 unmarshalling 物件的方法。以下是一個向 Web 服務傳送簡單 XML 訊息的示例。

import java.io.StringReader;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;

import org.springframework.ws.WebServiceMessageFactory;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.transport.WebServiceMessageSender;

public class WebServiceClient {

    private static final String MESSAGE =
        "<message xmlns=\"http://tempuri.org\">Hello Web Service World</message>";

    private final WebServiceTemplate webServiceTemplate = new WebServiceTemplate();

    public void setDefaultUri(String defaultUri) {
        webServiceTemplate.setDefaultUri(defaultUri);
    }

    // send to the configured default URI
    public void simpleSendAndReceive() {
        StreamSource source = new StreamSource(new StringReader(MESSAGE));
        StreamResult result = new StreamResult(System.out);
        webServiceTemplate.sendSourceAndReceiveToResult(source, result);
    }

    // send to an explicit URI
    public void customSendAndReceive() {
        StreamSource source = new StreamSource(new StringReader(MESSAGE));
        StreamResult result = new StreamResult(System.out);
        webServiceTemplate.sendSourceAndReceiveToResult("https://:8080/AnotherWebService",
            source, result);
    }

}

<beans xmlns="http://www.springframework.org/schema/beans">

    <bean id="webServiceClient" class="WebServiceClient">
        <property name="defaultUri" value="https://:8080/WebService"/>
    </bean>

</beans>

上述示例使用 WebServiceTemplate 向位於 https://:8080/WebService 的 Web 服務傳送一個 hello world 訊息（在 simpleSendAndReceive() 方法的情況下），並將結果寫入控制檯。WebServiceTemplate 被注入了預設 URI，該 URI 被使用是因為在 Java 程式碼中沒有顯式提供 URI。

請注意，WebServiceTemplate 類一旦配置完成就是執行緒安全的（假設它的所有依賴項也是執行緒安全的，Spring-WS 附帶的所有依賴項都是如此），因此如果需要，多個物件可以使用同一個共享的 WebServiceTemplate 例項。WebServiceTemplate 暴露了一個無參建構函式和 messageFactory/messageSender bean 屬性，可用於構造例項（使用 Spring 容器或普通 Java 程式碼）。或者，考慮從 Spring-WS 的 WebServiceGatewaySupport 便利基類派生，它暴露了便利的 bean 屬性以方便配置。（你不必繼承這個基類...它僅作為便利類提供。）

為了方便傳送普通 Java 物件，WebServiceTemplate 有許多 send(..) 方法，這些方法接受 Object 作為訊息資料內容的引數。WebServiceTemplate 類中的 marshalSendAndReceive(..) 方法將請求物件到 XML 的轉換委託給 Marshaller，並將響應 XML 到物件的轉換委託給 Unmarshaller。（有關 marshalling 和 unmarshaller 的更多資訊，請參考 Spring 文件。）透過使用 marshaller，你的應用程式程式碼可以專注於正在傳送或接收的業務物件，而無需關心它如何表示為 XML 的細節。為了使用 marshalling 功能，你必須使用 WebServiceTemplate 類的 marshaller/unmarshaller 屬性設定 marshaller 和 unmarshaller。

為了適應在訊息上設定 SOAP 頭和其他設定，WebServiceMessageCallback 介面允許你在訊息建立之後、傳送之前訪問訊息。下面的示例演示瞭如何在一個透過 marshalling 物件建立的訊息上設定 SOAP Action 頭。

public void marshalWithSoapActionHeader(MyObject o) {

    webServiceTemplate.marshalSendAndReceive(o, new WebServiceMessageCallback() {

        public void doWithMessage(WebServiceMessage message) {
            ((SoapMessage)message).setSoapAction("http://tempuri.org/Action");
        }
    });
}

webServiceTemplate.marshalSendAndReceive(o, new ActionCallback("http://samples/RequestOrder"));

WebServiceMessageExtractor 介面是一個低階 callback 介面，允許你完全控制從接收到的 WebServiceMessage 中提取 Object 的過程。WebServiceTemplate 將在所提供的 WebServiceMessageExtractor 上呼叫 extractData(..) 方法，同時與服務資源的底層連線仍然開啟。以下示例說明了 WebServiceMessageExtractor 的實際應用

public void marshalWithSoapActionHeader(final Source s) {
    final Transformer transformer = transformerFactory.newTransformer();
    webServiceTemplate.sendAndReceive(new WebServiceMessageCallback() {
        public void doWithMessage(WebServiceMessage message) {
            transformer.transform(s, message.getPayloadResult());
        },
        new WebServiceMessageExtractor() {
            public Object extractData(WebServiceMessage message) throws IOException
                // do your own transforms with message.getPayloadResult()
                //     or message.getPayloadSource()
            }
        });
}

Spring Web Services 2.0 引入了建立 Web 服務客戶端整合測試的支援。在此上下文中，客戶端是使用 WebServiceTemplate 訪問 Web 服務的類。

整合測試支援位於 org.springframework.ws.test.client 包中。該包中的核心類是 MockWebServiceServer。其基本思想是 Web 服務模板連線到此模擬伺服器，向其傳送請求訊息，然後模擬伺服器根據已註冊的期望進行驗證。如果滿足期望，模擬伺服器然後準備一個響應訊息，並將其傳送回模板。

MockWebServiceServer 的典型用法是

例如，考慮這個 Web 服務客戶端類

import org.springframework.ws.client.core.support.WebServiceGatewaySupport;

public class CustomerClient extends WebServiceGatewaySupport {                           

  public int getCustomerCount() {
    CustomerCountRequest request = new CustomerCountRequest();                           
    request.setCustomerName("John Doe");

    CustomerCountResponse response =
      (CustomerCountResponse) getWebServiceTemplate().marshalSendAndReceive(request);    
      
    return response.getCustomerCount();
  }

}

CustomerClient 的典型測試如下所示

import javax.xml.transform.Source;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.xml.transform.StringSource;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import static org.junit.Assert.assertEquals;

import org.springframework.ws.test.client.MockWebServiceServer;                          
import static org.springframework.ws.test.client.RequestMatchers.*;                      
import static org.springframework.ws.test.client.ResponseCreators.*;                     

@RunWith(SpringJUnit4ClassRunner.class)                                                  
@ContextConfiguration("integration-test.xml")                                            
public class CustomerClientIntegrationTest {

  @Autowired
  private CustomerClient client;                                                         

  private MockWebServiceServer mockServer;                                               

  @Before
  public void createServer() throws Exception {
    mockServer = MockWebServiceServer.createServer(client);
  }

  @Test
  public void customerClient() throws Exception {
    Source requestPayload = new StringSource(
      "<customerCountRequest xmlns='http://springframework.org/spring-ws'>" +
        "<customerName>John Doe</customerName>" +
      "</customerCountRequest>");
    Source responsePayload = new StringSource(
      "<customerCountResponse xmlns='http://springframework.org/spring-ws'>" +
        "<customerCount>10</customerCount>" +
      "</customerCountResponse>");

    mockServer.expect(payload(requestPayload)).andRespond(withPayload(responsePayload)); 

    int result = client.getCustomerCount();                                              
    assertEquals(10, result);                                                            

    mockServer.verify();                                                                 
  }

}

為了驗證請求訊息是否滿足某些期望，MockWebServiceServer 使用 RequestMatcher 策略介面。此介面定義的契約非常簡單

public interface RequestMatcher {

  void match(URI uri,
             WebServiceMessage request)
    throws IOException,
           AssertionError;

}

你可以編寫此介面的自己的實現，在訊息不符合你的期望時丟擲 AssertionError，但你當然不必這樣做。RequestMatchers 類提供了標準的 RequestMatcher 實現供你在測試中使用。你通常會靜態匯入這個類。

RequestMatchers 類提供以下請求匹配器

你可以透過鏈式呼叫 andExpect() 來設定多個請求期望，如下所示

mockServer.expect(connectionTo("http://example.com")).
 andExpect(payload(expectedRequestPayload)).
 andExpect(validPayload(schemaResource)).
 andRespond(...);

有關 RequestMatchers 提供的請求匹配器的更多資訊，請參考類級別 Javadoc。

當請求訊息已驗證並滿足定義的期望時，MockWebServiceServer 將建立一個供 WebServiceTemplate 使用的響應訊息。伺服器為此目的使用 ResponseCreator 策略介面

public interface ResponseCreator {

  WebServiceMessage createResponse(URI uri,
                                   WebServiceMessage request,
                                   WebServiceMessageFactory messageFactory)
    throws IOException;

}

同樣，你可以編寫此介面的自己的實現，使用訊息工廠建立響應訊息，但你當然不必這樣做，因為 ResponseCreators 類提供了標準的 ResponseCreator 實現供你在測試中使用。你通常會靜態匯入這個類。

ResponseCreators 類提供以下響應

有關 RequestMatchers 提供的請求匹配器的更多資訊，請參考類級別 Javadoc。