Microsoft entwickelt nicht nur das Entity

Transkript

1 Aus der Datenzugriffspraxis: Die Beratung von Dr. Holger Schwichtenberg Entity Framework 6.1 Tools für Visual Studio Konsolidiertes Werkzeug In der jüngsten Version 6.1 der Entity Framework Tools für Visual Studio bietet Microsoft im Rahmen des Entity-Framework-Assistenten nun auch Unterstützung für die Code-First-Entwicklung an. Microsoft entwickelt nicht nur das Entity Framework (EF) losgelöst vom.net Framework und Visual Studio in einem eigenständigen Veröffentlichungszyklus, sondern mittlerweile auch die Visual-Studio-Werkzeuge dafür. Zu der Zeit, in der dieser Artikel entsteht, ist die Version 6.1 dieser Werkzeuge als Betaversion verfügbar, die sich in Visual Studio 2012 und 2013 installieren lässt [1]. Auch das kommende Update 2 von Visual Studio 2013 wird diese Tools für Visual Studio enthalten. Momentan gibt es von diesem IDE-Update eine Community Technology Preview 2 [2]. Beim Anlegen eines Entitätenmodells mit den Tools wird ein aufmerksamer Nutzer bereits beim ersten Schritt einen kleinen Unterschied feststellen: Das Eingabefeld Name erwartet nicht mehr die Eingabe des Namens für eine.edmx-datei, sondern eines Namens ohne.edmx (siehe Abbildung 1). Dr. Holger Schwichtenberg alias der Dotnet-Doktor ist Inhaber des auf.net spezialisierten Beratungs- und Schulungsunternehmens mit Sitz in Essen. Er gehört durch zahlreiche Fachbücher und Vorträge auf Fachkonfe ren - zen zu den bekannten Experten für.net und Visual Studio in Deutschland. Sie erreichen ihn unter hs@ IT-Visions.de, sein Web log finden Sie unter Inhalt Die neuen Entity-Framework- Werkzeuge erweitern den Entity- Framework-Assistenten. Code-First-Klassen für bestehende Datenbanken erzeugen. Das Grundgerüst für ein neues Code-First-Modell erstellen lassen. dnpcode A1405DataAccess Listing 1 Eine als Empty Code First model erstellte Datei. using System.Data.Entity; using System.Linq; public class Modell : DbContext // Your context has been configured to use a 'Modell' connection string from your application's // configuration file (App.config or Web.config). By default, this connection string targets the // 'EF61Tools.Modell' database on your LocalDb instance. // // If you wish to target a different database and/or database provider, modify the 'Modell' // connection string in the application configuration file. public Modell() : base("name=modell") // Add a DbSet for each entity type that you want to include in your model. For more information // on configuring and using a Code First model, see // public virtual DbSet<MyEntity> MyEntities get; set; //public class MyEntity // // public int Id get; set; // public string Name get; set; //

2 [Abb. 1] Ein Entitätenmodell mit den Entity Framework 6.0 Tools für Visual Studio 2012/2013 erstellen. [Abb. 2] Die Optionen in den Entity Framework Tools für Visual Studio 2012/2013 in den Versionen 6.0 (links) und 6.1 (rechts). Der Grund dafür wird in Schritt 2 klar, denn hier bietet der Assistent nun vier statt der bisherigen zwei Optionen (siehe Abbildung 2), wobei in den zwei neuen Fällen gar keine.edmx-datei entsteht. Listing 2 Die bisherige Option Generate from database hat Microsoft in EF Designer from database und die Option Empty model in Empty EF Designer model umbenannt. Funktionell gibt es hier nur einen Unterschied: Wenn man im nächsten Schritt bei der Wahl zwischen Entity Framework 5.0 und Entity Framework 6.0 Letzteres wählt, wird in Wirklichkeit ein Modell mit EF 6.1 angelegt. Es bleibt zu hoffen, dass Die von Empty Code First model erstellte Konfigurationsdatei. <?xml version="1.0" encoding="utf-8"?> <configuration> <configsections> <!-- For more information on Entity Framework configuration, visit --> <section name="entityframework" type="system.data.entity.internal.configfile.entityframeworksection, EntityFramework, Version= , Culture=neutral, PublicKeyToken=b77a5c561934e089" requirepermission="false" /> </configsections> <startup> <supportedruntime version="v4.0" sku=".netframework,version=v4.5.1" /> </startup> <entityframework> <defaultconnectionfactory type="system.data.entity.infrastructure.sqlconnectionfactory, EntityFramework" /> <providers> <provider invariantname="system.data.sqlclient" type="system.data.entity.sqlserver.sqlproviderservices, EntityFramework.SqlServer" /> </providers> </entityframework> <connectionstrings> <add name="modell" connectionstring="data source=(localdb)\v11.0;initial catalog=modell;integrated security=true; MultipleActiveResultSets=True;App=EntityFramework" providername="system.data.sqlclient" /> </connectionstrings> </configuration>

