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

こんにちは！リードエンジニアの杉本です。

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

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

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

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

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

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

Blazor にADO.NET Provider for ApacheCouchDB を接続

• Visual Studio を立ち上げて、Blazor アプリのプロジェクトを作成します。

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

Blazor でCouchDB のデータをSELECT

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

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

      @page "/"
      @using System.Data;
      @using System.Data.CData.ApacheCouchDB;

      <h1>Hello, world!</h1>

      Welcome to your Data app.

      <div class="row">
          <div class="col-12">

              @using (ApacheCouchDBConnection connection = new ApacheCouchDBConnection(
                "Url=http://localhost:5984;User=abc123;Password=abcdef;"))
              {
                  var sql = "SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'";
                  var results = new DataTable();

                  ApacheCouchDBDataAdapter dataAdapter = new ApacheCouchDBDataAdapter(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>
    

Apache CouchDB 接続プロパティの取得・設定方法

Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするために本製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

Apache CouchDB への認証

• Basic：基本的なユーザー名 / パスワード認証。
• JWT：JWT 認証。
• None：パブリックなデータベースへの匿名アクセス。

Basic 認証

データに接続するには以下を設定します。

• AuthScheme：Basic。
• User：認証に使用されるApache CouchDB ユーザーアカウント。
• Password：認証するユーザーに関連付けられたApache CouchDB パスワード。

その他の認証方法は、ヘルプドキュメント の「接続の確立」セクションを参照してください。

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

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

まとめ