C#微信公眾號開發之用戶上下文WeixinContext和MessageContext

Posted on by

概述

由於微信公眾平臺的特殊機制，所有的信息都由微信服務器轉發而來，因此服務器是無法使用Session對用戶會話的上下文進行管理的。

為此Senparc.WeiXin.MP SDK增加瞭上下文的模塊，並集成到瞭MessageHandler中。

WeixinContext

WeixinContext是所有單個用戶上下文（MessageContext）實體的容器（暫且稱為全局上下文）。WeixinContext本身不是靜態類，意味著您可以在同一個應用中創建多個上下文實體。

同時，一個靜態的WeixinContext實例被放入到MessageHandler<TM>中，因此所有項目中由MessageHandler<TM>派生的子類中的WeixinContext是唯一的、全局的（註：TM為實現IMessageContext的類，包括SDK中已經提供的MessageContext）。

因此我們在任何一個實現瞭MessageHandler<TM>的實例中（比如叫MyMessageHandler），都可以訪問到一個類型和名稱都叫WeixinContext的對象。

WeixinContext用於保存所用戶的上下文（MessageContext），並且提供瞭一系列的方法，主要方法包括：

        /// <summary>
        /// 重置所有上下文參數，所有記錄將被清空
        /// </summary>
        public void Restore()
        {
            ...
        }

        /// <summary>
        /// 獲取MessageContext，如果不存在，返回null
        /// 這個方法的更重要意義在於操作TM隊列，及時移除過期信息，並將最新活動的對象移到尾部
        /// </summary>
        /// <param name="userName">用戶名（OpenId）</param>
        /// <returns></returns>
        private TM GetMessageContext(string userName)
        {
            ...
        }

        /// <summary>
        /// 獲取MessageContext
        /// </summary>
        /// <param name="userName">用戶名（OpenId）</param>
        /// <param name="createIfNotExists">True：如果用戶不存在，則創建一個實例，並返回這個最新的實例
        /// False：用戶儲存在，則返回null</param>
        /// <returns></returns>
        private TM GetMessageContext(string userName, bool createIfNotExists)
        {
            ...
        }


        /// <summary>
        /// 獲取MessageContext，如果不存在，使用requestMessage信息初始化一個，並返回原始實例
        /// </summary>
        /// <returns></returns>
        public TM GetMessageContext(IRequestMessageBase requestMessage)
        {
            ...
        }

        /// <summary>
        /// 獲取MessageContext，如果不存在，使用requestMessage信息初始化一個，並返回原始實例
        /// </summary>
        /// <returns></returns>
        public TM GetMessageContext(IResponseMessageBase responseMessage)
        {
            ...
        }

        /// <summary>
        /// 記錄請求信息
        /// </summary>
        /// <param name="requestMessage">請求信息</param>
        public void InsertMessage(IRequestMessageBase requestMessage)
        {
            ...
        }

        /// <summary>
        /// 記錄響應信息
        /// </summary>
        /// <param name="responseMessage">響應信息</param>
        public void InsertMessage(IResponseMessageBase responseMessage)
        {
            ...
        }

        /// <summary>
        /// 獲取最新一條請求數據，如果不存在，則返回Null
        /// </summary>
        /// <param name="userName">用戶名（OpenId）</param>
        /// <returns></returns>
        public IRequestMessageBase GetLastRequestMessage(string userName)
        {
            ...
        }

        /// <summary>
        /// 獲取最新一條響應數據，如果不存在，則返回Null
        /// </summary>
        /// <param name="userName">用戶名（OpenId）</param>
        /// <returns></returns>
        public IResponseMessageBase GetLastResponseMessage(string userName)
        {
            ...
        }

WeixinContext中有兩個用於儲存用戶上下文的對象：MessageCollection及MessageQueue。

這兩個對象中的元素集合是重合的，但是MessageQueue對元素進行瞭排序，以便及時處理掉頂部過期的上下文。

ExpireMinutes用於定義上下文時間有效期，默認為90分鐘。可以在程序的任何地方設置設個參數，且立即生效。

PS：MessageQueue中刪除過期數據的邏輯以極高的效率運作，開發時無需考慮CPU占用及對象沖突的問題（額外校驗時間是否超時）。

MessageContext

MessageContext用於保存單個用戶的上下文信息，被儲存在WeixinContext的MessageCollection及MessageQueue對象中。 IMessageContext定義如下：

    public interface IMessageContext
    {
        /// <summary>
        /// 用戶名（OpenID）
        /// </summary>
        string UserName { get; set; }
        /// <summary>
        /// 最後一次活動時間（用戶主動發送Resquest請求的時間）
        /// </summary>
        DateTime LastActiveTime { get; set; }
        /// <summary>
        /// 接收消息記錄
        /// </summary>
        List<IRequestMessageBase> RequestMessages { get; set; }
        /// <summary>
        /// 響應消息記錄
        /// </summary>
        List<IResponseMessageBase> ResponseMessages { get; set; }
        /// <summary>
        /// 臨時儲存數據，如用戶狀態等，出於保持.net 3.5版本，這裡暫不使用dynamic
        /// </summary>
        object StorageData { get; set; }
    }

您可以根據自己的需要創建自己的類，實現這個接口，並且被WeixinContext使用。當然如果你的要求不是那麼特殊，而且你比較懶的話，SDK提供瞭一個默認的MessageContext實現：

    /// <summary>
    /// 微信消息上下文（單個用戶）
    /// </summary>
    public class MessageContext : IMessageContext
    {
        public string UserName { get; set; }
        public DateTime LastActiveTime { get; set; }
        public List<IRequestMessageBase> RequestMessages { get; set; }
        public List<IResponseMessageBase> ResponseMessages { get; set; }

        public object StorageData { get; set; }

        public MessageContext()
        {
            /*
             * 註意：即使使用其他類實現IMessageContext，
             * 也務必在這裡進行下面的初始化，尤其是設置當前時間，
             * 這個時間關系到及時從緩存中移除過期的消息，節約內存使用
             */
            RequestMessages = new List<IRequestMessageBase>();
            ResponseMessages = new List<IResponseMessageBase>();
            LastActiveTime = DateTime.Now;
        }
    }

上面的代碼根據註釋很好理解，需要說明一下的是StorageData。這是一個用於儲存任何和用戶上下文有關數據的容器，WeixinContext和IMessageContext沒有對它進行任何引用，完全由開發者決定裡面的內容（比如用戶執行到哪一步、或某個比較重要的位置信息等等），類似於Session的作用。

到此這篇關於C#微信公眾號開發之用戶上下文的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

推薦閱讀：