3 Entity Framework 6.1 Tools für Visual Studio Listing 3 Generierte Entitätsklassendatei für eine Tabelle. using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; using System.Data.Entity.Spatial; [Table("Betrieb.Flug")] public partial class Flug public Flug() Passagier = new HashSet<Passagier>(); [DatabaseGenerated(DatabaseGeneratedOption.None)] public int FlugNr get; set; [Required] [StringLength(20)] public string Abflugort get; set; [Required] [StringLength(20)] public string Zielort get; set; public DateTime Datum get; set; public bool NichtRaucherFlug get; set; public short Plaetze get; set; public short? FreiePlaetze get; set; public int? Pilot_PersonID get; set; public DateTime? Ankunft get; set; public string Memo get; set; [StringLength(10)] public string test get; set; public bool? Bestreikt get; set; public virtual Pilot Pilot get; set; public virtual ICollection<Passagier> Passagier get; set; Listing 4 Generierte Entitätsklassendatei für eine Sicht. using System.Collections.Generic; using System.ComponentModel.DataAnnotations; using System.ComponentModel.DataAnnotations.Schema; using System.Data.Entity.Spatial; [Table("AllePassagiere")] public partial class AllePassagiere [Column(Order = 0)] [DatabaseGenerated(DatabaseGeneratedOption.None)] public int PersonID get; set; public DateTime? KundeSeit get; set; [StringLength(1)] public string KundenStatus get; set; [Column(Order = 1)] [StringLength(50)] public string Name get; set; [Column(Order = 2)] [StringLength(50)] public string Vorname get; set; [StringLength(2)] public string Land get; set; public DateTime? Geburtstag get; set; public byte[] Foto get; set; [StringLength(50)] public string get; set; [StringLength(30)] Microsoft die Benutzeroberfläche des Assistenten hier noch aktualisiert und die korrekte Versionsnummer wiedergibt oder am besten gleich dem Nutzer die Wahl zwischen 5.0, 6.0 und 6.1 lässt, denn ein neues EF-6.0-Modell lässt sich nach der Installation der aktuellen Version der Werkzeuge gar nicht mehr erzeugen. Die vierte Option, Code First from database, ist eine weiterentwickelte Variante der Funktion Reverse Engineer Code First, die bisher in den Entity Framework Power

4 Listing 5 Generierte Kontextdatei für einige Tabelle und Sichten. using System.Data.Entity; using System.ComponentModel.DataAnnotations.Schema; using System.Linq; public partial class Modell : DbContext public Modell() : base("name=modell") public virtual DbSet<Flug> Flug get; set; public virtual DbSet<Mitarbeiter> Mitarbeiter get; set; public virtual DbSet<Passagier> Passagier get; set; public virtual DbSet<Person> Person get; set; public virtual DbSet<Pilot> Pilot get; set; public virtual DbSet<Flughafen> Flughafen get; set; public virtual DbSet<AlleBuchungen> AlleBuchungen get; set; public virtual DbSet<AlleMitarbeiter> AlleMitarbeiter get; set; public virtual DbSet<AllePassagiere> AllePassagiere get; set; public virtual DbSet<FluegeVonRom> FluegeVonRom get; set; protected override void OnModelCreating( DbModelBuilder modelbuilder) modelbuilder.entity<flug>().property(e => e.memo).isunicode(false); modelbuilder.entity<flug>().property(e => e.test) modelbuilder.entity<flug>().hasmany(e => e.passagier).withmany(e => e.flug).map(m => m.totable("flug_passagier", "Betrieb")); modelbuilder.entity<mitarbeiter>().hasmany(e => e.mitarbeiter1).withoptional(e => e.mitarbeiter2).hasforeignkey(e => e.vorgesetzterpersonid); modelbuilder.entity<mitarbeiter>().hasoptional(e => e.pilot).withrequired(e => e.mitarbeiter); modelbuilder.entity<passagier>().property(e => e.kundenstatus) modelbuilder.entity<person>().property(e => e.memo).isunicode(false); modelbuilder.entity<person>().hasoptional(e => e.mitarbeiter).withrequired(e => e.person); modelbuilder.entity<person>().hasoptional(e => e.passagier).withrequired(e => e.person); modelbuilder.entity<pilot>().property(e => e.flugscheintyp) modelbuilder.entity<pilot>().hasmany(e => e.flug).withoptional(e => e.pilot).hasforeignkey(e => e.pilot_personid); modelbuilder.entity<flughafen>().property(e => e.name) modelbuilder.entity<allepassagiere>().property(e => e.kundenstatus) modelbuilder.entity<fluegevonrom>().property(e => e.memo).isunicode(false); modelbuilder.entity<fluegevonrom>().property(e => e.test) Tools zu finden war [3]. Die Power Tools verstanden sich als Preview of useful design-time features for DbContext. Neu dagegen ist die dritte Option, Empty Code First model. Das neue Empty Code First model Diese neue dritte Option legt eine C#- oder Visual-Basic-Klassendatei an. Sie enthält das Grundgerüst einer Kontextklasse, die von der Basisklasse DbContext erbt, sowie ein Beispiel für eine Entitätsklasse; Listing 1 zeigt ein Beispiel. Die Klassendatei heißt wie der zuvor eingebene Bezeichner. Außerdem gibt es dazu auch gleich eine passende Konfigurationsdatei wie in Listing 2. Sie enthält auch eine Verbindungszeichenfolge, die zu einer noch nicht existierenden Datenbank LocalDb auf dem SQL Server verweist. Verbindungszeichenfolge und Datenbank heißen ebenfalls genau wie der Bezeichner aus dem ersten Schritt. Ebenso hat das Tool dem Projekt die Referenzen auf die Datei EntityFramework.dll und die passende Treiber-Assembly EntityFramework.SqlServer.dll hinzugefügt. Das Ganze ist eine kleine, aber feine Hilfe für Schritte, die bisher manuell, wenn auch in fünf Minuten auszuführen waren. Die Option Code First from database Bei der Modellvariante Code First from database entsteht deutlich mehr Pro

