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

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

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

Gumroad CustomFields Entity のDAO を作成

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


public interface MyCustomFieldsDAO {
  //request specific data from Gumroad (String type is used for simplicity)
  @SqlQuery("SELECT  FROM CustomFields WHERE ProductId = :productId")
  String findByProductId(@Bind("productId") String productId);

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

Gumroad への接続を開く

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

OAuth 認証の設定

Gumroad への認証では、OAuth 2.0 標準を使って自分自身のデータに接続する場合はもちろん、他のユーザーが各自のデータに接続できるようにする場合にも利用できます。これが推奨される認証方式です。

まず、Gumroad に OAuth アプリケーションを登録する必要があります。https://app.gumroad.com/settings/advanced の Gumroad アカウント設定にアクセスし、Applications セクションに移動して OAuth アプリケーションを作成できます。

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

  • AuthScheme:OAuth に設定します。
  • InitiateOAuth:GETANDREFRESH に設定します。CData API Profile for Gumroad が OAuth プロセスを自動的に進め、アクセストークンを取得します。
  • OAuthClientID:アプリ設定で指定された client_id に設定します。
  • OAuthClientSecret:アプリ設定で指定された client_secret に設定します。
  • CallbackURL:アプリ設定で指定したリダイレクト URI に設定します。

接続文字列の例

Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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

JDBC URL の構成については、Gumroad 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.)

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

jdbc:api:Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

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


DBI dbi = new DBI("jdbc:api:Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;");
MyCustomFieldsDAO dao = dbi.open(MyCustomFieldsDAO.class);

//do stuff with the DAO

dao.close();

Gumroad データについて

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


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

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

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

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

Gumroad に接続