Taurus.MVC 2.2.3.4 :WebAPI 實現許可權控制認證(及功能增強說明)

来源:https://www.cnblogs.com/cyq1162/archive/2018/02/27/8476427.html
-Advertisement-
Play Games

前兩天,當我還在老家收拾行旅,準備回廣州,為IT連的創業再戰365天時,有網友扣上問:Taurus.MVC中如何實現認證和許可權控制,最好能做個小例子。我一不小心回了句:等回廣州我再寫篇文章......然後,今天就來補文章了〜〜〜〜 ...


前言:

前兩天,當我還在老家收拾行旅,準備回廣州,為IT連的創業再戰365天時,

有網友扣上問:Taurus.MVC中如何實現認證和許可權控制,最好能做個小例子。

我一不小心回了句:等回廣州我再寫篇文章......

然後,今天就來補文章了〜〜〜〜

Taurus.MVC Nuget 更新:

寫文之前,又提前花了點時間,把Nuget的Package升級了一下,和源碼版本做了下同步。

通常源碼的版本都會比Nuget包的靠前一個小版本:

目前:Taurus.MVC 升級到:V2.2.3.4 (CYQ.Data 同步升級到:V5.7.8.3)

最近版本的更新內容:

V2.2.3.1(2017-05-15)
1:增加CheckFormat方法【支持參數為空或正則驗證】

V2.2.3.3(2017-06-16)
1:增加方法參數的支持(相容常規webapi的使用方法)
2:CYQ.Data同時升級到V5.7.7.4

V2.2.3.4(2017-07-05,2017-10-22)
1 :增強跨域支持
2:修正Query<T>(aaa,defaultValue)的預設取的取值順序問題。
3:增加EndInvode事件和BenginInvode的事件執行順序調整。
4:CYQ.Data同時升級到V5.7.8.3

Taurus.MVC 增強功能:相容常規WebAPI參數寫法

比如對於以下請求:

itlinks.cn/user?uid=666 
itlinks.cn/user/uid/666

常規獲取參數:

        public void Get()
        {
            int uid = Query<int>("uid");
        }

相容性寫法:

        public void Get(int uid)
        {
 
        }

同時,相容參數還可以很複雜,比如這種:

        public void GetData(List<AB> unList,string a,int? b,AB ab)
        {
            Write("your data A:" + unList[0].A+" your data B:" + unList[0].B, true);
        }

傳遞對應的Post的Json可能是這樣的(手打的,就省了雙引號了):

{ uiList:[{a:1,b:1} , {a:2,b:2}]  ,a:1 ,b:2 ,ab:{a:3,b:3}}

以IT連示例:WebAPI 解決方案:

先看:IT連的後端WebApi解決方案:

再說:解決方案的創建步驟:

1:新建空Web應用程式。

即上圖的:ITLinks.API ,WebAPI不需要界面,該應用程式用於存放各種Controller即可。

2:在項目的引用中用Nuget包管理引入Taurus.MVC。

Nuget包管理會自動在Web.Config中加入以下相關配置。

需要把:key=“Taurus.Controllers” 項的值:改成控制器存放的項目名稱(一般名稱和最終生成的dll同名)。

Taurus.MVC被引用後,僅包含兩個dll,Taurus.Core和CYQ.Data。

IT連的解決方案中,對這兩個dll使用了源碼項目(方便於作者本人做調試或擴展功能)。

3:項目中新建各種Controller(創建請求規則)。

以IT連中的黑名單功能為例,控制器應繼承自Taurus.Core.Controller:

(這裡要註意一下構造函數,將自身this傳遞給邏輯類的構造函數)

namespace ITLinks.API
{
    public class BlacklistController : Taurus.Core.Controller
    {
        BlacklistLogic blacklist;
        public BlacklistController()
        {
            blacklist = new BlacklistLogic(this);
        }
        /// <summary>
        /// 獲取黑名單
        /// </summary>
        [Token]
        public void GetList()
        {
            string result = blacklist.GetList();
            Write(result);
        }
        [Token]
        public void Set()
        {
            string result = blacklist.Set();
            Write(result);
        }
    }
}

因Web.Config中的路由類型配置為1,即路由方式為:

/控制器名稱/方法名/參數

即創建了以下兩個路徑請求:

/blacklist/getlist
/blacklist/set

理論上來說,在可以方法里寫業務代碼,並調用Write方法輸出json格式的字元串即完成了。

不過,實際項目中,需要清晰一些的規劃:

IT連的項目中,控制器被規劃用來定義路由及許可權等簡單設定(不包括具體的業務代碼)。

把業務代碼分離到ITLinks.Logic項目中處理了:

業務邏輯類繼承自:Taurus.Core.LogicBase(繼承後可復用Taurus.Core.Controller中的常用方法,如Query<T>(xxx)獲取參數)

