天天看點

ASP.NET SignalR2持久連接配接層解析

    越是到年底越是感覺渾身無力,看着啥也不想動,隻期盼着年終獎的到來以此來給自己打一針強心劑。估摸着大多數人都跟我一樣犯着這樣渾身無力的病,感覺今年算是沒掙到啥錢,但是話也不能這麼說,搞得好像去年掙到錢了似的。不過該做的事情還是得到,因為畢竟自己拿着工資,拿一天錢就得幹一天活,無論自己覺得工資給的多還是少,覺得少可以辭職不幹,拿着工資就證明自己願意接受,既然願意接受,那就沒有理由不努力去幹活,我覺得這是作為一個員工最起碼的信念。

    隔着有一段時間沒寫部落格了,反正最近各種亂七八糟的事都在發生,不過不管怎麼樣,事情總會慢慢過去。(最近沒事,正在研究神學,待有所感悟再與大家分享。)

    這一篇部落客要介紹一下ASP.NET SignalR持久連接配接層的相關内容,如有寫的不到位和錯誤的地方,還望大家多多指正。

一.ASP.NET SignalR概述:

    談到ASP.NET SignalR大多數人應該會比較的熟悉,因在我們的mvc項目中,使用到ASP.NET SignalR的地方還是比較多的。

    ASP.NET SignalR是ASP.NET開發人員的庫,它簡化了向應用程式添加實時Web功能的過程。實時網絡功能能夠讓伺服器代碼在連接配接的用戶端可用時立即将内容推送到連接配接的用戶端,而不是讓伺服器等待用戶端請求新資料。SignalR可用于向ASP.NET應用程式添加任何類型的“實時”Web功能。任何時候使用者重新整理網頁,看看新的資料或頁面實作長輪詢來擷取新的資料,它是使用SignalR的候選人。示例包括儀表闆和監視應用程式,協作應用程式(如同時編輯文檔),作業進度更新和實時表單。

   SignalR還支援需要來自伺服器的高頻更新的全新類型的web應用。SignalR自動處理連接配接管理,并允許您同時向所有連接配接的用戶端廣播消息。SignalR支援“伺服器推送”功能,其中伺服器代碼可以使用遠端過程調用(RPC)在浏覽器中調用用戶端代碼。SignalR的應用可以擴充到使用服務總線。

   SignalR提供了一個用于建立從伺服器端.NET代碼調用用戶端浏覽器(和其他用戶端平台)中的JavaScript函數的伺服器到用戶端遠端過程調用(RPC)的簡單API。SignalR還包括用于連接配接管理(例如,連接配接和斷開事件)的API和分組連接配接。SignalR提供了一個用于建立從伺服器端.NET代碼調用用戶端浏覽器(和其他用戶端平台)中的JavaScript函數的伺服器到用戶端遠端過程調用(RPC)的簡單API。SignalR還包括用于連接配接管理(例如,連接配接和斷開事件)的API和分組連接配接。

    (以上描述摘自MSDN)

   上面介紹了ASP.NET SignalR的一些基本概念和操作,接下來看一下ASP.NET SignalR的抽象層,由底層向上以此為:Internet協定,傳輸(WebSockets,Server-SentEvents,foreverFrame,長輪詢),持久連接配接層,Hub層。

ASP.NET SignalR2持久連接配接層解析

     由以上的結構圖可知ASP.NET SignalR的抽象層結構,在伺服器端,當連接配接打開或關閉、接收資料、給用戶端發送資訊時,将接受到通知;在用戶端,打開或關閉連接配接,發送或接收任何資料。在ASP.NET SignalR的持久連接配接層中,有一個核心對象:PersisterConnection類,接下來我們具體了解一下這個類的一些方法。

二.ASP.NET SignalR持久連接配接層服務端核心對象方法解析:

    ASP.NET SignalR中的每一個持久層都可以通過某一個URL從外部進行通路。為保持用戶端和伺服器之間持久連接配接的開放性,并使用傳輸在這樣的連接配接上發送資料,這個用來通路SignalR持久連接配接的底層API提供了隐藏固有複雜性的抽象層。

   1.PersisterConnection類的事件方法:

      在PersisterConnection中包含幾個事件方法,這幾個方法都是虛方法,如下:

    OnConnected():在建立新連接配接時調用。

    OnReconnected():在逾時後連接配接重新連接配接時調用。

    OnReceived():從連接配接接收資料時調用。

    OnDisconnected():當連接配接正常斷開或由于逾時時調用。

      以上的4個方法中,傳回的類型都是TaskAsyncHelper.Empty,如下源碼:

