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

加藤龍彦
デジタルマーケティング

JDBI でShopify のデータ用のSQL オブジェクトAPIを作成する方法を概説します。

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

Shopify Customers Entity のDAO を作成

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

public interface MyCustomersDAO {
  //insert new data into Shopify
  @SqlUpdate("INSERT INTO Customers (FirstName, Id) values (:firstName, :id)")
  void insert(@Bind("firstName") String firstName, @Bind("id") String id);

  //request specific data from Shopify (String type is used for simplicity)
  @SqlQuery("SELECT Id FROM Customers WHERE FirstName = :firstName")
  String findIdByFirstName(@Bind("firstName") String firstName);

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

Shopify への接続を開く

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

それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

アクセストークンによる接続

アクセストークン経由の接続には、以下の2つのステップが必要です。

Shopify の管理画面でアクセストークンを作成
アクセストークンを使用して認証

アクセストークンの作成

まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
Develop apps をクリックしてCreate an app を選択します
Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
Save をクリックします
Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
- unauthenticated_read_content
Save をクリックします
API Credentials を選択します
"Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

アクセストークンによる認証

続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

AuthScheme：AccessToken に設定
AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

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

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

java -jar cdata.jdbc.shopify.jar

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

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

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

jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;

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

DBI dbi = new DBI("jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;");
MyCustomersDAO dao = dbi.open(MyCustomersDAO.class);

//do stuff with the DAO

dao.close();

Shopify データについて

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

//disply the result of our 'find' method
String id = dao.findIdByFirstName("jdoe1234");
System.out.println(id);

Shopify データの書き方

以前定義した方法を使用すれば、Shopify にデータを書き込むことも簡単になります。

//add a new entry to the Customers entity
dao.insert(newFirstName, newId);

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