JDBI からSpotify データのデータアクセスオブジェクトを作成

加藤龍彦
加藤龍彦
デジタルマーケティング
JDBI でSpotify のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。

JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for API は、Java アプリケーションとリアルタイムSpotify のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Spotify のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するSpotify のデータ の読み書きのためのコードの作成について説明します。

Spotify Albums Entity のDAO を作成

以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。 

public interface MyAlbumsDAO {
  //request specific data from Spotify (String type is used for simplicity)
  @SqlQuery("SELECT  FROM Albums WHERE Id = :id")
  String findById(@Bind("id") String id);

  /*
   * close with no args is used to close the connection
   */
  void close();
}

Spotify への接続を開く

必要な接続プロパティを収集し、Spotify に接続するための適切なJDBC URL を作成します。

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 ID と Client Secret をコピーします。

接続プロパティ

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

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。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：ユーザーのトップアーティストとトラックへの読み取りアクセス。

ビルトイン接続文字列デザイナー

JDBC URL の構成については、Spotify JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Spotify の接続文字列は、通常次のようになります。

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

構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。 

DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;");
MyAlbumsDAO dao = dbi.open(MyAlbumsDAO.class);

//do stuff with the DAO

dao.close();

Spotify データについて

Spotify への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Spotify のAlbums エンティティからデータを取得できます。 

//disply the result of our 'find' method
String  = dao.findById("4aawyAB9vmqN3uQ7FjRGTy");
System.out.println();

JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for API と統合することで、SQL Object API for API を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムSpotify を操作しましょう。

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

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

Spotify に接続

この記事の内容

関連記事