ASP.NET MVC 4

Адам Фриман

Использование фильтров для методов действий

Фильтры действий можно использовать для различных целей. Встроенный класс для создания таких фильтров, IActionFilter, показан в листинге 16-21.

namespace System.Web.Mvc
{
	public interface IActionFilter
	{
		void OnActionExecuting(ActionExecutingContext filterContext);
		void OnActionExecuted(ActionExecutedContext filterContext);
	}
}

Этот интерфейс определяет два метода. MVC Framework вызывает метод OnActionExecuting перед тем, как вызвать метод действия, и OnActionExecuted после вызова метода действия.

Реализуем метод OnActionExecuting

Метод OnActionExecuting вызывается до метода действия. Вы можете использовать его для того, чтобы изучить запрос и принять решение о его отмене, изменении или задержке его выполнения. Параметром этого метода является объект ActionExecutingContext, который создает подкласс класса ControllerContext и определяет два дополнительных свойства, описанных в таблице 16-7.

Вы можете использовать фильтр, чтобы отменить запрос, определив в качестве значения для свойства Result результат действия. Чтобы это продемонстрировать, мы создали свой собственный класс фильтра действий под названием CustomActionAttribute в папке Infrastructure, как показано в листинге 16-22.

using System.Web.Mvc;
namespace Filters.Infrastructure
{
	public class CustomActionAttribute : FilterAttribute, IActionFilter
	{
		public void OnActionExecuting(ActionExecutingContext filterContext)
		{
			if (filterContext.HttpContext.Request.IsLocal)
			{
				filterContext.Result = new HttpNotFoundResult();
			}
		}
		public void OnActionExecuted(ActionExecutedContext filterContext)
		{
			// not yet implemented
		}
	}
}

В этом примере мы используем метод OnActionExecuting, чтобы проверить, отправлен ли запрос с локальной машины. Если это так, то возвращаем пользователю ответ 404 — Not Found.

Фильтр действий применяется так же, как и любой другой атрибут. Чтобы продемонстрировать фильтр, который мы создали в листинге 16-22, мы добавили новый метод действия в контроллер Home, как показано в листинге 16-23.

[CustomAction]
public string FilterTest()
{
	return "This is the FilterTest action";
}

Вы можете протестировать фильтр, запустив приложение и перейдя по ссылке /Home/FilterTest. Если вы отправили запрос с локальной машины, то вы увидите результат, показанный на рисунке 16-7, хотя, как мы знаем, и контроллер, и действие существуют.

Рисунок 16-7: Эффект от использования фильтра действий

Реализуем метод OnActionExecuted

Фильтр также можно использовать для выполнения каких-либо задач, которые измеряют время выполнения метода действия. В качестве простого примера мы создали новый класс ProfileActionAttribute в папке Infrastructure, который измеряет количество времени, которое занимает выполнение метода действия. Код этого фильтра показан в листинге 16-24.

using System.Diagnostics;
using System.Web.Mvc;
namespace Filters.Infrastructure
{
	public class ProfileActionAttribute : FilterAttribute, IActionFilter
	{
		private Stopwatch timer;
		public void OnActionExecuting(ActionExecutingContext filterContext)
		{
			timer = Stopwatch.StartNew();
		}
		public void OnActionExecuted(ActionExecutedContext filterContext)
		{
			timer.Stop();
			if (filterContext.Exception == null)
			{
				filterContext.HttpContext.Response.Write(
					string.Format("<div>Action method elapsed time: {0}</div>",
						timer.Elapsed.TotalSeconds));
			}
		}
	}
}

В этом примере мы запускаем таймер с помощью метода OnActionExecuting (используется класс таймера Stopwatch из пространства имен System.Diagnostics). Метод OnActionExecuted вызывается по завершении метода действия. В листинге 16-25 показано, как мы применили атрибут к контроллеру Home (ранее созданный фильтр был удален, чтобы локальные запросы не перенаправлялись).

[ProfileAction]
public string FilterTest()
{
	return "This is the ActionFilterTest action";
}

Если вы запустите приложение и перейдете по ссылке /Home/FilterTest, то увидите те же результаты, что и на рисунке 16-8.

Рисунок 16-8: Используем фильтр действий для измерения производительности

В качестве параметра в метод OnActionExecuted передается объект ActionExecutedContext. Этот класс определяет дополнительные свойства, которые показаны в таблице 16-8. Свойство Exception возвращает любое исключение, выброшенное методом действия, а свойство ExceptionHandled указывает, было ли оно обработано другим фильтром.

Свойство Canceled возвращает true, если запрос был отменен другим фильтром (т.е. он установил значение для свойства Result) с того момента, когда был запущен метод фильтра OnActionExecuting. Метод OnActionExecuted все равно будет вызван, но только для того, чтобы можно было освободить или очистить ранее используемые ресурсы.

Подписаться

или RSS канал: