ASP.NET DIYの彗星

少し前まで、大規模なASP.NETプロジェクトの開発の一環として、次のサブタスクが発生しました。リアルタイムで更新される表形式データの視覚表示を実装することです。 更新スキームは非常に単純です。つまり、データはQueryStringを介してサーバーに送信されます。これにより、ページ上の古いデータをできるだけ早く、ページなしでページを更新することなく置き換える必要があります。 私がすぐに思いついた最初の解決策は、タイマーAJAXリクエストの確立されたテクニックを、たとえば5秒ごとに使用することでした。 しかし、このアプローチを適用することの明らかな欠点はすぐに明らかになりました：まず、かなりの数の潜在的なクライアントが毎回新しい接続を作成するたびに5秒ごとにサーバーをぴくぴく動かします。結局のところ、仮想的には、データは1秒あたり数回でもサーバーに到着する可能性があります（または、数分でも到着しない場合があります。これは「最初」の場合です）。

このソリューションのアイデアは、Webチャットを作成するためのPerlでのCometテクノロジーの実装について説明したHabréの記事へのリンクを共有した同僚から思いがけなく思いついたものです。 「 彗星はあなたが必要とするものです！ 」と私たちは考え、私はこのことをASP.NETにねじ込む方法を見つけ始めました。 実際には、カットの下で何が議論されますか。



まず、Cometとは何かを考えましょう。 ウィキペディアがこれについて私たちに伝えていることは次のとおりです。

Comet （Web開発）は、Webアプリケーションのモデルを説明する新語です。HTTP接続を使用すると、Webサーバーは、ブラウザーからの追加要求なしにブラウザーにデータをプッシュできます。 コメットは、この相互作用を達成するためのさまざまな手法を示すために使用されるハイパーネームです。 これらのメソッドの共通点は、独自のプラグインではなく、JavaScriptなどのブラウザーで直接サポートされているテクノロジーに基づいていることです。 理論的には、Cometのアプローチは、ブラウザがページを更新するためにページ全体または一部を要求するWorld Wide Webの元の概念とは異なります。 ただし、実際には、Cometアプリケーションは通常、長いポーリングでAjaxを使用してサーバー上の新しい情報を確認します。

ですから、この定義から私たちがとれるキーワードは「Ajax with long polling」です。 それは何で、何と一緒に食べられますか？ 「ロングポーリング」テクノロジーを使用する場合、クライアントはサーバーにリクエストを送信し、...待機します。 サーバーに新しいデータが表示されるのを待ちます。 データが到着すると、サーバーはそのデータをクライアントに送信し、その後、新しいリクエストを送信して再び待機します。 「エンドレスリクエスト」の代替技術。たとえば、いわゆる 「Forever iframe」（ ここでもう少し読むことができます ）は、常に適用できるものとはほど遠いです。 タイムアウトなど、これまで誰もキャンセルしていません。

まあ、タスクは非常に明確です-利用可能なツール（AJAX + ASP.NET）で上記の長いポーリングを実装する必要があります。 これは最初の問題につながります。つまり、サーバーに顧客に送信できる新しいデータがあるまで（そして明らかに複数のクライアントがあるまで）、着信要求を保存し、応答を提供しない方法です。 そして、ここで非同期HTTPハンドラーが助けになります。

public interface IHttpAsyncHandler : IHttpHandler
{
IAsyncResult BeginProcessRequest( HttpContext ctx,
AsyncCallback cb,
object obj);
void EndProcessRequest(IAsyncResult ar);
}

* This source code was highlighted with Source Code Highlighter .

IHttpHandlerインターフェイスからではなく、IHttpAsyncHandlerからクラスを継承します。IHttpAsyncHandlerは、使い慣れたProcessRequestメソッドと共にBeginProcessRequestとEndProcessRequestの2つの新しいメソッドを提供します。 特に、最初のものに興味があります。なぜなら、 つまり、リクエストの処理の開始時に、このリクエストを手で取得する必要があり、Xが来るまで放さないでください。 ご覧のとおり、BeginProcessRequestはIAsyncResultインターフェイスを実装するオブジェクトを返します。

public interface IAsyncResult
{
public object AsyncState { get ; }
public bool CompletedSynchronously { get ; }
public bool IsCompleted { get ; }
public WaitHandle AsyncWaitHandle { get ; }
}

