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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

Entity Framework Model の作成

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

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

6. 必要な接続文字列プロパティを指定します。

   UM SaaS Cloud 接続プロパティの取得・設定方法

   デフォルトでは、本製品は本番環境に接続します。UMSaaSCloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。ユーザー / パスワード認証を使用している場合は、User にsandbox のユーザー名を設定してください。

   UM SaaS Cloud への認証

   UM SaaS Cloud は、Basic、OAuth、OAuthJWT（コンシューマーキー）など、複数の認証方式をサポートしています。ここではBasic 認証について説明します。認証情報の詳しい取得方法や他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

   Basic 認証

   Basic 認証は、セキュリティトークンとユーザー資格情報の使用に基づきます。Basic 認証を使用するには、AuthScheme をBasic に、User とPassword をログイン資格情報に設定し、SecurityToken を設定します。

   デフォルトではSecurityToken が必要ですが、UM SaaS Cloud で信頼できるIP アドレスの範囲を設定することで、オプションにすることができます。

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

   AuthScheme=Basic;User=myUser;Password=myPassword;Security Token=myToken;

7. 接続に名前を付け、資格情報などのセンシティブ情報を接続文字列に含めるかどうかを選択します。簡略化のため、この例ではセンシティブ情報をWeb.config に保存しています。

   
8. 必要なテーブルおよびビューを選択します。ここでは、Account をインポートしています。また、オブジェクト名を複数形に変換するオプションは、チェックをはずしています。［Finish］をクリックして.edmx ファイルを作成します。
9. プロジェクトをビルドして完成です。

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

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

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

• Template：次のオプションを選択します：'Controller with read/write actions, using Entity Framework'.
• Model class：Account を選択。
• Data context class：UMSaaSCloudEntities を選択。

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

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

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

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

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

コンテキストの作成

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

UM SaaS Cloud のデータエンティティの取得

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

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

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

• Create a strongly typed view：このオプションを選択し、Account タイプのビューを作成。
• Model class：Account エンティティ、Account を選択。
• Scaffold template：［List］を選択。このメニューオプションは、エンティティを表示するHTML テーブルを生成します。

UM SaaS Cloud データ エンティティの作成

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

1. HttpPost 属性をアノテーションする2つ目のCreate メソッドをオーバーライドします。このメソッドは、ユーザーがsubmits it back したときにデータを処理します。最初のメソッドはフォームを表示するだけなので、この動作をオーバーライドする必要はありません。
2. デフォルトでインプットされたFormCollection を、ユーザーに作成を許可したいUM SaaS Cloud エンティティのタイプに置き換えます。

3. 以下のコードを追加して、Entity Framework 経由で新しいレコードを追加します。次のサンプルコードでは、コンテキストのAdd およびSaveChanges メソッドは、レコードを挿入するために呼び出されます。

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

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

• Create a strongly typed view：このオプションを選択し、Account タイプのビューを作成。
• Model class：Account エンティティを選択。
• Scaffold template：［Create］を選択し、フォーム用にHTML を生成。

UM SaaS Cloud のデータエンティティの編集および保存

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

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

   public ActionResult Edit(int id) { return View(db.Account.Find(id)); }
2. 最初のEdit メソッドを右クリックし、［Add］>［View］をクリックします。Create アクション同様、必要なEdit ビューは1つだけです。ウィザードが表示されたら、以下のオプションを設定します：
   • Create a strongly typed view：このオプションを選択し、Account タイプのビューを作成。Account を選択。
   • Model class：Account エンティティを選択。
   • Scaffold template：［Edit］を選択し、フォーム用にHTML を生成。

3. 以下のサンプルコードで、2つ目のEdit メソッドをオーバーライドします。HttpPost 属性によってアノテーションされると、このメソッドはユーザーがフォームの変更を送信するときにビューからデータを受け取ります。

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

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

   [HttpPost] public ActionResult Edit(Account account) { if (ModelState.IsValid) { db.Entry(account).State = EntityState.Modified; db.SaveChanges(); return RedirectToAction("Index"); } return View(account); }

UM SaaS Cloud のデータエンティティの削除

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

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

• Create a strongly typed view：このオプションを選択し、Account タイプのビューを作成。
• Model class：Account エンティティを選択。
• Scaffold template：［Delete］を選択し、フォーム用にHTML を生成。

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