作为ActionResult从控制器的操作中返回XML？

Question

从ASP.NET MVC中的控制器操作返回XML的最佳方法是什么？返回JSON有一种很好的方法,但不适用于XML.我是否真的需要通过View路由XML,还是应该采用Response.Write-it的非最佳实践方式？

Answer 1

return this.Content(xmlString, "text/xml");

Answer 2

使用MVCContrib的XmlResult Action.

这里参考的是他们的代码:

public class XmlResult : ActionResult
{
    private object objectToSerialize;

    /// <summary>
    /// Initializes a new instance of the <see cref="XmlResult"/> class.
    /// </summary>
    /// <param name="objectToSerialize">The object to serialize to XML.</param>
    public XmlResult(object objectToSerialize)
    {
        this.objectToSerialize = objectToSerialize;
    }

    /// <summary>
    /// Gets the object to be serialized to XML.
    /// </summary>
    public object ObjectToSerialize
    {
        get { return this.objectToSerialize; }
    }

    /// <summary>
    /// Serialises the object that was passed into the constructor to XML and writes the corresponding XML to the result stream.
    /// </summary>
    /// <param name="context">The controller context for the current request.</param>
    public override void ExecuteResult(ControllerContext context)
    {
        if (this.objectToSerialize != null)
        {
            context.HttpContext.Response.Clear();
            var xs = new System.Xml.Serialization.XmlSerializer(this.objectToSerialize.GetType());
            context.HttpContext.Response.ContentType = "text/xml";
            xs.Serialize(context.HttpContext.Response.Output, this.objectToSerialize);
        }
    }
}

Answer 3

如果您使用优秀的Linq-to-XML框架构建XML,那么这种方法将会很有帮助.

我XDocument在动作方法中创建了一个.

public ActionResult MyXmlAction()
{
    // Create your own XDocument according to your requirements
    var xml = new XDocument(
        new XElement("root",
            new XAttribute("version", "2.0"),
            new XElement("child", "Hello World!")));

    return new XmlActionResult(xml);
}

这个可重用的自定义ActionResult为您序列化XML.

public sealed class XmlActionResult : ActionResult
{
    private readonly XDocument _document;

    public Formatting Formatting { get; set; }
    public string MimeType { get; set; }

    public XmlActionResult(XDocument document)
    {
        if (document == null)
            throw new ArgumentNullException("document");

        _document = document;

        // Default values
        MimeType = "text/xml";
        Formatting = Formatting.None;
    }

    public override void ExecuteResult(ControllerContext context)
    {
        context.HttpContext.Response.Clear();
        context.HttpContext.Response.ContentType = MimeType;

        using (var writer = new XmlTextWriter(context.HttpContext.Response.OutputStream, Encoding.UTF8) { Formatting = Formatting })
            _document.WriteTo(writer);
    }
}

您可以指定MIME类型(例如application/rss+xml)以及是否需要缩进输出.这两个属性都有合理的默认值.

如果您需要UTF8以外的编码,那么为此添加属性也很简单.

Answer 4

如果您只想通过请求返回xml,并且您拥有xml"chunk",那么您可以这样做(作为控制器中的操作):

public string Xml()
{
    Response.ContentType = "text/xml";
    return yourXmlChunk;
}

Answer 5

MVC Contrib中有一个XmlResult(以及更多).请访问http://www.codeplex.com/MVCContrib

Answer 6

我最近不得不为一个 Sitecore 项目执行此操作，该项目使用一种方法从 Sitecore 项目及其子项创建 XmlDocument，并将其从控制器 ActionResult 作为文件返回。我的解决方案：

public virtual ActionResult ReturnXml()
{
    return File(Encoding.UTF8.GetBytes(GenerateXmlFeed().OuterXml), "text/xml");
}