各製品の資料を入手。
詳細はこちら →Adobe Commerce Data Provider の30日間無償トライアルをダウンロード
30日間の無償トライアルへ
CData
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
この記事では、Visual Studio のウィザードを使って簡単なMVC（モデル・ビュー・コントローラ）プロジェクトを作成し、Entity Framework のメソッドを使うAdobe Commerce にcreate, read, update, delete (CRUD) コマンドクエリを実行する方法を説明します。
下記の手順に従って接続プロパティを保存し、データモデルのエンティティにテーブルをマップします。
必要な接続文字列プロパティを指定します。
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" に設定します。
一般的な接続文字列は次のとおりです。
OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myadobecommercehost.com;
接続に名前を付け、資格情報などのセンシティブ情報を接続文字列に含めるかどうかを選択します。簡略化のため、この例ではセンシティブ情報をWeb.config に保存しています。
モデルの作成とプロジェクトのビルドが終わったら、以下の手順に従ってコントローラー、ビュー、および関連するCRUD メソッドを作成できます。 Products テーブルに許可されたすべてのアクションのビューは、［Views］フォルダ内のProducts サブフォルダに.cshtml ファイルとして格納されます。
［ソリューション エクスプローラー］で［Controllers］フォルダを右クリックし、［追加］>［コントローラー］をクリックします。コントローラーにAdobeCommerceController のような名前を付け、以下のオプションを設定します。
これで、プロジェクトを実行できます。［Index］ビューにアクセスするには、"AdobeCommerce" をURL に追加します。 ［Create New］をクリックして［Create view］を選択すると、自動生成されたフォームを含むビューが作成されます。各レコードの隣にあるEdit およびDelete links をクリックして、対応するEdit またはDelete ビューを表示します。
このセクションでは、ほんの数行のコードでCRUD コマンドクエリをインプリメントする方法について説明します。利用可能なウィザードは、各ステップで詳しく説明します。
このチュートリアルを始める前に、エンティティデータモデルを作成しておいてください。Adobe Commerce へのコマンドを実行するために、コンテキストクラスのメソッドを使用していきます。［Entity Framework Data Model］ウィザードを使ってモデルを作成する方法については、前のセクションをご参照ください。 — これはモデルファーストアプローチです。 コードファーストアプローチの利用に関する詳細は、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。
以下のコードを追加し、コンテキストクラスをクラス変数としてインスタンスを生成します。この簡単な例では、コントローラーはコンテキストクラスのメソッドを直接呼び出してCRUD コマンドを実行します。
private AdobeCommerceEntities db = new AdobeCommerceEntities();
レコードのリストをビューに表示するには、Index メソッドを以下のように書き換えます。このコードは、コンテキストクラスのToList() メソッドを呼び出して、レコードテーブルを表示するビューを返します。デフォルトでは、Index メソッドは空のビューを返します。
public ActionResult Index() { return View(db.Products.ToList()); }
ビューを作成するには、Index メソッド内を右クリックし、［Add View］をクリックします。ウィザードが表示されたら新しいビューIndex.cshtml を作成します。作成されたビューは［Views］フォルダに格納されます。このビューをロードするには、.cshtml ファイルを右クリックして［View In Page Inspector］をクリックします。
［Add View］ダイアログでビューに名前を付け、以下のオプションを設定します：
レコードを作成するには、フォームにユーザーが送ったProducts エンティティを受け取るビューを作成しておく必要があります。以下の手順に従って、create アクションをインプリメントします。
以下のコードを追加して、Entity Framework 経由で新しいレコードを追加します。次のサンプルコードでは、コンテキストのAdd およびSaveChanges メソッドは、レコードを挿入するために呼び出されます。
[HttpPost] public ActionResult Create(Products products) {
try {
db.Products.Add(products);
db.SaveChanges();
return RedirectToAction("Index");
} catch { return View(); }
}
Create アクションのために追加する必要があるビューは１つだけです。新しいビューCreate.cshtml は、Index.cshtml と並んでViews のAdobe Commerce サブフォルダに追加されます。どちらかのCreate メソッド内を右クリックし、［Add］>［View］をクリックします。［Add View］ダイアログが表示されたら、以下のオプションを設定します。
Adobe Commerce 内のレコードを編集するには、Create メソッド同様に、ビューから入力された値を受け取りデータソースにコマンドを実行する必要があります。さらに、Edit アクションのもう一つのアスペクトも定義が必要です：コントローラーのEdit メソッドで、コンテキストを変更されたエンティティの状態に更新します。これら3つのステップを以下に示します。
最初のEdit メソッドをオーバーライドして、コードを次のように書き換えます。ユーザーがProducts のEdit link をクリックすると、このメソッドは選択されたProducts エンティティをビューに送り、フォーム内での修正が可能になります。
public ActionResult Edit(int id) { return View(db.Products.Find(id)); }
以下のサンプルコードで、2つ目のEdit メソッドをオーバーライドします。HttpPost 属性によってアノテーションされると、このメソッドはユーザーがフォームの変更を送信するときにビューからデータを受け取ります。
送信された値がProducts レコードの更新に使える値である場合は、Adobe Commerce はSaveChanges メソッドが呼び出されたときに更新されます。提供されたデータ型が正しくないなど、送信された値が有効でない場合は、それらはフォームに再表示されます。
最初のEdit メソッドで作成したビューは、フォームを表示します。Edit ビューは、エラーメッセージを表示するHtml.ValidationMessageFor helper も含みます。
[HttpPost] public ActionResult Edit(Products products) {
if (ModelState.IsValid) {
db.Entry(products).State = EntityState.Modified;
db.SaveChanges();
return RedirectToAction("Index");
}
return View(products);
}
以下のコードは、最初のDelete メソッド用のコードで、削除するProducts エンティティのビューを返します。
public ActionResult Delete(string id) {
Products products = db.Products.Find(id);
return View(products);
}
このメソッド内を右クリックし、［Add］>［View］をクリックします。ダイアログが表示されたら、以下の情報を入力します。
ビューを作成したら、DeleteConfirmed メソッドに次のコードを使います。ユーザーから削除を確認するポストバックを受け取ったときにエンティティを削除します。
[HttpPost, ActionName("Delete")] public ActionResult DeleteConfirmed(string id) {
Products products = db.Products.Find(id);
db.Products.Remove(products);
db.SaveChanges();
return RedirectToAction("Index");
}
