C# Session 封裝最佳實踐：統一存取、預設值與安全清除指南

為什麼要封裝 Session 操作？

ASP.NET 原生 HttpContext.Current.Session 雖然方便，但直接在業務代碼中散落字串鍵值、型別轉換、空值判斷，極易導致拼寫錯誤、NullReferenceException 以及維護困難。建立一個靜態輔助類 CSession，集中管理鍵名常數、提供強型別存取、內建預設值與例外處理，能大幅提升代碼健壯性與可讀性。

核心功能實作

1. 多載 Get 方法：支援預設值與自動初始化

public static class CSession
{
    /// 
取得物件，不存在回傳 null
    public static object Get(string key) => HttpContext.Current.Session[key];

    /// 
取得字串，不存在回傳 String.Empty
    public static string GetString(string key)
    {
        object obj = HttpContext.Current.Session[key];
        return obj?.ToString() ?? string.Empty;
    }

    /// 
取得物件，不存在回傳指定預設值
    public static object Get(string key, object defaultValue)
        => HttpContext.Current.Session[key] ?? defaultValue;

    /// 
取得物件，不存在且允許新增時自動寫入預設值
    public static object Get(string key, object defaultValue, bool canAdd)
    {
        if (HttpContext.Current.Session[key] == null)
        {
            if (canAdd) HttpContext.Current.Session.Add(key, defaultValue);
            return defaultValue;
        }
        return HttpContext.Current.Session[key];
    }
}

2. 安全的 Set 方法：統一處理新增、更新、移除

同一個方法根據值是否為 null 與鍵是否存在，自動決定 Add、索引器賦值或 Remove，並包裝 try-catch 回傳布林結果。

public static bool Set(string key, object value)
{
    try
    {
        var session = HttpContext.Current.Session;
        if (value == null && session[key] != null)
        {
            session.Remove(key); // 值為 null 且鍵存在 → 刪除
        }
        else if (session[key] == null)
        {
            session.Add(key, value); // 鍵不存在 → 新增
        }
        else
        {
            session[key] = value; // 鍵存在 → 更新
        }
        return true;
    }
    catch (Exception ex)
    {
        // CMsgBox.Show(ex.Message); // 視專案日誌框架而定
        return false;
    }
}

Session 清除策略

進階建議

• 鍵名常數化：在專案中建立 SessionKeys 靜態類，集中定義所有鍵名字串，避免魔術字串散落。
• 泛型擴充方法：搭配 C# 擴充方法寫 Get<T>(this HttpSessionState, string)，進一步簡化型別轉換。
• 序列化考量：若使用 StateServer 或 SQLServer 模式，存入物件必須標記 [Serializable]。