【转贴】ASP.NET Forums2.0学习-关于ForumContext

  转自：http://blog.csdn.net/danielhf

    在asp.net中, context 对应于 HttpContext 类, 它承载了所有当前请求的相关信息, 在 Http 管道当中, 可以任何时刻通过它获取如 Request, Response, Session, Cache 等有用的相关对象, 尤其在HttpHandler 和 HttpModule 当中, 在 Page 中, 我们也可以通过访问公共属性 Session, Request 等, 但实际上和通过 HttpContext 调用的效果是等同的.
 除此之外, HttpContext 还有一个索引器, 它返回一个 IDictionary 的字典对象, 意即键值对, 如果在请求被处理之初添加数据, 这个数据集合将可以在当前请求的整个处理过程中被所有对象共享, 包括 HttpHandler, HttpModule, Application等, 在请求结束后, 这个数据集合会随着 HttpContext 一起被丢弃,所以, 可在此加入一些特定于自己应用程序的数据.
       在这个论坛中有一个 ForumContext 类, 它属于 AspNetForums.Components 名字空间, 在原来的HttpContext 的基础之上, 它封装了一些和该应用相关的环境信息在里面, 包括字段和方法, 以使其可获取与特定论坛相关的任何信息, 看代码:

using System;
using System.Web;
using System.Collections;
using AspNetForums.Enumerations;

namespace AspNetForums.Components {

    public class ForumContext {

 // 当前论坛的所有信息, 初始化为负值以在代码中判断其是否合法.
        int forumID =       -1;
        int messageID =     -1;
        int forumGroupID =  -1;
        int postID =        -1;
        int threadID =      -1;
        int userID =        -1;
        string userName =   "";
        int pageIndex =     -1;
        int roleID =        -1;
        string queryText =  "";
        string returnUrl =  "";

        HttpContext context;
        DateTime requestStartTime = DateTime.Now;

 // 这个对象在原有 HttpContext 基础上进行了额外信息的封装.
        public ForumContext() {

            context = HttpContext.Current;

            if (context == null)
                return;

     // 从 query string 也即 URL 中获取所有论坛相关的参数, 填充字段.
            postID = GetIntFromQueryString(context, "PostID");
            forumID = GetIntFromQueryString(context, "ForumID");
            forumGroupID = GetIntFromQueryString(context, "ForumGroupID");
            userID = GetIntFromQueryString(context, "UserID");
            messageID = GetIntFromQueryString(context, "MessageID");
            pageIndex = GetIntFromQueryString(context, "PageIndex");
            roleID = GetIntFromQueryString(context, "RoleID");
            queryText = context.Request.QueryString["q"];
            returnUrl = context.Request.QueryString["returnUrl"];

        }
 
 // 如果为空就重新生一个, 否则从当前 Context 的items集合中取回 ForumContext 对象.
        public static ForumContext Current {
            get {
                if (HttpContext.Current == null)
                    return new ForumContext();

                return (ForumContext) HttpContext.Current.Items["ForumContext"];
                //这句话不解，难道Items可以存放ForumContext对象？？
            }
        }

 // 解析请求 URL 中的参数
        public static int GetIntFromQueryString(HttpContext context, string key) {
            int returnValue = -1;
            string queryStringValue;

           // 从请求中获取 key 对应的值
     queryStringValue = context.Request.QueryString[key];

     // 如果没有提供这个参数, 返回 -1, 即默认值.
            if (queryStringValue == null)
                return returnValue;

    // 找到了就试图将它转换为一个整数
            try {
  
  // 某种情况下字符串里有一个#号, 就把#号以前的字符转换成整数.
                if (queryStringValue.IndexOf("#") > 0)
                    queryStringValue = queryStringValue.Substring(0, queryStringValue.IndexOf("#"));
  
  // 否则直接转换
                returnValue = Convert.ToInt32(queryStringValue);
            }
            catch {}

            return returnValue;

        }
 
 // 重定向到一个显示错误消息的页面, 这个错误消息封装在相应的异常对象中,
 // GetSiteUrls 方法返回 SiteUrls 对象, 它拥有在 SiteUrls.xml 文档中的路径信息,
 // 将 ExceptionType 枚举对应的整数值作为参数传给 Msg/default.aspx 页面.
        public static void RedirectToMessage (HttpContext context, ForumException exception) {

            if ((exception.InnerException != null) && ( exception.InnerException is ForumException)) {
                ForumException inner = (ForumException) exception.InnerException;
            }
            context.Response.Redirect(Globals.GetSiteUrls().Message( exception.ExceptionType ), true);
        }

 // 从缓存中取出 ForumsTable 对应的那个哈希表, 用 forumID 来查找相应的 Forum 对象
        public Forum GetForumFromForumLookupTable(int forumID) {
            Forum f = (Forum) this.ForumLookupTable[forumID];
   
    // 如果找到, 直接返回
            if (f != null)
                return f;

     // 如果没找到且缓存中这个哈希表还在, 意即尚未过期,
     // 则清除缓存中的数据, 试图重新加载最新的
            if ( (f == null) && (context.Cache["ForumsTable"] != null) )
                context.Cache.Remove("ForumsTable");

            // 再试着找一次
     f = (Forum) ForumLookupTable[forumID];

           // 如果重新加载数据仍未找到, 那这个 ID 肯定是错的
     if (f == null) {
                throw new Exception("Forum ID is invalid");
            }

            return f;
        }
 
 // 返回一个哈希表, 这个表的键是 ForumID, 值为 Forum 对象
        public Hashtable ForumLookupTable {
 
    // 缓存中名为 ForumsTable 键就对应这个哈希表, 如果它已经过期, 则添加一个
    // GetForums 这个方法返回这个哈希表, 它被放进缓冲中, 对应 ForumsTable
    // 的键值, 生存期为 120 分钟, 无依赖项.
            get {

                if (HttpRuntime.Cache["ForumsTable"] == null)
                    HttpRuntime.Cache.Insert("ForumsTable", Forums.GetForums(this, 0, true, false), null, DateTime.Now.AddMinutes(120), TimeSpan.Zero);

                return (Hashtable) HttpRuntime.Cache["ForumsTable"];
            }

        }

        public static string GetApplicationName () {
            return GetApplicationName (HttpContext.Current);
        }
 
 // 得到一个字符串如 localhost/sample/test.aspx, 主机名+虚拟目录+页面名
        public static string GetApplicationName (HttpContext context) {
            if (context == null)
                return "";

            string hostName = context.Request.Url.Host;
            string applicationPath = context.Request.ApplicationPath;

            return hostName + applicationPath;
        }
 
 // 一个 Singleton 模式 返回一个 HttpContext 对象
        public HttpContext Context {
            get {
                if (context == null)
                    return new HttpContext(null);

                return context;
            }
        }

        public int MessageID { get { return messageID; } }
        public int ForumID { get { return forumID; } }
        public int ForumGroupID { get { return forumGroupID; } }
        public int PostID { get { return postID; } }
        public int ThreadID { get { return threadID; } }
        public int UserID { get { return userID; } }
        public string UserName { get { return userName; } set { userName = value; } }
        public int RoleID { get { return roleID; } }
        public string QueryText { get { return queryText; } }
        public string ReturnUrl { get { return returnUrl; } }
        public int PageIndex { get { return (pageIndex - 1); } }
        public DateTime RequestStartTime { get { return requestStartTime; } }
        public User User { get { return Users.GetUser(); } }
        public SiteStatistics Statistics { get { return SiteStatistics.LoadSiteStatistics(context, true, 3); }}
    }
}