web-dev-qa-db-ja.com

コントローラーのアクションからXMLをActionResultとして返しますか？

ASP.NET MVCのコントローラーのアクションからXMLを返す最良の方法は何ですか？ JSONを返すには良い方法がありますが、XMLにはありません。ビューを介してXMLを本当にルーティングする必要がありますか、それともResponse.Write-ingのベストプラクティスではない方法を実行する必要がありますか？

asp.net.netxmlasp.net-mvc
135
Ken Randall

MVCContrib のXmlResultアクションを使用します。

参照用のコードは次のとおりです。

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);
        }
    }
}
112
Luke Smith
return this.Content(xmlString, "text/xml");
127
Petr

優れた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以外のエンコーディングが必要な場合は、そのためのプロパティも簡単に追加できます。

30
Drew Noakes

リクエストを通じてxmlを返すだけで、xmlが「チャンク」である場合は、次の操作を実行できます（コントローラーのアクションとして）。

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

MVC ContribにはXmlResult（およびその他）があります。 http://www.codeplex.com/MVCContrib をご覧ください

17
Mahdi Taghizadeh

メソッドを使用してSitecoreアイテムとその子からXmlDocumentを作成し、それをコントローラーのActionResultからFileとして返すSitecoreプロジェクトで最近これを行う必要がありました。私の解決策：

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

最終的にこの仕事を手に入れることができ、他の人の痛みを救うことを期待して、ここでどのように文書化するかを考えました。

環境

  • VS2012
  • SQL Server 2008R2
  • .NET 4.5
  • ASP.NET MVC4（カミソリ）
  • Windows 7

サポートされているWebブラウザ

  • FireFox 23
  • IE 10
  • クローム29
  • オペラ16
  • Safari 5.1.7（Windows用の最後の1つ？）

私のタスクは、UIボタンをクリックして、コントローラーのメソッドを（いくつかのパラメーターを使用して）呼び出し、xslt変換を介してMS-Excel XMLを返すようにしました。返されたMS-Excel XMLにより、ブラウザーは[開く/保存]ダイアログをポップアップ表示します。これは、上記のすべてのブラウザで動作する必要がありました。

最初はAjaxを使用して、ファイル名に「ダウンロード」属性を使用して動的アンカーを作成しようとしましたが、5つのブラウザー（FF、Chrome、Opera）のうち約3つでのみ機能し、IEまたはSafari 。また、実際に「ダウンロード」を引き起こすために、アンカーのClickイベントをプログラムで起動しようとすると問題が発生しました。

私がやったことは、「見えない」IFRAMEを使用することで、5つのブラウザーすべてで機能しました。

そこで、ここに私が思いついたものがあります：[私は決してhtml/javascriptの第一人者ではなく、関連するコードのみを含めていることに注意してください]

HTML（関連ビットのスニペット）

<div id="docxOutput">
<iframe id="ifOffice" name="ifOffice" width="0" height="0"
    hidden="hidden" seamless='seamless' frameBorder="0" scrolling="no"></iframe></div>

ジャバスクリプト

//url to call in the controller to get MS-Excel xml
var _lnkToControllerExcel = '@Url.Action("ExportToExcel", "Home")';
$("#btExportToExcel").on("click", function (event) {
    event.preventDefault();

    $("#ProgressDialog").show();//like an ajax loader gif

    //grab the basket as xml                
    var keys = GetMyKeys();//returns delimited list of keys (for selected items from UI) 

    //potential problem - the querystring might be too long??
    //2K in IE8
    //4096 characters in ASP.Net
    //parameter key names must match signature of Controller method
    var qsParams = [
    'keys=' + keys,
    'locale=' + '@locale'               
    ].join('&');

    //The element with id="ifOffice"
    var officeFrame = $("#ifOffice")[0];

    //construct the url for the iframe
    var srcUrl = _lnkToControllerExcel + '?' + qsParams;

    try {
        if (officeFrame != null) {
            //Controller method can take up to 4 seconds to return
            officeFrame.setAttribute("src", srcUrl);
        }
        else {
            alert('ExportToExcel - failed to get reference to the office iframe!');
        }
    } catch (ex) {
        var errMsg = "ExportToExcel Button Click Handler Error: ";
        HandleException(ex, errMsg);
    }
    finally {
        //Need a small 3 second ( delay for the generated MS-Excel XML to come down from server)
        setTimeout(function () {
            //after the timeout then hide the loader graphic
            $("#ProgressDialog").hide();
        }, 3000);

        //clean up
        officeFrame = null;
        srcUrl = null;
        qsParams = null;
        keys = null;
    }
});