如:IT連黑名單列表中的黑名單邏輯源碼示例:

(這裡要註意一下構造函數,定義繼承父類接收控制器參數的構造函數方法)

對於IT連的的業務邏輯:

一部分:獨立到解決方案ITLinks.CommonLogic中。

用於功能的復用(在ASP.NET Aries的管理後臺和此處的WebApi中復用同一份代碼)

一部分:獨立到解決方案ITlinks.Aop中。

用於一些第三方的消息處理。

這些,就不細講了~~~直接飄過!

OK,接下來,我們將重點聚焦在許可權安全認證這一塊:

Taurus.MVC WebAPI 許可權安全認證

寫此之前,又掃看了一下之前寫的關於Taurus.MVC的文章,發現一共才五篇,其中:

Taurus.MVC 2.0 開源發佈:WebAPI開發教程 ,步驟五:有簡單提到對於許可權控制這一塊的處理,只是不夠詳盡。

本文,就以 IT連 App的後端 WebAPI 的邏輯來給大伙做進一步細緻說明:

首先:對於繼承自Taurus.Core.Controller的控制器,都擁有以下幾個可重寫的方法:

    public class TestController : Taurus.Core.Controller
    {
        public override bool CheckToken() { }
        public override bool BeforeInvoke(string methodName) { }
        public override void EndInvoke(string methodName) { }
    }

以及三個許可權相關的特性[Token]、[HttpGet]、[HttpPost]:

    [Token]
    public class TestController : Taurus.Core.Controller
    {
        [HttpGet]
        public void Get()
        { }
        [HttpPost]
        public void Post()
        { }
    }

特性若放在類上,即對所有方法都生效!

整個的調用順序為:

1:調用CheckToken(如果方法標識[Token]屬性)【如果返回false則中止以下執行,可人工干預2:檢測Get或Post(如果方法標識[HttpGet]或[HttpPost]屬性)【如果返回false則中止以下執行,系統自動控制3:調用BeforeInvoke方法【如果返回false則中止以下執行,可人工干預4:調用我們定義的方法,如Get或Post方法。
5:調用EndInvoke方法。

接下來,再以IT連中的請求為例講述流程:

1:用戶首次打開IT連App時,獲取App的版本更新及配置信息:

此時不需許可權,一切正常定義,如:

    public class SysController : Controller
    {
        SysLogic sysLogic = null;
        public SysController()
        {
            sysLogic = new SysLogic(this);
        }
        /// <summary>
        /// 獲取配置信息
        /// </summary>
        public void GetConfig()
        {
            string msg = sysLogic.GetConfig();
            Write(msg);
        }

        /// <summary>
        /// App版本升級
        /// </summary>
        public void Update()
        {
            string msg = sysLogic.CheckAppVersion();
            Write(msg);
        }
    }

2:用戶登陸或註冊App:

