ASP.NET SignalR の HubPipelineModule を使ってみる

ASP.NET SignalR 1.0 から HubPipeline という機能が実装されました。詳細は SignalR の最新情報をまとめてみた - しばやん雑記とかを見てください。

簡単に概要だけ説明しておくと、MVC や Web API の ActionFilter に相当する機能が SignalR の HubPipeline です。しかし、SignalR の場合は受信と送信があるので ActionFilter のように簡単ではありません。実体となる IHubPipelineModule には以下のようなメソッドが定義されています。

public interface IHubPipelineModule
{
    Func<IHubIncomingInvokerContext, Task<object>> BuildIncoming(Func<IHubIncomingInvokerContext, Task<object>> invoke);
    Func<IHubOutgoingInvokerContext, Task> BuildOutgoing(Func<IHubOutgoingInvokerContext, Task> send);
    Func<IHub, Task> BuildConnect(Func<IHub, Task> connect);
    Func<IHub, Task> BuildReconnect(Func<IHub, Task> reconnect);
    Func<IHub, Task> BuildDisconnect(Func<IHub, Task> disconnect);
    Func<HubDescriptor, IRequest, bool> BuildAuthorizeConnect(Func<HubDescriptor, IRequest, bool> authorizeConnect);
    Func<HubDescriptor, IRequest, IList<string>, IList<string>> BuildRejoiningGroups(Func<HubDescriptor, IRequest, IList<string>, IList<string>> rejoiningGroups);
}

Func デリゲートが絡んで非常に複雑な感じですよね。

しかし大丈夫、予め基本的な部分が実装された HubPipelineModule クラスが用意されているので、特別な事情が無い場合にはこっちのクラスを継承して作れば OK です。

public abstract class HubPipelineModule : IHubPipelineModule
{
    protected virtual bool OnBeforeAuthorizeConnect(HubDescriptor hubDescriptor, IRequest request);
    protected virtual bool OnBeforeConnect(IHub hub);
    protected virtual void OnAfterConnect(IHub hub);
    protected virtual bool OnBeforeReconnect(IHub hub);
    protected virtual void OnAfterReconnect(IHub hub);
    protected virtual bool OnBeforeOutgoing(IHubOutgoingInvokerContext context);
    protected virtual void OnAfterOutgoing(IHubOutgoingInvokerContext context);
    protected virtual bool OnBeforeDisconnect(IHub hub);
    protected virtual void OnAfterDisconnect(IHub hub);
    protected virtual bool OnBeforeIncoming(IHubIncomingInvokerContext context);
    protected virtual object OnAfterIncoming(object result, IHubIncomingInvokerContext context);
    protected virtual void OnIncomingError(Exception ex, IHubIncomingInvokerContext context);
}

インターフェースが ActionFilter っぽくて良い感じですね。この中でも OnBefore~ というメソッドで false を返すと、ハブのメソッド実行が行われずに即終了します。

これを利用して、メソッドの実行可能な間隔を制限する HubPipelineModule を作成してみました。

public class AntiClickModule : HubPipelineModule
{
    public AntiClickModule()
    {
        Interval = 1000;
    }

    public int Interval { get; set; }

    private readonly ConcurrentDictionary<string, DateTime> _connections = new ConcurrentDictionary<string, DateTime>();

    protected override void OnAfterDisconnect(IHub hub)
    {
        DateTime lastDateTime;

        _connections.TryRemove(hub.Context.ConnectionId, out lastDateTime);
    }

    protected override bool OnBeforeIncoming(IHubIncomingInvokerContext context)
    {
        var now = DateTime.Now;
        var connectionId = context.Hub.Context.ConnectionId;

        DateTime lastDateTime;

        if (_connections.TryGetValue(connectionId, out lastDateTime))
        {
            var span = now - lastDateTime;

            if (span.TotalMilliseconds < Interval)
            {
                return false;
            }
        }

        _connections.AddOrUpdate(connectionId, now, (_, __) => now);

        return true;
    }
}

コネクション ID 毎に最後にリクエストされた日付を保存して、次回のリクエストのタイミングで間隔をチェックしているだけです。非同期でメソッドが呼ばれるので ConcurrentDictionary を使って対応付けを保存しています。

そして実際に使うためには Global.asax.cs で GlobalHost を使ってモジュールを追加します。

protected void Application_Start(object sender, EventArgs e)
{
    GlobalHost.HubPipeline.AddModule(new AntiClickModule());
}

よくイベントで使われるボタンをクリックしてカウントアップするようなデモでは、参加者に悪い人がいると途端にカウントが目にもとまらぬ速さになってしまうのですが、このモジュールを使えば解決します。

HubPipeline は全てのハブへのメソッド呼び出しに対して呼び出されるので、ログを取りたい場合や実行時間を取得することなどに使えそうですね。