首頁 > 軟體

ASP.NET MVC自定義操作過濾器

2022-03-16 13:00:32

一、操作過濾器

1、定義

操作過濾器用於實現IActionFilter介面以及包裝操作方法執行。IActionFilter介面宣告兩個方法：OnActionExecuting和OnActionExecuted。OnActionExecuting在操作方法之前執行。OnActionExecuted在操作方法之後執行，可以執行其他處理，如向操作方法提供額外資料、檢查返回值或取消執行操作方法。

檢視ActionFilterAttribute類的定義：

#region 程式集 System.Web.Mvc, Version=5.2.7.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35
// D:PracticeMVC自定義操作過濾器MVCCustomerActionFilterDemopackagesMicrosoft.AspNet.Mvc.5.2.7libnet45System.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 類的新範例。
        protected ActionFilterAttribute();

        //
        // 摘要:
        //     在執行操作方法後由 ASP.NET MVC 框架呼叫。
        //
        // 引數:
        //   filterContext:
        //     篩選器上下文。
        public virtual void OnActionExecuted(ActionExecutedContext filterContext);
        //
        // 摘要:
        //     在執行操作方法之前由 ASP.NET MVC 框架呼叫。
        //
        // 引數:
        //   filterContext:
        //     篩選器上下文。
        public virtual void OnActionExecuting(ActionExecutingContext filterContext);
        //
        // 摘要:
        //     在執行操作結果後由 ASP.NET MVC 框架呼叫。
        //
        // 引數:
        //   filterContext:
        //     篩選器上下文。
        public virtual void OnResultExecuted(ResultExecutedContext filterContext);
        //
        // 摘要:
        //     在執行操作結果之前由 ASP.NET MVC 框架呼叫。
        //
        // 引數:
        //   filterContext:
        //     篩選器上下文。
        public virtual void OnResultExecuting(ResultExecutingContext filterContext);
    }
}

根據方法的名字就知道4個方法執行的順序了：

OnActionExecuting是Action執行前的操作、OnActionExecuted則是Action執行後的操作、OnResultExecuting是解析ActionResult前執行、OnResultExecuted是解析ActionResult後執行。
即：Action執行前：OnActionExecuting方法先執行→Action執行 →OnActionExecuted方法執行→OnResultExecuting方法執行→返回的ActionRsult中的 executeResult方法執行→OnResultExecuted執行。

2、案例

2.1、建立自定義操作過濾器

新建一個自定義過濾器，然後重新裡面的方法，程式碼如下：

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方法準備執行");
            base.OnActionExecuting(filterContext);
        }

        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("Action方法執行結束");
            base.OnActionExecuted(filterContext);
        }
    }
}

2.2、新建控制器

建立一個控制器，用來測試自定義操作過濾器，程式碼如下：

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>執行Index...</h2>");
            return View();
        }
    }
}

Index方法對應的檢視程式碼如下：

@{
    Layout = null;
}

<!DOCTYPE html>

<html>
<head>
    <meta name="viewport" content="width=device-width" />
    <title>Index</title>
</head>
<body>
    <div> 
        <h1>操作過濾器測試頁面</h1>
    </div>
</body>
</html>

執行結果;

二、結果過濾器

1、定義

結果篩選器用於實現IResultFilter介面以及包裝ActionResult物件的執行。IResultFilter介面宣告兩個方法OnResultExecuting和OnResultExecuted。OnResultExecuting在執行ActionResult物件之前執行。OnResultExecuted在結果之後執行，可以對結果執行其他處理，如修改 HTTP 響應。

結果過濾器也是實現了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方法準備執行");
            base.OnActionExecuting(filterContext);
        }

        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("Action方法執行結束");
            base.OnActionExecuted(filterContext);
        }


        public override void OnResultExecuting(ResultExecutingContext filterContext)
        {
            filterContext.HttpContext.Response.Write("Action方法執行結束，準備呈現檢視");
            base.OnResultExecuting(filterContext);
        }

        public override void OnResultExecuted(ResultExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("檢視呈現結束");
            base.OnResultExecuted(filterContext);
        }
    }
}