* This source code was highlighted with Source Code Highlighter .

指定されたインターフェイスを実装する新しいクラスを作成し、BeginProcessRequestに送信された要求データと独自のclientGuidパラメーターのリポジトリとしても機能します。これは、サーバーに接続するクライアントの一意の識別子として将来使用し、何らかの方法で要求を識別します。

public class CometAsyncRequestState : IAsyncResult
{
private HttpContext _currentContext;
private AsyncCallback _asyncCallback;
private Object _extraData;

private Boolean _isCompleted;
private Guid _clientGuid;
private ManualResetEvent _callCompleteEvent = null ;

public CometAsyncRequestState( HttpContext currentContext, AsyncCallback asyncCallback, Object extraData)
{
_currentContext = currentContext;
_asyncCallback = asyncCallback;
_extraData = extraData;

_isCompleted = false ;
}

public void CompleteRequest()
{
_isCompleted = true ;

lock ( this )
{
if (_callCompleteEvent != null )
_callCompleteEvent.Set();
}

if (_asyncCallback != null )
{
_asyncCallback( this );
}
}

public HttpContext CurrentContext
{
get
{
return _currentContext;
}
set
{
_currentContext = value ;
}
}

public AsyncCallback AsyncCallback
{
get
{
return _asyncCallback;
}
set
{
_asyncCallback = value ;
}
}

public Object ExtraData
{
get
{
return _extraData;
}
set
{
_extraData = value ;
}
}

public Guid ClientGuid
{
get
{
return _clientGuid;
}
set
{
_clientGuid = value ;
}
}

// IAsyncResult implementations
public Boolean CompletedSynchronously
{
get
{
return false ;
}
}

public Boolean IsCompleted
{
get
{
return _isCompleted;
}
}

public Object AsyncState
{
get
{
return _extraData;
}
}

public WaitHandle AsyncWaitHandle
{
get
{
lock ( this )
{
if (_callCompleteEvent == null )
_callCompleteEvent = new ManualResetEvent( false );

return _callCompleteEvent;
}
}
}
}

* This source code was highlighted with Source Code Highlighter .

ご覧のとおり、CompleteRequest関数を呼び出すまで、リクエストは完了したと見なされません。 素晴らしい-それが必要です。 これらの着信リクエストを保存する場所はどこかにのみ残っています。 この関数およびリクエスト処理関数に対して、静的クラスCometClientProcessorを作成します。

public static class CometClientProcessor
{
private static Object _lockObj;
private static List <CometAsyncRequestState> _clientStateList;

static CometClientProcessor()
{
_lockObj = new Object();
_clientStateList = new List <CometAsyncRequestState>();
}

public static void PushData( String pushedData)
{
List <CometAsyncRequestState> currentStateList = new List <CometAsyncRequestState>();

lock (_lockObj)
{
foreach (CometAsyncRequestState clientState in _clientStateList)
{
currentStateList.Add(clientState);
}
}

foreach (CometAsyncRequestState clientState in currentStateList)
{
if (clientState.CurrentContext.Session != null )
{
clientState.CurrentContext.Response.Write(pushedData);
clientState.CompleteRequest();
}
}
}

public static void AddClient(CometAsyncRequestState state)
{
Guid newGuid;

lock (_lockObj)
{
while ( true )
{
newGuid = Guid .NewGuid();
if (_clientStateList.Find(s => s.ClientGuid == newGuid) == null )
{
state.ClientGuid = newGuid;
break ;
}
}

_clientStateList.Add(state);
}
}

public static void UpdateClient(CometAsyncRequestState state, String clientGuidKey)
{
Guid clientGuid = new Guid (clientGuidKey);

lock (_lockObj)
{
CometAsyncRequestState foundState = _clientStateList.Find(s => s.ClientGuid == clientGuid);

if (foundState != null )
{
foundState.CurrentContext = state.CurrentContext;
foundState.ExtraData = state.ExtraData;
foundState.AsyncCallback = state.AsyncCallback;
}
}
}

public static void RemoveClient(CometAsyncRequestState state)
{
lock (_lockObj)
{
_clientStateList.Remove(state);
}
}
}

* This source code was highlighted with Source Code Highlighter .