5 Entity Framework 6.1 Tools für Visual Studio Listing 6 [Abb. 4] Bei der Option Code First from database die Datenbankobjekte bestimmen. Lese- und Schreibzugriff auf die Sicht AllePassagiere. using (var ctx = new Modell()) var abfrage = from p in ctx.allepassagiere where String.IsNullOrEmpty(p.KundenStatus) select p; var liste = abfrage.tolist(); foreach (var p in liste) Console.WriteLine(p.PersonID + ": " + p.name); if (String.IsNullOrEmpty(p.KundenStatus)) p.kundenstatus = "C"; ctx.savechanges(); Console.WriteLine("Kundenstatus aktualisiert!"); grammcode, denn hier wird der Benutzer wie in Abbildung 3 aufgefordert, eine existierende Datenbank zu wählen, die dem bisherigen Generate from database aus Abbildung 2 (links) entspricht. Anders als bei Empty Code First model wählt der Nutzer dabei auch gleich einen eigenen Namen für die Verbindungszeichenfolge. Darauf folgt ein Dialog, in dem der Anwender Tabellen und Sichten auswählen kann, für die Entitätsklassen erzeugt werden sollen, siehe Abbildung 4. Diese Auswahl gab es bei Reverse Engineer Code First in den Entity Framework Power Tools nicht; dort wurden immer Klassen für alle Tabellen generiert und Sichten gar nicht berücksichtigt. Die in Abbildung 4 gezeigte Option für die Pluralisierung von Namen funk tioniert genau wie bisher bei der.edmx-basierten orgehensweise nur bei englischen Tabellennamen. Fremdschlüssel eigenschaften werden immer angelegt, und für gespeicherte Prozeduren lässt sich auf diese Weise noch kein Programmcode erzeugen, zumal das Code-First-Verfahren beim Entity Framework bisher auch gespeicherte Prozeduren lediglich für INSERT, DELETE und UPDATE unterstützt, nicht aber für das Laden von Datensätzen [4]. An dieser Einschränkung wird auch EF 6.1 leider nichts ändern. Das Resultat all dieser Konfigurationsschritte besteht jeweils aus einer Entitätsklassendatei für jede Tabelle und jede Sicht (Beispiele dazu enthalten die Listings 3 und 4) sowie einer Kontextklassendatei (siehe das Beispiel in Listing 5). In dem von den Tools generierten Programmcode ist zu erkennen, dass das Entity Framework nach Möglichkeit die von den Code-First-Konventionen abweichenden Eigenarten des Datenbankschemas durch Datenannotationen kenntlich macht und nur dann auf das Fluent-Konfigurations-API ausweicht, [Abb. 3] Die Auswahl einer Datenbank bei der Option Code First from database. wenn es keine Da tenannotationen für den jeweiligen Zweck heranziehen kann zum Beispiel für Zeichenketten fester Länge oder die Benennung einer n:m- Zwischentabelle. Leider hat die Funktion Code First from database, zumindest in der vorliegenden Betaversion, noch einige Schwächen: Der Assistent hat in Listing 4 das Datenbankschema vergessen. Wie er schon in Abbildung 4 hat erkennen lassen, liegen auch die Sichten nicht im Standard-Datenbankschema dbo des SQL Servers, sondern im Ast Views Betrieb. Die Datenannotation [Table("AllePassagiere")] spiegelt dies aber nicht wider. Sie müsste [Table("Betrieb.AllePassagiere")] lauten. So, wie der Assistent die Klasse erstellt hat, kommt es bei jeglichem Zugriff so etwa auch in Listing 6 zum Fehler Invalid object name 'dbo.alle- Passagiere'. Dieser neue Teil des EF-Assistenten bietet ebensowenig wie die bisherigen Assistenten für Database-First und Model-First an, die Kontextklasse und die Entitätsklasse auf verschiedene Assemblies aufzuteilen. Aus architektonischer

