JDBI からスマレジ データのデータアクセスオブジェクトを作成
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for Smaregi は、Java アプリケーションとリアルタイムスマレジ のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、スマレジ のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO(Data Access Object )とそれに付随するスマレジ のデータ の読み書きのためのコードの作成について説明します。
スマレジ Products Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyProductsDAO {
//insert new data into スマレジ
@SqlUpdate("INSERT INTO Products (ProductId, Description) values (:productId, :description)")
void insert(@Bind("productId") String productId, @Bind("description") String description);
//request specific data from スマレジ (String type is used for simplicity)
@SqlQuery("SELECT Description FROM Products WHERE ProductId = :productId")
String findDescriptionByProductId(@Bind("productId") String productId);
/*
* close with no args is used to close the connection
*/
void close();
}
スマレジ への接続を開く
必要な接続プロパティを収集し、スマレジ に接続するための適切なJDBC URL を作成します。
スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。
- スマレジにログイン後、「設定」->「システム連携」->「スマレジAPI 設定」に移動します。
- 「API受信設定」セクションにある「受信機能を利用する」を「利用する」に変更し、「アクセストークンの生成」をクリックし、AccessToken を取得します。
- 次に必要なAPI アクセスを有効にするため、「機能設定」セクションで必要な機能を「利用する」に変更します。
ContractId: アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken: 受信設定セクションのアクセストークン。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、スマレジ JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.smaregi.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
スマレジ の接続文字列は、通常次のようになります。
jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:smaregi:ContractId=mycontractid;AccessToken=myaccesstoken;");
MyProductsDAO dao = dbi.open(MyProductsDAO.class);
//do stuff with the DAO
dao.close();
スマレジ データについて
スマレジ への接続を開いた状態で以前定義したメソッドを呼び出すだけで、スマレジ のProducts エンティティからデータを取得できます。
//disply the result of our 'find' method
String description = dao.findDescriptionByProductId("666666");
System.out.println(description);
スマレジ データの書き方
以前定義した方法を使用すれば、スマレジ にデータを書き込むことも簡単になります。
//add a new entry to the Products entity dao.insert(newProductId, newDescription);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for Smaregi と統合することで、SQL Object API for Smaregi を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムスマレジ を操作しましょう。