CometClientProcessorには、現在保持されているリクエストのリスト、リクエストを追加するためのAddClient関数（新しいクライアントを接続する場合）、リクエストを更新するためのUpdateClient（既に接続されているクライアントが新しいリクエストを送信する場合）、およびリクエストを削除するためのRemoveClient（クライアントが切断する場合）、メインPushDataメソッド。 わかりやすくするために、最も単純なデータ、つまりURLのパラメーターを介してサーバーに送られる行を「プッシュ」します。 ご覧のとおり、すべてが非常に単純です。現在保持されている要求を実行し、サーバーからのデータを応答に書き込み、CompleteRequest関数を呼び出して、要求を解放し、クライアントに応答を送信します。 この例では、唯一のページのPage_Load関数からPushData呼び出しが行われます。

protected void Page_Load( object sender, EventArgs e)
{
if (!IsPostBack)
{
if (Request.QueryString[ "x" ] != null )
{
CometClientProcessor.PushData(Request.QueryString[ "x" ].ToString());
}
}
}

* This source code was highlighted with Source Code Highlighter .

前述のように、データはURLのパラメーターを介して取得されます。この場合、わかりやすくするために「x」と呼ばれます。 サーバー部分では、実際には非同期ハンドラー自体を実装するだけです。 しかし、最初に、クライアント部分に目を向けて（jQueryライブラリーの助けなしではなく）いくつかのかなり普通のJavaScript関数を作成しましょう。

var clientGuid

$( document ).ready( function () {
var str = window.location.href;
if (str.indexOf( "?" ) < 0)
Connect();
});

$(window).unload( function () {
var str = window.location.href;
if (str.indexOf( "?" ) < 0)
Disconnect();
});

function SendRequest() {
var url = './CometAsyncHandler.ashx?cid=' + clientGuid;
$.ajax({
type: "POST" ,
url: url,
success: ProcessResponse,
error: SendRequest
});
}

function Connect() {
var url = './CometAsyncHandler.ashx?cpsp=CONNECT' ;
$.ajax({
type: "POST" ,
url: url,
success: OnConnected,
error: ConnectionRefused
});
}

function Disconnect() {
var url = './CometAsyncHandler.ashx?cpsp=DISCONNECT' ;
$.ajax({
type: "POST" ,
url: url
});
}

function ProcessResponse(transport) {
$( "#contentWrapper" ).html(transport);
SendRequest();
}

function OnConnected(transport) {
clientGuid = transport;
SendRequest();
}

function ConnectionRefused() {
$( "#contentWrapper" ).html( "Unable to connect to Comet server. Reconnecting in 5 seconds..." );
setTimeout(Connect(), 5000);
}

* This source code was highlighted with Source Code Highlighter .

ドキュメントが読み込まれるとすぐに、URLでパラメーターの存在を確認し（パラメーター化されたURL、もう一度お知らせします-これはプッシュのためにサーバーにデータを送信しています）、Connect関数を呼び出します。 これは、順番に、すでにハンドラーとの通信を開始しています。 わかりやすいように、アクションを定義するサービスワード（CONNECT / DISCONNECT）は、cpspパラメーターを介して渡されます。 したがって、ConnectはサーバーでAddClient呼び出しを開始し、Disconnect-RemoveClientを開始する必要があります。 接続が確立され、クライアントがclientGuidを受信すると、SendRequest関数が呼び出されます。これは、クライアントが接続を切断することを決定するまでサーバーを「ロングフィル」します。 各SendRequest呼び出しは、サーバー上でUpdateClient関数の実行を開始し、このクライアントはコンテキストとコールバックを更新します。

さて、ほとんどすべての準備が整ったので、上記のメカニズム全体の中核である非同期ハンドラーを実装するときが来ました。

public enum ConnectionCommand
{
CONNECT,
DISCONNECT
}

public static class ConnectionProtocol
{
public static String PROTOCOL_GET_PARAMETER_NAME = "cpsp" ;
public static String CLIENT_GUID_PARAMETER_NAME = "cid" ;
}

* This source code was highlighted with Source Code Highlighter .

<%@ WebHandler Language= "C#" Class= "CometAsyncHandler" %>

using System;
using System.Web;

using DevelopMentor;

