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

杉本和也
杉本和也
リードエンジニア
ASP.NET Core Blazor C# でSpotify にSQL でクエリ。



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

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

Blazor はADO.NET Provider の利用が可能

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

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

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

NuGet でADO.NET Spotify Provider をインストール

SELECT Spotify のデータ from the Blazor App

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

    OAuth 認証の設定

    Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

    Spotify アプリケーションのセットアップ

    1. Spotify Developer Dashboard にアクセスします。
    2. Spotify アカウントでログインして Create app をクリックします。
    3. アプリ名、説明を入力し、Redirect URI を設定します(デスクトップアプリケーションの場合は
      http://localhost:33333
      など)。
    4. アプリ設定から Client IDClient Secret をコピーします。

    接続プロパティ

    以下の接続プロパティを設定して接続を確立してください:

    • AuthScheme:OAuth に設定します。
    • InitiateOAuthGETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId:Spotify アプリケーションの Client ID に設定します。
    • OAuthClientSecret:Spotify アプリケーションの Client Secret に設定します。
    • Scope:必要な OAuth スコープ(スペース区切り)に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
    • CallbackURL:Spotify アプリケーションで設定したリダイレクト URI に設定します(例:http://localhost:33333)。

    接続文字列の例

    Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;
    

    利用可能な OAuth スコープ

    • user-read-private:ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
    • user-read-email:ユーザーのメールアドレスへの読み取りアクセス。
    • user-library-read:ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
    • playlist-read-private:ユーザーの非公開プレイリストへの読み取りアクセス。
    • playlist-read-collaborative:ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
    • user-follow-read:現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
    • user-read-playback-state:ユーザーのプレーヤー状態(デバイス、現在のトラック、再生位置)への読み取りアクセス。
    • user-read-currently-playing:ユーザーが現在再生中のコンテンツへの読み取りアクセス。
    • user-read-playback-history:ユーザーが最近再生したトラックへの読み取りアクセス。
    • user-top-read:ユーザーのトップアーティストとトラックへの読み取りアクセス。

    For example: Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;

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

    Blazor にADO.NET Provider for API を接続

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

    Blazor でSpotify のデータをSELECT

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

    以下のコードを書きます。使っているクエリはおなじみの標準SQL です。Spotify 固有の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\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;"))
                  {
                      var sql = "SELECT ,  FROM Albums WHERE Id = '4aawyAB9vmqN3uQ7FjRGTy'";
                      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>
        

    OAuth 認証の設定

    Spotify は認証に OAuth 2.0 を使用します。クライアント認証情報を取得するには、Spotify Developer Dashboard でアプリケーションを作成する必要があります。

    Spotify アプリケーションのセットアップ

    1. Spotify Developer Dashboard にアクセスします。
    2. Spotify アカウントでログインして Create app をクリックします。
    3. アプリ名、説明を入力し、Redirect URI を設定します(デスクトップアプリケーションの場合は
      http://localhost:33333
      など)。
    4. アプリ設定から Client IDClient Secret をコピーします。

    接続プロパティ

    以下の接続プロパティを設定して接続を確立してください:

    • AuthScheme:OAuth に設定します。
    • InitiateOAuthGETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId:Spotify アプリケーションの Client ID に設定します。
    • OAuthClientSecret:Spotify アプリケーションの Client Secret に設定します。
    • Scope:必要な OAuth スコープ(スペース区切り)に設定します。デフォルトには、このプロファイルのテーブルに必要なすべての読み取りスコープが含まれます。
    • CallbackURL:Spotify アプリケーションで設定したリダイレクト URI に設定します(例:http://localhost:33333)。

    接続文字列の例

    Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;
    

    利用可能な OAuth スコープ

    • user-read-private:ユーザーのサブスクリプション詳細と露骨なコンテンツ設定への読み取りアクセス。
    • user-read-email:ユーザーのメールアドレスへの読み取りアクセス。
    • user-library-read:ユーザーが保存したトラック、アルバム、エピソード、ショー、オーディオブックへの読み取りアクセス。
    • playlist-read-private:ユーザーの非公開プレイリストへの読み取りアクセス。
    • playlist-read-collaborative:ユーザーがフォローしているコラボレーティブプレイリストへの読み取りアクセス。
    • user-follow-read:現在のユーザーがフォローしているアーティストの一覧への読み取りアクセス。
    • user-read-playback-state:ユーザーのプレーヤー状態(デバイス、現在のトラック、再生位置)への読み取りアクセス。
    • user-read-currently-playing:ユーザーが現在再生中のコンテンツへの読み取りアクセス。
    • user-read-playback-history:ユーザーが最近再生したトラックへの読み取りアクセス。
    • user-top-read:ユーザーのトップアーティストとトラックへの読み取りアクセス。

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

    Blazor アプリからSpotify のデータをクエリ

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

    まとめ

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

はじめる準備はできましたか?

API Driver で Spotify のライブデータに接続

Spotify に接続