製品をチェック

無償トライアル:

無償トライアルへ

製品の情報と無償トライアルへ:

Ponparemall ADO.NET Provider

在庫、商品、受注などのPonparemall アカウントデータを組み込んだ強力な.NET アプリケーションを迅速に作成して配布できます。

データ連携でお困りですか?

お問い合わせ

Ponparemall とのデータ連携ができるMVC アプリケーションの作成


この記事では、Ponparemall にデータ接続して、MVC Web アプリケーションでクエリを実行する方法を説明します。


加藤龍彦
ウェブデベロッパー

ponparemall ロゴ画像

ADO.NET Adapter

ado ロゴ画像
Entity Framework ロゴ画像


この記事では、Visual Studio のウィザードを使って簡単なMVC(モデル・ビュー・コントローラ)プロジェクトを作成し、Entity Framework のメソッドを使うPonparemall にcreate, read, update, delete (CRUD) コマンドクエリを実行する方法を説明します。

Entity Framework Model の作成

下記の手順に従って接続プロパティを保存し、データモデルのエンティティにテーブルをマップします。

  1. Entity Framework 6 をお使いの場合は、あらかじめプロジェクトに Ponparemall Entity Framework プロバイダーを登録してください。詳しくは、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。
  2. Visual Studio で新規MVC プロジェクトを作成[Internet Application]テンプレート、[Razor]ビューエンジンを選択します。この例では、プロジェクト名はMvcPonparemallApp です。
  3. デザイナーから.edmx ファイルを追加するには、[プロジェクト]>[新しい項目の追加]をクリックします。ADO.NET Entity Data Model を選択してモデルに名前を付けたら[追加]をクリックします。この例では、モデル名はPonparemallModel です。
  4. [Entity Data Model]ウィザードで、[EF Designer from database]オプションを選択します。[Entity Data Model]ウィザードが表示されます。
  5. [New Connection]をクリックします。ダイアログが表示されたらCData Ponparemall データソースを選択します。
  6. 必要な接続文字列プロパティを指定します。

    Ponparemall に接続するには、ShopUrl、InventoryUserId、InventoryPassword、OrderUserId、OrderPassword、PaymentUserId、およびPaymentPassword が必要です。

    Ponparemall へのアクセスの設定

    Ponparemall には各API のId とPassword が必要です。取得するには、以下の手順に従ってください。

    • Ponparemall Manager にログインし、メニューの「各種申請」の「WebAPI利用申請」をクリックします。
    • Web API メニューの「WebAPIサービス利用申請」をクリックし、利用申請を行います。
    • 後日、Ponparemall から必要なId とPassword が送られてきます。

    Ponparemall アカウントの認証

    次の接続プロパティを設定して接続します。

    • ShopUrl:接続先のPonparemall Shop URL を設定。「http://storetst4.ponparemall.com/sample/」に含まれる「sample」の部分を入力します。
    • InventoryUserId:「在庫API」のユーザID を設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
    • InventoryPassword:「在庫API」のパスワードを設定。このプロパティは、Inventory テーブルにアクセスする場合に必要です。
    • OrderUserId:「受注API」のユーザID を設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
    • OrderPassword:「受注API」のパスワードを設定。このプロパティは、Orders テーブルにアクセスする場合に必要です。
    • PaymentUserId:「決済API」のユーザID を設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。
    • PaymentPassword:「決済API」のパスワードを設定。このプロパティは、Payments テーブルにアクセスする場合に必要です。

    一般的な接続文字列は次のとおりです。

    InventoryUserId=Inventory UserId;InventoryPassword=Invetory Password;The connection for the model. (QuickBooks is shown.)
  7. 接続に名前を付け、資格情報などのセンシティブ情報を接続文字列に含めるかどうかを選択します。簡略化のため、この例ではセンシティブ情報をWeb.config に保存しています。

    The completed connection step in the ADO.NET Entity Data Model wizard. (A QuickBooks connection is shown.)
  8. 必要なテーブルおよびビューを選択します。ここでは、Orders をインポートしています。また、オブジェクト名を複数形に変換するオプションは、チェックをはずしています。[Finish]をクリックして.edmx ファイルを作成します。Tables to be imported into the .edmx file. (QuickBooks is shown.)
  9. プロジェクトをビルドして完成です。

