如何将 XML 作为 POST 传递到 ASP MVC .NET 中的 ActionResult

Question

我正在尝试为我的 ASP MVC 项目提供一个简单的 RESTful API。 我无法控制此 API 的客户端，它们将通过 POST 方法传递 XML，该方法将包含在服务器端执行某些操作所需的信息，并返回带有操作结果的 XML。 我在发回 XML 时没有遇到问题，问题是通过 POST 接收 XML。 我看过一些 JSON 示例，但由于我不会控制我的客户端（从我的角度来看，它甚至可能是 telnet），我认为 JSON 不起作用。 我对么？

我见过这样的例子：客户端简单地构建正确的表单格式作为请求正文的一部分，然后 ASP 解析消息，数据以 FormCollection 形式提供（？param1=value1&param2=value2&等）。 但是，我想将纯 XML 作为消息正文的一部分传递。

感谢您的帮助，

Answer 1

@Freddy - 喜欢你的方法，并使用以下代码对其进行了改进，以简化流读取：

    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        HttpContextBase httpContext = filterContext.HttpContext;
        if (!httpContext.IsPostNotification)
        {
            throw new InvalidOperationException("Only POST messages allowed on this resource");
        }

        Stream httpBodyStream = httpContext.Request.InputStream;
        if (httpBodyStream.Length > int.MaxValue)
        {
            throw new ArgumentException("HTTP InputStream too large.");
        }

        StreamReader reader = new StreamReader(httpBodyStream, Encoding.UTF8);
        string xmlBody = reader.ReadToEnd();
        reader.Close();

        filterContext.ActionParameters["message"] = xmlBody;

        // Sends XML Data To Model so it could be available on the ActionResult
        base.OnActionExecuting(filterContext);
    }

然后在控制器中，你可以将 xml 作为字符串访问：

[RestAPIAttribute]    
public ActionResult MyActionResult(string message)    
{         

}

Answer 2

这可以通过使用 ActionFilterAttribute 来完成。 操作过滤器基本上在操作结果之前或之后与请求相交。 所以我刚刚为 POST Action Result 构建了一个自定义操作过滤器属性。 这就是我所做的：

public class RestAPIAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        HttpContextBase httpContext = filterContext.HttpContext;
        if (!httpContext.IsPostNotification)
        {
            throw new InvalidOperationException("Only POST messages allowed on this resource");
        }
        Stream httpBodyStream = httpContext.Request.InputStream;

        if (httpBodyStream.Length > int.MaxValue)
        {
            throw new ArgumentException("HTTP InputStream too large.");
        }

        int streamLength = Convert.ToInt32(httpBodyStream.Length);
        byte[] byteArray = new byte[streamLength];
        const int startAt = 0;

        /*
         * Copies the stream into a byte array
         */
        httpBodyStream.Read(byteArray, startAt, streamLength);

        /*
         * Convert the byte array into a string
         */
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < streamLength; i++)
        {
            sb.Append(Convert.ToChar(byteArray[i]));
        }

        string xmlBody = sb.ToString();

        //Sends XML Data To Model so it could be available on the ActionResult

        base.OnActionExecuting(filterContext);
    }
}

然后在控制器上的操作结果方法上，您应该执行如下操作：

    [RestAPIAttribute]
    public ActionResult MyActionResult()
    {
        //Gets XML Data From Model and do whatever you want to do with it
    }

希望这对其他人有帮助，如果您认为有更优雅的方法可以做到这一点，请告诉我。

Answer 3

为什么他们不能在表单帖子中将 xml 作为字符串传递？

示例：

public ActionResult SendMeXml(string xml)
{
  //Parse into a XDocument or something else if you want, and return whatever you want.
  XDocument xmlDocument = XDocument.Parse(xml);

  return View();
}

您可以创建表单帖子并将其发送到单个表单字段中。

Answer 4

我知道您可以创建一个自定义价值提供者工厂。 这还可以让您在模型发布时验证模型，然后再尝试保存它们。 Phil Haack 有一篇关于同一概念的 JSON 版本的博客文章。 唯一的问题是我不知道如何为 XML 实现同样的事情。

Answer 5

IMO 实现此目的的最佳方法是编写一个自定义值提供程序，这是一个处理请求到表单字典的映射的工厂。 您只需继承 ValueProviderFactory 并处理类型为“text/xml”或“application/xml”的请求。

更多信息：

菲尔·哈克

我的博客

MSDN

protected override void OnApplicationStarted()
{
    AreaRegistration.RegisterAllAreas();

    RegisterRoutes(RouteTable.Routes);

    ValueProviderFactories.Factories.Add(new JsonValueProviderFactory());
    ValueProviderFactories.Factories.Add(new XmlValueProviderFactory());
}

XmlValueProviderFactory

using System;
using System.Collections.Generic;
using System.Globalization;
using System.Web.Mvc;
using System.Xml;
using System.Xml.Linq;

public class XmlValueProviderFactory : ValueProviderFactory
{

