Winform实现调用asp.net数据接口实例

下面是详细讲解Winform实现调用ASP.NET数据接口的完整攻略。

一、概述

在使用Winform开发桌面应用程序时，有时需要从服务器获取数据，通常可以使用Web API来实现。而ASP.NET Web API是一个用于构建RESTful服务的框架。本文将以调用ASP.NET Web API为例，介绍如何在Winform中进行数据访问。

二、准备工作

1. 创建ASP.NET Web API项目
   首先，我们需要创建一个ASP.NET Web API项目。在Visual Studio中，选择“新建项目”->“ASP.NET Web 应用程序”->“Web API”。

2. 编写API接口
   在Web API项目中添加控制器类，并编写API接口。这里我们以返回学生信息列表为例：

csharp
[RoutePrefix("api/students")]
public class StudentsController : ApiController
{
[HttpGet]
[Route("List")]
public IHttpActionResult GetStudentsList()
{
//从数据库或其他数据源获取学生信息
List<Student> students = new List<Student>
{
new Student{ID=1, Name="张三", Age=18},
new Student{ID=2, Name="李四", Age=19},
new Student{ID=3, Name="王五", Age=20}
};
return Ok(students);
}
}

1. 启动Web API项目
   在调用API之前，我们需要先启动Web API项目，并确保可以正常访问API接口。我们可以在浏览器中输入API接口的URL进行测试。如果能够成功返回数据，说明API接口已经可以正常使用。

三、调用API接口

1. 创建Winform项目
   我们需要创建一个Winform项目，用于调用API接口。

2. 添加HttpClient
   在Winform项目中添加HttpClient，可以使用NuGet包管理器搜索并安装“Microsoft.AspNet.WebApi.Client”包。

csharp
using System.Net.Http;

1. 调用API接口
   使用HttpClient可以发出HTTP请求，并处理HTTP响应。我们可以在Winform项目的按钮点击事件中调用API接口。

```csharp
private async void button1_Click(object sender, EventArgs e)
{
using (var client = new HttpClient())
{
client.BaseAddress = new Uri("http://localhost:12345/");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

     HttpResponseMessage response = await client.GetAsync("api/students/List");
     if (response.IsSuccessStatusCode)
     {
        var students = await response.Content.ReadAsAsync<IEnumerable<Student>>();
        //将学生信息绑定到DataGridView
        dataGridView1.DataSource = students.ToList();
     }
  }

}
```

通过以上代码，我们使用HttpClient发送了一个GET请求，并获取了API返回的学生信息列表，然后将学生信息绑定到DataGridView中，即可在Winform应用程序中显示学生信息。

四、示例说明

示例一：通过HttpClient访问API接口

前面已经给出了一个通过HttpClient访问API接口的示例，这里再做一些说明。

首先，我们需要根据API接口的URL创建HttpClient实例，并设置一些HTTP请求头的参数，然后使用GetAsync方法发送GET请求，并通过ReadAsAsync方法将返回的JSON格式的数据转换成IEnumerable类型的对象。

关于HttpClient的更多使用方法和示例，可以参考微软官方文档：https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/http-client

示例二：使用RestSharp库访问API接口

另外一个比较常用的库是RestSharp，它提供了更简洁的API访问方式。我们可以使用NuGet包管理器搜索并安装“RestSharp”包。

首先，在按钮点击事件中创建RestClient实例，并设置API接口的URL和请求参数。然后调用Execute方法发出请求，获取API返回的数据。

using RestSharp;

private void button2_Click(object sender, EventArgs e)
{
    RestClient client = new RestClient("http://localhost:12345/");
    RestRequest request = new RestRequest("api/students/List", Method.GET);
    request.AddHeader("Accept", "application/json");
    IRestResponse<List<Student>> response = client.Execute<List<Student>>(request);
    if (response.StatusCode == HttpStatusCode.OK)
    {
        dataGridView1.DataSource = response.Data;
    }
}

以上代码使用了RestSharp库的Execute方法来发出请求，通过IRestResponse类型的response对象获取API返回的数据，并将学生信息绑定到DataGridView中。

关于RestSharp库的更多使用方法和示例，可以参考其官方文档：https://restsharp.dev/