TempData知多少

网上对TempData的总结为: 保存在session中,Controller每次执行请求时,会从session中一次获取所有tempdata数据,保存在单独的内部数据字典中,而后从session中清空tempdata。然后通过key从字典中获取指定的Tempdata,每访问一次后对应的Key就会从字典中删除,因此Tempdata数据最多只能经过一次controller传递,并且每个元素最多只能访问一次。

也许你不需要知道背后的原理,那下面这张图就能满你所需。

若好奇它背后是怎样实现,跟我查下源码一探究竟:

一、Controller是何时取TempData数据

看下Controller类的ExecuteCore方法

    /// <summary>执行请求</summary>
    protected override void ExecuteCore()
    {
      this.PossiblyLoadTempData();
      try
      {
        string actionName = Controller.GetActionName(this.RouteData);
        if (this.ActionInvoker.InvokeAction(this.ControllerContext, actionName))
          return;
        this.HandleUnknownAction(actionName);
      }
      finally
      {
        this.PossiblySaveTempData();
      }
    }

    internal void PossiblyLoadTempData()
    {
      if (this.ControllerContext.IsChildAction)
        return;
      this.TempData.Load(this.ControllerContext, this.TempDataProvider);
    }

    internal void PossiblySaveTempData()
    {
      if (this.ControllerContext.IsChildAction)
        return;
      this.TempData.Save(this.ControllerContext, this.TempDataProvider);
    }

从中可以看到在请求开始时就去取TempData,在Action调用结束后去保存TempData。
为什么要再去保存一遍呢?

二、TempDataProvider 临时数据存储方案

1、Controller类中,定义了TempDataProvider属性

    /// <summary>获取用于为下一个请求存储数据的临时数据提供程序对象。  </summary>
    /// <returns>临时数据提供程序。</returns>
    public ITempDataProvider TempDataProvider
    {
      get
      {
        if (this._tempDataProvider == null)
          this._tempDataProvider = this.CreateTempDataProvider();
        return this._tempDataProvider;
      }
      set
      {
        this._tempDataProvider = value;
      }
    }

    /// <summary>创建临时数据提供程序。</summary>
    /// <returns>临时数据提供程序。</returns>
    protected virtual ITempDataProvider CreateTempDataProvider()
    {
      ITempDataProviderFactory service = this.Resolver.GetService<ITempDataProviderFactory>();
      if (service != null)
        return service.CreateInstance();
      return this.Resolver.GetService<ITempDataProvider>() ?? (ITempDataProvider) new SessionStatesTempDataProvider();
    }

从代码中可知MVC中默认使用的是SessionStatesTempDataProvider来存储临时数据。

2、看一看SessionStatesTempDataProvider的实现

public class SessionStateTempDataProvider : ITempDataProvider
  {
    internal const string TempDataSessionStateKey = "__ControllerTempData";

    /// <summary>使用指定的控制器上下文来加载临时数据。</summary>
    /// <returns>临时数据。</returns>
    /// <param name="controllerContext">控制器上下文。</param>
    /// <exception cref="T:System.InvalidOperationException">检索会话上下文时出错。</exception>
    public virtual IDictionary<string, object> LoadTempData(ControllerContext controllerContext)
    {
      HttpSessionStateBase session = controllerContext.HttpContext.Session;
      if (session != null)
      {
        Dictionary<string, object> dictionary = session["__ControllerTempData"] as Dictionary<string, object>;
        if (dictionary != null)
        {
          session.Remove("__ControllerTempData");
          return (IDictionary<string, object>) dictionary;
        }
      }
      return (IDictionary<string, object>) new Dictionary<string, object>((IEqualityComparer<string>) StringComparer.OrdinalIgnoreCase);
    }

    /// <summary>使用指定的控制器上下文将指定的值保存在临时数据字典中。</summary>
    /// <param name="controllerContext">控制器上下文。</param>
    /// <param name="values">值。</param>
    /// <exception cref="T:System.InvalidOperationException">检索会话上下文时出错。</exception>
    public virtual void SaveTempData(ControllerContext controllerContext, IDictionary<string, object> values)
    {
      if (controllerContext == null)
        throw new ArgumentNullException("controllerContext");
      HttpSessionStateBase session = controllerContext.HttpContext.Session;
      bool flag = values != null && values.Count > 0;
      if (session == null)
      {
        if (flag)
          throw new InvalidOperationException(MvcResources.SessionStateTempDataProvider_SessionStateDisabled);
      }
      else if (flag)
      {
        session["__ControllerTempData"] = (object) values;
      }
      else
      {
        if (session["__ControllerTempData"] == null)
          return;
        session.Remove("__ControllerTempData");
      }
    }
  }

从图中可知,SessionStatesTempDataProvider暴露了LoadTempDataSaveTempData两个方法。
其中从SaveTempDatasession["__ControllerTempData"] = (object) values;可以看出,TempData是存储在Session中的。
其中LoadTempData方法中session.Remove("__ControllerTempData");就说明了从session中获取tempdata后,对应的tempdata就从session中清空了

原来每次取完TempData后都会从Session中清空,如果TempData未曾使用,那当然要重新保存到Session中啊。(回答了上个问题)

三、TempData 何许类也?

TempData是ControllerBase中定义的属性,TempData的类型为TempDataDictionary。
那就来看看这个类中定义的几个核心方法。

