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

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Magento JDBC Driver

Magento データ連携のパワフルなJava アプリケーションを素早く作成して配布。



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

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

Magento Products Entity のDAO を作成

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

public interface MyProductsDAO { //insert new data into Magento @SqlUpdate("INSERT INTO Products (Style, Price) values (:style, :price)") void insert(@Bind("style") String style, @Bind("price") String price); //request specific data from Magento (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(); }

Magento への接続を開く

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

Magento はOAuth 1 認証標準を使用します。Magento REST API に接続するには、Magento システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Magento システムへのURL を提供する必要があります。URL は、Magento REST API を顧客として使用しているか管理者として使用しているかによって異なります。

  • Customer: Magento を顧客として使用するには、事前にMagento のホームページで顧客アカウントを作成します。これを行うには、[アカウント]->[登録]をクリックします。それからURL 接続プロパティをMagento システムのエンドポイントに設定します。

  • Administrator: Magento を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、[Admin]メニューの[Advanced]設定で取得できます。[System]->[Configuration]->[Advanced]->[Admin]->[Admin Base URL]を選択することでアクセスできます。

    このページ上の[Use Custom Admin Path]設定がYES に設定されている場合、値は[Custom Admin Path]テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

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

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

java -jar cdata.jdbc.magento.jar

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

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

jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH

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

DBI dbi = new DBI("jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=GETANDREFRESH"); MyProductsDAO dao = dbi.open(MyProductsDAO.class); //do stuff with the DAO dao.close();

Magento Data について

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

//disply the result of our 'find' method String price = dao.findPriceByStyle("High Tech"); System.out.println(price);

Magento Data の書き方

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

//add a new entry to the Products entity dao.insert(newStyle, newPrice);

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