asp.net-mvc
Filtry akcji
Szukaj…
Filtr akcji rejestrowania
public class LogActionFilter : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
Log("OnActionExecuting", filterContext.RouteData);
}
public override void OnActionExecuted(ActionExecutedContext filterContext)
{
Log("OnActionExecuted", filterContext.RouteData);
}
public override void OnResultExecuting(ResultExecutingContext filterContext)
{
Log("OnResultExecuting", filterContext.RouteData);
}
public override void OnResultExecuted(ResultExecutedContext filterContext)
{
Log("OnResultExecuted", filterContext.RouteData);
}
private void Log(string methodName, RouteData routeData)
{
var controllerName = routeData.Values["controller"];
var actionName = routeData.Values["action"];
var message = String.Format("{0} controller:{1} action:{2}", methodName, controllerName, actionName);
Debug.WriteLine(message, "Action Filter Log");
}
}
Filtr akcji kontroli sesji - żądanie strony i ajax
Zwykle procesy uwierzytelniania i autoryzacji są wykonywane przez wbudowane pliki cookie i obsługę tokenów w .NET MVC. Ale jeśli zdecydujesz się zrobić to sam z Session
, możesz użyć poniższej logiki dla żądań stron i żądań ajax.
public class SessionControl : ActionFilterAttribute
{
public override void OnActionExecuting ( ActionExecutingContext filterContext )
{
var session = filterContext.HttpContext.Session;
/// user is logged in (the "loggedIn" should be set in Login action upon a successful login request)
if ( session["loggedIn"] != null && (bool)session["loggedIn"] )
return;
/// if the request is ajax then we return a json object
if ( filterContext.HttpContext.Request.IsAjaxRequest() )
{
filterContext.Result = new JsonResult
{
Data = "UnauthorizedAccess",
JsonRequestBehavior = JsonRequestBehavior.AllowGet
};
}
/// otherwise we redirect the user to the login page
else
{
var redirectTarget = new RouteValueDictionary { { "Controller", "Login" }, { "Action", "Index" } };
filterContext.Result = new RedirectToRouteResult(redirectTarget);
}
}
public override void OnResultExecuting ( ResultExecutingContext filterContext )
{
base.OnResultExecuting(filterContext);
/// we set a field 'IsAjaxRequest' in ViewBag according to the actual request type
filterContext.Controller.ViewBag.IsAjaxRequest = filterContext.HttpContext.Request.IsAjaxRequest();
}
}
Lokalizacje użycia filtra akcji (globalne, kontroler, akcja)
Możesz umieścić filtry akcji na trzech możliwych poziomach:
- Światowy
- Kontroler
- Akcja
Umieszczenie filtra globalnie Oznacza to wykonać w sprawie wniosków o dowolnej trasie. Umieszczenie jednego na kontrolerze powoduje, że jest on wykonywany na żądanie dowolnej akcji w tym kontrolerze. Umieszczenie jednego na akcji oznacza, że działa z akcją.
Jeśli mamy ten prosty filtr akcji:
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = true)]
public class CustomActionFilterAttribute : FilterAttribute, IActionFilter
{
private readonly string _location;
public CustomActionFilterAttribute(string location)
{
_location = location;
}
public void OnActionExecuting(ActionExecutingContext filterContext)
{
Trace.TraceInformation("OnActionExecuting: " + _location);
}
public void OnActionExecuted(ActionExecutedContext filterContext)
{
Trace.TraceInformation("OnActionExecuted: " + _location);
}
}
Możemy dodać go na poziomie globalnym, dodając go do globalnej kolekcji filtrów. W typowej konfiguracji projektu ASP.NET MVC odbywa się to w App_Start / FilterConfig.cs.
public class FilterConfig
{
public static void RegisterGlobalFilters(GlobalFilterCollection filters)
{
filters.Add(new CustomActionFilterAttribute("Global"));
}
}
Możemy również dodać go na poziomie kontrolera i akcji, tak jak w kontrolerze:
[CustomActionFilter("HomeController")]
public class HomeController : Controller
{
[CustomActionFilter("Index")]
public ActionResult Index()
{
return View();
}
}
Jeśli uruchomimy aplikację i spojrzymy na okno Wyjście, zobaczymy następujące komunikaty:
iisexpress.exe Information: 0 : OnActionExecuting: Global
iisexpress.exe Information: 0 : OnActionExecuting: HomeController
iisexpress.exe Information: 0 : OnActionExecuting: Index
iisexpress.exe Information: 0 : OnActionExecuted: Index
iisexpress.exe Information: 0 : OnActionExecuted: HomeController
iisexpress.exe Information: 0 : OnActionExecuted: Global
Jak widać, gdy przychodzi żądanie, filtry są wykonywane:
- Światowy
- Kontroler
- Akcja
Doskonałe przykłady filtrów umieszczonych na poziomie globalnym obejmują:
- Filtry uwierzytelnienia
- Filtry autoryzacji
- Filtry rejestrowania
Atrybut modułu obsługi wyjątków
Ten atrybut obsługuje wszystkie nieobsługiwane wyjątki w kodzie (dotyczy to głównie zapytań Ajax - które dotyczą JSON - ale można je rozszerzyć)
public class ExceptionHandlerAttribute : HandleErrorAttribute
{
/// <summary>
/// Overriden method to handle exception
/// </summary>
/// <param name="filterContext"> </param>
public override void OnException(ExceptionContext filterContext)
{
// If exeption is handled - return ( don't do anything)
if (filterContext.ExceptionHandled)
return;
// Set the ExceptionHandled to true ( as you are handling it here)
filterContext.ExceptionHandled = true;
//TODO: You can Log exception to database or Log File
//Set your result structure
filterContext.Result = new JsonResult
{
Data = new { Success = false, Message = filterContext .Exception.Message, data = new {} },
JsonRequestBehavior = JsonRequestBehavior.AllowGet
};
}
}
Powiedzmy, że zawsze musisz wysłać odpowiedź JSON podobną do tej:
{
Success: true, // False when Error
data: {},
Message:"Success" // Error Message when Error
}
Zamiast obsługiwać wyjątki w działaniach kontrolera, takie jak to:
public ActionResult PerformMyAction()
{
try
{
var myData = new { myValue = 1};
throw new Exception("Handled", new Exception("This is an Handled Exception"));
return Json(new {Success = true, data = myData, Message = ""});
}
catch(Exception ex)
{
return Json(new {Success = false, data = null, Message = ex.Message});
}
}
Możesz to zrobić:
[ExceptionHandler]
public ActionResult PerformMyAction()
{
var myData = new { myValue = 1};
throw new Exception("Unhandled", new Exception("This is an unhandled Exception"));
return Json(new {Success = true, data = myData, Message = ""});
}
LUB możesz dodać na poziomie kontrolera
[ExceptionHandler]
public class MyTestController : Controller
{
public ActionResult PerformMyAction()
{
var myData = new { myValue = 1};
throw new Exception("Unhandled", new Exception("This is an unhandled Exception"));
return Json(new {Success = true, data = myData, Message = ""});
}
}