C#进阶-ASP.NET WebForms调用ASMX的WebService接口

在ASP.NET WebForms应用程序中，调用ASMX WebService接口是一种常见的需求。ASMX WebService是基于SOAP协议的Web服务，可以在不同平台之间进行通信。本文将详细介绍如何在ASP.NET WebForms中调用ASMX WebService接口，包括添加服务引用、调用服务方法和处理响应。

一、添加WebService引用

1.1 创建ASMX WebService

首先，创建一个简单的ASMX WebService。假设我们有一个名为 MyWebService的Web服务，其中包含一个简单的方法 HelloWorld。

// MyWebService.asmx.cs
using System.Web.Services;

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[System.ComponentModel.ToolboxItem(false)]
public class MyWebService : WebService
{
    [WebMethod]
    public string HelloWorld()
    {
        return "Hello, World!";
    }
}

1.2 在ASP.NET WebForms项目中添加服务引用

1. 右键点击项目名称，选择“添加服务引用”。
2. 在弹出的对话框中，点击“高级...”按钮。
3. 再点击“添加Web引用...”按钮。
4. 在地址栏输入ASMX WebService的URL，例如 http://localhost:12345/MyWebService.asmx。
5. 点击“转到”按钮，找到Web服务并命名引用，例如 MyWebServiceRef，然后点击“添加引用”。

二、调用WebService方法

2.1 在前端页面调用WebService

在ASP.NET WebForms页面中，可以通过服务引用来调用WebService的方法。以下是一个示例，展示如何在 Default.aspx页面中调用 HelloWorld方法。

Default.aspx

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="Default.aspx.cs" Inherits="Default" %>



    


    

        

            
            

            
        
    

Default.aspx.cs

using System;
using MyWebServiceRef; // 引用服务命名空间

public partial class Default : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {

    }

    protected void btnCallService_Click(object sender, EventArgs e)
    {
        // 创建WebService客户端实例
        MyWebServiceSoapClient client = new MyWebServiceSoapClient();

        // 调用HelloWorld方法
        string result = client.HelloWorld();

        // 显示结果
        lblResult.Text = result;
    }
}

2.2 异步调用WebService方法

为了提高用户体验，可以使用异步方式调用WebService方法。以下是异步调用的示例。

Default.aspx.cs

using System;
using System.Threading.Tasks;
using MyWebServiceRef;

public partial class Default : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {

    }

    protected async void btnCallService_Click(object sender, EventArgs e)
    {
        // 创建WebService客户端实例
        MyWebServiceSoapClient client = new MyWebServiceSoapClient();

        // 异步调用HelloWorld方法
        string result = await Task.Run(() => client.HelloWorld());

        // 显示结果
        lblResult.Text = result;
    }
}

三、错误处理与调试

3.1 错误处理

在调用WebService时，可能会遇到各种错误，如网络连接问题、服务端错误等。需要进行适当的错误处理，确保应用程序的健壮性。

protected async void btnCallService_Click(object sender, EventArgs e)
{
    MyWebServiceSoapClient client = new MyWebServiceSoapClient();

    try
    {
        string result = await Task.Run(() => client.HelloWorld());
        lblResult.Text = result;
    }
    catch (Exception ex)
    {
        lblResult.Text = "调用服务时发生错误：" + ex.Message;
    }
}
​

3.2 调试技巧

• 使用Fiddler或Wireshark：监控HTTP请求和响应，分析WebService调用过程。
• 启用WCF日志：在客户端配置文件中启用WCF日志，以便记录详细的调用信息。
• 检查服务URL：确保服务URL正确，服务正在运行。

四、最佳实践

4.1 使用配置文件管理服务引用

将WebService的URL配置在 Web.config文件中，便于管理和修改。

Web.config

  
    
  

​

Default.aspx.cs

using System.Configuration;
using MyWebServiceRef;

public partial class Default : System.Web.UI.Page
{
    protected void btnCallService_Click(object sender, EventArgs e)
    {
        string serviceUrl = ConfigurationManager.AppSettings["MyWebServiceUrl"];
        MyWebServiceSoapClient client = new MyWebServiceSoapClient();
        client.Endpoint.Address = new System.ServiceModel.EndpointAddress(serviceUrl);

        string result = client.HelloWorld();
        lblResult.Text = result;
    }
}
​

4.2 使用数据契约

在WebService中使用数据契约（Data Contract）定义复杂类型，确保客户端和服务端之间的数据传输一致。

[DataContract]
public class MyData
{
    [DataMember]
    public int Id { get; set; }

    [DataMember]
    public string Name { get; set; }
}

[WebMethod]
public MyData GetData(int id)
{
    return new MyData { Id = id, Name = "Example" };
}
​

五、总结

通过本文的介绍，您应能掌握在ASP.NET WebForms中调用ASMX WebService接口的基本方法，包括添加服务引用、同步和异步调用服务方法、错误处理和调试等。合理运用这些技术，可以提高应用程序的可靠性和用户体验。