淺談ASP.NET MVC中TempData的實(shí)現(xiàn)機(jī)制
本文將介紹的ASP.NET MVC中的TempData，希望通過(guò)這些分析能為大家了解ASP.NET MVC有所幫助。
今天我們討論的是MVC中一項(xiàng)重要的功能，在其它的一些MVC框架中也很常見(jiàn)它的身影，它就是TempData，下面我們一起來(lái)分析一下TempData的原理。
#t#
內(nèi)容概覽Top
本篇主要討論ASP.NET MVC中TempData是如何實(shí)現(xiàn)的，通過(guò)研讀MVC的源代碼你將清楚的了解MVC是如何實(shí)現(xiàn)TempData功能的。
TempData特性
TempDataDictionary與ITempDataProvider
TempDataDictionary的設(shè)計(jì)
SessionStateTempDataProvider與ITempDataProvider
TempData特性Top
TempData的特性就是可以在兩個(gè)Action之間傳遞數(shù)據(jù)，它會(huì)保存一份數(shù)據(jù)到下一個(gè)Action，并隨著再下一個(gè)Action的到來(lái)而失效。所以它被用在兩個(gè)Action之間來(lái)保存數(shù)據(jù)，比如，這樣一個(gè)場(chǎng)景，你的一個(gè)Action接受一些post的數(shù)據(jù)，然后交給另一個(gè)Action來(lái)處理，并顯示到頁(yè)面，這時(shí)就可以使用TempData來(lái)傳遞這份數(shù)據(jù)。
那到底TempData是怎樣完成這個(gè)功能的呢？下面我們從MVC的源代碼入手來(lái)解析TempData的機(jī)制。
TempDataDictionary與ITempDataProviderTop
首先來(lái)看看ITempDataProvider接口，從字面意思上看我們先把它翻譯為：暫時(shí)數(shù)據(jù)的提供者所遵從的規(guī)則，它約定了兩個(gè)方法：
- public interface ITempDataProvider {
- IDictionary LoadTempData(ControllerContext controllerContext);
- void SaveTempData(ControllerContext controllerContext, IDictionary values);
- }
這兩個(gè)方法是LoadTempData和SaveTempData，我們猜想這兩個(gè)方法是用來(lái)取得TempData容器和保存TempData數(shù)據(jù)的，因?yàn)長(zhǎng)oadTempData返回一個(gè)IDictionary類型，而SaveTempData沒(méi)有返回類型，而參數(shù)ControllerContext就是針對(duì)不同的用戶上下文來(lái)設(shè)計(jì)的，標(biāo)明是對(duì)那一個(gè)上下文的TempData進(jìn)行操作。的確是這樣的，后面會(huì)驗(yàn)證我們的猜想。
再來(lái)看看TempDataDictionary，我們對(duì)這個(gè)類的第一印象在哪里呢？是在ControllerBase類中的TempData屬性，在普通的Controller中我們打上tempdata，vs幫助我們完成的那個(gè)屬性其實(shí)就是ControllerBase類中的TempData。因此我們明白了，不管是在controller中，還是在view中，所有對(duì)TempData的操作都是對(duì)TempDataDictionary類型的操作。那ITempDataProvider有是怎么與TempDataDictionary聯(lián)系的呢？看一下TempDataDictionary的設(shè)計(jì)便一目了然。
TempDataDictionary的設(shè)計(jì)Top
public class TempDataDictionary : IDictionary<string, object>, ISerializable
這是TempDataDictionary的簽名，我們看到它繼承了一個(gè)IDictionary<string,object>的字典類型和一個(gè)ISerializable的接口。因此我們知道它是可以被序列化和反序列化的，該類有一個(gè)常字符串類型的字段和一個(gè)Dictionary<string,object>類型的字段：
- internal const string _tempDataSerializationKey = "__tempData";
- internal Dictionary<string, object> _data;
在它帶參的構(gòu)造函數(shù)中發(fā)現(xiàn)了對(duì)_tempDataSerializationKey的使用：
- protected TempDataDictionary(SerializationInfo info, StreamingContext context) {
- _initialKeys = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
- _modifiedKeys = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
- _data = info.GetValue(_tempDataSerializationKey, typeof(Dictionary<string, object>))
- as Dictionary<string, object>;
- }
我們可以看到這是用來(lái)從一個(gè)流中，反序列化得到一個(gè)Dictionary類型的過(guò)程。
另一點(diǎn)，在controller中，我們可以這樣使用TempData的：
- TempData["msg"] = new Object();
- Object obj = TempData["msg"] as object;
在了解它的索引器之前我們先看看它的幾個(gè)字段和方法，TempDataDictionary類重要的字段有三個(gè)：
- internal Dictionary<string, object> _data;
- private HashSet<string> _initialKeys;
- private HashSet<string> _modifiedKeys;
_data用來(lái)存放真正的數(shù)據(jù)，_initialKeys用來(lái)存放原先數(shù)據(jù)的key，_modifiedKeys用來(lái)存放修改過(guò)或新添加的數(shù)據(jù)key。為什么要這樣呢？回想一下TempData的特性，TempData只存放一次數(shù)據(jù)，到第三個(gè)Action時(shí)，第一個(gè)Action存放的數(shù)據(jù)就失效了，所以，_initialKeys被設(shè)計(jì)來(lái)存放那些數(shù)據(jù)是原來(lái)的，_modifiedKeys被設(shè)計(jì)來(lái)存放那些數(shù)據(jù)是修改過(guò)的或是新添加上的，這樣就區(qū)分了“舊”數(shù)據(jù)和“新”數(shù)據(jù)，那下一步就是把“舊”的刪除，把“新”的記錄了。
我們?cè)俚剿饕骺纯矗驗(yàn)槲覀儗?duì)TempData的操作是從索引器開(kāi)始的，下面是索引器的代碼：
- public object this[string key] {
- get {
- object value;
- if (TryGetValue(key, out value)) {
- return value;
- }
- return null;
- }
- set {
- _data[key] = value;
- _modifiedKeys.Add(key);
- }
- }
當(dāng)我們TempData["msg"]=new Object();時(shí)不僅向_data中添加了數(shù)據(jù)，同時(shí)_modifiedKeys也保存了“新”數(shù)據(jù)的key。那什么時(shí)候“新”數(shù)據(jù)被保存“舊”數(shù)據(jù)被刪除，真正的執(zhí)行呢？這個(gè)過(guò)程是在Load和Save方法中發(fā)生的。下面看它們的具體實(shí)現(xiàn)：
- public void Load(ControllerContext controllerContext, ITempDataProvider tempDataProvider) {
- IDictionary<string, object> providerDictionary = tempDataProvider.LoadTempData(
- controllerContext);
- _data = (providerDictionary != null) ? new Dictionary<string, object>(providerDictionary,
- StringComparer.OrdinalIgnoreCase) : new Dictionary<string, object>
- (StringComparer.OrdinalIgnoreCase);
- _initialKeys = new HashSet<string>(_data.Keys);
- _modifiedKeys.Clear();
- }
- public void Save(ControllerContext controllerContext, ITempDataProvider tempDataProvider) {
- if (_modifiedKeys.Count > 0) {
- // Apply change tracking.
- foreach (string x in _initialKeys) {
- if (!_modifiedKeys.Contains(x)) {
- _data.Remove(x);
- }
- }
- // Store the dictionary
- tempDataProvider.SaveTempData(controllerContext, _data);
- }
- }
我們看到TempDataDictionary的Load方法首先是調(diào)用了ITempDataProvider的LoadTempData方法來(lái)獲取tempdata容器，然后讓_initialKeys等于_data.Keys，相當(dāng)于保存了“舊”數(shù)據(jù)的key，然后清空_modifiedKeys，相當(dāng)于目前沒(méi)有“新”數(shù)據(jù)。而Save方法則是檢查_(kāi)modifiedKeys.Count是否大于0，就相當(dāng)于檢查是否有“新”數(shù)據(jù)，有則調(diào)用ITempDataProveder的SaveTempData方法保存掉“新”數(shù)據(jù)。這里也驗(yàn)證了我們先前的猜想是正確的。
說(shuō)到這里，我們似乎還沒(méi)有發(fā)現(xiàn)沒(méi)有一個(gè)地方調(diào)用TempDataDictionary的Load和Save方法，也就是說(shuō)“新”“舊”數(shù)據(jù)一直在都在_data中，似乎“舊”的數(shù)據(jù)沒(méi)有真正刪除，“新”數(shù)據(jù)也一直沒(méi)有一個(gè)安定的家。
我們說(shuō)對(duì)TempData中數(shù)據(jù)的“刷新”操作（刷新操作即把“舊”數(shù)據(jù)刪除，把“新”數(shù)據(jù)保存）應(yīng)該發(fā)生在執(zhí)行Action的時(shí)候，那在什么地方我們執(zhí)行了Action呢，是在IController的Execute方法中，IController<=ControllerBase<=Controller，順著這樣的繼承順序，我們找到Controller類的ExecuteCore方法，這里是執(zhí)行Action的地方，下面我們看看ExecuteCore方法的實(shí)現(xiàn)：
- protected override void ExecuteCore() {
- TempData.Load(ControllerContext, TempDataProvider);
- try {
- string actionName = RouteData.GetRequiredString("action");
- if (!ActionInvoker.InvokeAction(ControllerContext, actionName)) {
- HandleUnknownAction(actionName);
- }
- }
- finally {
- TempData.Save(ControllerContext, TempDataProvider);
- }
- }
我們看到在這里，Action執(zhí)行之前TempData.Load，Action執(zhí)行之后TempData.Save。這就實(shí)現(xiàn)了TempData的“刷新”操作。
SessionStateTempDataProvider與ITempDataProviderTop
到這里，我們發(fā)現(xiàn)似乎還不知道到底數(shù)據(jù)是怎么被保存的，我們只知道ITempDataProvider提供了一個(gè)保存數(shù)據(jù)和獲取容器的這么一個(gè)約定，那么具體的實(shí)現(xiàn)肯定是繼承了ITempDataProvider接口的類來(lái)做，SessionStateTempDataProvider就是這么一個(gè)類。
我們知道是在Controller類中的ExecuteCore方法中執(zhí)行了“刷新”操作，我們還知道TempDataDictionary的Load和Save方法需要一個(gè)ITempDataProvider的方法，那么我們可以推斷肯定要去Controller類中尋找ITempDataProvider的實(shí)現(xiàn)。如我們所料：
- public ITempDataProvider TempDataProvider {
- get {
- if (_tempDataProvider == null) {
- _tempDataProvider = new SessionStateTempDataProvider();
- }
- return _tempDataProvider;
- }
- set {
- _tempDataProvider = value;
- }
- }
這里使用了屬性注入，強(qiáng)硬的注入了一個(gè)SessionStateTempDataProvider對(duì)象。那么具體是怎樣實(shí)現(xiàn)存儲(chǔ)的就要去看一下SessionStateTempDataProvider類了。
SessionStateTempDataProvider有一個(gè)常字符串字段：
- internal const string TempDataSessionStateKey = "__ControllerTempData";
下面是LoadTempData方法：
- public virtual IDictionary LoadTempData(ControllerContext controllerContext) {
- HttpContextBase httpContext = controllerContext.HttpContext;
- if (httpContext.Session == null) {
- throw new InvalidOperationException(
- MVCResources.SessionStateTempDataProvider_SessionStateDisabled);
- }
- Dictionary<string, object> tempDataDictionary = httpContext.Session[TempDataSessionStateKey]
- as Dictionary<string, object>;
- if (tempDataDictionary != null) {
- // If we got it from Session, remove it so that no other request gets it
- httpContext.Session.Remove(TempDataSessionStateKey);
- return tempDataDictionary;
- }
- else {
- return new Dictionary<string, object>(StringComparer.OrdinalIgnoreCase);
- }
- }
上面的代碼很簡(jiǎn)單，原來(lái)它把Dictionary類型的數(shù)據(jù)存進(jìn)了Session["__ControllerTempData"]里，讀的時(shí)候也只是簡(jiǎn)單的類型轉(zhuǎn)換一下就返回了。
下面是SaveTempData方法：
- public virtual void SaveTempData(ControllerContext controllerContext, IDictionary values) {
- HttpContextBase httpContext = controllerContext.HttpContext;
- if (httpContext.Session == null) {
- throw new InvalidOperationException(
- MVCResources.SessionStateTempDataProvider_SessionStateDisabled);
- }
- httpContext.Session[TempDataSessionStateKey] = values;
- }
SaveTempData方法也很簡(jiǎn)單。
總結(jié)Top
ITempDataProvider只是一個(gè)提供臨時(shí)數(shù)據(jù)存取的一個(gè)約定的接口，它并不提供如何管理“新舊”數(shù)據(jù)，TempDataDictionary類才是真正管理“新舊”數(shù)據(jù)的管理者，但是這個(gè)“管理者”需要一個(gè)存取“新舊”數(shù)據(jù)的途徑，也就是說(shuō)它告訴ITempDataProvider該存什么該取什么，然后由ITempDataProvider真正的去執(zhí)行存取操作。在Controller執(zhí)行Action之前，這個(gè)“管理者”要取得上一次的“舊”數(shù)據(jù)，Action結(jié)束之后它還要把“新”數(shù)據(jù)給存起來(lái)。而Controller恰似這么一個(gè)“指揮者”，它把一個(gè)能做ITempDataProvider事情的類——SessionStateTempDataProvider交給TempDataProvider使用。下面用一個(gè)類圖概括一下幾個(gè)類的關(guān)系。
原文標(biāo)題：揭秘ASP.NET mvc TempData機(jī)制
鏈接：http://www.cnblogs.com/niuchenglei/archive/2009/12/19/1627988.html
