Visual Studio 2015でWinFormsアプリケーションを開発するためのSQLite DBMSでのEntity Framework Coreコードファーストの使用

一見、下の資料はもう1つの「ハローワールド」、「Captain Obviousnessのチュートリアル」のように見えるかもしれませんが、これらはすでにWebに豊富にありますが、この印象は誤解を招きます。 実際、同じ結果をゼロから達成するために、以前にEntity Framework Core（従来のEntity Frameworkと混同しないで）を使用せず、Webおよびドキュメントの広大な領域に既に豊富なEF Coreチュートリアルおよびドキュメントのみで武装したWinFormsプログラマーは、より長い時間がかかる可能性があります彼が仕事に取りかかる前に、彼は素朴に予想していました。 それで私に起こった。 したがって、私の経験を共有したいと思います。



主な問題は、圧倒的多数のEF CoreマテリアルがVisual Studioの使用を暗示しておらず（代わりに、軽量のクロスプラットフォーム.NET Coreチューニングを使用している）、デスクトップでEF Coreを使用したいことを考慮していないことです。 Windows Formsフレームワークに基づくアプリケーション（代わりに、通常はASP.NETコアが代わりに想定されます）。 ただし、デスクトップアプリケーションの形式のソリューションが望ましい（または必要な）場合があり、Entity Framework CoreにはEntity Framework 6と比較していくつかの利点（もちろん、欠点）があるという問題と状況がまだあります。 さらに、Webで利用可能な例では、原則として、データベースへのレコードの追加など、最も基本的なアクションのみが考慮され、その後のデータ抽出の問題さえ考慮されないことが多く、その中にはすでに明らかな点はありません。 また、EF Coreは非常に活発に開発されており、次のような多くの命令の関連性が失われています。 この理由で。



VisualStudo 2015でEF Coreを使用して最小限のWinFormsデモアプリケーションを開発するような一見基本的なタスクを解決しようとすると、例外、予期しない動作、チュートリアルで自明なことを行う方法の理解不足などの一連の問題に遭遇しました。 。 その結果、Googleが質問や実験を行うことで、以下で説明するいくつかの手順をほとんど盲目的に感じる必要がありました。



プラットフォームとして、.NET Framework 4.6.1を選択しました（何らかの理由でバージョン4.6.2はVisual Studioで利用可能なリストに表示されませんが、4.6.1を選択するとすべてが機能しますが、おそらく以前のバージョンで動作しますが、開発環境として-Visual Studio Community Edition 2015 Update 3、DBMSとして-SQLite、OSとして-Windows 7 64ビットとして、私はチェックしませんでした）。



以下は、デモアプリケーションが適切に動作し、エラーメッセージが受信されなかったステップのリストです。



0. .NET Framework 4.6.2（ Webインストーラー 、 オフラインインストーラー ）の最新バージョンとVisual Studio 2015 Update 3（ Webインストーラーの 更新、オフラインインストーラーISOの更新 、Visual Studio 2015 Update Community Edition 3のWebインストーラーフルバージョン 、 オフラインが インストールされていることを確認します インストーラーISOフルバージョンのVisual Studio 2015 Update Community Edition 3と統合された更新プログラム ）



1. Windows Management Framework 5.0をインストールして、PowerShellをバージョン5.0にアップグレードします。 私は（Windows 7およびVisual Studio 2015とそれらのすべての更新プログラムをインストールした後）システムにバージョン2.0があり、そのプロセスで新しいバージョンを要求するエラーメッセージを受け取りました



2. .NET Core 1.0.1ツールプレビュー2をインストールします（ Webインストーラーを使用して、/ layoutスイッチを使用してオフライン配布を作成できます）。



3. NuGetリポジトリを操作するためのVisual Studio拡張機能の更新。 これを行うには、 直接リンクで現在のバージョン3.5.0.1996をダウンロードするか、Visual Studioの設定を自動更新するための適切な拡張リポジトリを追加します。







4. Windowsフォームアプリケーションなどの新しいプロジェクトを作成します。 私はそれを「Vs2015WinFormsEfcSqliteCodeFirst20170304Example」（Entity Framework Core、「コードファースト」アプローチ、および2017年3月4日のVisual Studio 2015のSQLite DBMSを使用した実際のWinFormsアプリケーション）と呼びました。 ターゲットフレームワークとして、.NET Framework 4.6.1を選択します。



