Blazor でCleverPush のデータにリアルタイムで連携するアプリを構築

Blazor は、.NET を使って対話型のクライアント側Web UI を構築するためのフレームワークです。JavaScript の代わりにC# を使って、UI を作れるところが魅力です。また、既存の.NET ライブラリや.NET エコシステムを使うことができる利点があります。

CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってCleverPush を操作可能にします。Blazor が.NET Core 対応をしているため、Server Side Blazor からADO.NET Provider を使うことができます。この記事では、Server Side Blazor からCleverPush に接続して直接SQL クエリを実行する方法を説明します。

CData ADO.NET Provider for API のインストール

CData ADO.NET Provider は、通常であればRDB に接続するフレームワークである ADO.NET DataAdapter やLinqToSQL（もしくはDapper などのORM を挟んでもいいです）であり、CleverPush のデータへもRDB と同感覚でアクセスが可能になります。

CData のWebsite からProvider をダウンロードして、マシンにインストールします。NuGet からインストールすることも可能です。CleverPush ADO.NET Data Provider で検索してください。

SELECT CleverPush のデータ from the Blazor App

1. Open the Index.razor file from the Project page.
2. In a APIConnection object, set the connection string:

   まず、Profile 接続プロパティをディスク上の Cleverpush プロファイルの場所に設定します（例：C:\profiles\Cleverpush.apip）。次に、ProfileSettings 接続プロパティを Cleverpush の接続文字列に設定します（以下を参照）。

   Cleverpush API プロファイル設定

   CleverPush では、プライベート API キーでリクエストを認証します。API キーは、すべての API 呼び出しで Authorization リクエストヘッダーの値として渡されます。

   プライベート API キーは、CleverPush ダッシュボードの「Settings」>「API」で確認できます。サーバーサイドからアクセスする場合は、パブリックキーではなくプライベートキーを使用してください。

   以下の接続プロパティを設定すると、接続できるようになります。

   • AuthScheme：APIKey に設定します。
   • APIKey：CleverPush のプライベート API キーに設定します。

   オプションの接続プロパティ

   • ChannelId：デフォルトで使用する CleverPush のチャネル識別子に設定します。ほとんどのテーブルではチャネルによるフィルタが必要です。このプロパティを設定しておくと、WHERE 句で毎回 ChannelId を指定しなくてもクエリを実行できます。

   For example: Profile=C:\profiles\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';

   Blazor でCleverPush にデータ連携するアプリを構築

   Blazor にADO.NET Provider for API を接続

   • Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。
   
   • ソリューションエクスプローラーで「依存関係」から右クリックで「プロジェクト参照の追加」をクリック。
   • 参照マネージャーが開くので、「参照」ボタンをクリックして、先ほどインストールしたADO.NET Provider の.dll を選択します。「C:\Program Files\CData\CData ADO.NET Provider for API 2019J\lib etstandard2.0」内のSystem.Data.CData.API.dll」を参照に選びます。
   

   Blazor でCleverPush のデータをSELECT

   サンプルプロジェクトの「Page」→「Index.razor」を開きます。

   以下のコードを書きます。使っているクエリはおなじみの標準SQL です。CleverPush 固有のAPI を書かなくてもRDB と同感覚でSQL が書けるところがADO.NET Prover for API の強味です。
   

         @page "/"
         @using System.Data;
         @using System.Data.CData.API;
   
         <h1>Hello, world!</h1>
   
         Welcome to your Data app.
   
         <div class="row">
             <div class="col-12">
   
                 @using (APIConnection connection = new APIConnection(
                   "Profile=C:\profiles\Cleverpush.apip;ProfileSettings='APIKey=my_api_key';"))
                 {
                     var sql = "SELECT Id, Name FROM Segments WHERE ChannelId = 'your_channel_id'";
                     var results = new DataTable();
   
                     APIDataAdapter dataAdapter = new APIDataAdapter(sql, connection);
                     dataAdapter.Fill(results);
   
                     <table class="table table-bordered">
                         <thead class="thead-light">
                             <tr>
                                 @foreach (DataColumn item in results.Rows[0].Table.Columns)
                                 {
                                     <th scope="col">@item.ColumnName</th>
                                 }
                             </tr>
                         </thead>
                         <tbody>
                             @foreach (DataRow row in results.Rows)
                             {
                                 <tr>
                                     @foreach (var column in row.ItemArray)
                                     {
                                         <td>@column.ToString()</td>
                                     }
                                 </tr>
                             }
                         </tbody>
                     </table>
                 }
             </div>
         </div>
       

   まず、Profile 接続プロパティをディスク上の Cleverpush プロファイルの場所に設定します（例：C:\profiles\Cleverpush.apip）。次に、ProfileSettings 接続プロパティを Cleverpush の接続文字列に設定します（以下を参照）。

   Cleverpush API プロファイル設定

   CleverPush では、プライベート API キーでリクエストを認証します。API キーは、すべての API 呼び出しで Authorization リクエストヘッダーの値として渡されます。

   プライベート API キーは、CleverPush ダッシュボードの「Settings」>「API」で確認できます。サーバーサイドからアクセスする場合は、パブリックキーではなくプライベートキーを使用してください。

   以下の接続プロパティを設定すると、接続できるようになります。

   • AuthScheme：APIKey に設定します。
   • APIKey：CleverPush のプライベート API キーに設定します。

   オプションの接続プロパティ

   • ChannelId：デフォルトで使用する CleverPush のチャネル識別子に設定します。ほとんどのテーブルではチャネルによるフィルタが必要です。このプロパティを設定しておくと、WHERE 句で毎回 ChannelId を指定しなくてもクエリを実行できます。

   プロジェクトをリビルドして実行します。このようにCleverPush からデータを直接取得し、HTML テーブル形式にレンダリングしています。

   

   もちろんSaaS データソースへの接続の場合には、RDB 向けのドライバーと違い最終的にはHTTP リクエストが行われるので、サーバーサイド Blazor としてサーバーサイドから実行されるのか、クライアントサイド Blazor として、実行中のブラウザからHTTPリクエストが行われるのかの違いはあります。そのあたりはネットワークやプロキシの設定として注意が必要でしょう。設定はコード内の接続プロパティで可能です。

   まとめ

   このようにサーバーサイドBlazor アプリから簡単にADO.NET Provider を使ってCleverPush にリアルタイムでデータ取得を行うアプリを作ることができました。Blazor が.NET Core、フレームワークのツール群を使えるというメリットを活かすことができます。今回はSELECT * でしたが、フィルタリングやJOIN も可能です。是非、30日の無償評価版でシンプルかつパワフルなADO.NET Provider でのサーバーサイドBlazor 連携をお試しください。