ASP.NET?MVC自定義操作過(guò)濾器
一、操作過(guò)濾器
1、定義
操作過(guò)濾器用于實(shí)現(xiàn)IActionFilter接口以及包裝操作方法執(zhí)行。IActionFilter接口聲明兩個(gè)方法:OnActionExecuting和OnActionExecuted。OnActionExecuting在操作方法之前運(yùn)行。OnActionExecuted在操作方法之后運(yùn)行,可以執(zhí)行其他處理,如向操作方法提供額外數(shù)據(jù)、檢查返回值或取消執(zhí)行操作方法。
查看ActionFilterAttribute類的定義:
#region 程序集 System.Web.Mvc, Version=5.2.7.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35
// D:\Practice\MVC\自定義操作過(guò)濾器\MVCCustomerActionFilterDemo\packages\Microsoft.AspNet.Mvc.5.2.7\lib\net45\System.Web.Mvc.dll
#endregion
namespace System.Web.Mvc
{
//
// 摘要:
// 表示篩選器特性的基類。
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, Inherited = true, AllowMultiple = false)]
public abstract class ActionFilterAttribute : FilterAttribute, IActionFilter, IResultFilter
{
//
// 摘要:
// 初始化 System.Web.Mvc.ActionFilterAttribute 類的新實(shí)例。
protected ActionFilterAttribute();
//
// 摘要:
// 在執(zhí)行操作方法后由 ASP.NET MVC 框架調(diào)用。
//
// 參數(shù):
// filterContext:
// 篩選器上下文。
public virtual void OnActionExecuted(ActionExecutedContext filterContext);
//
// 摘要:
// 在執(zhí)行操作方法之前由 ASP.NET MVC 框架調(diào)用。
//
// 參數(shù):
// filterContext:
// 篩選器上下文。
public virtual void OnActionExecuting(ActionExecutingContext filterContext);
//
// 摘要:
// 在執(zhí)行操作結(jié)果后由 ASP.NET MVC 框架調(diào)用。
//
// 參數(shù):
// filterContext:
// 篩選器上下文。
public virtual void OnResultExecuted(ResultExecutedContext filterContext);
//
// 摘要:
// 在執(zhí)行操作結(jié)果之前由 ASP.NET MVC 框架調(diào)用。
//
// 參數(shù):
// filterContext:
// 篩選器上下文。
public virtual void OnResultExecuting(ResultExecutingContext filterContext);
}
}根據(jù)方法的名字就知道4個(gè)方法執(zhí)行的順序了:
OnActionExecuting是Action執(zhí)行前的操作、OnActionExecuted則是Action執(zhí)行后的操作、OnResultExecuting是解析ActionResult前執(zhí)行、OnResultExecuted是解析ActionResult后執(zhí)行。
即:Action執(zhí)行前:OnActionExecuting方法先執(zhí)行→Action執(zhí)行 →OnActionExecuted方法執(zhí)行→OnResultExecuting方法執(zhí)行→返回的ActionRsult中的 executeResult方法執(zhí)行→OnResultExecuted執(zhí)行。
2、案例
2.1、創(chuàng)建自定義操作過(guò)濾器
新建一個(gè)自定義過(guò)濾器,然后重新里面的方法,代碼如下:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace MVCCustomerActionFilterDemo.Extension
{
public class CustomerActionFilter :ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法準(zhǔn)備執(zhí)行");
base.OnActionExecuting(filterContext);
}
public override void OnActionExecuted(ActionExecutedContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法執(zhí)行結(jié)束");
base.OnActionExecuted(filterContext);
}
}
}2.2、新建控制器
創(chuàng)建一個(gè)控制器,用來(lái)測(cè)試自定義操作過(guò)濾器,代碼如下:
using MVCCustomerActionFilterDemo.Extension;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace MVCCustomerActionFilterDemo.Controllers
{
public class ActionFiltersController : Controller
{
// GET: ActionFilters
[CustomerActionFilter]
public ActionResult Index()
{
Response.Write("<h2>執(zhí)行Index...</h2>");
return View();
}
}
}Index方法對(duì)應(yīng)的視圖代碼如下:
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>Index</title>
</head>
<body>
<div>
<h1>操作過(guò)濾器測(cè)試頁(yè)面</h1>
</div>
</body>
</html>運(yùn)行結(jié)果;