C＃SERVER-SIDE（コードスニペット）@Drewは、目的に合わせて変更したXmlActionResultというカスタムActionResultを作成しました。

コントローラーのアクションからXMLをActionResultとして返しますか？

コントローラーメソッド（ActionResultを返します）

  • xMLを生成するSQL Serverストアドプロシージャにキーパラメータを渡します
  • そのXMLは、xsltを介してMS-Excel xml（XmlDocument）に変換されます。

  • 変更されたXmlActionResultのインスタンスを作成し、それを返します

    XmlActionResult result = new XmlActionResult（excelXML、 "application/vnd.ms-Excel"）;文字列バージョン= DateTime.Now.ToString（ "dd_MMM_yyyy_hhmmsstt"）; string fileMask = "LabelExport_ {0} .xml";
    result.DownloadFilename = string.Format（fileMask、version）;結果を返す;

@Drewが作成したXmlActionResultクラスの主な変更。

public override void ExecuteResult(ControllerContext context)
{
    string lastModDate = DateTime.Now.ToString("R");

    //Content-Disposition: attachment; filename="<file name.xml>" 
    // must set the Content-Disposition so that the web browser will pop the open/save dialog
    string disposition = "attachment; " +
                        "filename=\"" + this.DownloadFilename + "\"; ";

    context.HttpContext.Response.Clear();
    context.HttpContext.Response.ClearContent();
    context.HttpContext.Response.ClearHeaders();
    context.HttpContext.Response.Cookies.Clear();
    context.HttpContext.Response.Cache.SetCacheability(System.Web.HttpCacheability.NoCache);// Stop Caching in IE
    context.HttpContext.Response.Cache.SetNoStore();// Stop Caching in Firefox
    context.HttpContext.Response.Cache.SetMaxAge(TimeSpan.Zero);
    context.HttpContext.Response.CacheControl = "private";
    context.HttpContext.Response.Cache.SetLastModified(DateTime.Now.ToUniversalTime());
    context.HttpContext.Response.ContentType = this.MimeType;
    context.HttpContext.Response.Charset = System.Text.UTF8Encoding.UTF8.WebName;

    //context.HttpContext.Response.Headers.Add("name", "value");
    context.HttpContext.Response.Headers.Add("Last-Modified", lastModDate);
    context.HttpContext.Response.Headers.Add("Pragma", "no-cache"); // HTTP 1.0.
    context.HttpContext.Response.Headers.Add("Expires", "0"); // Proxies.

    context.HttpContext.Response.AppendHeader("Content-Disposition", disposition);

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

それは基本的にそれでした。それが他の人を助けることを願っています。

2
sheir

ストリームとreturn File(stream, "text/xml");のみを使用できるシンプルなオプション。

1
Casey

これを行う簡単な方法を次に示します。

        var xml = new XDocument(
            new XElement("root",
            new XAttribute("version", "2.0"),
            new XElement("child", "Hello World!")));
        MemoryStream ms = new MemoryStream();
        xml.Save(ms);
        return File(new MemoryStream(ms.ToArray()), "text/xml", "HelloWorld.xml");
0
user2670714

Drew Noakesからの回答 の小さなバリエーションで、XDocumentのメソッドSave（）を使用します。

public sealed class XmlActionResult : ActionResult
{
    private readonly XDocument _document;
    public string MimeType { get; set; }

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

        _document = document;

        // Default values
        MimeType = "text/xml";
    }

    public override void ExecuteResult(ControllerContext context)
    {
        context.HttpContext.Response.Clear();
        context.HttpContext.Response.ContentType = MimeType;
        _document.Save(context.HttpContext.Response.OutputStream)
    }
}
0
Nelson Lopez Centeno