在C# Winform里调用WEB Service API(如何在C# Winform中调用Web Service API)

原创

ithorizon 4周前 (10-19) 阅读数 29 #后端开发

在当今的软件开发中，Winform 应用程序与 Web Service API 的交互变得越来越多数。本文将详细介绍怎样在 C# Winform 应用程序中调用 Web Service API。我们将从基础知识开端，逐步深入，涵盖从创建 HTTP 请求到处理响应的整个过程。

一、了解 Web Service API

Web Service API 是一种允许应用程序通过网络进行通信的接口。它允许不同的软件系统之间进行数据交换和通信。在本文中，我们将重点讨论 RESTful API，这是一种广泛使用的 Web Service API。

二、准备工作

在开端之前，请确保你的开发环境已经安装了以下工具：

Visual Studio（推荐版本为 2019 或更高）

.NET Framework 或 .NET Core SDK

三、创建 Winform 应用程序

首先，我们需要创建一个 Winform 应用程序。在 Visual Studio 中，按照以下步骤操作：

打开 Visual Studio。

选择“创建新项目”。

在“创建新项目”窗口中，选择“Windows 窗体应用 (.NET Framework)”或“Windows 窗体应用 (.NET Core)”模板。

指定项目名称和存储位置，然后点击“创建”。

四、添加 Web Service API 调用的方法

在 Winform 应用程序中，我们通常会在一个单独的类中封装 Web Service API 的调用。以下是一个简洁的示例，演示怎样调用一个返回 JSON 数据的 RESTful API。

1. 引入命名空间

在调用 Web Service API 之前，我们需要引入一些命名空间。


using System;
using System.Net.Http;
using System.Threading.Tasks;
using Newtonsoft.Json;

2. 创建 WebServiceHelper 类

创建一个名为 WebServiceHelper 的类，用于封装 HTTP 请求和响应处理。


public class WebServiceHelper
{
    private static readonly HttpClient httpClient = new HttpClient();
    public static async Task GetAsync(string url)
    {
        try
        {
            HttpResponseMessage response = await httpClient.GetAsync(url);
            response.EnsureSuccessStatusCode();
            string responseBody = await response.Content.ReadAsStringAsync();
            return JsonConvert.DeserializeObject(responseBody);
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine(" Exception Caught!");
            Console.WriteLine("Message :{0} ", e.Message);
            return default(T);
        }
    }
}

3. 调用 Web Service API

现在，我们可以在 Winform 应用程序中的任何地方调用 WebServiceHelper 类来获取 API 数据。


public async Task LoadDataAsync()
{
    string apiUrl = "https://api.example.com/data"; // 替换为实际的 API URL
    var data = await WebServiceHelper.GetAsync<YourDataType>(apiUrl);
    // 处理获取到的数据
    // 例如：this.dataGridView.DataSource = data;
}

五、异常处理和差错处理

在调用 Web Service API 时，也许会遇到各种异常和差错。以下是一些常见的差错处理方法：

1. 处理 HTTP 请求异常

当 HTTP 请求落败时，我们会捕获 HttpRequestException 异常。


try
{
    // 调用 API 的代码
}
catch (HttpRequestException e)
{
    // 处理异常
    Console.WriteLine("请求落败: " + e.Message);
}

2. 处理 HTTP 响应状态码

当 API 返回非 200 状态码时，我们需要检查 HttpResponseMessage 对象以获取差错信息。


HttpResponseMessage response = await httpClient.GetAsync(url);
if (!response.IsSuccessStatusCode)
{
    // 处理差错
    Console.WriteLine("响应状态码: " + response.StatusCode);
}

六、使用异步编程减成本时间性能

在调用 Web Service API 时，使用异步编程可以避免阻塞 UI 线程，从而减成本时间应用程序的性能。在上述示例中，我们已经使用了 async 和 await 关键字来实现异步调用。

七、保险性和认证

在实际应用中，许多 Web Service API 都需要身份验证。以下是一些常见的认证方法：

1. 基本认证

使用基本认证时，我们需要在 HTTP 请求的头部添加一个包含用户名和密码的 Authorization 字段。


var byteArray = new System.Text.UTF8Encoding().GetBytes(username + ":" + password);
httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", Convert.ToBase64String(byteArray));