各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からSquare データ のデータアクセスオブジェクトを作成
JDBI でSquare のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるSquare 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Square は、Java アプリケーションとリアルタイムSquare のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Square のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するSquare のデータ の読み書きのためのコードの作成について説明します。
Square Refunds Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyRefundsDAO {
//insert new data into Square
@SqlUpdate("INSERT INTO Refunds (Type, RefundedMoneyAmount) values (:type, :refundedMoneyAmount)")
void insert(@Bind("type") String type, @Bind("refundedMoneyAmount") String refundedMoneyAmount);
//request specific data from Square (String type is used for simplicity)
@SqlQuery("SELECT RefundedMoneyAmount FROM Refunds WHERE Type = :type")
String findRefundedMoneyAmountByType(@Bind("type") String type);
/*
* close with no args is used to close the connection
*/
void close();
}
Square への接続を開く
必要な接続プロパティを収集し、Square に接続するための適切なJDBC URL を作成します。
Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。
追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Square JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.square.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Square の接続文字列は、通常次のようになります。
jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;InitiateOAuth=GETANDREFRESH");
MyRefundsDAO dao = dbi.open(MyRefundsDAO.class);
//do stuff with the DAO
dao.close();
Square データ について
Square への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Square のRefunds エンティティからデータを取得できます。
//disply the result of our 'find' method
String refundedMoneyAmount = dao.findRefundedMoneyAmountByType("FULL");
System.out.println(refundedMoneyAmount);
Square データ の書き方
以前定義した方法を使用すれば、Square にデータを書き込むことも簡単になります。
//add a new entry to the Refunds entity
dao.insert(newType, newRefundedMoneyAmount);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Square と統合することで、SQL Object API for Square を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムSquare を操作しましょう。
関連コンテンツ
