.net core中的哪些過濾器 （Authorization篇）

喜歡吃魚的青年發表於2020-11-18
過濾器

前言

我們們上篇說到，過濾的簡單介紹，但是未介紹如何使用，接下來幾篇，我來給大家講講如何使用，今天第一篇是Authorization。認證過濾器，

開發環境介紹

  • 開發工具:VS2019
  • 開發環境:.net core 3.1

1.建立專案


首先建立一個Api的專案,選擇.net core的版本，選擇好，點選建立即可

2 建立一個自定義類

public class AuthenticationTest: IAuthorizationFilter
{
   public void OnAuthorization(AuthorizationFilterContext context)
        {
             //邏輯處理
        } 
}

檢視IAuthorizationFilter原始碼

IAuthorizationFilter介面只有一個方法OnAuthorization，
建立一個類，繼承IAuthorizationFilter介面，然後實現一下介面方法。是不是有點疑問，AuthorizationFilterContext是什麼？

3 AuthorizationFilterContext是什麼？

中文理解:授權過濾器上下文
六大屬性:

  • ActionDescriptor:獲取或設定所選動作的ActionDescriptor。(獲取請求的Method)
  • Filters:獲取所有適用的IFilterMetadata實現。（可以檢測請求的Action是否具備AllowAnonymous，如果有，則直接跳過AuthorizationFilter濾器）
  • HttpContext：獲取或設定當前請求的HttpContext。（獲取當前請求的很多資訊，例如當前使用者資訊，當前請求的Heads[可以從Head獲取Token,即驗證Token]）
  • ModelState：獲取模型狀態字典。在你使用MVC框架下，對Molde進行驗證的時候才會使用到，去驗證模型是否驗證通過。
  • Result：獲取或設定請求的結果。將結果設定為null授權過濾器內的非值將使過濾器管道的其餘部分短路。
  • RouteData：獲取或設定當前請求的RouteData。（獲取當前路由的資訊）

4 編寫簡答的業務邏輯

    public class AuthenticationTest: IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
           Console.WriteLine("我是Authorization過濾器");
            //請求的地址
            var url = context.HttpContext.Request.Path.Value;
            #region 列印頭部資訊
            var heads = context.HttpContext.Request.Headers;
            string msg = string.Empty;

            foreach (var item in heads)
            {
                msg += item.Key + ":" + item.Value + "\r\n";
            }

            Console.WriteLine("我是heads：" + msg);
            #endregion
        }
    }

5 註冊全域性過濾器

找到Startup.cs檔案，然後找到其中一個方法ConfigureServices，將程式碼修改為這樣:

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();

            //全域性新增過濾器
            #region 全域性過濾器
            services.AddMvc(a => {
                a.Filters.Add<AuthenticationTest>();
            });
            #endregion
       }

6.啟動專案（這裡是使用Kestrel作為伺服器啟動，啟動的是控制檯程式）

啟動之後，會在控制檯列印如上圖所示，我們可以獲取當前請求的Head資訊。如果Head包含Token，我們也是可以獲取token，然後驗證token，後面可以進行一系列自己的邏輯運算。

7.1擴充套件IAsyncAuthorizationFilter

過濾器還存在一個非同步過濾器，它是繼承IAsyncAuthorizationFilter

    public class AsyncAuthentication : IAsyncAuthorizationFilter
    {
        public Task OnAuthorizationAsync(AuthorizationFilterContext context)
        {
            return Task.CompletedTask;
        }
    }

非同步確認請求授權的過濾器,和之前的IAuthorizationFilter區別，大家顯而易見，只是處理請求的方式不一樣，一個是同步，一個是非同步，如果瞭解執行緒，就應該瞭解二者的區別，在這隻做簡單介紹，編寫你自己業務邏輯，可以自由編寫。

7.2 擴充套件:修改401返回的返回值

正常的401報錯:

public class AuthenticationTest: IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
            context.Result = new StatusCodeResult(401);
        }
    }

效果如下圖:

這種並不是客戶想看到的，我們可以自定義返回值。

自定義的401報錯:

 public class AuthenticationTest: IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
            context.Result = new JsonResult(new { StatusCodeResult = StatusCodes.Status401Unauthorized, Title = "401", Time = DateTime.Now,test="測試" });
        }
    }

效果如下圖:

自定義設定返回的值，是沒有限制，可以根據場景進行自定義，合適才是最好。

8.總結：

通過上面的一頓操作，我們應該能明白，一個自定義的許可權過濾器的建立，註冊，使用等。這個過濾器讓我們能控制使用者的請求，哪些是請求是當前使用者可以匿名登入，哪些請求是當前使用者無權訪問的，在一方面，可以幫助我編寫自定義的許可權管理，還是那句話，合適才是重要的！

相關文章