.NET Core中如何从端点URL读取XML并反序列化为C#对象

本方案适配.NET Core 2.1及以上所有版本，遵循官方架构规范，规避常见性能与稳定性问题。

前置准备 #

首先定义与目标XML结构完全匹配的C#实体类，通过System.Xml.Serialization命名空间下的特性标记节点对应关系：

• 根节点用[XmlRoot]标记
• 子元素用[XmlElement]标记
• 属性用[XmlAttribute]标记
• 集合用[XmlArray]+[XmlArrayItem]标记
• 如果XML包含命名空间，需要在对应特性的Namespace参数中指定

示例XML对应的实体类：

<!-- 目标XML结构参考 -->
<BookStore xmlns="http://example.com/xmlschemas">
  <Books>
    <Book Id="1">
      <Name>CLR via C#</Name>
      <Author>Jeffrey Richter</Author>
      <Price>128</Price>
    </Book>
  </Books>
</BookStore>

using System.Xml.Serialization;

[XmlRoot(ElementName = "BookStore", Namespace = "http://example.com/xmlschemas")]
public class BookStore
{
    [XmlArray(ElementName = "Books")]
    [XmlArrayItem(ElementName = "Book")]
    public List<Book> Books { get; set; }
}

public class Book
{
    [XmlAttribute(AttributeName = "Id")]
    public int Id { get; set; }

    [XmlElement(ElementName = "Name")]
    public string Name { get; set; }

    [XmlElement(ElementName = "Author")]
    public string Author { get; set; }

    [XmlElement(ElementName = "Price")]
    public decimal Price { get; set; }
}

核心实现（官方推荐） #

.NET Core 环境下禁止直接new HttpClient实例，必须通过IHttpClientFactory依赖注入的方式获取HttpClient，避免套接字资源耗尽问题。
反序列化时直接读取响应流处理，不要转为字符串后再反序列化，可减少性能开销，同时避免编码不匹配问题。

1. 服务注册 #

在Program.cs中注册HttpClient和自定义服务：

// .NET 6+ 顶级语句写法
var builder = WebApplication.CreateBuilder(args);

// 注册带强类型服务的HttpClient
builder.Services.AddHttpClient<XmlDataService>(client =>
{
    // 可全局配置超时时间、默认请求头等
    client.Timeout = TimeSpan.FromSeconds(30);
    client.DefaultRequestHeaders.Add("Accept", "application/xml");
});

// 旧版Startup.cs写法：在ConfigureServices方法中加入
// services.AddHttpClient<XmlDataService>(client => { ... });

2. 封装XML数据获取服务 #

using System.Net.Http;
using System.Xml.Serialization;

public class XmlDataService
{
    private readonly HttpClient _httpClient;

    public XmlDataService(HttpClient httpClient)
    {
        _httpClient = httpClient;
    }

    /// <summary>
    /// 从指定URL获取XML并反序列化为指定类型对象
    /// </summary>
    /// <typeparam name="T">目标反序列化类型</typeparam>
    /// <param name="requestUrl">XML数据地址</param>
    /// <param name="cancellationToken">取消令牌</param>
    /// <returns>反序列化后的对象，失败返回null</returns>
    public async Task<T?> GetXmlDataAsync<T>(string requestUrl, CancellationToken cancellationToken = default)
    {
        // 发送GET请求，仅读取响应头即返回，减少内存占用
        using var response = await _httpClient.GetAsync(requestUrl, HttpCompletionOption.ResponseHeadersRead, cancellationToken);
        // 非200状态码直接抛出异常，可根据业务需求调整错误处理逻辑
        response.EnsureSuccessStatusCode();

        // 直接读取流反序列化
        await using var stream = await response.Content.ReadAsStreamAsync(cancellationToken);
        var serializer = new XmlSerializer(typeof(T));
        return (T?)serializer.Deserialize(stream);
    }
}

3. 业务代码调用 #

// 业务服务中注入XmlDataService使用
public class BookService
{
    private readonly XmlDataService _xmlDataService;

    public BookService(XmlDataService xmlDataService)
    {
        _xmlDataService = xmlDataService;
    }

    public async Task<BookStore?> GetBookStoreDataAsync()
    {
        const string targetUrl = "https://你的目标XML地址";
        return await _xmlDataService.GetXmlDataAsync<BookStore>(targetUrl);
    }
}

常见问题排查 #

• 反序列化结果为null或属性全为空：检查实体类的特性标记是否和XML节点名称、命名空间完全匹配
• 编码错误：如果XML使用非UTF-8编码，可先读取为字节数组，再用对应编码创建MemoryStream进行反序列化
• 性能问题：不要在每次请求时都实例化XmlSerializer，可将同类型的Serializer静态缓存复用

内容的提问来源于stack exchange，提问作者jessye bottalico