मैंने इस समस्या को हल करने में कुछ घंटे बिताए हैं। मेरा समाधान निम्नलिखित इच्छाओं / आवश्यकताओं पर आधारित है:
- सभी JSON नियंत्रक क्रियाओं में दोहराए जाने वाले बॉयलरप्लेट त्रुटि हैंडलिंग कोड न रखें।
- HTTP (त्रुटि) स्थिति कोड संरक्षित करें। क्यों? क्योंकि उच्च स्तर की चिंताओं को निचले स्तर के कार्यान्वयन को प्रभावित नहीं करना चाहिए।
- सर्वर पर कोई त्रुटि / अपवाद होने पर JSON डेटा प्राप्त करने में सक्षम हो। क्यों? क्योंकि मैं अमीर त्रुटि जानकारी चाहते हो सकता है। उदाहरण त्रुटि संदेश, डोमेन विशिष्ट त्रुटि स्थिति कोड, स्टैक ट्रेस (डिबग / विकास वातावरण में)।
- उपयोग की आसानी ग्राहक पक्ष - बेहतर jQuery का उपयोग कर।
मैं एक HandleErrorAttribute बनाता हूं (विवरण की व्याख्या के लिए कोड टिप्पणियां देखें)। "Usings" सहित कुछ विवरण छोड़ दिए गए हैं, इसलिए कोड संकलित नहीं हो सकता है। मैं इस तरह से Global.asax.cs में एप्लिकेशन इनिशियलाइज़ेशन के दौरान फ़िल्टर को वैश्विक फ़िल्टर में जोड़ता हूं:
GlobalFilters.Filters.Add(new UnikHandleErrorAttribute());
विशेषता:
namespace Foo
{
using System;
using System.Diagnostics;
using System.Linq;
using System.Net;
using System.Reflection;
using System.Web;
using System.Web.Mvc;
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public sealed class FooHandleErrorAttribute : HandleErrorAttribute
{
private readonly TraceSource _TraceSource;
public FooHandleErrorAttribute(TraceSource traceSource)
{
if (traceSource == null)
throw new ArgumentNullException(@"traceSource");
_TraceSource = traceSource;
}
public TraceSource TraceSource
{
get
{
return _TraceSource;
}
}
public FooHandleErrorAttribute()
{
var className = typeof(FooHandleErrorAttribute).FullName ?? typeof(FooHandleErrorAttribute).Name;
_TraceSource = new TraceSource(className);
}
public override void OnException(ExceptionContext filterContext)
{
var actionMethodInfo = GetControllerAction(filterContext.Exception);
if(actionMethodInfo == null) return;
var controllerName = filterContext.Controller.GetType().FullName;
var actionName = actionMethodInfo.Name;
var traceMessage = string.Format(@"Unhandled exception from {0}.{1} handled in {2}. Exception: {3}", controllerName, actionName, typeof(FooHandleErrorAttribute).FullName, filterContext.Exception);
_TraceSource.TraceEvent(TraceEventType.Error, TraceEventId.UnhandledException, traceMessage);
if (actionMethodInfo.ReturnType != typeof(JsonResult)) return;
var jsonMessage = FooHandleErrorAttributeResources.Error_Occured;
if (filterContext.Exception is MySpecialExceptionWithUserMessage) jsonMessage = filterContext.Exception.Message;
filterContext.Result = new JsonResult
{
Data = new
{
message = jsonMessage,
stacktrace = MyEnvironmentHelper.IsDebugging ? filterContext.Exception.StackTrace : null
},
JsonRequestBehavior = JsonRequestBehavior.AllowGet
};
filterContext.ExceptionHandled = true;
filterContext.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
filterContext.HttpContext.Response.Cache.SetCacheability(HttpCacheability.NoCache);
base.OnException(filterContext);
}
private static MethodInfo GetControllerAction(Exception exception)
{
var stackTrace = new StackTrace(exception);
var frames = stackTrace.GetFrames();
if(frames == null) return null;
var frame = frames.FirstOrDefault(f => typeof(IController).IsAssignableFrom(f.GetMethod().DeclaringType));
if (frame == null) return null;
var actionMethod = frame.GetMethod();
return actionMethod as MethodInfo;
}
}
}
मैंने उपयोग की आसानी के लिए निम्नलिखित jQuery प्लगइन विकसित किया है:
(function ($, undefined) {
"using strict"
$.FooGetJSON = function (url, data, success, error) {
/// <summary>
/// **********************************************************
/// * UNIK GET JSON JQUERY PLUGIN. *
/// **********************************************************
/// This plugin is a wrapper for jQuery.getJSON.
/// The reason is that jQuery.getJSON success handler doesn't provides access to the JSON object returned from the url
/// when a HTTP status code different from 200 is encountered. However, please note that whether there is JSON
/// data or not depends on the requested service. if there is no JSON data (i.e. response.responseText cannot be
/// parsed as JSON) then the data parameter will be undefined.
///
/// This plugin solves this problem by providing a new error handler signature which includes a data parameter.
/// Usage of the plugin is much equal to using the jQuery.getJSON method. Handlers can be added etc. However,
/// the only way to obtain an error handler with the signature specified below with a JSON data parameter is
/// to call the plugin with the error handler parameter directly specified in the call to the plugin.
///
/// success: function(data, textStatus, jqXHR)
/// error: function(data, jqXHR, textStatus, errorThrown)
///
/// Example usage:
///
/// $.FooGetJSON('/foo', { id: 42 }, function(data) { alert('Name :' + data.name)
/// </summary>
// Call the ordinary jQuery method
var jqxhr = $.getJSON(url, data, success)
// Do the error handler wrapping stuff to provide an error handler with a JSON object - if the response contains JSON object data
if (typeof error !== "undefined") {
jqxhr.error(function(response, textStatus, errorThrown) {
try {
var json = $.parseJSON(response.responseText)
error(json, response, textStatus, errorThrown)
} catch(e) {
error(undefined, response, textStatus, errorThrown)
}
})
}
// Return the jQueryXmlHttpResponse object
return jqxhr
}
})(jQuery)
इस सब से मुझे क्या मिलेगा? अंतिम परिणाम यह है कि
- मेरे नियंत्रक क्रियाओं में से किसी पर भी HandleErrorAttributes की आवश्यकताएं नहीं हैं।
- मेरे किसी भी नियंत्रक क्रिया में कोई भी दोहराए जाने वाले बॉयलर प्लेट त्रुटि हैंडलिंग कोड नहीं है।
- मेरे पास एक एकल बिंदु त्रुटि हैंडलिंग कोड है जो मुझे लॉगिंग और अन्य त्रुटि से संबंधित सामान को आसानी से बदलने की अनुमति देता है।
- एक साधारण आवश्यकता: JsonResult को लौटाने वाले नियंत्रक क्रियाओं में रिटर्न प्रकार JsonResult होना चाहिए न कि कुछ आधार प्रकार जैसे ActionResult। कारण: FooHandleErrorAttribute में कोड टिप्पणी देखें।
ग्राहक पक्ष का उदाहरण:
var success = function(data) {
alert(data.myjsonobject.foo);
};
var onError = function(data) {
var message = "Error";
if(typeof data !== "undefined")
message += ": " + data.message;
alert(message);
};
$.FooGetJSON(url, params, onSuccess, onError);
टिप्पणियों का स्वागत है! मैं शायद किसी दिन इस समाधान के बारे में ब्लॉग करूँगा ...