🤐 🚞 👩🏽‍🌾 WinFormsのエンティティフレームワーク。パート1 🕵🏿 ✊🏾 👨🏽‍🎓

エントリー

これらのエンティティをWinFormsコントロールにバインドすることに専念した Bernardo Castilho による記事の翻訳に注目します。 私と同様に、この記事があなたにも役立つことを願っています。

今日、Winformsは依然として多くのデータ指向ビジネスアプリケーションのプラットフォームであり、データバインディングはWinforms開発の不可欠な部分です。データを処理するために標準のADO.NETクラスを使用した場合、DataSetクラスを作成し、それらのクラスをDataSource 、 DataMember、またはBindingプロパティを使用して設計時にバインドするために使用されるツールに精通しています。

悪いニュースは、これらの豊富な開発機能がEntity Frameworkデータソースに適用できないことです。簡単なバインディングでも、コードを書く必要があります。動作する基本的なバインディングを取得するには、少しのコードで十分ですが、慣れている完全なバインディング（自動ソート、フィルタリング、階層バインディングなど）を取得するには、かなりの作業が必要です。

幸いなことに、 EFWinFormsライブラリを使用すると、データバインディングを簡単に実行し、 Winformsでデータバインディング用の再利用可能なコンポーネントを作成できます。ライブラリには2つのコンポーネントがあります。

EntityDataSource ：データエンティティモデルをカプセル化し、その要素をバインディングに適したデータソースとして提示するコンポーネント。開発中に完全にサポートされます。
EntityBindingNavigator ：表示用のナビゲーションを提供し、エントリの追加と削除、データベースへの変更の保存または復帰のためのユーザーインターフェイスを提供するコントロール。

EntityDataSourceコンポーネント

EntityDataSourceコンポーネントは、標準のADO.NETプログラミングでDataSetおよびBindingSourceの役割を果たします。これを使用するには、最初にエンティティデータモデルを作成する必要があります。

その後、 EntityDataSourceコンポーネントをフォームにドラッグし、 ObjectContextタイプのObjectContextTypeプロパティを、Entity Data Modelが提供するコンテキストのいずれかに設定します。（EF6がある場合は、ObjectContextTypeの代わりにDbContextTypeプロパティを使用します）。これを行うと、 EntityDataSourceコンポーネントはコンテキストオブジェクトを作成し、リフレクションを使用して、コンテキストで使用可能なすべてのデータソースを検索します。これらのデータソースは、 IListSource実装を使用してデザイナーに表示されます。

その後、コントロールをフォームに追加し、通常どおりDataSource 、 DataMember 、およびBindingプロパティを使用してそれらをEntityDataSourceに関連付けることができます。 1つのEntityDataSourceは、モデル内のすべてのテーブルとビューへのアクセスを提供し、 SaveChangesメソッドを呼び出すことによってのみ変更を保存します。

例

EntityDataSourceの動作を理解する最良の方法は、いくつかの例を検討することです。次のセクションでは、EntityDataSourceを使用して4つの典型的なデータバインディングシナリオを実装する方法について説明します。すべてのスクリプトは、 Northwindデータベースに基づいた単一のエンティティデータモデルを使用します。

これを使用するには、最初にエンティティデータモデルを作成する必要があります。

エンティティデータモデルの作成

エンティティデータモデルを作成するには、 ソリューションエクスプローラーウィンドウでプロジェクトツリーを右クリックし、[ 追加]を選択します。 新しいアイテム...」

「新しいアイテムの追加」ダイアログボックスが表示されます 。 「ADO.NET Entity Data Model」を選択し、モデルに名前を付けて、フォームの下部にある「追加」ボタンをクリックします。

[ エンティティデータモデルウィザード ]ダイアログボックスが表示されます。このダイアログボックスで、作成するモデル（既存のデータベースから生成されたモデルまたは空のモデル）を選択する必要があります。最初のオプションを選択し、 「次へ」をクリックします。

次のステップは、データベースを選択してモデルを作成することです。既存の接続を選択するか、 「新しい接続」ボタンを使用して新しい接続を作成できます。この例では、Northwind SQL Serverデータベースへの接続を作成します。

データベースファイルは「NorthWnd.mdf」と呼ばれ、例の一部です。データベースを選択すると、ウィザードは、 エンティティデータモデルに含めるテーブル、ビュー、およびストアドプロシージャを選択するよう求めます。この例では、次の図に示すように、すべてのテーブルを選択するだけです。

