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

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

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

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

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

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

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

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

Blazor にADO.NET Provider for AdobeCommerce を接続

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

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

Blazor でAdobe Commerce のデータをSELECT

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

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

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

      <h1>Hello, world!</h1>

      Welcome to your Data app.

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

              @using (AdobeCommerceConnection connection = new AdobeCommerceConnection(
                "OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;"))
              {
                  var sql = "SELECT Name, Price FROM Products";
                  var results = new DataTable();

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

Adobe Commerce はOAuth 1 認証標準を使用します。Adobe Commerce REST API に接続するには、Adobe Commerce システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Adobe Commerce システムへのURL を提供する必要があります。URL は、Adobe Commerce REST API を顧客として使用しているか管理者として使用しているかによって異なります。

• Customer: Adobe Commerce を顧客として使用するには、事前にAdobe Commerce のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをAdobe Commerce システムのエンドポイントに設定します。

• Administrator: Adobe Commerce を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。

  このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

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

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

まとめ