6 Listing 7 Mit der Paketmanagerkonsole die Datenbank auf Code-First-Migration vorbereiten. PM> enable-migrations Checking if the context targets an existing database... Code First Migrations enabled for project EF61Tools. PM> Add-Migration v1 -IgnoreChanges Scaffolding migration 'v1'. The Designer Code for this migration file includes a snapshot of your current Code First model. This snapshot is used to calculate the changes to your model when you scaffold the next migration. If you make additional changes to your model that you want to include in this migration, then you can re-scaffold it by running 'Add-Migration v1' again. PM> update-database Specify the '-Verbose' flag to view the SQL statements being applied to the target database. Applying explicit migrations: [ _v1]. Applying explicit migration: _v1. Running Seed method. Listing 8 Mit der Paketmanagerkonsole die Modifizierungen erfassen. PM> Add-Migration v2 Scaffolding migration 'v2'. The Designer Code for this migration file includes a snapshot of your current Code First model. This snapshot is used to calculate the changes to your model when you scaffold the next migration. If you make additional changes to your model that you want to include in this migration, then you can re-scaffold it by running 'Add-Migration v2' again. Sicht ist dies aber notwendig, wenn die Entitätsklassen zu anderen Schichten hochgereicht werden sollen, denn diese oberen Schichten könnten sonst illegalerweise den Kontext verwenden. So muss also der Entwickler die Klassen manuell auf verschiedene Assemblies aufteilen. Es ist nicht möglich, die erzeugten Entitätsklassen zu aktualisieren, wenn sich das Datenbankschema erweitert oder ändert. Die Klassen lassen sich nur löschen und neu anlegen, wobei alle manuellen Änderungen verloren gehen würden. Code First Migrations mit bestehenden Datenbanken Hinsichtlich des dritten Punktes ist es allerdings möglich, fortan Schemaänderungen gemäß Code-First-Vorgehen in den Entitätsklassen vorzunehmen und diese dann in das Datenbankschema per Code First Migrations einzuspielen. Damit dies klappt, benötigt die Datenbank aber auch eine Tabelle MigrationHistory im Schema dbo. Das Anlegen dieser Datenbanktabelle mit einem entsprechenden Eintrag, der dem aktuellen Schema entspricht, lässt sich in der Paketmanagerkonsole mit der Befehlsfolge erreichen, die in Listing 7 zu sehen ist. Nun sind Änderungen an den Entitätsklassen möglich. Wenn diese Änderungen dann zur Datenbank gesendet werden sollen, muss zunächst die Menge der Modifizierungen erfasst werden. Dies erfolgt mit dem Befehl, der in Listing 8 zu sehen ist. Einspielen lassen sich die Änderungen dann mit: PM> update-database Specify the '-Verbose' flag to view the SQL statements being applied to the target database. Applying explicit migrations: [ _v2]. Applying explicit migration: _v2. Running Seed method. Wer will, kann sich auch das SQL-Skript mit update-database -script ausgeben lassen. Fazit Zunächst einmal ist die Konsolidierung der EF-Werkzeuge sehr sinnvoll, denn der Autor stellt in seinen Schulungen zum Thema immer wieder fest, dass die meisten Entwickler die Power Tools gar nicht kennen. Die neue Version der EF- Werkzeuge für Visual Studio macht durch die Auswahl der Tabellen und Sichten den Einsatz der Code-First-Methode auch bei bestehenden Datenbanken besser und somit praktikabler als bei den Power Tools. Es bleibt zu hoffen, das Microsoft die noch bestehenden Schwächen bald ausbessert. Zudem gibt es noch weitere Funktionen in den Power Tools, die noch nicht in die Entity Framework Tools für Visual Studio Einzug gehalten haben, zum Beispiel das Visualisieren eines Code-First-Modells in einer.edmx-datei und das Erzeugen von sogenannten Entity Framework Views, welche die Startzeit von EF-basierten Anwendungen reduzieren. [jp] [1] Entity Framework Beta 1 Tools for Visual Studio 2012 & 2013, [2] Visual Studio 2013 Update 2 CTP 2, [3] Entity Framework Power Tools Beta 4, [4] Holger Schwichtenberg, Abgeschirmt, Gespeicherte Prozeduren für Code First in Entity Framework 6.0, dotnetpro 5/2013, Seite 76 ff.,