如何让C# .NET Web API同时兼容带/不带xmlns的XML请求？

可以实现兼容，核心是解决XML命名空间不匹配的问题——带xmlns的请求属于指定命名空间，不带的属于空命名空间，而System.Xml.Serialization默认仅匹配单一命名空间。以下是两种可靠的实现方式：

方法1：双序列化器尝试反序列化 #

创建两个XmlSerializer实例，分别对应带命名空间和空命名空间的场景，依次尝试反序列化请求内容：

步骤1：定义模型类（保留原有命名空间配置） #

假设你的原有模型类是这样的：

[XmlRoot(Namespace = "http://abcxyz.com")]
public class YourModel
{
    [XmlElement("Person")]
    public List<Person> Persons { get; set; }
}

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
    public Address Address { get; set; }
}

public class Address
{
    public string City { get; set; }
    public string Street { get; set; }
    public string ZipCode { get; set; }
}

步骤2：控制器中实现兼容逻辑 #

// 提前初始化序列化器，避免重复创建影响性能
private static readonly XmlSerializer _serializerWithNs = new XmlSerializer(typeof(YourModel), "http://abcxyz.com");
private static readonly XmlSerializer _serializerWithoutNs = new XmlSerializer(typeof(YourModel));

[HttpPost]
public IHttpActionResult Post()
{
    using (var stream = Request.Content.ReadAsStreamAsync().Result)
    {
        YourModel model = null;
        // 先尝试解析带命名空间的请求
        try
        {
            stream.Position = 0;
            model = (YourModel)_serializerWithNs.Deserialize(stream);
        }
        catch (InvalidOperationException)
        {
            // 失败后尝试解析空命名空间的请求
            stream.Position = 0;
            model = (YourModel)_serializerWithoutNs.Deserialize(stream);
        }

        if (model == null)
        {
            return BadRequest("无效的XML请求格式");
        }

        // 业务逻辑处理
        return Ok(model);
    }
}

方法2：自定义XmlReader忽略命名空间 #

通过自定义XmlTextReader，将所有元素的命名空间统一替换为目标值（或空），实现一次反序列化兼容两种情况：

步骤1：实现自定义XmlReader #

public class NamespaceIgnoringXmlReader : XmlTextReader
{
    private readonly string _targetNamespace;

    public NamespaceIgnoringXmlReader(Stream stream, string targetNamespace) : base(stream)
    {
        _targetNamespace = targetNamespace;
    }

    // 重命名空间属性，强制替换为目标值
    public override string NamespaceURI => _targetNamespace;
}

步骤2：控制器中使用自定义Reader #

[HttpPost]
public IHttpActionResult Post()
{
    using (var stream = Request.Content.ReadAsStreamAsync().Result)
    {
        YourModel model;
        // 用自定义Reader将所有命名空间替换为目标命名空间
        using (var reader = new NamespaceIgnoringXmlReader(stream, "http://abcxyz.com"))
        {
            var serializer = new XmlSerializer(typeof(YourModel), "http://abcxyz.com");
            model = (YourModel)serializer.Deserialize(reader);
        }

        if (model == null)
        {
            return BadRequest("无法解析XML请求");
        }

        // 业务逻辑处理
        return Ok(model);
    }
}

备选妥协方案 #

如果上述方法存在兼容性问题，可以考虑：

• 正则替换XML内容：接收原始XML字符串，移除xmlns属性后再反序列化（适合简单场景，注意边缘情况）：

  [HttpPost]
  public IHttpActionResult Post([FromBody] string xmlContent)
  {
      // 移除所有xmlns属性
      xmlContent = Regex.Replace(xmlContent, @"xmlns=""[^""]+""", string.Empty, RegexOptions.IgnoreCase);
      using (var reader = new StringReader(xmlContent))
      {
          var model = (YourModel)new XmlSerializer(typeof(YourModel)).Deserialize(reader);
          return Ok(model);
      }
  }
  

• 新增独立端点：为新用户单独创建一个不带命名空间的请求端点，不影响原有业务。

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