登陸註冊也不需要許可權驗證,方法依舊如常。

    public class UserController : Controller
    {
        UserLogic user;
        public UserController()
        {
            user = new UserLogic(this);
        }
        public void Register()
        {
            string result = user.Register();
            Write(result);
        }
        public void Login()
        {
            string result = user.Login();
            Write(result);
        }

不過,在登陸或註冊成功後,需要創建一個Token返回給App客端存檔:

如何創建Token:

可以把用戶的基本固定又不重要的信息串在一起,然後加下密就可以了;

比如:(用戶ID+註冊時間+用戶名+有效日期)=》加密成:abfabcbcdxxabfabccdc

具體代碼可參考 ASP.NET Aries 框架中的 UserAuth.cs 中的 GetAuthToken 方法

3:用戶進入主界面,或再次打開App時:

由於用戶在註冊或登陸時,已經存檔了Token在客戶端,只要之後的請求,都帶上這個Token即可。

比如用戶獲取自身的完整信息,或提交用戶反饋是需要許可權的:

    public class FeedbackController : Controller
    {
        FeedbackLogic feedbackLogic = null;
        public FeedbackController()
        {
            feedbackLogic = new FeedbackLogic(this);
        }

        public override bool CheckToken()
        {
            string userid = UserAuth.UserID;//從用戶傳來的Token中解密獲取數據
            bool result = !string.IsNullOrEmpty(userid) && UserAuth.UserID.Length == 36 && UserAuth.RegTime.Length == 8;
            if (!result)
            {
                Write(LangConst.EC_10000, false);//返回Token驗證失敗
            }
            return result;
        }
        /// <summary>
        /// 用戶反饋建議
        /// </summary>
        /// <returns></returns>
        [Token]
        public void Set()
        {
            string result = feedbackLogic.Set();
            Write(result);
        }
    }

對於Set方法,需要基本的身份認證,加上了[Token]特性;

同時:需要在CheckToken方法寫代碼來檢測用戶帶過來的Token是否合法:

1:從請求數據或請求頭中獲取(Token字元串)

2:解密,較驗格式及是否過期。

3:根據解密的結果,來返回true或false。
具體代碼仍可參考 ASP.NET Aries 框架中的 UserAuth.cs 中UserID屬性是怎麼被反解出來的。

這樣,就完成了基本的許可權認證。

Taurus.MVC WebAPI 特殊的 DefaultController

鑒於檢測Token合法性的代碼是一樣的,業務控制器可能不少,因此需要有統一的地方:

Taurus.MVC定義了三個全局的方法,位於DefaultController中,當然這個控制器文件預設是不存在的,需要自己新建:

    public class DefaultController : Controller
    {
       
        public static bool CheckToken(IController controller, string methodName)
        {
            //將Token驗證合法性的代碼寫在這全局的地方,對所有的Controller都生效。

             string userid = UserAuth.UserID;
             bool result = !string.IsNullOrEmpty(userid) && UserAuth.UserID.Length == 36 && UserAuth.RegTime.Length == 8;
             if (!result)
             {
                    controller.Write(LangConst.EC_10000, false);
             }
             return result;


        }
        public static bool BeforeInvoke(IController controller, string methodName)
        {
            
        }
        public static void EndInvoke(IController controller, string methodName)
        {

        }

    }

DefaultController的全局方法的優先順序:

這三個static方法的優先順序,低於Controller自身同名的實例方法;

即如果某個Controller已經重寫了CheckToken實例方法,則全局的CheckToken不會被調 用,其它兩個方法亦同。

DefaultController是Taurus.MVC的特殊的控制器,其特殊在:

1:當尋找的控制器不存在時,都會定位到DefaultController中尋找,如果DefaultController也沒有,則拋出異常。

2:如果方法在DefaultController中找不到時,則會調用Default方法(Taurus.Core.Controller有預設Default方法,可被重寫)。

3:三個全局的統一方法,被命運安排在這裡。

總結:

你值的擁有!

接下來又得把線程切回去繼續寫IT連創業系列、以及IOS的Sagit.Framework開發框架系列了! 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 前言 在圖論中,除了在有向圖中的強連通分量,在無向圖中還有一類雙聯通分量 雙聯通分量一般是指 點雙連通分量 當然,還有一種叫做 邊雙連通分量 邊雙聯通分量 對於一個連通圖,如果任意兩點至少存在兩條“邊不重覆”的路徑,則說圖是點雙連通的,邊雙連通的極大子圖稱為邊雙連通分量。 邊雙聯通分量的計算方法比較 ...
  • 前言 在圖論中,除了在有向圖中的強連通分量,在無向圖中還有一類雙連通分量 雙連通分量一般是指 點雙連通分量 當然,還有一種叫做 邊雙連通分量 點雙連通分量 對於一個連通圖,如果任意兩點至少存在兩條“點不重覆”的路徑,則說圖是點雙連通的(即任意兩條邊都在一個簡單環中),點雙連通的極大子圖稱為點雙連通分 ...
  • 最近幾年一直從事地圖方面的工作,自主研發了WPF和Winform兩個版本瓦片地圖引擎。輕量級、不依賴第三庫。先上一張圖片展示一下吧! 產品包括服務端和客戶端兩部份: 1、服務端主要地圖圖層配製和空間計算等,支持mysql,oracle,sqlserver,arcsde和postgis,shp等數據。 ...
  • 解決方案: 1. 調整option中的grid.top值才能避免重疊;(可以設置定製,也可以定義了一個計算公式) 2. 文檔註明【特殊字元串 ''(空字元串)或者 '\n' (換行字元串)用於圖例的換行。】 轉載來源:http://blog.csdn.net/doleria/article/deta ...
  • select和from語句 註意:select和from可以不設置,預設情況下: select獲取映射表的所有欄位; from獲取實體映射表的表名;如果設置select則必須設置frorm,但是允許僅設置from而不設置select Where語句 設置參數 通過@數字設置參數,例如: 定義命名參數 ...
  • 前端HTML <!DOCTYPE html> {% load static %} {% get_static_prefix as getstatic %} <html lang="zh-CN"> <head> <meta charset="UTF-8"> <meta http-equiv="x-ua ...
  • 用WebService開發介面十分方便。但介面提供的數據不應是對所有人可見的,我們來利用SoapHeader寫一個簡單的身份驗證Demo 目錄 創建WebService項目(帶SoapHeader) 利用IIS發佈WebService 添加服務引用並利用SoapHeader驗證訪問介面的例子 一、創 ...
  • 1.創建excel方法 /// <summary> /// 創建Excel表格 /// </summary> /// <param name="dt">數據流</param> /// <param name="FileName">文件名稱</param> public static void Cre ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...