MVC過濾器：自定義操做過濾器

時間  2019-11-06
標籤 mvc 過濾器 自定義 简体版
原文   原文鏈接

1、操做過濾器

一、定義

操做過濾器用於實現IActionFilter接口以及包裝操做方法執行。IActionFilter接口聲明兩個方法：OnActionExecuting和OnActionExecuted。OnActionExecuting在操做方法以前運行。OnActionExecuted在操做方法以後運行，能夠執行其餘處理，如向操做方法提供額外數據、檢查返回值或取消執行操做方法。html

查看ActionFilterAttribute類的定義：git

#region 程序集 System.Web.Mvc, Version=5.2.7.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35
// D:\Practice\MVC\自定義操做過濾器\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 類的新實例。
        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個方法執行的順序了：github

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

二、案例

2.一、建立自定義操做過濾器

新建一個自定義過濾器，而後從新裏面的方法，代碼以下：瀏覽器

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.二、新建控制器

建立一個控制器，用來測試自定義操做過濾器，代碼以下：框架

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方法對應的視圖代碼以下：ide

@{
    Layout = null;
}

<!DOCTYPE html>

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

 運行結果;測試

2、結果過濾器

一、定義

結果篩選器用於實現IResultFilter接口以及包裝ActionResult對象的執行。IResultFilter接口聲明兩個方法OnResultExecuting和OnResultExecuted。OnResultExecuting在執行ActionResult對象以前運行。OnResultExecuted在結果以後運行，能夠對結果執行其餘處理，如修改 HTTP 響應。this

結果過濾器也是實現了ActionFilterAttribute類。spa

二、案例

修改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);
        }
    }
}

 運行結果：

3、案例

一、記錄操做

在真實項目中，能夠利用操做過濾器記錄哪一個用戶登陸系統之後進行了哪些操做。

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.二、建立日誌類

建立日誌幫助類，代碼以下：

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.三、修改操做過濾器類

修改後的操做過濾器類代碼以下：

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);
        }
    }
}

運行程序，查看生成的日誌：

 

二、實現權限控制功能

能夠重寫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爲二、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"},
                // 角色二、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代碼地址：git@github.com:JiangXiaoLiang1988/MVCCustomerActionFilterDemo.git

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程