「完了」ボタンをクリックして、モデルを作成します。プロジェクトに2つの要素が追加されます。XMLを使用した概念モデルを記述するファイル「Model1.edmx」と、データやProductなどのエンティティクラスにアクセスするために使用されるObjectContextを含む生成コードを含む関連する「Model1.Designer.cs」 従業員など

edmxファイルをダブルクリックします。データベーススキーマを突然変更した場合、またはモデルに含める必要のあるテーブルとビューのリストを変更したい場合は、 Entity Data Model Designerウィンドウが表示され、モデルを表示、編集、およびいつでも再作成できます。 Designer.csファイルで自動的に生成されたすべてのクラスは、部分として宣言されます。これにより、データベースからモデルを再作成した場合に変更されない別のファイルにビジネスロジックを追加することで、それらを拡張できます。

これで、以下に示すようにデータモデルを使用できます。

public Form1() { InitializeComponent(); using ( var ctx = new NORTHWNDEntities()) { dataGridView1.DataSource = ctx.Products.ToList(); } }

このコードは、モデルのデータを提供するObjectContextオブジェクトを作成し、すべての製品を含むリストを作成して、リストをテーブルに表示します。 ctx.SaveChanges（）メソッドを呼び出すことにより、製品を編集し、変更をデータベースに保存できます。

コードを実行すると、いくつかの重大な制限があります：データの並べ替えやフィルター処理、リストへのアイテムの追加や削除、そしてもちろん、テーブルエディター（Grid）を使用した開発中のテーブル列（Grid）の構成はできません。

これらの制限は、リストがソースとして使用されるという事実によるものです（単なるデータの「スナップショット」）。 Winformsが自動的に作成するIBindingListは 、この場合、最小限の機能のみを提供します。

グリッドビューの作成（オートルックアップを使用）

これらの欠点を解消するには、 EntityDataSourceコンポーネントをフォームに追加し、[ プロパティ]ウィンドウで、下の図に示すように、そのObjectContextTypeプロパティを「Sample.NORTHWNDEntities」に設定します（注：EF6がある場合は、ObjectContextTypeの代わりにDbContextTypeを使用します）。

EntityDataSourceコンポーネントは、 ObjectContextTypeの値を使用してオブジェクトのコンテキストを作成し、データモデルに記述されているすべての要素のビューを生成します。

次に、 DataGridViewコントロールをフォームに追加し、[ プロパティ]ウィンドウで、以下に示すように、 DataSourceプロパティをentityDataSource1に、 DataMemberプロパティをProductsに設定します。

DataGridViewに列が自動的に作成され、 Productクラスのプロパティが表示されます。デザイナーモードでは、列の順序を変更し、幅、タイトル、配置、形式などを設定できます。

ここでプロジェクトを開始すると、テーブルが自動的に入力され、要素の編集、並べ替え、追加、削除など、必要なすべてのアクションを実行できることがわかります。

EntityDataSourceコンポーネントはEntityBindingListクラスの製品リストをラップするため、これはすべて可能です。このクラスはIBindingListViewインターフェイスを実装し、 アイテムの並べ替え、フィルタリング、追加、削除をサポートします。

変更を保存する

データを編集した後、おそらく変更をデータベースに保存する必要があります。これを行う方法を示すには、フォームに3つのボタンを追加し、 Textプロパティを「保存」、「キャンセル」、および「更新」に設定し、これらのボタンのClickイベントに次のハンドラーをアタッチします。

  // save/cancel/refresh changes in the data source void _btnSave_Click(object sender, EventArgs e) { entityDataSource1.SaveChanges(); } void _btnCancel_Click(object sender, EventArgs e) { entityDataSource1.CancelChanges(); } void _btnRefresh_Click(object sender, EventArgs e) { entityDataSource1.Refresh(); }

このコードは一目瞭然です。最初のボタンは、すべての変更をデータベースに保存します。 2番目はデータを再抽出して変更をキャンセルし、3番目は変更を保存してデータを再度選択します。

忘れられがちな重要な詳細が1つあります。データベースに変更を保存すると、例外が発生する場合があります。たとえば、データベースの整合性制限に違反する変更を保存するとき。残念ながら、このタイプの例外に対処するための一般的なレシピはありません。それらの性質は、データベーススキーマとアプリケーション自体に依存します。

考えられる例外をどのように処理するかに関係なく、最初にすべきことはそれらをキャッチすることです。これを行うには、 SaveChangesメソッドの呼び出しをtry / catchブロックでラップするか、 DataErrorイベントハンドラーをEntityDataSourceコンポーネントに追加します。これは、アプリケーションがデータを保存するときに起こりうるエラーを処理する方法です。

  // report any errors void entityDataSource1_DataError(object sender, DataErrorEventArgs e) { MessageBox.Show("Error Detected:\r\n" + e.Exception.Message); entityDataSource1.CancelChanges(); e.Handled = true; }

