Taurus.MVC 2.2.3.4 ：WebAPI 實現許可權控制認證（及功能增強說明）
前言：
前兩天，當我還在老家收拾行旅，準備回廣州，為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,stringa,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的文章，發現一共才五篇，其中：
本文，就以 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。
這樣，就完成了基本的許可權認證。
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開發框架系列了！