C#操作Cookie封裝類CookieHelper

lpkde 9年前發布 | 3K 次閱讀 C#

    using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Web;
using System.Collections.Specialized;

namespace Utility.Helper  
{  
    /// <summary>  
    /// Cookie操作類  
    /// </summary>  
    public static class CookieHelper  
    {  
        /// <summary>  
        /// 創建COOKIE對象并賦Value值,修改COOKIE的Value值也用此方法,因為對COOKIE修改必須重新設Expires  
        /// </summary>  
        /// <param name="strCookieName">COOKIE對象名</param>  
        /// <param name="strValue">COOKIE對象Value值</param>  
        public static void SetObj(string strCookieName, string strValue)  
        {  
            SetObj(strCookieName, 1, strValue, "", "/");  
        }  
        /// <summary>  
        /// 創建COOKIE對象并賦Value值,修改COOKIE的Value值也用此方法,因為對COOKIE修改必須重新設Expires  
        /// </summary>  
        /// <param name="strCookieName">COOKIE對象名</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365),</param>  
        /// <param name="strValue">COOKIE對象Value值</param>  
        public static void SetObj(string strCookieName, int iExpires, string strValue)  
        {  
            SetObj(strCookieName, iExpires, strValue, "", "/");  
        }  
        /// <summary>  
        /// 創建COOKIE對象并賦Value值,修改COOKIE的Value值也用此方法,因為對COOKIE修改必須重新設Expires  
        /// </summary>  
        /// <param name="strCookieName">COOKIE對象名</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365),</param>  
        /// <param name="strValue">COOKIE對象Value值</param>  
        /// <param name="strDomains">作用域,多個域名用;隔開</param>  
        public static void SetObj(string strCookieName, int iExpires, string strValue, string strDomains)  
        {  
            SetObj(strCookieName, iExpires, strValue, strDomains, "/");  
        }  
        /// <summary>  
        /// 創建COOKIE對象并賦Value值,修改COOKIE的Value值也用此方法,因為對COOKIE修改必須重新設Expires  
        /// </summary>  
        /// <param name="strCookieName">COOKIE對象名</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365),</param>  
        /// <param name="strValue">COOKIE對象Value值</param>  
        /// <param name="strDomains">作用域,多個域名用;隔開</param>  
        /// <param name="strPath">作用路徑</param>  
        public static void SetObj(string strCookieName, int iExpires, string strValue, string strDomains, string strPath)  
        {  
            string _strDomain = SelectDomain(strDomains);  
            HttpCookie objCookie = new HttpCookie(strCookieName.Trim());  
            objCookie.Value = HttpUtility.UrlEncode(strValue.Trim());  
            if (_strDomain.Length > 0)  
                objCookie.Domain = _strDomain;  
            if (iExpires > 0)  
            {  
                if (iExpires == 1)  
                    objCookie.Expires = DateTime.MaxValue;  
                else  
                    objCookie.Expires = DateTime.Now.AddSeconds(iExpires);  
            }  
            HttpContext.Current.Response.Cookies.Add(objCookie);  
        }  
        /// <summary>  
        /// 創建COOKIE對象并賦多個KEY鍵值  
        /// 設鍵/值如下:  
        /// NameValueCollection myCol = new NameValueCollection();  
        /// myCol.Add("red", "rojo");  
        /// myCol.Add("green", "verde");  
        /// myCol.Add("blue", "azul");  
        /// myCol.Add("red", "rouge");   結果“red:rojo,rouge;green:verde;blue:azul”  
        /// </summary>  
        /// <param name="strCookieName">COOKIE對象名</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365),</param>  
        /// <param name="KeyValue">鍵/值對集合</param>  
        public static void SetObj(string strCookieName, int iExpires, NameValueCollection KeyValue)  
        {  
            SetObj(strCookieName, iExpires, KeyValue, "", "/");  
        }  
        public static void SetObj(string strCookieName, int iExpires, NameValueCollection KeyValue, string strDomains)  
        {  
            SetObj(strCookieName, iExpires, KeyValue, strDomains, "/");  
        }  
        /// <summary>  
        /// 創建COOKIE對象并賦多個KEY鍵值  
        /// 設鍵/值如下:  
        /// NameValueCollection myCol = new NameValueCollection();  
        /// myCol.Add("red", "rojo");  
        /// myCol.Add("green", "verde");  
        /// myCol.Add("blue", "azul");  
        /// myCol.Add("red", "rouge");   結果“red:rojo,rouge;green:verde;blue:azul”  
        /// </summary>  
        /// <param name="strCookieName">COOKIE對象名</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365),</param>  
        /// <param name="KeyValue">鍵/值對集合</param>  
        /// <param name="strDomains">作用域,多個域名用;隔開</param>  
        /// <param name="strPath">作用路徑</param>  
        public static void SetObj(string strCookieName, int iExpires, NameValueCollection KeyValue, string strDomains, string strPath)  
        {  
            string _strDomain = SelectDomain(strDomains);  
            HttpCookie objCookie = new HttpCookie(strCookieName.Trim());  
            foreach (String key in KeyValue.AllKeys)  
            {  
                objCookie[key] = HttpUtility.UrlEncode(KeyValue[key].Trim());  
            }  
            if (_strDomain.Length > 0)  
                objCookie.Domain = _strDomain;  
            objCookie.Path = strPath.Trim();  
            if (iExpires > 0)  
            {  
                if (iExpires == 1)  
                    objCookie.Expires = DateTime.MaxValue;  
                else  
                    objCookie.Expires = DateTime.Now.AddSeconds(iExpires);  
            }  
            HttpContext.Current.Response.Cookies.Add(objCookie);  
        }  
        /// <summary>  
        /// 讀取Cookie某個對象的Value值,返回Value值,如果對象本就不存在,則返回字符串null  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <returns>Value值,如果對象本就不存在,則返回字符串null</returns>  
        public static string GetValue(string strCookieName)  
        {  
            if (HttpContext.Current.Request.Cookies[strCookieName] == null)  
            {  
                return null;  
            }  
            else  
            {  
                string _value = HttpContext.Current.Request.Cookies[strCookieName].Value;  
                return HttpUtility.UrlDecode(_value);  
            }  
        }  
        /// <summary>  
        /// 讀取Cookie某個對象的某個Key鍵的鍵值,返回Key鍵值,如果對象本就不存在,則返回字符串null,如果Key鍵不存在,則返回字符串"KeyNonexistence"  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strKeyName">Key鍵名</param>  
        /// <returns>Key鍵值,如果對象本就不存在,則返回字符串null,如果Key鍵不存在,則返回字符串"KeyNonexistence"</returns>  
        public static string GetValue(string strCookieName, string strKeyName)  
        {  
            if (HttpContext.Current.Request.Cookies[strCookieName] == null)  
            {  
                return null;  
            }  
            else  
            {  
                string strObjValue = HttpContext.Current.Request.Cookies[strCookieName].Value;  
                string strKeyName2 = strKeyName + "=";  
                //if (strObjValue.IndexOf(strKeyName2) == -1)  
                if (!strObjValue.Contains(strKeyName2))  
                    return null;  
                else  
                {  
                    string _value = HttpContext.Current.Request.Cookies[strCookieName][strKeyName];  
                    return HttpUtility.UrlDecode(_value);  
                }  
            }  
        }  
        /// <summary>  
        /// 修改某個COOKIE對象某個Key鍵的鍵值 或 給某個COOKIE對象添加Key鍵 都調用本方法,操作成功返回字符串"success",如果對象本就不存在,則返回字符串null。  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strKeyName">Key鍵名</param>  
        /// <param name="KeyValue">Key鍵值</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365)。注意:雖是修改功能,實則重建覆蓋,所以時間也要重設,因為沒辦法獲得舊的有效期</param>  
        /// <returns>如果對象本就不存在,則返回字符串null,如果操作成功返回字符串"success"。</returns>  
        public static string Edit(string strCookieName, string strKeyName, string KeyValue, int iExpires)  
        {  
            return Edit(strCookieName, strKeyName, KeyValue, iExpires, "", "/");  
        }  
        /// <summary>  
        /// 修改某個COOKIE對象某個Key鍵的鍵值 或 給某個COOKIE對象添加Key鍵 都調用本方法,操作成功返回字符串"success",如果對象本就不存在,則返回字符串null。  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strKeyName">Key鍵名</param>  
        /// <param name="KeyValue">Key鍵值</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365)。注意:雖是修改功能,實則重建覆蓋,所以時間也要重設,因為沒辦法獲得舊的有效期</param>  
        /// <param name="strPath">作用路徑</param>  
        /// <returns>如果對象本就不存在,則返回字符串null,如果操作成功返回字符串"success"。</returns>  
        public static string Edit(string strCookieName, string strKeyName, string KeyValue, int iExpires, string strPath)  
        {  
            return Edit(strCookieName, strKeyName, KeyValue, iExpires, "", strPath);  
        }  
        /// <summary>  
        /// 修改某個COOKIE對象某個Key鍵的鍵值 或 給某個COOKIE對象添加Key鍵 都調用本方法,操作成功返回字符串"success",如果對象本就不存在,則返回字符串null。  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strKeyName">Key鍵名</param>  
        /// <param name="KeyValue">Key鍵值</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365)。注意:雖是修改功能,實則重建覆蓋,所以時間也要重設,因為沒辦法獲得舊的有效期</param>  
        /// <param name="strDomains">作用域,多個域名用;隔開</param>  
        /// <param name="strPath">作用路徑</param>  
        /// <returns>如果對象本就不存在,則返回字符串null,如果操作成功返回字符串"success"。</returns>  
        public static string Edit(string strCookieName, string strKeyName, string KeyValue, int iExpires, string strDomains, string strPath)  
        {  
            if (HttpContext.Current.Request.Cookies[strCookieName] == null)  
                return null;  
            else  
            {  
                HttpCookie objCookie = HttpContext.Current.Request.Cookies[strCookieName];  
                objCookie[strKeyName] = HttpUtility.UrlEncode(KeyValue.Trim());  
                if (iExpires > 0)  
                {  
                    if (iExpires == 1)  
                        objCookie.Expires = DateTime.MaxValue;  
                    else  
                        objCookie.Expires = DateTime.Now.AddSeconds(iExpires);  
                }  
                HttpContext.Current.Response.Cookies.Add(objCookie);  
                return "success";  
            }  
        }  
        /// <summary>  
        /// 刪除COOKIE對象  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        public static void Del(string strCookieName)  
        {  
            Del(strCookieName, "", "/");  
        }  
        /// <summary>  
        /// 刪除COOKIE對象  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strDomains">作用域,多個域名用;隔開</param>  
        public static void Del(string strCookieName, string strDomains)  
        {  
            Del(strCookieName, strDomains, "/");  
        }  
        /// <summary>  
        /// 刪除COOKIE對象  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strDomains">作用域,多個域名用;隔開</param>  
        /// <param name="strPath">作用路徑</param>  
        public static void Del(string strCookieName, string strDomains, string strPath)  
        {  
            string _strDomain = SelectDomain(strDomains);  
            HttpCookie objCookie = new HttpCookie(strCookieName.Trim());  
            if (_strDomain.Length > 0)  
                objCookie.Domain = _strDomain;  
            objCookie.Path = strPath.Trim();  
            objCookie.Expires = DateTime.Now.AddYears(-1);  
            HttpContext.Current.Response.Cookies.Add(objCookie);  
        }  
        /// <summary>  
        /// 刪除某個COOKIE對象某個Key子鍵,操作成功返回字符串"success",如果對象本就不存在,則返回字符串null  
        /// </summary>  
        /// <param name="strCookieName">Cookie對象名稱</param>  
        /// <param name="strKeyName">Key鍵名</param>  
        /// <param name="iExpires">COOKIE對象有效時間(秒數),1表示永久有效,0和負數都表示不設有效時間,大于等于2表示具體有效秒數,31536000秒=1年=(60*60*24*365)。注意:雖是修改功能,實則重建覆蓋,所以時間也要重設,因為沒辦法獲得舊的有效期</param>  
        /// <returns>如果對象本就不存在,則返回字符串null,如果操作成功返回字符串"success"。</returns>  
        public static string DelKey(string strCookieName, string strKeyName, int iExpires)  
        {  
            if (HttpContext.Current.Request.Cookies[strCookieName] == null)  
            {  
                return null;  
            }  
            else  
            {  
                HttpCookie objCookie = HttpContext.Current.Request.Cookies[strCookieName];  
                objCookie.Values.Remove(strKeyName);  
                if (iExpires > 0)  
                {  
                    if (iExpires == 1)  
                        objCookie.Expires = DateTime.MaxValue;  
                    else  
                        objCookie.Expires = DateTime.Now.AddSeconds(iExpires);  
                }  
                HttpContext.Current.Response.Cookies.Add(objCookie);  
                return "success";  
            }  
        }  
        /// <summary>  
        /// 定位到正確的域  
        /// </summary>  
        /// <param name="strDomains"></param>  
        /// <returns></returns>  
        private static string SelectDomain(string strDomains)  
        {  
            bool _isLocalServer = false;  
            if (strDomains.Trim().Length == 0)  
                return "";  
            string _thisDomain = HttpContext.Current.Request.ServerVariables["SERVER_NAME"].ToString();  
            //if (_thisDomain.IndexOf(".") < 0)//說明是計算機名,而不是域名  
            if (!_thisDomain.Contains("."))  
                _isLocalServer = true;  
            string _strDomain = "www.abc.com";//這個域名是瞎扯  
            string[] _strDomains = strDomains.Split(';');  
            for (int i = 0; i < _strDomains.Length; i++)  
            {  
                //if (_thisDomain.IndexOf(_strDomains[i].Trim()) < 0)//判斷當前域名是否在作用域內  
                if (!_thisDomain.Contains(_strDomains[i].Trim()))  
                    continue;  
                else  
                {  
                    //區分真實域名(或IP)與計算機名  
                    if (_isLocalServer)  
                        _strDomain = "";//作用域留空,否則Cookie不能寫入  
                    else  
                        _strDomain = _strDomains[i].Trim();  
                    break;  
                }  
            }  
            return _strDomain;  
        }  
    }  
}  </pre> 


 本文由用戶 lpkde 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!