Android 中调用 SOAP Web 服务：一份实用指南

2024-03-08 12:17:40

Android 中调用 SOAP Web 服务：一份全面的指南

在当今互联网普及的时代，Android 应用程序经常需要与后端 Web 服务交互，以交换数据和执行各种操作。SOAP（简单对象访问协议）是一种流行的 Web 服务协议，广泛用于不同系统之间传递结构化数据。本文将深入探讨如何在 Android 应用程序中调用 SOAP Web 服务，提供一个循序渐进的指南。

先决条件：

熟悉 Android Studio 开发环境
具有 Java 编程基础
准备一份有效的 SOAP Web 服务 WSDL 文件

步骤 1：添加依赖项

在 Android Studio 中，在你的项目 build.gradle 文件中添加以下依赖项：

dependencies {
    implementation 'com.squareup.okhttp3:okhttp:4.9.0'
    implementation 'com.squareup.okhttp3:logging-interceptor:4.9.0'
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-simplexml:2.9.0'
}

步骤 2：创建 SOAP 请求体

使用 Java 类来定义 SOAP 请求体。该类需要继承自 @XmlRootElement 注解，并包含请求消息的字段和方法。例如：

@XmlRootElement(name = "Envelope")
public class SoapEnvelope {

    @XmlElement(name = "Body")
    private SoapBody body;

    // ... getters and setters
}

步骤 3：创建 SOAP 响应体

类似地，创建 Java 类来定义 SOAP 响应体。该类也需要继承自 @XmlRootElement 注解，并包含响应消息的字段和方法。例如：

@XmlRootElement(name = "Envelope")
public class SoapResponse {

    @XmlElement(name = "Body")
    private SoapBody body;

    // ... getters and setters
}

步骤 4：创建 Retrofit 接口

使用 Retrofit 库来简化 REST 和 SOAP Web 服务的调用。创建 Retrofit 接口，其中包含所需的操作和方法。例如：

public interface SoapService {

    @POST("/service")
    @Headers({"Content-Type: text/xml", "SOAPAction: ""})
    Call<SoapResponse> callService(@Body SoapEnvelope envelope);
}

步骤 5：配置 Retrofit 客户端

使用 Retrofit.Builder 来配置 Retrofit 客户端。确保在 baseUrl 中指定 Web 服务的端点 URL。例如：

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://example.com/service")
    .addConverterFactory(SimpleXmlConverterFactory.create())
    .client(new OkHttpClient.Builder()
        .addInterceptor(new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
        .build())
    .build();

步骤 6：调用 SOAP Web 服务

现在，你可以使用 Retrofit 客户端调用 SOAP Web 服务了。创建 Retrofit 服务并使用之前定义的方法。例如：

SoapService soapService = retrofit.create(SoapService.class);
Call<SoapResponse> call = soapService.callService(envelope);
Response<SoapResponse> response = call.execute();

示例代码

以下是一个完整的示例代码，展示了如何在 Android 中调用 SOAP Web 服务：

public class SoapActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_soap);

        // 初始化 Retrofit
        Retrofit retrofit = new Retrofit.Builder()
            .baseUrl("https://example.com/service")
            .addConverterFactory(SimpleXmlConverterFactory.create())
            .client(new OkHttpClient.Builder()
                .addInterceptor(new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
                .build())
            .build();

        // 创建 SOAP 请求体
        SoapEnvelope envelope = new SoapEnvelope();
        envelope.setBody(new SoapBody());
        envelope.getBody().setOperation("OperationName");
        envelope.getBody().setParameters(new HashMap<String, Object>());

        // 调用 SOAP Web 服务
        SoapService soapService = retrofit.create(SoapService.class);
        Call<SoapResponse> call = soapService.callService(envelope);

        call.enqueue(new Callback<SoapResponse>() {
            @Override
            public void onResponse(Call<SoapResponse> call, Response<SoapResponse> response) {
                // 处理 SOAP 响应
                SoapResponse soapResponse = response.body();
                // ...
            }

            @Override
            public void onFailure(Call<SoapResponse> call, Throwable t) {
                // 处理错误
                // ...
            }
        });
    }
}