.NET 統合 - クイックスタートガイド

このガイドの目的は、MVC アプリケーションにおいて、CrowdHandler の基本的な .NET 統合を行う方法の概要を説明することです。

さらに詳細なカスタマイズや高度な設定については、プロジェクトのGitHub リポジトリまたはNuGet のドキュメントをご参照ください。

1.) プロジェクトへの参照を追加してください。

これを行うにはNuGetを使うのが最も簡単です。次のものを探してください。 Crowdhandler.MVCSDK NuGet パッケージ マネージャーでパッケージをインストールするか、あるいは dotnet CLI を使用してインストールします。

dotnet add package Crowdhandler.MVCSDK

2.) コントローラーのアクションに「Crowdhandler」フィルター属性を適用します。

ExampleTicketingController.cs

using Crowdhandler.MVC5SDK;

namespace MyTicketingApp.Controllers
{
    public class TicketingController : Controller
    {
        [CrowdhandlerFilter]
        public ActionResult Index()
        {
            return View();
        }
    }
}

キューイングの対象から除外したいパターンを含む正規表現を「Exclusions」パラメータとしてフィルタに渡すことで、無視するURLパターンを設定します。

無視すべき一般的なパターンは以下の通りです:

  • 静的アセットやメディアを保存するために使用されるパス。例:/static-media/*
  • サードパーティの決済プロバイダーによって生成されたコールバックURL。
  • JSONおよびRSSフィード。

ExampleTicketingController.cs

using Crowdhandler.MVCSDK;

namespace MyTicketingApp.Controllers
{
    public class TicketingController : Controller
    {
        [CrowdhandlerFilter(Exclusions = @"^(\/contact-us.*)|((?!.*\?).*(\.(avi|css|eot|gif|ICO|jpg|jpeg|js|json|mov|mp4|mpeg|mpg|og[g|v]|pdf|png|svg|ttf|txt|wmv|woff|woff2|xml)))$")]
        public ActionResult Index()
        {
            return View();
        }
    }
}

3.) CrowdHandler の設定を注入します。

* 公開鍵と秘密鍵は、CrowdHandler 管理コンソールの「アカウント」→「API」セクションで確認できます。

app.config経由、または web.config を通じて

<appSettings>
    <add key="CROWDHANDLER_PUBLIC_KEY" value="YOUR_PUBLIC_KEY"/>
    <add key="CROWDHANDLER_PRIVATE_KEY" value="YOUR_PRIVATE_KEY"/>
</appSettings>

あるいは、フィルターに直接注入することも可能です。

using Crowdhandler.MVC5SDK;

namespace MyTicketingApp.Controllers
{
    public class TicketingController : Controller
    {
        [CrowdhandlerFilter(PrivateApiKey = "YOUR_PRIVATE_KEY", PublicApiKey = "YOUR_PUBLIC_KEY")]
        public ActionResult Index()
        {
            return View();
        }
    }
}

* 設定可能な項目とそのデフォルト設定の完全な一覧は、NuGet ドキュメントのセクション 2b に記載されています。

https://www.nuget.org/packages/Crowdhandler.MVCSDK/

4.) CrowdHandler JavaScript 統合のインストール

サーバーサイドでCrowdHandlerを統合する場合、なぜこれを行う必要があるのですか?

統合処理を可能な限り高速に実行するため、ミッションクリティカルではない機能は、当社のJavaScript統合を通じてクライアント側にオフロードされています。

その機能が業務上不可欠でない場合、この手順を省略してもよろしいでしょうか?

理論的には可能ですが、実際にはお勧めしません。JavaScript 連携機能をインストールすると、ページのパフォーマンス追跡やスマートセッションキープアライブなどの機能が利用できるようになります。

前者は、当社のオートチューン機能が正しく動作するための要件であるだけでなく、負荷がかかった状態でのアプリケーションのパフォーマンス状況を可視化するためにも役立ちます。

後者は、クライアント側とCrowdHandlerのバックエンド間でセッション情報を同期させ、設定されたCrowdHandlerのセッション時間より長く経過した、最近アクティブだったユーザーが、不必要にCrowdHandlerのセッションバリデータに送信されて再検証されるのを防ぎます。

JavaScript 連携機能をインストールするにはどうすればよいですか

このJavaScriptは、Googleタグマネージャーを介して、マスターテンプレートのheadセクションに直接組み込むか、あるいはご都合の良いその他の方法で導入することができます。

JavaScript 統合機能のインストール手順については、こちらをご覧ください。

5.) CrowdHandlerのコントロールパネルで、統合タイプを.NETに変更します。

デプロイ先の選択は、ドメイン画面から行うことができます。

6.) さて、これからどうする?

.NET との統合手順が完了したら、CrowdHandler コントロールパネル内での待合室の作成および設定について理解を深めるのに役立つ「はじめに」ガイドをご覧になることをお勧めします。