1、 定义了索引器

    /// <summary>获取或设置具有指定键的对象。</summary>
    /// <returns>具有指定键的对象。</returns>
    public object this[string key]
    {
      get
      {
        object obj;
        if (!this.TryGetValue(key, out obj))
          return (object) null;
        this._initialKeys.Remove(key);
        return obj;
      }
      set
      {
        this._data[key] = value;
        this._initialKeys.Add(key);
      }
    }

要注意这段代码this._initialKeys.Remove(key);

2、再来看看取出TempData的Load方法

    /// <summary>使用指定的数据提供程序加载指定的控制器上下文。</summary>
    /// <param name="controllerContext">控制器上下文。</param>
    /// <param name="tempDataProvider">临时数据提供程序。</param>
    public void Load(ControllerContext controllerContext, ITempDataProvider tempDataProvider)
    {
      IDictionary<string, object> dictionary = tempDataProvider.LoadTempData(controllerContext);
      this._data = dictionary != null ? new Dictionary<string, object>(dictionary, (IEqualityComparer<string>) StringComparer.OrdinalIgnoreCase) : new Dictionary<string, object>((IEqualityComparer<string>) StringComparer.OrdinalIgnoreCase);
      this._initialKeys = new HashSet<string>((IEnumerable<string>) this._data.Keys, (IEqualityComparer<string>) StringComparer.OrdinalIgnoreCase);
      this._retainedKeys.Clear();
    }

这个方法是从TempDataProvider中加载出的数据,将全部TempData保存在字典_data全局变量中,TempData的key全部保存在_initialKeys全局变量中。

3、TempData如何使用多次?

    /// <summary>将字典中的所有键都标记为需保留。</summary>
    public void Keep()
    {
      this._retainedKeys.Clear();
      this._retainedKeys.UnionWith((IEnumerable<string>) this._data.Keys);
    }

    /// <summary>将字典中的指定键标记为需保留。</summary>
    /// <param name="key">字典中要保留的键。</param>
    public void Keep(string key)
    {
      this._retainedKeys.Add(key);
    }

    /// <summary>返回包含与指定键关联的元素的对象,不将该键标记为需删除。</summary>
    /// <returns>包含与指定键关联的元素的对象。</returns>
    /// <param name="key">要返回的元素的键。</param>
    public object Peek(string key)
    {
      object obj;
      this._data.TryGetValue(key, out obj);
      return obj;
    }

从TempData中通过索引器取值后,可以通过Keep或Peek方法,将该临时数据保留不删除。

4、再来看看将数据保存到TempData的Save方法

    /// <summary>使用指定的数据提供程序保存指定的控制器上下文。</summary>
    /// <param name="controllerContext">控制器上下文。</param>
    /// <param name="tempDataProvider">临时数据提供程序。</param>
    public void Save(ControllerContext controllerContext, ITempDataProvider tempDataProvider)
    {
      this._data.RemoveFromDictionary<string, object, TempDataDictionary>((Func<KeyValuePair<string, object>, TempDataDictionary, bool>) ((entry, tempData) =>
      {
        string key = entry.Key;
        if (!tempData._initialKeys.Contains(key))
          return !tempData._retainedKeys.Contains(key);
        return false;
      }), this);
      tempDataProvider.SaveTempData(controllerContext, (IDictionary<string, object>) this._data);
    }

_data 是放Keys + Values
_initialKeys 是放Keys,取值后移除Key
_retainedKeys 是需要保留的Key
当我们根据key从索引器中读取临时数据时,该key从_initialKeys中移出。
Save方法首先遍历_data:
若_initialKeys不存在该key,说明已经取值使用。
若_retainedKeys中也不存在该key,说明取值使用后并未keep。

以上两个条件都成立时就从_data中移出该TempData。
未成立就说明临时数据没有使用,需重新保存到Session中。


总结

  1. Controller每次执行请求时,会从session中一次获取所有tempdata数据,保存在单独的内部数据字典中,而后从session中清空tempdata。
  2. 在需要的action中通过key从字典中获取指定的Tempdata,每访问一次后对应的Key就会从字典中删除。因此Tempdata数据最多只能经过一次controller传递,并且每个元素最多只能访问一次。
  3. Action执行完毕后数据字典中未使用的tempdata会重新保存到Session中,供下一个请求访问。
  4. 如果tempdata使用后还想供下一个请求使用,可以通过调用TempData.Keep()TempData.Keep("key")保留至下一次请求。
  5. 还可以通过TempData.Peek()读取,这种方式同样会保留至下一次请求。

啰嗦了半天,TempData你懂了吗?反正我是懂了。
还没懂,那就回头看看吧。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,598评论 18 139
  • //我所经历的大数据平台发展史(三):互联网时代 • 上篇http://www.infoq.com/cn/arti...
    葡萄喃喃呓语阅读 51,181评论 10 200
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,577评论 18 399
  • iOS网络架构讨论梳理整理中。。。 其实如果没有APIManager这一层是没法使用delegate的,毕竟多个单...
    yhtang阅读 5,164评论 1 23
  • 我的手机是诺基亚的5800,水货,10年9月在小北关街买的。在选的时候,我遵循着自己的第一感受,挑选的这个型...
    于三宝阅读 272评论 0 0