/// <summary>
    /// 從連接配接接收資料時調用。
    /// </summary>
    /// <param name="request">目前連接配接的IRequest。</param>
       <param name="connectionId">發送資料的連接配接的ID。</param>
       <param name="data">有效負載發送到連接配接。</param>
    /// <returns>
    ///System.Threading.Tasks.Task在接收操作完成時完成。/// </returns>
    protected virtual Task OnReceived(IRequest request, string connectionId, string data)
    {
      return TaskAsyncHelper.Empty;
    }      

    以上的方法都是異步方法,用以實作代碼的異步執行,或者傳回一個能夠通過某個Task對象表示和異步執行的背景任務,在方法的傳入參數中,代碼中已經做類對應的介紹。如果需要進一步了解TaskAsyncHelper.Empty的相關資訊,可以具體檢視System.Threading.Tasks.Task命名空間中的類。

   2.ProcessRequest():處理所有的請求。

      PersisterConnection類的ProcessRequest()方法是用與OWIN入口點,該方法存在多個重載版本,現在隻介紹一個重載的源碼:

public virtual Task ProcessRequest(HostContext context)
    {
      if (context == null)
        throw new ArgumentNullException("context");
      if (!this._initialized)
        throw new InvalidOperationException(string.Format((IFormatProvider) CultureInfo.CurrentCulture, Resources.Error_ConnectionNotInitialized, new object[0]));
      if (PersistentConnection.IsNegotiationRequest(context.Request))
        return this.ProcessNegotiationRequest(context);
      if (PersistentConnection.IsPingRequest(context.Request))
        return PersistentConnection.ProcessPingRequest(context);
      this.Transport = this.GetTransport(context);
      if (this.Transport == null)
        return PersistentConnection.FailResponse(context.Response, string.Format((IFormatProvider) CultureInfo.CurrentCulture, Resources.Error_ProtocolErrorUnknownTransport, new object[0]), 400);
      string connectionToken = context.Request.QueryString["connectionToken"];
      if (string.IsNullOrEmpty(connectionToken))
        return PersistentConnection.FailResponse(context.Response, string.Format((IFormatProvider) CultureInfo.CurrentCulture, Resources.Error_ProtocolErrorMissingConnectionToken, new object[0]), 400);
      string connectionId;
      string message;
      int statusCode;
      if (!this.TryGetConnectionId(context, connectionToken, out connectionId, out message, out statusCode))
        return PersistentConnection.FailResponse(context.Response, message, statusCode);
      this.Transport.ConnectionId = connectionId;
      Task<string> groupsToken = this.Transport.GetGroupsToken();
      Func<string, PersistentConnection, HostContext, Task> func = (Func<string, PersistentConnection, HostContext, Task>) ((g, pc, c) => pc.ProcessRequestPostGroupRead(c, g));
      HostContext hostContext = context;
      Func<string, PersistentConnection, HostContext, Task> successor;
      return TaskAsyncHelper.FastUnwrap(TaskAsyncHelper.Then<string, PersistentConnection, HostContext, Task>(groupsToken, successor, this, hostContext));
    }      

    由以上的源碼可以看出,該方法為一個異步虛方法,并且接受一個參數HostContext表示目前請求。當一個PersistentConnection的管道完成時,傳回一個System.Threading.Tasks.Task。Transport.GetGroupsToken()用與擷取組令牌。ProcessRequest()的另一個重載版本是OWIN的入口。

   3.TryGetConnectionId():用與擷取ConnectionId。

     看到ConnectionId應該都不會陌生,因為在前面介紹的4中事件方法中有一個參數就是ConnectionId,該參數是一個唯一辨別符,他和初始化通信過程中通過SiganlR自動産生的連接配接有關。預設情況下,SignalR架構将使用一個guid進行辨別。

    可以使用該連接配接符給某些特定的用戶端直接發送消息,或是對他們實施任何類型的個性化監視。

    接下來,我們具體看一下源碼:

