ASP.NET MVC में नियंत्रक की कार्रवाई से XML को वापस करने का सबसे अच्छा तरीका क्या है? JSON को वापस करने का एक अच्छा तरीका है, लेकिन XML के लिए नहीं। क्या मुझे वास्तव में एक दृश्य के माध्यम से XML को रूट करने की आवश्यकता है, या क्या मुझे Response.Write-ing का सबसे अच्छा अभ्यास तरीका नहीं करना चाहिए?
जवाबों:
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); } } }
XmlSerialiserऔर सदस्य एनोटेशन को बनाए रखना मुश्किल हो सकता है। चूंकि ल्यूक ने यह उत्तर (लगभग चार साल पहले) पोस्ट किया था, लिनेक ने एक्सएमएल को खुद को सबसे आम परिदृश्यों के लिए अधिक सुरुचिपूर्ण और शक्तिशाली प्रतिस्थापन के रूप में साबित किया है। यह कैसे करना है, इसके एक उदाहरण के लिए मेरा उत्तर देखें ।
return this.Content(xmlString, "text/xml");application/xmlइसके बजाय mimetype का उपयोग करना चाह सकते हैं ।
यदि आप उत्कृष्ट 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 के अलावा किसी अन्य एन्कोडिंग की आवश्यकता है, तो उसके लिए भी एक संपत्ति जोड़ना आसान है।
application/octet-streamइसे डाउनलोड करने के लिए मजबूर करने के लिए कुछ का उपयोग करना । मुझे नहीं पता कि MIME टाइप एक्सेल लॉन्च करता है, लेकिन आपको इसे आसानी से ऑनलाइन ढूंढने में सक्षम होना चाहिए।
MVC कंट्रिब में एक XmlResult (और भी बहुत कुछ) है। Http://www.codeplex.com/MVCContrib पर एक नज़र डालें
मुझे यह हाल ही में एक Sitecore प्रोजेक्ट के लिए करना है, जो एक Sitecore आइटम और उसके बच्चों से XmlDocument बनाने के लिए एक विधि का उपयोग करता है और इसे एक फ़ाइल के रूप में कंट्रोलर ActionResult से लौटाता है। मेरा समाधान:
public virtual ActionResult ReturnXml()
{
return File(Encoding.UTF8.GetBytes(GenerateXmlFeed().OuterXml), "text/xml");
}अंत में इस काम को प्राप्त करने के लिए प्रबंधन करें और सोचा कि मैं यहां दस्तावेज दूंगा कि दूसरों को दर्द से बचाने की उम्मीद में यहां कैसे।
वातावरण
समर्थित वेब ब्राउज़र
मेरा कार्य ui बटन क्लिक पर था, मेरे नियंत्रक पर एक विधि को कॉल करें (कुछ params के साथ) और फिर इसे xslt परिवर्तन के माध्यम से MS-Excel XML लौटाएं। MS-Excel XML लौटाया गया तो ब्राउज़र ओपन / सेव डायलॉग को पॉपअप करेगा। यह सभी ब्राउज़रों (ऊपर सूचीबद्ध) में काम करना था।
पहले तो मैंने अजाक्स के साथ और फ़ाइलनाम के लिए "डाउनलोड" विशेषता के साथ एक गतिशील एंकर बनाने की कोशिश की, लेकिन यह केवल 5 ब्राउज़रों (एफएफ, क्रोम, ओपेरा) में से लगभग 3 के लिए काम किया और आईई या सफारी के लिए नहीं। और वास्तविक "डाउनलोड" का कारण बनने के लिए एंकर के क्लिक इवेंट को प्रोग्रामिक रूप से फायर करने की कोशिश करने के मुद्दे थे।
मैंने जो किया वह एक "अदृश्य" IFRAME का उपयोग करते हुए समाप्त हो गया और इसने सभी 5 ब्राउज़रों के लिए काम किया!
तो यहाँ है कि मैं क्या लेकर आया हूँ: [कृपया ध्यान दें कि मैं किसी भी तरह से html / जावास्क्रिप्ट गुरु नहीं हूँ और केवल प्रासंगिक कोड शामिल किया है]
HTML (प्रासंगिक बिट्स का स्निपेट)
<div id="docxOutput">
<iframe id="ifOffice" name="ifOffice" width="0" height="0"
hidden="hidden" seamless='seamless' frameBorder="0" scrolling="no"></iframe></div>JAVASCRIPT
//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 (कोड स्निपेट) @ ड्रू ने XmlActionResult नामक एक कस्टम ActionResult बनाया है जिसे मैंने अपने उद्देश्य के लिए संशोधित किया है।
XML को एक नियंत्रक के एक्शन से एक ActionResult के रूप में लौटाएं?
मेरा नियंत्रक तरीका (ActionResult लौटाता है)
संशोधित XmlActionResult का उदाहरण बनाता है और इसे लौटाता है
XmlActionResult परिणाम = नया XmlActionResult (excelXML, "एप्लिकेशन / vnd.ms-excel)"; स्ट्रिंग संस्करण = DateTime.Now.ToString ("dd_MMM_yyyy_hhmmsstb"); string fileMask = "LabelExport_ {0} .xml";
result.DownloadFilename = string.Format (fileMask, संस्करण); वापसी परिणाम;
XDActionResult वर्ग का मुख्य संशोधन जो @ बनाया गया था।
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);
}वह मूल रूप से यह था। आशा है कि यह दूसरों की मदद करता है।
यहाँ यह करने का एक सरल तरीका है:
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");msएक नए की नकल करने के बजाय सीधे पास क्यों नहीं ? दोनों वस्तुओं का जीवनकाल समान होगा।
ms.Position=0और आप मूल मेमोरीस्ट्रीम वापस कर सकते हैं। फिर आप कर सकते हैंreturn new FileStreamResult(ms,"text/xml");
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)
}
}