public class CometAsyncHandler : IHttpAsyncHandler, System.Web.SessionState.IRequiresSessionState
{
static private ThreadPool _threadPool;

static CometAsyncHandler()
{
_threadPool = new ThreadPool(2, 50, "Comet Pool" );
_threadPool.PropogateCallContext = true ;
_threadPool.PropogateThreadPrincipal = true ;
_threadPool.PropogateHttpContext = true ;
_threadPool.Start();
}

public IAsyncResult BeginProcessRequest( HttpContext ctx, AsyncCallback cb, Object obj)
{
CometAsyncRequestState currentAsyncRequestState = new CometAsyncRequestState(ctx, cb, obj);
_threadPool.PostRequest( new WorkRequestDelegate(ProcessServiceRequest), currentAsyncRequestState);

return currentAsyncRequestState;
}

private void ProcessServiceRequest(Object state, DateTime requestTime)
{
CometAsyncRequestState currentAsyncRequestState = state as CometAsyncRequestState;

if (currentAsyncRequestState.CurrentContext.Request.QueryString[ConnectionProtocol.PROTOCOL_GET_PARAMETER_NAME] ==
ConnectionCommand.CONNECT.ToString())
{
CometClientProcessor.AddClient(currentAsyncRequestState);
currentAsyncRequestState.CurrentContext.Response.Write(currentAsyncRequestState.ClientGuid.ToString());
currentAsyncRequestState.CompleteRequest();
}
else if (currentAsyncRequestState.CurrentContext.Request.QueryString[ConnectionProtocol.PROTOCOL_GET_PARAMETER_NAME] ==
ConnectionCommand.DISCONNECT.ToString())
{
CometClientProcessor.RemoveClient(currentAsyncRequestState);
currentAsyncRequestState.CompleteRequest();
}
else
{
if (currentAsyncRequestState.CurrentContext.Request.QueryString[ConnectionProtocol.CLIENT_GUID_PARAMETER_NAME] != null )
{
CometClientProcessor.UpdateClient(currentAsyncRequestState,
currentAsyncRequestState.CurrentContext.Request.QueryString[ConnectionProtocol.CLIENT_GUID_PARAMETER_NAME].ToString());
}
}
}

public void EndProcessRequest(IAsyncResult ar)
{
}

public void ProcessRequest( HttpContext context)
{
}

public bool IsReusable
{
get
{
return true ;
}
}
}

* This source code was highlighted with Source Code Highlighter .

上記のすべての後、注意深い読者が持つかもしれない唯一の質問は、「カスタムスレッドプールを使用する理由」です。 完全に明らかではありませんが、答えは非常に単純です。ASP.NETトレッドプールのワークフローをできるだけ早く「解放」して、着信要求の処理を継続し、要求の直接処理を「内部」スレッドに転送できるようにするためです。 これが行われない場合、十分な数の着信要求があると、一見したところ一見馬鹿げた「ギャグ」が発生する可能性があります。「ASP.NETはワークフローを使い果たしました」。 同じ理由で、BeginInvokeメソッドまたは標準のスレッドプールメソッドThreadPool.QueueUserWorkItemによって励起された非同期デリゲートを使用することはできません。 どちらの場合も、スレッドは同じASP.NETトレッドミルから削除され、「石鹸で縫い付けられた」状況になります。 この例では、Mike Woodringによって実装されたカスタムスレッドプールが使用されます。 これと彼の他の多くの発展はここで見られます 。

基本的には以上です。 当初のように難しくはありませんでした。 クライアントはDefault.aspxを呼び出してCometサーバーに接続し、GETパラメーターala Default.aspx？X = Happy_New_Yearを同じページに渡すことでデータをプッシュします。 残念ながら、このアプローチのスケーラビリティの大規模なテストはまだ可能ではありませんが、だれかがこれについてアイデアを持っているなら、書いて、恥ずかしがらないでください。

ご清聴ありがとうございました。

UPD サンプルプロジェクトのリンクをアーカイブに追加します （〜30 KB）。 表示方法：VSでは、CometPage.aspxをスタートページとして設定し、起動し、ブラウザー/ブラウザーで同じURLで複数のタブを開き（これらのブラウザーでの同時接続数の制限を覚えているだけです ）、パラメーターを追加しますか？X = [any_text]を開き、開いているすべてのタブでパラメーターの値がどのように表示されるかを確認します。