internal bool TryGetConnectionId(HostContext context, string connectionToken, out string connectionId, out string message, out int statusCode)
    {
      string str1 = (string) null;
      connectionId = (string) null;
      message = (string) null;
      statusCode = 400;
      try
      {
        str1 = this.ProtectedData.Unprotect(connectionToken, "SignalR.ConnectionToken");
      }
      catch (Exception ex)
      {
        TraceSource trace = this.Trace;
        string format = "Failed to process connectionToken {0}: {1}";
        object[] objArray = new object[2];
        int index1 = 0;
        string str2 = connectionToken;
        objArray[index1] = (object) str2;
        int index2 = 1;
        Exception exception = ex;
        objArray[index2] = (object) exception;
        trace.TraceInformation(format, objArray);
      }
      if (string.IsNullOrEmpty(str1))
      {
        message = string.Format((IFormatProvider) CultureInfo.CurrentCulture, Resources.Error_ConnectionIdIncorrectFormat, new object[0]);
        return false;
      }
      string[] strArray = str1.Split(PersistentConnection.SplitChars, 2);
      connectionId = strArray[0];
      if (string.Equals(strArray.Length > 1 ? strArray[1] : string.Empty, PersistentConnection.GetUserIdentity(context), StringComparison.OrdinalIgnoreCase))
        return true;
      message = string.Format((IFormatProvider) CultureInfo.CurrentCulture, Resources.Error_UnrecognizedUserIdentity, new object[0]);
      statusCode = 403;
      return false;
    }      

   該方法傳回bool值,接受5個參數,分别為:HostContext請求内容,connectionToken連接配接令牌,connectionId連接配接ID,message消息,statusCode狀态代碼。進入方法後,首先判斷參數資訊是否符合要求。ProtectedData.Unprotect()方法用與取消保護,接受傳入的連接配接令牌。PersistentConnection.GetUserIdentity()用與擷取使用者身份。

   4.VerifyGroups():用與驗證組。

     在我們的實際項目中,一般是針對某一個使用者進行消息的處理,如果想要将消息按照組别進行操作應該怎麼處理,在SignalR提供了一個VerifyGroups方法。

internal IList<string> VerifyGroups(string connectionId, string groupsToken)
    {
      if (string.IsNullOrEmpty(groupsToken))
        return ListHelper<string>.Empty;
      string str1 = (string) null;
      try
      {
        str1 = this.ProtectedData.Unprotect(groupsToken, "SignalR.Groups.v1.1");
      }
      catch (Exception ex)
      {
        TraceSource trace = this.Trace;
        string format = "Failed to process groupsToken {0}: {1}";
        object[] objArray = new object[2];
        int index1 = 0;
        string str2 = groupsToken;
        objArray[index1] = (object) str2;
        int index2 = 1;
        Exception exception = ex;
        objArray[index2] = (object) exception;
        trace.TraceInformation(format, objArray);
      }
      if (string.IsNullOrEmpty(str1))
        return ListHelper<string>.Empty;
      string[] strArray = str1.Split(PersistentConnection.SplitChars, 2);
      string a = strArray[0];
      string json = strArray.Length > 1 ? strArray[1] : string.Empty;
      string b = connectionId;
      int num = 5;
      if (!string.Equals(a, b, (StringComparison) num))
        return ListHelper<string>.Empty;
      return (IList<string>) JsonSerializerExtensions.Parse<string[]>(this.JsonSerializer, json);
    }      

  該方法傳回一個List<string>集合,接受兩個參數connectionId,groupsToken進行分組操作。ProtectedData.Unprotect()方法用與取消保護,接受傳入的連接配接令牌。在SignalR中一般在處理消息請求時,需要進行取消保護這一步操作。Split()對取消保護操作後傳回的資料進行分割擷取一個數組。

三.總結:

   以上是簡單的介紹SignalR的持久層的一些方法,并沒有提供一些基本樣例,因為個人覺得在網上還是有自己多的demo,微軟的官網也提供的更為詳盡的操作說明,是以在這裡就不做這一方面的重複介紹。

愛知求真,靜心鑽研,虛心學習,務實創新,細緻平和。