コントローラーの作成およびメソッドとビューの生成

モデルの作成とプロジェクトのビルドが終わったら、以下の手順に従ってコントローラー、ビュー、および関連するCRUD メソッドを作成できます。 Orders テーブルに許可されたすべてのアクションのビューは、[Views]フォルダ内のOrders サブフォルダに.cshtml ファイルとして格納されます。

[ソリューション エクスプローラー]で[Controllers]フォルダを右クリックし、[追加]>[コントローラー]をクリックします。コントローラーにPonparemallController のような名前を付け、以下のオプションを設定します。

  • Template:次のオプションを選択します:'Controller with read/write actions, using Entity Framework'.
  • Model class:Orders を選択。
  • Data context class:PonparemallEntities を選択。
Creating a new Controller from an existing entity data model in the Add Controller dialog. (QuickBooks is shown.)

これで、プロジェクトを実行できます。[Index]ビューにアクセスするには、"Ponparemall" をURL に追加します。 [Create New]をクリックして[Create view]を選択すると、自動生成されたフォームを含むビューが作成されます。各レコードの隣にあるEdit およびDelete links をクリックして、対応するEdit またはDelete ビューを表示します。

The Index view of the example MVC Web application. (QuickBooks is shown.)

一からコントローラーを作成

このセクションでは、ほんの数行のコードでCRUD コマンドクエリをインプリメントする方法について説明します。利用可能なウィザードは、各ステップで詳しく説明します。

このチュートリアルを始める前に、エンティティデータモデルを作成しておいてください。Ponparemall へのコマンドを実行するために、コンテキストクラスのメソッドを使用していきます。[Entity Framework Data Model]ウィザードを使ってモデルを作成する方法については、前のセクションをご参照ください。 — これはモデルファーストアプローチです。 コードファーストアプローチの利用に関する詳細は、ヘルプドキュメントの「LINQ およびEntity Framework」をご参照ください。

  1. 次の例のPonparemallController のようにコントローラーを手動で作成するには、[ソリューション エクスプローラー]で[Controllers]フォルダを右クリックし、[追加]>[コントローラー]をクリックします。
  2. [Add Controller]ダイアログが表示されたら、[Template]メニューから'Controller with empty read/write actions' オプションを選択します。[Controller]フォルダ内にPonparemallController.cs が作成されます。
The Add Controller dialog with the selected template, Controller with empty read/write actions. (QuickBooks is shown.)

コンテキストの作成

以下のコードを追加し、コンテキストクラスをクラス変数としてインスタンスを生成します。この簡単な例では、コントローラーはコンテキストクラスのメソッドを直接呼び出してCRUD コマンドを実行します。

private PonparemallEntities db = new PonparemallEntities();

Ponparemall データエンティティの取得

レコードのリストをビューに表示するには、Index メソッドを以下のように書き換えます。このコードは、コンテキストクラスのToList() メソッドを呼び出して、レコードテーブルを表示するビューを返します。デフォルトでは、Index メソッドは空のビューを返します。

public ActionResult Index() { return View(db.Orders.ToList()); }

ビューを作成するには、Index メソッド内を右クリックし、[Add View]をクリックします。ウィザードが表示されたら新しいビューIndex.cshtml を作成します。作成されたビューは[Views]フォルダに格納されます。このビューをロードするには、.cshtml ファイルを右クリックして[View In Page Inspector]をクリックします。

[Add View]ダイアログでビューに名前を付け、以下のオプションを設定します:

  • Create a strongly typed view:このオプションを選択し、Orders タイプのビューを作成。
  • Model class:Orders エンティティ、Orders を選択。
  • Scaffold template:[List]を選択。このメニューオプションは、エンティティを表示するHTML テーブルを生成します。
Settings for an Index view. (QuickBooks is shown.)

Ponparemall Data エンティティの作成

