Spring SOAP Web サービスクライアントの HTTP ヘッダーを構成する方法

Spring SOAP Web サービスクライアントに HTTP ヘッダーを追加する

このソリューションは、Spring Framework と JAX-WS を使用して、WSDL ファイルから生成された SOAP クライアントに HTTP ヘッダーを挿入するモジュール式のアプローチを示します。

import javax.xml.ws.BindingProvider;
import javax.xml.ws.handler.MessageContext;
import org.springframework.stereotype.Component;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
@Component
public class SOAPClient {
    private final SOAPService soapService = new SOAPService();
    public SOAPPort getSOAPPort() {
        SOAPPort port = soapService.getSOAPPort();
        Map<String, List<String>> headers = new HashMap<>();
        headers.put("AUTH_HEADER", List.of("AUTH_HEADER_VALUE"));
        BindingProvider bindingProvider = (BindingProvider) port;
        bindingProvider.getRequestContext().put(MessageContext.HTTP_REQUEST_HEADERS, headers);
        return port;
    }
}

カスタムインターセプターを使用したヘッダーの追加

このアプローチでは、Spring Web サービスとカスタム インターセプターを使用して HTTP ヘッダーを動的に管理します。

import org.springframework.ws.client.core.WebServiceMessageCallback;
import org.springframework.ws.client.core.WebServiceTemplate;
import org.springframework.ws.soap.client.core.SoapActionCallback;
import org.springframework.ws.transport.context.TransportContext;
import org.springframework.ws.transport.http.HttpUrlConnection;
import org.springframework.stereotype.Component;
@Component
public class SOAPClientWithInterceptor {
    private final WebServiceTemplate webServiceTemplate;
    public SOAPClientWithInterceptor(WebServiceTemplate webServiceTemplate) {
        this.webServiceTemplate = webServiceTemplate;
    }
    public Object callWebService(String uri, Object requestPayload) {
        WebServiceMessageCallback callback = message -> {
            TransportContext context = TransportContextHolder.getTransportContext();
            HttpUrlConnection connection = (HttpUrlConnection) context.getConnection();
            connection.addRequestHeader("AUTH_HEADER", "AUTH_HEADER_VALUE");
        };
        return webServiceTemplate.marshalSendAndReceive(uri, requestPayload, callback);
    }
}

最初のソリューションの単体テスト

HTTP ヘッダーが SOAP クライアントに正しく追加されていることを検証する JUnit テスト ケース。

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import org.junit.jupiter.api.Test;
import javax.xml.ws.BindingProvider;
import java.util.Map;
public class SOAPClientTest {
    @Test
    public void testHeaderInjection() {
        SOAPService mockService = mock(SOAPService.class);
        SOAPPort mockPort = mock(SOAPPort.class);
        when(mockService.getSOAPPort()).thenReturn(mockPort);
        SOAPClient client = new SOAPClient(mockService);
        SOAPPort port = client.getSOAPPort();
        BindingProvider provider = (BindingProvider) port;
        Map<String, List<String>> headers = (Map<String, List<String>>) provider.getRequestContext().get(MessageContext.HTTP_REQUEST_HEADERS);
        assertEquals("AUTH_HEADER_VALUE", headers.get("AUTH_HEADER").get(0));
    }
}

SOAP クライアントの HTTP ヘッダーに関するよくある質問

1. Spring SOAP クライアントにカスタム HTTP ヘッダーを追加するにはどうすればよいですか?
2. 使用できます BindingProvider を設定するインターフェイス MessageContext.HTTP_REQUEST_HEADERS カスタムヘッダーを使用してマップします。
3. リクエストごとにヘッダーを動的に更新できますか?
4. はい、を使用して、 WebServiceTemplate カスタムで WebServiceMessageCallbackを使用すると、リクエスト コンテキストに基づいてヘッダーを動的に変更できます。
5. セッション中にトークンの有効期限が切れたらどうなりますか?
6. クライアントに再試行メカニズムを実装して、リクエストを再試行する前に 401 応答を検出し、トークンを更新します。
7. ヘッダーのハードコーディングに代わるものはありますか?
8. はい、プロパティ ファイルまたは環境変数を使用してヘッダーを動的に構成し、SOAP クライアントに挿入できます。
9. ヘッダーのセキュリティに関するベスト プラクティスは何ですか?
10. 常に HTTPS を使用して、転送中のヘッダーを暗号化し、サーバー側でヘッダーの内容を検証し、ログ内の機密情報の公開を回避します。

SOAP ヘッダーの統合に関する最終的な考え方

適当に追加 HTTPヘッダー SOAP クライアントでは、特に認証が必要なシナリオにおいて、Web サービスとのシームレスな通信が保証されます。 Spring Web Services や JAX-WS BindingProvider などのツールを使用すると、安全な API 呼び出しのヘッダーを動的に処理できます。 💡

これらのテクニックを習得することで、開発者は 403 エラーなどの一般的な問題に効果的に対処できます。静的ヘッダーを処理する場合でも、高度なトークンベースのセキュリティを実装する場合でも、これらのメソッドは堅牢な統合を可能にし、最新の Web サービスに不可欠なものとなっています。 🚀