執行結果：

三、案例

1、記錄操作

在真實專案中，可以利用操作過濾器記錄哪個使用者登入系統以後進行了哪些操作。

1.1、建立實體類

新建用於記錄資訊的實體類。程式碼如下：

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>
        /// 操作時間
        /// </summary>
        public DateTime OperationTime { get; set; }
    }
}

1.2、建立紀錄檔類

建立紀錄檔幫助類，程式碼如下：

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>
        /// 記錄操作紀錄檔
        /// 這裡為了方便測試記錄到txt檔案裡面，實際中應該是記錄到資料庫中
        /// 然後有介面可以顯示這些操作記錄
        /// </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($"操作時間:{entity.OperationTime}");
                sw.WriteLine($"當前Controller名稱:{entity.ControllerName}");
                sw.WriteLine($"當前Action名稱:{entity.ActionName}");
                sw.WriteLine($"當前操作使用者id:{entity.OperationUserId}");
                sw.Close();
            }
        }
    }
}

1.3、修改操作過濾器類

修改後的操作過濾器類程式碼如下：

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方法準備執行");
            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,
                // 為了方便測試寫admin，真實案例需要獲取當前登入的使用者
                OperationUserId = "admin"
            };
            // 記錄操作記錄
            LogHelper.WriteOperRecore(entity);
            base.OnActionExecuting(filterContext);
        }

        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("Action方法執行結束");
            base.OnActionExecuted(filterContext);
        }


        public override void OnResultExecuting(ResultExecutingContext filterContext)
        {
            filterContext.HttpContext.Response.Write("Action方法執行結束，準備呈現檢視");
            base.OnResultExecuting(filterContext);
        }

        public override void OnResultExecuted(ResultExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("檢視呈現結束");
            base.OnResultExecuted(filterContext);
        }
    }
}

執行程式，檢視生成的紀錄檔：

2、實現許可權控制功能

可以重寫OnActionExecuting方法實現授權過濾器一樣的功能，因為OnActionExecuting方法是在Action方法執行前執行的，自定義一個實現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)
        {
            // 如果未登入，則跳轉到登入介面
            if (!filterContext.HttpContext.User.Identity.IsAuthenticated)
            {
                filterContext.HttpContext.Response.Redirect("/Account/LogOn");
                return;
            }
            //當前登入使用者的使用者名稱
            string userName = filterContext.HttpContext.User.Identity.Name;
            //當前登入使用者物件
            User user = SampleData.users.Find(u => u.UserName == userName);  

            if (user != null)
            {
                //當前登入使用者的角色
                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)
                {
                    //有許可權操作當前控制器和Action的角色id
                    this.Roles = roleWithControllerAction.RoleIds;    
                }
                if (!string.IsNullOrEmpty(Roles))
                {
                    foreach (string roleid in Roles.Split(','))
                    {
                        if (role.Id.ToString() == roleid)
                        {
                            //return就說明有許可權了，後面的程式碼就不跑了，直接返回檢視給瀏覽器就好
                            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資料，使角色id為2、3的可以存取ActionPremisFilters的Index方法：

using MVCCustomerActionFilterDemo.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;

namespace MVCCustomerActionFilterDemo.DataBase
{
    /// <summary>
    /// 測試資料（實際專案中，這些資料應該從資料庫拿）
    /// </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="高階會員", Description="高階會員角色"},
                new Role() { Id=3, RoleName="初級會員", Description="初級會員角色"}
            };
            // 初始化角色控制器和Action對應類
            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可以存取ActionPremisFilters控制器的Index方法
                new RoleWithControllerAction(){ Id=4, ControllerName="ActionPremisFilters", ActionName="Index", RoleIds="2,3"}
            };
        }
    }
}

修改組態檔

<authentication mode="Forms">
   <forms loginUrl="~/Account/LogOn" timeout="2880" />
