在.NET Core的WebAPI开发中，默认的输入格式化器仅支持JSON格式的数据，当客户端发送XML格式的POST请求时，接口往往无法正常接收和解析数据，需要手动配置相关服务来支持XML格式的请求处理。
配置XML输入格式化器
首先需要在Program.cs文件中添加XML序列化相关的服务，让WebAPI支持XML格式的输入和输出。默认情况下，.NET Core WebAPI没有启用XML格式化器，需要手动引入Microsoft.AspNetCore.Mvc.Formatters.Xml包，然后在服务配置中添加XML相关设置。
以下是Program.cs的配置代码示例：
// 引入必要的命名空间
using Microsoft.AspNetCore.Mvc;
var builder = WebApplication.CreateBuilder(args);
// 添加控制器服务，并配置XML格式化器
builder.Services.AddControllers(options =>
{
// 添加XML输入格式化器，支持读取XML格式的请求体
options.InputFormatters.Add(new Microsoft.AspNetCore.Mvc.Formatters.XmlSerializerInputFormatter(options));
// 添加XML输出格式化器，支持返回XML格式的响应
options.OutputFormatters.Add(new Microsoft.AspNetCore.Mvc.Formatters.XmlSerializerOutputFormatter());
})
// 配置支持的返回格式，优先XML
.AddXmlSerializerFormatters();
var app = builder.Build();
// 启用路由和控制器
app.MapControllers();
app.Run();
定义接收XML数据的模型
XML数据的反序列化需要匹配对应的实体模型，模型的属性需要和XML节点的名称、结构对应，同时可以通过特性指定XML元素的名称，避免命名不一致导致解析失败。
以下是一个用户信息的模型示例，用于接收XML格式的用户数据：
using System.Xml.Serialization;
// 指定XML根节点名称
[XmlRoot("User")]
public class UserModel
{
// 指定XML元素名称，和请求中的XML节点对应
[XmlElement("UserId")]
public int UserId { get; set; }
[XmlElement("UserName")]
public string UserName { get; set; }
[XmlElement("UserAge")]
public int UserAge { get; set; }
[XmlElement("UserEmail")]
public string UserEmail { get; set; }
}
编写接收XML POST请求的接口
接口需要明确指定支持的请求内容类型，同时保证模型绑定能够正确读取XML格式的请求体。可以在接口方法上通过Consumes特性指定接收的内容类型为text/xml，确保只有XML格式的请求才能进入该接口。
以下是接收XML POST请求的接口示例：
using Microsoft.AspNetCore.Mvc;
[ApiController]
[Route("api/[controller]")]
public class UserController : ControllerBase
{
/// <summary>
/// 接收XML格式的用户数据POST请求
/// </summary>
/// <param name="user">用户数据模型</param>
/// <returns>处理结果</returns>
[HttpPost("receive-xml")]
// 指定该接口仅接收text/xml格式的请求
[Consumes("text/xml")]
public IActionResult ReceiveXmlUser([FromBody] UserModel user)
{
if (user == null)
{
return BadRequest("接收到的用户数据为空");
}
// 这里可以处理接收到的用户数据，比如存入数据库
return Ok(new
{
Message = "XML数据接收成功",
ReceivedUser = user
});
}
}
客户端发送XML请求示例
客户端发送POST请求时，需要设置请求头Content-Type为text/xml，请求体为符合模型结构的XML字符串。以下是使用C#的HttpClient发送XML请求的示例：
using System.Net.Http.Xml; var client = new HttpClient(); // 接口地址，如果是本地测试可以使用http://127.0.0.1:5000 var url = "http://127.0.0.1:5000/api/user/receive-xml"; // 构造XML格式的请求内容 var xmlContent = @"<?xml version=""1.0"" encoding=""utf-8""?> <User> <UserId>1</UserId> <UserName>张三</UserName> <UserAge>25</UserAge> <UserEmail>test@ipipp.com</UserEmail> </User>"; var content = new StringContent(xmlContent, System.Text.Encoding.UTF8, "text/xml"); // 发送POST请求 var response = await client.PostAsync(url, content); var result = await response.Content.ReadAsStringAsync(); Console.WriteLine(result);
常见问题排查
- 如果接口接收不到数据，首先检查Program.cs中是否正确添加了XML格式化器，没有配置的话默认不会解析XML请求体。
- 检查模型的XML特性是否正确，XML节点的名称和模型属性的
XmlElement特性指定的名称是否一致，大小写不匹配也会导致解析失败。 - 检查请求的
Content-Type是否为text/xml，如果客户端设置的类型不正确，格式化器不会处理该请求。 - 如果XML中有命名空间，需要在模型的
XmlRoot和XmlElement特性中指定对应的命名空间，否则无法正确匹配节点。
注意事项
XML格式的数据相比JSON体积更大，解析效率也更低，如果不是必须兼容旧系统，建议优先使用JSON格式的数据交互。如果确实需要支持XML，要注意XML的注入风险，对接收到的XML数据进行必要的校验，避免恶意XML内容导致服务异常。
另外，.NET Core的XML格式化器默认使用的是XmlSerializer，如果需要更复杂的XML解析能力，也可以自定义输入格式化器，实现更灵活的XML处理逻辑。