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暴露了LoadTempData和SaveTempData两个方法。
其中从SaveTempData中session["__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中。

总结

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

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

posted @ 2017-01-20 08:30 「圣杰」阅读(3119) 评论(1) 编辑收藏举报

刷新页面返回顶部

『___知多少』

一名寻求机会努力破局的架构师

TempData知多少

一、Controller是何时取TempData数据

二、TempDataProvider 临时数据存储方案

三、TempData 何许类也？

总结

公告