5.ソリューションエクスプローラーパネルでプロジェクトを右クリックし、[NuGetパッケージの管理...]を選択し、[参照]タブに移動して、Microsoft.EntityFrameworkCore.Sqlite.DesignおよびMicrosoft.EntityFrameworkCore.Toolsをインストールします。 現在のバージョンをインストールするには、「プレリリースを含める」チェックボックスをオンにする必要があります;安定バージョンでは、何かが欠落している場合や修正されていないバグがある場合があります。 現時点で最新のMicrosoft.EntityFrameworkCore.Sqlite.Design 1.1.0およびMicrosoft.EntityFrameworkCore.Tools 1.1.0-preview4-finalをインストールしました。 Microsoft.EntityFrameworkCore.Toolsのインストールに問題がある場合は、NuGetコマンドラインを使用してこれを実行できます。招待「PM>」の後に表示されるコンソールで、メニューから[ツール]-[NuGetパッケージマネージャー]-[パッケージマネージャーコンソール]を選択します"Enter" Install-Package Microsoft.EntityFrameworkCore.Tools -Pre "

PM> Install-Package Microsoft.EntityFrameworkCore.Tools -Pre
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

6.データモデルクラスのソースコードファイルを作成します。 順序のために、それらを「モデル」のサブフォルダーに配置しました（「エンティティ」と呼ぶものもあれば、プロジェクトのルートにあるすべてのクラスをスローするもの、同じファイルに移動するものもあります）。 このモデルは、都市と都市のリストを保存するデータベースのケーススタディを記述しています。 各人物は1つの都市にのみ関連付けることができます。一般的にどの都市から関連付けられているかは不明です。



Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext.cs

 using Microsoft.EntityFrameworkCore; namespace Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model { public class Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext : DbContext { public DbSet<City> Cities { get; set; } public DbSet<Person> People { get; set; } protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) { optionsBuilder.UseSqlite("Filename=Vs2015WinFormsEfcSqliteCodeFirst20170304Example.sqlite"); } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

City.cs

 using System.Collections.Generic; using System.ComponentModel.DataAnnotations.Schema; namespace Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model { public class City { public int Id { get; set; } public string Name { get; set; } [InverseProperty("City")] public virtual ICollection<Person> People { get; set; } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Person.cs

 using System.ComponentModel.DataAnnotations.Schema; namespace Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model { public class Person { public int Id { get; set; } public string Name { get; set; } public string Surname { get; set; } public int? CityId { get; set; } [InverseProperty("People")] public virtual City City { get; set; } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

7. PowerShellスクリプトを解決します。これが行われない場合、エラー「... \ packages \ Microsoft.EntityFrameworkCore.Tools.1.1.0-preview4-final \ tools \ init.ps1を読み込むことができません。このシステムではスクリプトの実行が無効になっているためです。 」 これを行うには、NuGetコマンドラインに移動し（メニューで[ツール]-[NuGetパッケージマネージャー]-[パッケージマネージャーコンソール]を選択）、次のコマンドを実行します。

 PM> Set-ExecutionPolicy RemoteSigned
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

8. 「移行」を作成します。 これを行うには、コードを保存してコンパイルし（タイプミスがないことを確認するために）、NuGetコマンドラインに移動し、次のコマンドを実行します。

 PM> Add-Migration -Name "Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleMigration" -Context "Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

結果として、プロジェクトと「Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContextModelSnapshot.cs」および「20170304204355_Vs2015WinFormsEfcSqliteCodeFirstManagement」という2つのファイルがプロジェクトに表示されます。明らかな形式で生成された瞬間、後で「Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleMigration.cs」のみを残して完全に削除しました。



9.生成されたファイルを編集して、一意性の条件（一意制約、2次キーとも呼ばれる）を都市の名前に追加します（実際には、もちろん、同じ名前の都市がありますが、例えば、それは間違っていません）



Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleMigration.cs

 using Microsoft.EntityFrameworkCore.Migrations; namespace Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Migrations { public partial class Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleMigration : Migration { protected override void Up(MigrationBuilder migrationBuilder) { migrationBuilder.CreateTable( name: "Cities", columns: table => new { Id = table.Column<int>(nullable: false) .Annotation("Sqlite:Autoincrement", true), Name = table.Column<string>(nullable: true) }, constraints: table => { table.PrimaryKey("PK_Cities", x => x.Id); //     table.UniqueConstraint("UQ_Cities_Name", x => x.Name); }); migrationBuilder.CreateTable( name: "People", columns: table => new { Id = table.Column<int>(nullable: false) .Annotation("Sqlite:Autoincrement", true), CityId = table.Column<int>(nullable: true), Name = table.Column<string>(nullable: true), Surname = table.Column<string>(nullable: true) }, constraints: table => { table.PrimaryKey("PK_People", x => x.Id); table.ForeignKey( name: "FK_People_Cities_CityId", column: x => x.CityId, principalTable: "Cities", principalColumn: "Id", onDelete: ReferentialAction.Restrict); }); migrationBuilder.CreateIndex( name: "IX_People_CityId", table: "People", column: "CityId"); } protected override void Down(MigrationBuilder migrationBuilder) { migrationBuilder.DropTable( name: "People"); migrationBuilder.DropTable( name: "Cities"); } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContextModelSnapshot.cs

 using Microsoft.EntityFrameworkCore; using Microsoft.EntityFrameworkCore.Infrastructure; using Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model; namespace Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Migrations { [DbContext(typeof(Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext))] partial class Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContextModelSnapshot : ModelSnapshot { protected override void BuildModel(ModelBuilder modelBuilder) { modelBuilder .HasAnnotation("ProductVersion", "1.1.0-rtm-22752"); modelBuilder.Entity("Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model.City", b => { b.Property<int>("Id") .ValueGeneratedOnAdd(); b.Property<string>("Name"); b.HasKey("Id"); //     b.HasIndex("Name").IsUnique(); b.ToTable("Cities"); }); modelBuilder.Entity("Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model.Person", b => { b.Property<int>("Id") .ValueGeneratedOnAdd(); b.Property<int?>("CityId"); b.Property<string>("Name"); b.Property<string>("Surname"); b.HasKey("Id"); b.HasIndex("CityId"); b.ToTable("People"); }); modelBuilder.Entity("Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model.Person", b => { b.HasOne("Vs2015WinFormsEfcSqliteCodeFirst20170304Example.Model.City", "City") .WithMany("People") .HasForeignKey("CityId"); }); } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

10.データベースファイルを生成します。 これを行うには、NuGetコマンドプロンプトで次のコマンドを実行します

 PM> Update-Database -Context "Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext"
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

データベースファイルは、アプリケーションのコンパイル済みexeファイルが置かれているディレクトリと同じディレクトリに作成されます。これは、「... \ Vs2015WinFormsEfcSqliteCodeFirst20170304Example \ bin \ Debug \ Vs2015WinFormsEfcSqliteCodeFirst20170304Example.sqlite」です。



この段階で、たとえば、公式コンソールクライアントsqlite3または無料のクロスプラットフォームGUIシェルSQL Browser用DBブラウザーを使用して、作成されたファイル内を確認し、テーブルが正しく作成されたことを確認できます。 Cities and Peopleテーブルに加えて、EF Coreオーバーヘッドのある__EFMigrationsHistoryテーブルと、SQLiteオーバーヘッドのあるsqlite_sequenceもあります。



11.次に、フォームのデザイナーに移動し、ボタンを配置し、2回クリックしてボタンをクリックするためのイベントハンドラーを作成し、コードの編集に進みます。 以下は、データベースレコードを使用した基本アクションを示すコードです。 私はまだForm1を常にMainFormに名前変更する習慣があり、コントロールの意味は似ています（この場合、唯一のコントロールはmainButtonのbutton1です）が、これは好みの問題であり、チームで受け入れられている命名基準です。



MainForm.cs

 private void mainButton_Click(object sender, EventArgs e) { //       using (var context = new Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext()) { foreach (var person in context.People) context.Remove(person); foreach (var city in context.Cities) context.Remove(city); context.SaveChanges(); } //         //     ,     using (var context = new Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext()) { var praha = new City { Name = "Praha" }; var london = new City { Name = "London" }; var madrid = new City { Name = "Madrid" }; var jan = new Person { Name = "Jan", City = praha }; var john = new Person { Name = "John", City = london }; var juan = new Person { Name = "Juan", City = madrid }; context.Cities.AddRange(praha, london, madrid); context.People.AddRange(jan, john, juan); context.SaveChanges(); } //        , //      , //       ( ) using (var context = new Vs2015WinFormsEfcSqliteCodeFirst20170304ExampleContext()) { //     Include(city => city.People) //    context.Cities.Single(city => city.Name == "London"); //   ,    .People   null. //  production    .Single     , //           var london = context.Cities.Include(city => city.People)(city => city.Name == "London"); var peter = new Person { Name = "Peter", City = london }; var john = london.People.Single(person => person.Name == "John"); john.Surname = "Smith"; context.Add(peter); context.Update(john); context.SaveChanges(); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

もちろん、実際には、アプリケーションに豊富なインターフェイス、より意味のあるロジックを実装し、例外処理とデータ検証を追加してそれらを防止しますが、上記の例はこれを行う方法を理解するのに十分です。



上記および関連するコードはすべてこちらからダウンロードできます。