    public override IValueProvider GetValueProvider(ControllerContext controllerContext)
    {
        var deserializedXml = GetDeserializedXml(controllerContext);

        if (deserializedXml == null) return null;

        var backingStore = new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);

        AddToBackingStore(backingStore, string.Empty, deserializedXml.Root);

        return new DictionaryValueProvider<object>(backingStore, CultureInfo.CurrentCulture);

    }

    private static void AddToBackingStore(Dictionary<string, object> backingStore, string prefix, XElement xmlDoc)
    {
        // Check the keys to see if this is an array or an object
        var uniqueElements = new List<String>();
        var totalElments = 0;
        foreach (XElement element in xmlDoc.Elements())
        {
            if (!uniqueElements.Contains(element.Name.LocalName))
                uniqueElements.Add(element.Name.LocalName);
            totalElments++;
        }

        var isArray = (uniqueElements.Count == 1 && totalElments > 1);


        // Add the elements to the backing store
        var elementCount = 0;
        foreach (XElement element in xmlDoc.Elements())
        {
            if (element.HasElements)
            {
                if (isArray)
                    AddToBackingStore(backingStore, MakeArrayKey(prefix, elementCount), element);
                else
                    AddToBackingStore(backingStore, MakePropertyKey(prefix, element.Name.LocalName), element);
            }
            else
            {
                backingStore.Add(MakePropertyKey(prefix, element.Name.LocalName), element.Value);
            }
            elementCount++;
        }
    }


    private static string MakeArrayKey(string prefix, int index)
    {
        return prefix + "[" + index.ToString(CultureInfo.InvariantCulture) + "]";
    }

    private static string MakePropertyKey(string prefix, string propertyName)
    {
        if (!string.IsNullOrEmpty(prefix))
            return prefix + "." + propertyName;
        return propertyName;
    }

    private XDocument GetDeserializedXml(ControllerContext controllerContext)
    {
        var contentType = controllerContext.HttpContext.Request.ContentType;
        if (!contentType.StartsWith("text/xml", StringComparison.OrdinalIgnoreCase) &&
            !contentType.StartsWith("application/xml", StringComparison.OrdinalIgnoreCase))
            return null;

        XDocument xml;
        try
        {
            var xmlReader = new XmlTextReader(controllerContext.HttpContext.Request.InputStream);
            xml = XDocument.Load(xmlReader);
        }
        catch (Exception)
        {
            return null;
        }

        if (xml.FirstNode == null)//no xml.
            return null;

        return xml;
    }
}

Answer 6

我喜欢@Freddy 的回答和@Bowerm 的改进。 它简洁并保留了基于表单的操作的格式。

但 IsPostNotification 检查在生产代码中不起作用。 它不会像错误消息似乎暗示的那样检查 HTTP 谓词，并且当编译调试标志设置为 false 时，它​​会从 HTTP 上下文中剥离。 这里解释一下：
编译调试为 false 时 HttpContext.IsPostNotification 为 false

我希望这可以节省某人 1/2 天的调试路由的时间。 这是没有该检查的解决方案：

public class XmlApiAttribute : ActionFilterAttribute
{
    public override void OnActionExecuting(ActionExecutingContext filterContext)
    {
        HttpContextBase httpContext = filterContext.HttpContext;
        // Note: for release code IsPostNotification stripped away, so don't check it!
        // https://stackoverflow.com/questions/28877619/httpcontext-ispostnotification-is-false-when-compilation-debug-is-false            

        Stream httpBodyStream = httpContext.Request.InputStream;
        if (httpBodyStream.Length > int.MaxValue)
        {
            throw new ArgumentException("HTTP InputStream too large.");
        }

        StreamReader reader = new StreamReader(httpBodyStream, Encoding.UTF8);
        string xmlBody = reader.ReadToEnd();
        reader.Close();

        filterContext.ActionParameters["xmlDoc"] = xmlBody;

        // Sends XML Data To Model so it could be available on the ActionResult
        base.OnActionExecuting(filterContext);
    }
}
...
public class MyXmlController 
{ ...
    [XmlApiAttribute]
    public JsonResult PostXml(string xmlDoc)
    {
...

Answer 7

很好！，

我在控制器方法中获得了什么对象来操作 Xml？

我使用这种方式：

在 actionFilter 上，我用以下内容填充模型：

        .
        .

        string xmlBody = sb.ToString();

        filterContext.Controller.ViewData.Model = xmlBody;

在我的控制器方法上，我得到的模型为：

        string xmlUserResult = ViewData.Model as string;

        XmlSerializer ser = new XmlSerializer(typeof(UserDTO));
        StringReader stringReader = new StringReader(xmlUserResult);
        XmlTextReader xmlReader = new XmlTextReader(stringReader);
        UserDTO userToUpdate = ser.Deserialize(xmlReader) as UserDTO;
        xmlReader.Close();
        stringReader.Close();

这是正确的实现吗？

谢谢。