在C# Avalonia应用开发过程中，很多场景需要和后端服务进行数据交互，通过调用Rest API获取或提交数据是最常用的方式。Avalonia作为跨平台的.NET UI框架，完全兼容.NET生态下的网络请求相关组件，我们可以借助HttpClient类完成和Web API的交互。
Avalonia调用Rest API的准备工作
首先需要在Avalonia项目的工程文件中引入必要的依赖，默认情况下.NET项目已经包含了System.Net.Http命名空间，无需额外安装NuGet包。如果需要处理JSON数据，建议引入System.Text.Json组件，它是.NET内置的高性能JSON序列化工具。
如果是.NET 6及以上版本的项目，可以直接使用顶级的HttpClient实例，不需要手动管理生命周期。如果是旧版本项目，需要注意HttpClient的单例使用原则，避免频繁创建和释放带来的端口耗尽问题。
基础GET请求调用示例
下面以调用一个获取用户列表的Web API为例，展示GET请求的实现方式，假设接口地址为http://ipipp.com/api/users，返回的是JSON格式的用户数组。
using System;
using System.Net.Http;
using System.Text.Json;
using System.Threading.Tasks;
using System.Collections.Generic;
namespace AvaloniaApp.Models
{
// 用户数据模型
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public string Email { get; set; }
}
public class ApiService
{
private readonly HttpClient _httpClient;
public ApiService()
{
// 创建HttpClient实例，实际项目中建议通过依赖注入获取
_httpClient = new HttpClient();
// 设置基础请求地址，可选
_httpClient.BaseAddress = new Uri("http://ipipp.com/api/");
}
// 获取用户列表的方法
public async Task<List<User>> GetUsersAsync()
{
try
{
// 发送GET请求，获取响应
HttpResponseMessage response = await _httpClient.GetAsync("users");
// 确保请求成功
response.EnsureSuccessStatusCode();
// 读取响应内容为字符串
string responseBody = await response.Content.ReadAsStringAsync();
// 反序列化JSON为User列表
List<User> users = JsonSerializer.Deserialize<List<User>>(responseBody);
return users;
}
catch (HttpRequestException ex)
{
// 处理请求异常，比如网络错误、接口不存在等
Console.WriteLine($"请求发生错误：{ex.Message}");
return null;
}
}
}
}
POST请求提交数据示例
如果需要向Web API提交数据，比如新增用户信息，可以使用POST请求，下面是具体的实现代码，接口地址为http://ipipp.com/api/users/add。
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
namespace AvaloniaApp.Models
{
public class ApiService
{
private readonly HttpClient _httpClient;
public ApiService()
{
_httpClient = new HttpClient();
_httpClient.BaseAddress = new Uri("http://ipipp.com/api/");
}
// 新增用户的方法
public async Task<bool> AddUserAsync(User newUser)
{
try
{
// 将用户对象序列化为JSON字符串
string jsonContent = JsonSerializer.Serialize(newUser);
// 创建请求内容，设置媒体类型为application/json
StringContent content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
// 发送POST请求
HttpResponseMessage response = await _httpClient.PostAsync("users/add", content);
// 判断请求是否成功
if (response.IsSuccessStatusCode)
{
return true;
}
else
{
Console.WriteLine($"请求失败，状态码：{response.StatusCode}");
return false;
}
}
catch (HttpRequestException ex)
{
Console.WriteLine($"请求发生错误：{ex.Message}");
return false;
}
}
}
}
进阶优化建议
在实际的Avalonia项目中，还可以对API调用做进一步的优化：
- 使用依赖注入管理HttpClient实例，避免重复创建，提升性能
- 统一封装API调用层，将请求发送、响应解析、异常处理逻辑集中管理，减少重复代码
- 如果需要调用需要认证的Web API，可以在HttpClient的DefaultRequestHeaders中添加Authorization头，比如Bearer令牌
- 对于频繁调用的接口，可以添加本地缓存机制，减少不必要的网络请求
- 处理网络请求时建议添加加载状态提示，避免用户操作时界面无响应
常见问题处理
在Avalonia中调用Rest API时，可能会遇到一些常见问题：
- 跨域问题：如果是本地调试时调用不同域的接口，需要后端接口配置允许跨域，Avalonia作为桌面应用本身不存在浏览器的跨域限制
- JSON序列化失败：需要确保数据模型的属性和接口返回的JSON字段名称、类型一致，不一致时可以通过JsonSerializerOptions配置属性名映射
- 请求超时：可以通过设置HttpClient的Timeout属性调整请求超时时间，默认是100秒
注意：在Avalonia项目中发起网络请求时，不要在主线程直接执行同步的网络调用，避免阻塞UI线程导致界面卡顿，所有网络请求都建议使用异步方法配合await关键字执行。
AvaloniaRest_APIHttpClientC#Web_API修改时间：2026-06-26 08:48:29