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

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

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

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

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

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

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

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

Blazor にADO.NET Provider for Confluence を接続

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

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

Blazor でConfluence のデータをSELECT

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

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

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

      <h1>Hello, world!</h1>

      Welcome to your Data app.

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

              @using (ConfluenceConnection connection = new ConfluenceConnection(
                "User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"))
              {
                  var sql = "SELECT Key, Name FROM Pages WHERE Id = '10000'";
                  var results = new DataTable();

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

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

任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

Confluence への認証

Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。

API トークン - Confluence Cloud アカウント

トークンの取得

アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

トークンを使用する認証

Cloud アカウントへの認証を行うには、以下を入力します。

• AuthScheme：APIToken に設定。
• User：Confluence サーバーに認証する際に使用されるユーザー。
• APIToken：現在認証されているユーザーに紐づくAPI トークン。
• Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

Basic 認証 - Confluence Server インスタンス

Server インスタンスへの認証を行うには、以下のように指定します。

• AuthScheme：Basic に設定。
• User：Confluence インスタンスに認証する際に使用されるユーザー。
• Password：Confluence サーバーに認証する際に使われるパスワード。
• Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

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

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

まとめ