ASP.NET Core WebApi怎么返回XML数据格式

发布时间：2021-09-10 14:49:10 作者：小新
来源：亿速云阅读：560

# ASP.NET Core WebApi怎么返回XML数据格式

## 前言

在Web API开发中，JSON虽然是主流的数据交换格式，但在某些特定场景（如企业级系统集成、传统系统对接等）仍然需要支持XML格式。ASP.NET Core默认使用JSON作为响应格式，本文将详细介绍如何让WebAPI支持XML数据格式的返回。

---

## 一、基础配置方法

### 1. 添加XML格式化支持

在`Program.cs`中通过`AddXmlSerializerFormatters()`方法启用XML支持：

```csharp
var builder = WebApplication.CreateBuilder(args);

// 添加XML格式化器
builder.Services.AddControllers()
    .AddXmlSerializerFormatters(); // 或 AddXmlDataContractSerializerFormatters()

两种序列化器的区别： - XmlSerializer：兼容性更好，但性能稍低 - DataContractSerializer：性能更高，但需要显式标记[DataContract]

2. 通过Accept头指定格式

客户端请求时需在Header中添加：

Accept: application/xml

示例控制器：

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    [HttpGet]
    public ActionResult<Product> Get()
    {
        return new Product { Id = 1, Name = "XML Product" };
    }
}

二、强制返回XML格式

1. 控制器级别设置

使用[Produces]特性强制指定格式：

[Produces("application/xml")]
[ApiController]
public class XmlOnlyController : ControllerBase
{
    // 所有动作都将返回XML
}

2. 单个Action设置

[HttpGet]
[Produces("application/xml")]
public Product GetProduct()
{
    return new Product();
}

3. 全局配置（慎用）

builder.Services.AddControllers(options => 
{
    options.OutputFormatters.RemoveType<SystemTextJsonOutputFormatter>();
    options.OutputFormatters.Add(new XmlSerializerOutputFormatter());
});

三、高级配置技巧

1. 自定义XML序列化设置

builder.Services.AddControllers()
    .AddXmlOptions(options =>
    {
        options.XmlSerializerOptions.IgnoreNullValues = true;
        options.XmlSerializerOptions.IncludeXmlDeclaration = false;
        options.XmlSerializerOptions.Indent = true;
    });

2. 处理命名空间问题

对于需要XML命名空间的场景：

[DataContract(Namespace = "http://schemas.example.com")]
public class Product
{
    [DataMember]
    public int Id { get; set; }
}

3. 混合格式支持

同时支持JSON和XML（根据Accept头自动切换）：

[HttpGet]
[Produces("application/json", "application/xml")]
public Product Get()
{
    return new Product();
}

四、常见问题解决

1. 返回XML空标签问题

在模型类上设置默认值：

public class Product
{
    public string Description { get; set; } = string.Empty;
}

2. 循环引用处理

使用[IgnoreDataMember]特性：

public class Order
{
    [IgnoreDataMember]
    public Customer Customer { get; set; }
}

3. 日期格式控制

[DataContract]
public class Event
{
    [DataMember]
    [XmlElement(DataType = "date")]
    public DateTime EventDate { get; set; }
}

五、性能优化建议

对于大型XML响应，考虑使用XmlWriter直接输出流：

public IActionResult GetLargeXml()
{
    return new XmlResult(products);
}

实现自定义的IXmlSerializable接口可提升复杂对象的序列化性能
启用响应压缩：

app.UseResponseCompression();

结语

通过本文介绍的方法，您可以轻松实现ASP.NET Core WebAPI的XML格式支持。在实际项目中，建议根据具体需求选择适当的配置方式，同时注意XML格式相比JSON会有约30%-50%的体积增长，在性能敏感场景需要做好权衡。

提示：在.NET 7+中，XML序列化性能有显著提升，建议使用最新运行时版本。 “`