Java で Spotify のデータエンティティのオブジェクトリレーショナルマッピング（ORM）を行う

Jerod Johnson
Director, Technology Evangelism

オブジェクトリレーショナルマッピング（ORM）技術を使用すると、リレーショナルデータソースの操作が容易になり、論理的なビジネスモデルと物理ストレージモデルを橋渡しできます。本記事では、Java ベースの ORM フレームワーク Hibernate に Spotify のデータへの接続を組み込む方法を説明します。

Hibernate を使用して、オブジェクト指向のドメインモデルを従来のリレーショナルデータベースにマッピングできます。以下のチュートリアルでは、CData JDBC Driver for Spotify を使用して Hibernate で Spotify リポジトリの ORM を生成する方法を説明します。

本記事では IDE として Eclipse を使用していますが、CData JDBC Driver for Spotify は Java ランタイム環境をサポートするあらゆる製品で使用できます。Knowledge Base には、IntelliJ IDEA や NetBeans から Spotify のデータに接続するためのチュートリアルも用意しています。

Hibernate のインストール

以下の手順に従って、Eclipse に Hibernate プラグインをインストールします。

Eclipse で、Help -> Install New Software を選択します。
Work With ボックスに「http://download.jboss.org/jbosstools/neon/stable/updates/」を入力します。
フィルタボックスに「Hibernate」と入力します。
Hibernate Tools を選択します。

新規プロジェクトの作成

以下の手順に従って、新しいプロジェクトにドライバー JAR を追加します。

新規プロジェクトを作成します。プロジェクトタイプとして Java Project を選択し、Next をクリックします。プロジェクト名を入力して Finish をクリックします。
プロジェクトを右クリックして Properties をクリックします。Java Build Path をクリックし、Libraries タブを開きます。
Add External JARs をクリックして、インストールディレクトリの lib サブフォルダにある cdata.jdbc.api.jar ライブラリを追加します。

Hibernate 設定ファイルの追加

以下の手順に従って、Spotify のデータへの接続プロパティを設定します。

新規プロジェクトを右クリックし、New -> Hibernate -> Hibernate Configuration File (cfg.xml) を選択します。
src を親フォルダとして選択し、Next をクリックします。
以下の値を入力します:
- Hibernate version:: 5.2
- Database dialect: Derby
- Driver class: cdata.jdbc.api.APIDriver
- Connection URL: JDBC URL です。jdbc:api: から始まり、セミコロン区切りの接続プロパティが続きます。
  
  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
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  一般的な JDBC URL は以下のとおりです:
```
jdbc:api:Profile=C:\profiles\Spotify.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=http://localhost:33333;
```

Hibernate から Spotify のデータに接続

以下の手順に従って、前のステップで作成した設定を選択します。

Hibernate Configurations パースペクティブに切り替えます: Window -> Open Perspective -> Hibernate。
Hibernate Configurations パネルを右クリックし、Add Configuration をクリックします。
Hibernate version を 5.2 に設定します。
Browse ボタンをクリックし、プロジェクトを選択します。
Configuration file フィールドで、Setup -> Use Existing をクリックし、hibernate.cfg.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
Classpath タブで、User Entries の下に何もない場合は、Add External JARS をクリックしてドライバー jar を再度追加します。設定が完了したら OK をクリックします。
新しく作成した Hibernate 設定ファイルの Database ノードを展開します。

Spotify のデータのリバースエンジニアリング

以下の手順に従って、reveng.xml 設定ファイルを生成します。オブジェクトとしてアクセスするテーブルを指定します。

Package Explorer に戻ります。
プロジェクトを右クリックし、New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml) を選択します。Next をクリックします。
src を親フォルダとして選択し、Next をクリックします。
Console configuration ドロップダウンメニューで、上記で作成した Hibernate 設定ファイルを選択し、Refresh をクリックします。
ノードを展開し、リバースエンジニアリングするテーブルを選択します。完了したら Finish をクリックします。

Hibernate の実行設定

以下の手順に従って、Spotify テーブルの POJO（Plain Old Java Object）を生成します。

メニューバーから、Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations をクリックします。
Console configuration ドロップダウンメニューで、前のセクションで作成した Hibernate 設定ファイルを選択します。Output directory の横にある Browse をクリックし、src を選択します。
Reverse Engineer from JDBC Connection チェックボックスを有効にします。Setup ボタンをクリックし、Use Existing をクリックして、hibernate.reveng.xml ファイルの場所（このデモでは src フォルダ内）を選択します。
Exporters タブで、Domain code (.java) と Hibernate XML Mappings (hbm.xml) をチェックします。
Run をクリックします。

前のステップのリバースエンジニアリング設定に基づいて、1 つ以上の POJO が作成されます。

マッピングタグの挿入

生成した各マッピングに対して、hibernate.cfg.xml にマッピングタグを作成し、Hibernate がマッピングリソースを参照できるようにする必要があります。hibernate.cfg.xml を開き、以下のようにマッピングタグを挿入します:





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

SQL の実行

前のステップで作成したエンティティを使用して、Spotify のデータのデータの検索が可能になります:


import java.util.*;
import org.hibernate.Session;
import org.hibernate.cfg.Configuration;
import org.hibernate.query.Query;

public class App {
  public static void main(final String[] args) {
    Session session =  new
    Configuration().configure().buildSessionFactory().openSession();
    String SELECT = "FROM Albums A WHERE Id = :Id";
    Query q = session.createQuery(SELECT, Albums.class);
    q.setParameter("Id","4aawyAB9vmqN3uQ7FjRGTy");
    List<Albums> resultList = (List<Albums>) q.list();

    for(Albums s: resultList){
      System.out.println(s.get());
      System.out.println(s.get());
    }
  }
}

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

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

Spotify に接続

CData は、AI を本番環境で機能させるデータレイヤーです。数百の主要エンタープライズソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ

Java で Spotify のデータエンティティのオブジェクトリレーショナルマッピング（ORM）を行う

Hibernate のインストール

新規プロジェクトの作成

Hibernate 設定ファイルの追加

OAuth 認証の設定

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

接続プロパティ

接続文字列の例

利用可能な OAuth スコープ

組み込みの接続文字列デザイナー

Hibernate から Spotify のデータに接続

Spotify のデータのリバースエンジニアリング

Hibernate の実行設定

マッピングタグの挿入

SQL の実行

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

この記事の内容

関連記事

Java で Spotify のデータ エンティティのオブジェクト リレーショナル マッピング（ORM）を行う

Hibernate のインストール

新規プロジェクトの作成

Hibernate 設定ファイルの追加

OAuth 認証の設定

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

接続プロパティ

接続文字列の例

利用可能な OAuth スコープ

組み込みの接続文字列デザイナー

Hibernate から Spotify のデータ に接続

Spotify のデータ のリバースエンジニアリング

Hibernate の実行設定

マッピングタグの挿入

SQL の実行

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

この記事の内容

関連記事

Java で Spotify のデータエンティティのオブジェクトリレーショナルマッピング（ORM）を行う

Hibernate から Spotify のデータに接続

Spotify のデータのリバースエンジニアリング