レコードを作成するには、フォームにユーザーが送ったOrders エンティティを受け取るビューを作成しておく必要があります。以下の手順に従って、create アクションをインプリメントします。

  1. HttpPost 属性をアノテーションする2つ目のCreate メソッドをオーバーライドします。このメソッドは、ユーザーがsubmits it back したときにデータを処理します。最初のメソッドはフォームを表示するだけなので、この動作をオーバーライドする必要はありません。
  2. デフォルトでインプットされたFormCollection を、ユーザーに作成を許可したいPonparemall エンティティのタイプに置き換えます。
  3. 以下のコードを追加して、Entity Framework 経由で新しいレコードを追加します。次のサンプルコードでは、コンテキストのAdd およびSaveChanges メソッドは、レコードを挿入するために呼び出されます。

    [HttpPost] public ActionResult Create(Orders orders) { try { db.Orders.Add(orders); db.SaveChanges(); return RedirectToAction("Index"); } catch { return View(); } }

Create アクションのために追加する必要があるビューは1つだけです。新しいビューCreate.cshtml は、Index.cshtml と並んでViews のPonparemall サブフォルダに追加されます。どちらかのCreate メソッド内を右クリックし、[Add]>[View]をクリックします。[Add View]ダイアログが表示されたら、以下のオプションを設定します。

  • Create a strongly typed view:このオプションを選択し、Orders タイプのビューを作成。
  • Model class:Orders エンティティを選択。
  • Scaffold template:[Create]を選択し、フォーム用にHTML を生成。
Settings for a Create view. (QuickBooks is shown.)

Ponparemall データエンティティの編集および保存

Ponparemall 内のレコードを編集するには、Create メソッド同様に、ビューから入力された値を受け取りデータソースにコマンドを実行する必要があります。さらに、Edit アクションのもう一つのアスペクトも定義が必要です:コントローラーのEdit メソッドで、コンテキストを変更されたエンティティの状態に更新します。これら3つのステップを以下に示します。

  1. 最初のEdit メソッドをオーバーライドして、コードを次のように書き換えます。ユーザーがOrders のEdit link をクリックすると、このメソッドは選択されたOrders エンティティをビューに送り、フォーム内での修正が可能になります。

    public ActionResult Edit(int id) { return View(db.Orders.Find(id)); }
  2. 最初のEdit メソッドを右クリックし、[Add]>[View]をクリックします。Create アクション同様、必要なEdit ビューは1つだけです。ウィザードが表示されたら、以下のオプションを設定します:
    • Create a strongly typed view:このオプションを選択し、Orders タイプのビューを作成。Orders を選択。
    • Model class:Orders エンティティを選択。
    • Scaffold template:[Edit]を選択し、フォーム用にHTML を生成。
  3. 以下のサンプルコードで、2つ目のEdit メソッドをオーバーライドします。HttpPost 属性によってアノテーションされると、このメソッドはユーザーがフォームの変更を送信するときにビューからデータを受け取ります。

    送信された値がOrders レコードの更新に使える値である場合は、Ponparemall はSaveChanges メソッドが呼び出されたときに更新されます。提供されたデータ型が正しくないなど、送信された値が有効でない場合は、それらはフォームに再表示されます。

    最初のEdit メソッドで作成したビューは、フォームを表示します。Edit ビューは、エラーメッセージを表示するHtml.ValidationMessageFor helper も含みます。

    [HttpPost] public ActionResult Edit(Orders orders) { if (ModelState.IsValid) { db.Entry(orders).State = EntityState.Modified; db.SaveChanges(); return RedirectToAction("Index"); } return View(orders); }
Settings for an Edit view. (QuickBooks is shown.)

Ponparemall データエンティティの削除

以下のコードは、最初のDelete メソッド用のコードで、削除するOrders エンティティのビューを返します。

public ActionResult Delete(string id) { Orders orders = db.Orders.Find(id); return View(orders); }

このメソッド内を右クリックし、[Add]>[View]をクリックします。ダイアログが表示されたら、以下の情報を入力します。

  • Create a strongly typed view:このオプションを選択し、Orders タイプのビューを作成。
  • Model class:Orders エンティティを選択。
  • Scaffold template:[Delete]を選択し、フォーム用にHTML を生成。
Settings for the HTTP GET Delete method. (QuickBooks is shown.)

ビューを作成したら、DeleteConfirmed メソッドに次のコードを使います。ユーザーから削除を確認するポストバックを受け取ったときにエンティティを削除します。

[HttpPost, ActionName("Delete")] public ActionResult DeleteConfirmed(string id) { Orders orders = db.Orders.Find(id); db.Orders.Remove(orders); db.SaveChanges(); return RedirectToAction("Index"); }