[asp.net mvc 奇淫巧技] 01 - 封裝上下文 - 在View中獲取自定義的上下文

　　我們在asp.net 開發中已經封裝了最強大的HttpContext，我們可以在HttpContext中可以獲取到幾乎任何想獲取的東西，也可以在HttpContext寫入需要返回客戶端的信息。但是這些還遠遠不能滿足一些要求，比如在任何地方可以獲取到登錄用戶的信息等等。

　　之前獲取登錄用戶的信息基本上都是哪里用到就從session里獲取，這樣做的缺點很多就不一一說明了。

　　現在我們通過封裝一個WebWorkContext就可以隨用隨取，不用再次從session、數據庫或者緩存中獲取了。

 1、首先新建類WebWorkContext

　　為了演示方便就不建立多個項目了，WebWorkContext就直接建在Mvc的Model中了。

public class WebWorkContext
    {

        /// <summary>
        /// 判斷用戶是否登錄
        /// </summary>
        public bool IsLogin { get; set; }

        /// <summary>
        /// 用戶ID
        /// </summary>
        public int UserId { get; set; }

        /// <summary>
        /// 用戶名稱
        /// </summary>
        public string UserName { get; set; }

        /// <summary>
        /// 用戶郵箱
        /// </summary>
        public string UserEmail { get; set; }

        /// <summary>
        /// 是否是Get請求
        /// </summary>
        public bool IsGet { get; set; }


        /// <summary>
        /// 是否是Ajax請求
        /// </summary>
        public bool IsAjax { get; set; }


    }

 

 

2、在Controller中新建類BaseController，並繼承Controller

　　剛剛提出剛才的需求就會有很多人想到用繼承了，確實是用繼承，不過后面也許會有你想不到的好處。

 public class BaseController : Controller
    {
        /// <summary>
        /// 創建上下文Context
        /// </summary>
        protected WebWorkContext WorkContext = new WebWorkContext();

        /// <summary>
        /// 重寫Controller中的Initialize方法。在此方法中獲取用戶和其他的信息
        /// </summary>
        /// <param name="requestContext"></param>
        protected override void Initialize(RequestContext requestContext)
        {
            base.Initialize(requestContext);

            // 判斷用戶信息
            if (!string.IsNullOrEmpty(Convert.ToString(Session["USERID"])))
            {
                WorkContext.IsLogin = true;
                WorkContext.UserId = Convert.ToInt32(Session["USERID"]);
                WorkContext.UserName = Convert.ToString(Session["USERNAME"]);
                WorkContext.UserEmail = Convert.ToString(Session["USEREMAIL"]);
            }

            // 判斷是否是Get請求
            WorkContext.IsGet = requestContext.HttpContext.Request.HttpMethod == "GET";

            // 判斷是否是Ajax請求
            WorkContext.IsAjax = requestContext.HttpContext.Request.IsAjaxRequest();

        }

    }

 

3.1、在Controller中使用WebWorkContext

　　我們剛才所做的所有代碼都是為了方便使用一些封裝的信息，在Controller中使用WebWorkContext是最簡單的一種使用方式，只要Controller繼承新建的BaseController就可使用WebWorkContext中的任何東西。

 public class HomeController : BaseController  2     {
        public ActionResult Index()
        {
            var userId = WorkContext.UserId; 
            var userName = WorkContext.UserName; 
            return View();
        }
    }
}

 3.2、在View(cshtml)中使用WebWorkContext

　　重點來了，之前的幾步對於有一點工作經驗的都可以很簡單的完成，但是在View中使用自定義的類有很多童鞋還是不明白其中的道理。

　　第一首先要明白我們可以在View中使用比如Html/Ajax/Model之類的東西，是因為我們的頁面都繼承了一個類WebViewPage。

　　明白這個道理以后就很簡單了，我們只要讓我們的View繼承我們自定義的一個類，然后讓我們自定義的類繼承WebViewPage即可，然后我們就可以在我們自定義的類中做你想做的任何事了。

