各製品の資料を入手。
詳細はこちら →
製品をチェック
JDBI からAdobe Commerce データ のデータアクセスオブジェクトを作成
JDBI でAdobe Commerce のデータ 用のSQL オブジェクトAPIを作成する方法を概説します。
最終更新日：2022-05-25
この記事で実現できるAdobe Commerce 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
JDBI は、Fluent スタイルとSQL オブジェクトスタイルという2つの異なるスタイルAPI を公開する、Java 用のSQL コンビニエンスライブラリです。CData JDBC Driver for AdobeCommerce は、Java アプリケーションとリアルタイムAdobe Commerce のデータ のデータ連携を実現します。これらの技術を組み合わせることによって、Adobe Commerce のデータ へのシンプルなコードアクセスが可能になります。ここでは、基本的なDAO（Data Access Object ）とそれに付随するAdobe Commerce のデータ の読み書きのためのコードの作成について説明します。
Adobe Commerce Products Entity のDAO を作成
以下のインターフェースは、実装されるSQL ステートメントごとに単一のメソッドを作成するためのSQL オブジェクトの正しい動作を宣言します。
public interface MyProductsDAO {
//insert new data into Adobe Commerce
@SqlUpdate("INSERT INTO Products (Style, Price) values (:style, :price)")
void insert(@Bind("style") String style, @Bind("price") String price);
//request specific data from Adobe Commerce (String type is used for simplicity)
@SqlQuery("SELECT Price FROM Products WHERE Style = :style")
String findPriceByStyle(@Bind("style") String style);
/*
* close with no args is used to close the connection
*/
void close();
}
Adobe Commerce への接続を開く
必要な接続プロパティを収集し、Adobe Commerce に接続するための適切なJDBC URL を作成します。
Adobe Commerce はOAuth 1 認証標準を使用します。Adobe Commerce REST API に接続するには、Adobe Commerce システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。
また、Adobe Commerce システムへのURL を提供する必要があります。URL は、Adobe Commerce REST API を顧客として使用しているか管理者として使用しているかによって異なります。
-
Customer: Adobe Commerce を顧客として使用するには、事前にAdobe Commerce のホームページで顧客アカウントを作成します。これを行うには、「アカウント」->「登録」をクリックします。それからURL 接続プロパティをAdobe Commerce システムのエンドポイントに設定します。
-
Administrator: Adobe Commerce を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、「Admin」メニューの「Advanced」設定で取得できます。「System」->「Configuration」->「Advanced」->「Admin」->「Admin Base URL」を選択することでアクセスできます。
このページ上の「Use Custom Admin Path」設定がYES に設定されている場合、値は「Custom Admin Path」テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。
ビルトイン接続文字列デザイナー
JDBC URL の構成については、Adobe Commerce JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルのダブルクリック、またはコマンドラインからJAR ファイルを実行します。
java -jar cdata.jdbc.adobecommerce.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Adobe Commerce の接続文字列は、通常次のようになります。
jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;InitiateOAuth=GETANDREFRESH
構成済みのJDBC URL を使用して、DAO インターフェースのインスタンスを取得します。以下に示す特定のメソッドはインスタンスにバインドされたハンドルを開くため、ハンドルとバインドされたJDBC 接続を開放するには、インスタンスを明示的に閉じる必要があります。
DBI dbi = new DBI("jdbc:adobecommerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;InitiateOAuth=GETANDREFRESH");
MyProductsDAO dao = dbi.open(MyProductsDAO.class);
//do stuff with the DAO
dao.close();
Adobe Commerce データ について
Adobe Commerce への接続を開いた状態で以前定義したメソッドを呼び出すだけで、Adobe Commerce のProducts エンティティからデータを取得できます。
//disply the result of our 'find' method
String price = dao.findPriceByStyle("High Tech");
System.out.println(price);
Adobe Commerce データ の書き方
以前定義した方法を使用すれば、Adobe Commerce にデータを書き込むことも簡単になります。
//add a new entry to the Products entity
dao.insert(newStyle, newPrice);
JDBI ライブラリはJDBC 接続を処理できるため、CData JDBC Driver for AdobeCommerce と統合することで、SQL Object API for AdobeCommerce を簡単に作成できます。今すぐ無料トライアルをダウンロードし、Java アプリケーションでリアルタイムAdobe Commerce を操作しましょう。
関連コンテンツ