二、結(jié)果過(guò)濾器
1、定義
結(jié)果篩選器用于實(shí)現(xiàn)IResultFilter接口以及包裝ActionResult對(duì)象的執(zhí)行。IResultFilter接口聲明兩個(gè)方法OnResultExecuting和OnResultExecuted。OnResultExecuting在執(zhí)行ActionResult對(duì)象之前運(yùn)行。OnResultExecuted在結(jié)果之后運(yùn)行,可以對(duì)結(jié)果執(zhí)行其他處理,如修改 HTTP 響應(yīng)。
結(jié)果過(guò)濾器也是實(shí)現(xiàn)了ActionFilterAttribute類。
2、案例
修改CustomerActionFilter類,重寫OnResultExecuting和OnResultExecuted,修改后的代碼如下:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace MVCCustomerActionFilterDemo.Extension
{
public class CustomerActionFilter :ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法準(zhǔn)備執(zhí)行");
base.OnActionExecuting(filterContext);
}
public override void OnActionExecuted(ActionExecutedContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法執(zhí)行結(jié)束");
base.OnActionExecuted(filterContext);
}
public override void OnResultExecuting(ResultExecutingContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法執(zhí)行結(jié)束,準(zhǔn)備呈現(xiàn)視圖");
base.OnResultExecuting(filterContext);
}
public override void OnResultExecuted(ResultExecutedContext filterContext)
{
filterContext.HttpContext.Response.Write("視圖呈現(xiàn)結(jié)束");
base.OnResultExecuted(filterContext);
}
}
}運(yùn)行結(jié)果:

三、案例
1、記錄操作
在真實(shí)項(xiàng)目中,可以利用操作過(guò)濾器記錄哪個(gè)用戶登錄系統(tǒng)以后進(jìn)行了哪些操作。
1.1、創(chuàng)建實(shí)體類
新建用于記錄信息的實(shí)體類。代碼如下:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
namespace MVCCustomerActionFilterDemo.Models
{
public class LogEntity
{
/// <summary>
/// 控制器名稱
/// </summary>
public string ControllerName { get; set; }
/// <summary>
/// Action方法名稱
/// </summary>
public string ActionName { get; set; }
/// <summary>
/// 操作用戶id
/// </summary>
public string OperationUserId { get; set; }
/// <summary>
/// 操作時(shí)間
/// </summary>
public DateTime OperationTime { get; set; }
}
}1.2、創(chuàng)建日志類
創(chuàng)建日志幫助類,代碼如下:
using MVCCustomerActionFilterDemo.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.IO;
namespace MVCCustomerActionFilterDemo.Util
{
public class LogHelper
{
/// <summary>
/// 記錄操作日志
/// 這里為了方便測(cè)試記錄到txt文件里面,實(shí)際中應(yīng)該是記錄到數(shù)據(jù)庫(kù)中
/// 然后有界面可以顯示這些操作記錄
/// </summary>
/// <param name="entity"></param>
public static void WriteOperRecore(LogEntity entity)
{
string strPath = @"C:\log.txt";
using (StreamWriter sw = new StreamWriter(strPath, true))
{
sw.WriteLine("**************************");
sw.WriteLine($"操作時(shí)間:{entity.OperationTime}");
sw.WriteLine($"當(dāng)前Controller名稱:{entity.ControllerName}");
sw.WriteLine($"當(dāng)前Action名稱:{entity.ActionName}");
sw.WriteLine($"當(dāng)前操作用戶id:{entity.OperationUserId}");
sw.Close();
}
}
}
}1.3、修改操作過(guò)濾器類
修改后的操作過(guò)濾器類代碼如下:
using MVCCustomerActionFilterDemo.Models;
using MVCCustomerActionFilterDemo.Util;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace MVCCustomerActionFilterDemo.Extension
{
public class CustomerActionFilter : ActionFilterAttribute
{
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法準(zhǔn)備執(zhí)行");
string strControllerName = filterContext.RouteData.Values["controller"].ToString();
string strActionName = filterContext.RouteData.Values["action"].ToString();
LogEntity entity = new LogEntity()
{
OperationTime = DateTime.Now,
ControllerName = strControllerName,
ActionName = strActionName,
// 為了方便測(cè)試寫admin,真實(shí)案例需要獲取當(dāng)前登錄的用戶
OperationUserId = "admin"
};
// 記錄操作記錄
LogHelper.WriteOperRecore(entity);
base.OnActionExecuting(filterContext);
}
public override void OnActionExecuted(ActionExecutedContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法執(zhí)行結(jié)束");
base.OnActionExecuted(filterContext);
}
public override void OnResultExecuting(ResultExecutingContext filterContext)
{
filterContext.HttpContext.Response.Write("Action方法執(zhí)行結(jié)束,準(zhǔn)備呈現(xiàn)視圖");
base.OnResultExecuting(filterContext);
}
public override void OnResultExecuted(ResultExecutedContext filterContext)
{
filterContext.HttpContext.Response.Write("視圖呈現(xiàn)結(jié)束");
base.OnResultExecuted(filterContext);
}
}
}運(yùn)行程序,查看生成的日志:

2、實(shí)現(xiàn)權(quán)限控制功能
可以重寫OnActionExecuting方法實(shí)現(xiàn)授權(quán)過(guò)濾器一樣的功能,因?yàn)镺nActionExecuting方法是在Action方法執(zhí)行前執(zhí)行的,自定義一個(gè)實(shí)現(xiàn)ActionFilterAttribute類的CustomerActionPremisFilters類,代碼如下:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
using MVCCustomerActionFilterDemo.DataBase;
using MVCCustomerActionFilterDemo.Models;
namespace MVCCustomerActionFilterDemo.Extension
{
public class CustomerActionPremisFilters :ActionFilterAttribute
{
public string ActionName { get; set; } //用于保存Action配置的別名
public string AreaName { get; set; }
public string Roles { get; set; }
public override void OnActionExecuting(ActionExecutingContext filterContext)
{
// 如果未登錄,則跳轉(zhuǎn)到登錄界面
if (!filterContext.HttpContext.User.Identity.IsAuthenticated)
{
filterContext.HttpContext.Response.Redirect("/Account/LogOn");
return;
}
//當(dāng)前登錄用戶的用戶名
string userName = filterContext.HttpContext.User.Identity.Name;
//當(dāng)前登錄用戶對(duì)象
User user = SampleData.users.Find(u => u.UserName == userName);
if (user != null)
{
//當(dāng)前登錄用戶的角色
Role role = SampleData.roles.Find(r => r.Id == user.RoleId);
//獲得controller:
string controllerName = filterContext.RouteData.Values["controller"].ToString().ToLower();
if (ActionName == null)
{
ActionName = filterContext.RouteData.Values["action"].ToString();
}
//查詢角色id
RoleWithControllerAction roleWithControllerAction = SampleData.roleWithControllerAndAction.Find(r => r.ControllerName.ToLower() == controllerName && ActionName.ToLower() == ActionName.ToLower());
if (roleWithControllerAction != null)
{
//有權(quán)限操作當(dāng)前控制器和Action的角色id
this.Roles = roleWithControllerAction.RoleIds;
}
if (!string.IsNullOrEmpty(Roles))
{
foreach (string roleid in Roles.Split(','))
{
if (role.Id.ToString() == roleid)
{
//return就說(shuō)明有權(quán)限了,后面的代碼就不跑了,直接返回視圖給瀏覽器就好
return;
}
}
}
filterContext.Result = new ViewResult { ViewName = "Error", };
return;
}
else
{
filterContext.Result = new EmptyResult();
filterContext.HttpContext.Response.Redirect("/Account/Logon", true);
return;
}
}
}
}新建ActionPremisFilters控制器,代碼如下:
using MVCCustomerActionFilterDemo.Extension;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Mvc;
namespace MVCCustomerActionFilterDemo.Controllers
{
public class ActionPremisFiltersController : Controller
{
// GET: ActionPremisFilters
[CustomerActionPremisFilters]
public ActionResult Index()
{
return View();
}
}
}修改SampleData數(shù)據(jù),使角色id為2、3的可以訪問(wèn)ActionPremisFilters的Index方法:
using MVCCustomerActionFilterDemo.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
namespace MVCCustomerActionFilterDemo.DataBase
{
/// <summary>
/// 測(cè)試數(shù)據(jù)(實(shí)際項(xiàng)目中,這些數(shù)據(jù)應(yīng)該從數(shù)據(jù)庫(kù)拿)
/// </summary>
public class SampleData
{
public static List<User> users;
public static List<Role> roles;
public static List<RoleWithControllerAction> roleWithControllerAndAction;
static SampleData()
{
// 初始化用戶
users = new List<User>()
{
new User(){ Id=1, UserName="jxl", RoleId=1},
new User(){ Id=2, UserName ="senior1", RoleId=2},
new User(){ Id=3, UserName ="senior2", RoleId=2},
new User(){ Id=5, UserName="junior1", RoleId=3},
new User(){ Id=6, UserName="junior2", RoleId=3},
new User(){ Id=6, UserName="junior3", RoleId=3}
};
// 初始化角色
roles = new List<Role>()
{
new Role() { Id=1, RoleName="管理員", Description="管理員角色"},
new Role() { Id=2, RoleName="高級(jí)會(huì)員", Description="高級(jí)會(huì)員角色"},
new Role() { Id=3, RoleName="初級(jí)會(huì)員", Description="初級(jí)會(huì)員角色"}
};
// 初始化角色控制器和Action對(duì)應(yīng)類
roleWithControllerAndAction = new List<RoleWithControllerAction>()
{
new RoleWithControllerAction(){ Id=1, ControllerName="AuthFilters", ActionName="AdminUser", RoleIds="1"},
new RoleWithControllerAction(){ Id=2, ControllerName="AuthFilters", ActionName="SeniorUser",RoleIds="1,2"},
new RoleWithControllerAction(){ Id=3, ControllerName="AuthFilters", ActionName="JuniorUser",RoleIds="1,2,3"},
new RoleWithControllerAction(){ Id=3, ControllerName="AuthFilters", ActionName="Welcome",RoleIds="1,2"},
new RoleWithControllerAction(){ Id=4, ControllerName="ActionFilters", ActionName="Index", RoleIds="2,3"},
// 角色2、3可以訪問(wèn)ActionPremisFilters控制器的Index方法
new RoleWithControllerAction(){ Id=4, ControllerName="ActionPremisFilters", ActionName="Index", RoleIds="2,3"}
};
}
}
}修改配置文件
<authentication mode="Forms"> <forms loginUrl="~/Account/LogOn" timeout="2880" /> </authentication>
測(cè)試,訪問(wèn)ActionPremisFilters的Index方法,由于系統(tǒng)還沒(méi)有登錄,所以會(huì)跳轉(zhuǎn)到登錄頁(yè)面,這時(shí)候用jxl用戶登錄:

由于jxl用戶沒(méi)有訪問(wèn)ActionPremisFilters控制器中Index方法的權(quán)限,所以會(huì)跳轉(zhuǎn)到Error頁(yè)面:

這時(shí)在用senior1用戶登錄,由于senior1用戶有權(quán)限訪問(wèn),所以會(huì)顯示Index視圖內(nèi)容:

GitHub代碼地址:https://github.com/jxl1024/MVCCustomerActionFilterDemo
到此這篇關(guān)于ASP.NET MVC自定義操作過(guò)濾器的文章就介紹到這了。希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- ASP.NET MVC自定義授權(quán)過(guò)濾器
- ASP.NET?MVC自定義異常過(guò)濾器使用案例
- ASP.NET MVC自定義異常過(guò)濾器
- ASP.NET?MVC授權(quán)過(guò)濾器用法
- ASP.NET MVC異常過(guò)濾器用法
- ASP.NET MVC緩存過(guò)濾器用法
- ASP.NET Core MVC中過(guò)濾器工作原理介紹
- .NET6自定義WebAPI過(guò)濾器
- ASP.NET Core MVC 過(guò)濾器(Filter)
- ASP.NET Core MVC 過(guò)濾器的使用方法介紹
- ASP.NET MVC過(guò)濾器執(zhí)行順序介紹
相關(guān)文章
Windows Server 2012 R2 或 2016無(wú)法安裝.Net 3.5.1
這篇文章主要為大家詳細(xì)介紹了Windows Server 2012 R2 或 2016 無(wú)法安裝 .Net 3.5.1,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-02-02
asp.net TemplateField模板中的Bind方法和Eval方法
在TemplateField模板中為了能夠有限制的或者取出數(shù)據(jù)庫(kù)中某列的值時(shí),可以用Bind和Eval方法來(lái)實(shí)現(xiàn)。以下是Bind方法的格式,Eval的格式也是和Bind一樣的。 Bind("列的名稱","顯示的格式文")2009-06-06
ASP.NET中GridView 重復(fù)表格列合并的實(shí)現(xiàn)方法
本文通過(guò)GridView 和 Repeater 解決有關(guān)表格顯示數(shù)據(jù)重復(fù)的數(shù)據(jù)列和并的方法,非常實(shí)用,感興趣的朋友一起看下吧2016-08-08
asp.net實(shí)現(xiàn)訪問(wèn)局域網(wǎng)共享目錄下文件的解決方法
這篇文章主要介紹了asp.net實(shí)現(xiàn)訪問(wèn)局域網(wǎng)共享目錄下文件的解決方法,需要的朋友可以參考下2014-07-07
國(guó)產(chǎn)化之銀河麒麟安裝.netcore3.1的詳細(xì)步驟(手動(dòng)安裝)
這篇文章主要介紹了國(guó)產(chǎn)化之銀河麒麟安裝.netcore3.1的詳細(xì)步驟(手動(dòng)安裝),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-03-03
簡(jiǎn)單Web service 身份驗(yàn)證解決方案
問(wèn)題提出:為了構(gòu)建一個(gè)安全的web服務(wù),需要對(duì)調(diào)用方進(jìn)行身份驗(yàn)證,只讓通過(guò)審核的用戶調(diào)用web服務(wù)。2009-05-05
.NET?Core?GC壓縮(compact_phase)底層原理解析
GC的最后一個(gè)步驟,分為清除和壓縮兩種情況,清除操作將不可到達(dá)對(duì)象轉(zhuǎn)換為Free,而壓縮操作涉及復(fù)制對(duì)象并移動(dòng)到新位置,更新所有引用,并重新劃分代邊界,本文介紹.NET Core GC壓縮原理解析,感興趣的朋友一起看看吧2025-01-01