　　還要明白一個很重要的知識點，就是在哪更改View繼承類，當然微軟已經為我們擴展做好了，在每個Views文件夾下都有個web.config，找到pageBaseType，更改值為我們自定義類的即可。

 3.2.1、新建自定義WebViewPage類(WebWorkContextWebViewPage)

 public abstract class WebWorkContextWebViewPage<TModel> : System.Web.Mvc.WebViewPage<TModel>
    {
        public WebWorkContext WorkContext; 
        public sealed override void InitHelpers()
        {
            base.InitHelpers();
            BaseController baseController = ((this.ViewContext.Controller) as BaseController);
            if (baseController != null)
            {
                WorkContext = baseController.WorkContext; 
            }

        }
    } 

 3.2.2、更改View的繼承，在Views文件夾中的web.config中找到pageBaseType，值更改為我們自定義的類就行了。

 <system.web.webPages.razor>
    <host factoryType="System.Web.Mvc.MvcWebRazorHostFactory, System.Web.Mvc, Version=5.2.3.0, Culture=neutral, PublicKeyToken=31BF3856AD364E35" />
    <pages pageBaseType="WebWorkContextDemo.WebWorkContextWebViewPage">
    </pages>
  </system.web.webPages.razor>

 3.2.3、最后一步就是使用了，這個更簡單了直接調用即可。

　　這里需要注意的是，我們觀察代碼就知道，View中的WebWorkContext其實是獲取BaseController中的，所以使用WebWorkContext的View所對應的Controller必須繼承BaseController。

@{
    ViewBag.Title = "Home Page";
}

用戶的郵箱是： @WorkContext.UserEmail<br />
用戶名是： @WorkContext.UserName<br />

@{ 
    var id = WorkContext.UserId;
}

 

4、【擴展】，在BLL和DAL中使用WebWorkContext

　　在Asp.net MVC中使用WebWorkContext已經結束了，但是有很多的時候在需要在其他的層也需要把一些重要的信息沉淀下去，當然最簡單的就是每次調用方法把需要的值通過方法參數傳遞至BLL和DAL。當然這樣不是最優的解決方案，如果一個類中的很多方法都需要一個參數，我們肯定不會每次都通過方法傳遞的，我們會通過設置屬性，或者通過一個方法設置值，然后在調用我們需要的方法。

　　這樣說就簡單了，我們可以在Action每次調用BLL方法之前先設置我們的WebWorkContext就可以了。

 public class HomeController : BaseController
    {

        UserBLL bll = new UserBLL();

        /// <summary>
        /// 重寫Initialize，給BLL設置WebWorkContext
        /// </summary>
        /// <param name="requestContext"></param>
        protected override void Initialize(RequestContext requestContext)
        {
            base.Initialize(requestContext);
     　　　　bll.WorkContext = WorkContext; 14         }
 }

　　這樣我們就可以在BLL中任意的使用WebWorkContext了。

　　同樣的道理也可以設置DAL中的WebWorkContext。

 BLL：

 public class UserBLL : BaseBLL
    {
        UserDAL dal = new UserDAL();

        public override WebWorkContext WorkContext
        {
            get
            {
                return base.WorkContext;
            }

            set
            {
                base.WorkContext = value;
                dal.WorkContext = value;
            }
        }
         
        public string GetBLLUserAge()
        {
            return WorkContext.UserId.ToString();
        } 
    }

DAL：

 public class UserDAL : BaseDAL
    {
        public string GetUserAge()
        {
            return WorkContext.UserId.ToString();
        }
    }

在BaseBLL和BaseDAL中都只有一段代碼，設置可以重寫的WebWorkContext。

   public virtual WebWorkContext WorkContext { get; set; }

 

總結：這樣我們就可以幾乎在整個解決方案中使用WebWorkContext了，這樣每次使用的時候直接用就可以，不需要再次判斷獲取。

 

源碼Github：https://github.com/Emrys5/Asp.MVC-01-WebWorkContext

 

系列課程

• [asp.net mvc 奇淫巧技] 01 - 封裝上下文 - 在View中獲取自定義的上下文
• [asp.net mvc 奇淫巧技] 02 - 巧用Razor引擎在Action內生成Html代碼
• [asp.net mvc 奇淫巧技] 03 - 枚舉特性擴展解決枚舉命名問題和支持HtmlHelper
• [asp.net mvc 奇淫巧技] 04 - 你真的會用Action的模型綁定嗎？
• [asp.net mvc 奇淫巧技] 05 - 擴展ScriptBundle，支持混淆加密javascript
• [asp.net mvc 奇淫巧技] 06 - 也許你的項目同一個用戶的請求都是同步的