</authentication>

測試，存取ActionPremisFilters的Index方法，由於系統還沒有登入，所以會跳轉到登入頁面，這時候用jxl使用者登入：

由於jxl使用者沒有存取ActionPremisFilters控制器中Index方法的許可權，所以會跳轉到Error頁面：

這時在用senior1使用者登入，由於senior1使用者有許可權存取，所以會顯示Index檢視內容：

GitHub程式碼地址：https://github.com/jxl1024/MVCCustomerActionFilterDemo

到此這篇關於ASP.NET MVC自定義操作過濾器的文章就介紹到這了。希望對大家的學習有所幫助，也希望大家多多支援it145.com。


相關文章

  • 德漢姆中學就讀條件 德漢姆中學就讀條件

    <em>Mac</em>Book项目 2009年学校开始实施<em>Mac</em>Book项目,所有师生配备一本<em>Mac</em>Book,并同步更新了校园无线网络。学校每周进行电脑技术更新,每月发送技术支持资料,极大改变了教学及学习方式。因此2011

    2021-06-01 09:32:01

  • 黑科技的輕簡出行，告別「電量焦慮症」：Anker氮化鎵超能充系列 黑科技的輕簡出行，告別「電量焦慮症」：Anker氮化鎵超能充系列

    综合看Anker超能充系列的性价比很高，并且与不仅和iPhone12/苹果<em>Mac</em>Book很配，而且适合多设备充电需求的日常使用或差旅场景，不管是安卓还是Switch同样也能用得上它，希望这次分享能给准备购入充电器的小伙伴们有所

    2021-06-01 09:31:42

  • 吳亦凡廠牌首秀，L4WUDU居然忘詞了，Rapper和明星比還是有差距！ 吳亦凡廠牌首秀，L4WUDU居然忘詞了，Rapper和明星比還是有差距！

    除了L4WUDU与吴亦凡已经多次共事，成为了明面上的厂牌成员，吴亦凡还曾带领20XXCLUB全队参加2020年的一场音乐节，这也是20XXCLUB首次全员合照，王嗣尧Turbo、陈彦希Regi、<em>Mac</em> Ova Seas、林渝植等人全部出场。然而让

    2021-06-01 09:31:34

  • IPFS、Chia、Bzz和ICP挖礦該怎麼選？哪一個更有優勢？ IPFS、Chia、Bzz和ICP挖礦該怎麼選？哪一個更有優勢？

    目前应用IPFS的机构：1 谷歌<em>浏览器</em>支持IPFS分布式协议 2 万维网 (历史档案博物馆)数据库 3 火狐<em>浏览器</em>支持 IPFS分布式协议 4 EOS 等数字货币数据存储 5 美国国会图书馆，历史资料永久保存在 IPFS 6 加

    2021-06-01 09:31:24

  • 有哪些事是買了雪佛蘭後才知道的？美事偷著樂，開拓者車主隨聊 有哪些事是買了雪佛蘭後才知道的？美事偷著樂，開拓者車主隨聊

    开拓者的车机是兼容苹果和<em>安卓</em>，虽然我不怎么用，但确实兼顾了我家人的很多需求：副驾的门板还配有解锁开关，有的时候老婆开车，下车的时候偶尔会忘记解锁，我在副驾驶可以自己开门：第二排设计很好，不仅配置了一个很大的

    2021-06-01 09:30:48

  • iPhone12在618最新定價，跌價幅度超過1400元，還等iPhone13嗎？ iPhone12在618最新定價，跌價幅度超過1400元，還等iPhone13嗎？

    不仅是<em>安卓</em>手机，苹果手机的降价力度也是前所未有了，iPhone12也“跳水价”了，发布价是6799元，如今已经跌至5308元，降价幅度超过1400元，最新定价确认了。iPhone12是苹果首款5G手机，同时也是全球首款5nm芯片的智能机，它

    2021-06-01 09:30:45

IT145.com E-mail:sddin#qq.com