コードは警告を発行し、変更を破棄し、HandledパラメーターをTrueに設定して、エラーが既に処理されており、例外をスローする必要がないことを示します。

辞書検索を使用して関連エンティティを表す

この例を終了するために、通常のシナリオを見てみましょう。 Productクラスには、CategoryとSupplierという2つのプロパティがあり、これらは関連するエンティティです。デフォルトでは、これらのプロパティはテーブルに表示されませんが、列エディターを使用して、これらのエンティティの列をテーブルに追加できます。以下の画像は、これを行う方法を示しています。

問題は、DataGridViewが関連するエンティティの表示方法を知らないため、デフォルトでToStringメソッドが使用されるだけで、その結果、セルに「Sample.Category」および「Sample.Supplier」という値が入力される2つの読み取り専用列が得られることです。。

しかし、実際の仕事をするには、仕入先のカテゴリと名前を表示する列が必要です。理想的には、リストから選択してカテゴリと仕入先を変更できるエディタが必要です。これは通常、カスタム列（ DataGridViewコントロールを使用する場合はDataGridViewComboBoxColumn内）を作成してバインドするコードを記述することによって行われます。

なぜならこれは一般的なシナリオであり、 EntityDataSourceコンポーネントは拡張AutoLookupプロパティをサポートします。このプロパティは、フォームに配置されたDataGridViewまたはC1FlexGridコントロールで自動的に使用可能になります（ C1FlexGridでは 、 DataGridViewよりもはるかに高速で洗練された表形式のデータ表示用の一般的なコンポーネントです）。

EntityDataSourceコンポーネントはC1FlexGridをサポートしていますが、EFWinFormsアセンブリはC1FlexGridアセンブリから独立していることに注意してください。これは、実行時にプロパティをバインドするために主にリフレクションに依存するdynamicキーワードを使用することで実現されます。

以下の図は、 DataGridViewで AutoLookupプロパティを有効にする方法を示しています。

AutoLookupプロパティを有効にすると、 EntityDataSourceコンポーネントはテーブル内の列を自動的にスキャンし、エンティティにバインドされた列を、関連するエンティティの可能な値のリストを含む「データマップ」に基づいて編集可能な列に置き換え、それぞれの値を表示します。

次の図は、 AutoLookupプロパティをTrueに設定した結果を示しています。

[カテゴリ]列と[サプライヤ]列にカテゴリ名とサプライヤ名がどのように表示されるか、リストから新しいサプライヤを選択するだけで製品のサプライヤを変更できることに注意してください。

EntityDataSourceがテーブルに表示する関連エンティティから目的のフィールドをどのように選択するのか疑問に思うかもしれません。これは、次のアルゴリズムを使用して行われます。

クラスが（単に継承するだけでなく） ToStringメソッドを実装する場合、 ToString実装を使用してエンティティを表します。
そうではなく、クラスにstring型のプロパティがあり、その名前に「Name」という単語がある場合、このプロパティはエンティティを表すために使用されます。
そうではなく、クラスにstring型のプロパティがあり、その名前に「Description」という単語がある場合、このプロパティはエンティティを表すために使用されます。
上記のいずれも当てはまらない場合、このクラスに対してデータバインディングを実行できません。

最初のルールは最も一般的で柔軟です。たとえば、NorthwindデータベースのEmployeeクラスにはFirstnameプロパティとLastnameプロパティがあります 。それらの1つはリスト内のエンティティを表すために使用できますが、理想的には両方を使用したいと思います。これを行うには、 EmployeeクラスのToStringメソッドをオーバーライドし、両方のプロパティで構成される行を作成します。

 /// <summary> /// Add a field with the employee's full name /// </summary> public partial class Employee { public string FullName { get { return string.Format("{0} {1}", FirstName, LastName); } } public override string ToString() { return FullName; } }

部分クラスを使用すると、ADO.NET Entity Frameworkウィザードを使用して作成された標準クラスが拡張されることに注意してください。ある時点でデータエンティティモデルを再生成する場合、 ToStringメソッドの実装は影響を受けません。

Northwindデータベースでは、データをバインドするために特別なメソッドを必要とするクラスはEmployeeのみです。他のすべてのクラスには、 「CustomerName」や「CategoryDescription」などのプロパティがあり、これらはEntityDataSourceコンポーネントによって自動的に使用され、目的の効果を提供します。

最初の例は終わりました。

WinFormsのエンティティフレームワーク。 パート1