© best_vector/Shutterstock.com
Ausblick auf Entity Framework 6

Stabilität und lang Erwartetes


Entity Framework 6 bringt einige Neuerungen, die das Leben der Entwickler vereinfachen werden, darunter Tracing, benutzerdefinierte Konventionen für Code Only, Unterstützung für Stored Procedures durch Migrations sowie Code Only und asynchrone Operationen.

How to write Code that Others can read

Vor einigen Wochen hat Microsoft die Version 6 seines O/R Mappers Entity Framework veröffentlicht. Im Zuge dessen wurde das Entity Framework auch aus dem .NET Framework ausgegliedert. Das erfolgte mit dem Ziel, seine Weiterentwicklung von der .NET-Weiterentwicklung zu entkoppeln, um rascher neue Versionen auf den Markt bringen zu können. Die neuesten Versionen des Entity Frameworks findet der geneigte Entwickler nun jeweils über NuGet.

Breaking Changes

Bevor der vorliegende Artikel auf die neuen Möglichkeiten von Entity Framework 6 eingeht, werden an dieser Stelle zwei Breaking Changes erwähnt. Der eingangs erwähnten Ausgliederung aus dem .NET Framework ist es zu schulden, dass einige Klassen, die sich noch in Version 5 in Namensräumen unter der Hoheit des Product-Teams befanden, in einen anderen Namensraum verschoben werden mussten. Bestehender Code muss somit ein wenig angepasst werden, wobei dies in den meisten Fällen über Suchen und Ersetzen zu bewerkstelligen sein dürfte.

Darüber hinaus gab es auch Änderungen am Providermodell. Das hat zur Folge, dass sich Entwickler im Zuge der Migration auf Version 6 ggf. die neueste Version des verwendeten Datenbankproviders besorgen müssen.

Konfiguration

Während es in der Vergangenheit vereinzelt über statische Eigenschaften möglich war, Entity Framework an eigene Bedürfnisse anzupassen, sieht Version 6 eine zentrale Klasse hierfür vor. Um solch eine Klasse einzurichten, leitet der Entwickler von DbConfiguration ab und hinterlegt im Konstruktor dieser Klasse Eckdaten für die Konfiguration des Frameworks. Bei diesen Eckdaten handelt es sich in der Regel um die Angabe von austauschbaren Komponenten, die Entity Framework zur Bewerkstelligung der angeforderten Aufgaben verwendet. Listing 1 demonstriert dies, indem es den DatabaseInitializer DropCreateDatabaseAlways für den HotelDbContext sowie die benutzerdefinierte CustomConnectionFactory zum Aufbau von Datenbankverbindungen festlegt.

Listing 1

public class CustomDbConfiguration : DbConfiguration
{
  public CustomDbConfiguration()
  {
    SetDatabaseInitializer(new DropCreateDatabaseAlways<HotelDbContext>());
    SetDefaultConnectionFactory(new CustomConnectionFactory());
  }
}

Auf diese Art und Weise kann der Entwickler seit Version 6 eine ganze Menge an Komponenten austauschen [1]. Zu den Highlights unter diesen Komponenten zählt der PluralizationService, der festlegt, wie Entity Framework den Plural bzw. Singular aus Tabellen- und Spaltenbezeichnungen bilden soll, sowie der Migration­SqlGenerator, der bestimmt, auf welche Weise SQL-Code für Migrationen zu erzeugen ist.

Ein Derivat von DbConfiguration zu erstellen, ist jedoch nur die halbe Miete bei der Konfiguration des Entity Frameworks. Daneben muss der Entwickler auch noch den DbContext mit der gewünschten Konfiguration in Verbindung setzen. Existiert in der gesamten Anwendung lediglich eine Subklasse von DbConfiguration, so wird diese verwendet. Existieren in der Anwendung mehrere solcher Klassen, in der Assembly mit dem verwendeten DbContext-Derivat jedoch nur eine einzige, kommt diese zum Zug. Ist auch dies nicht der Fall, besteht die Möglichkeit, das DbContext-Derivat mit dem Attribut DbConfigurationType zu annotieren. Über dieses kann der Entwickler die zu verwendende DbConfiguration-Implementierung angeben:

[DbConfigurationType(typeof(CustomDbConfiguration))]
public class HotelDbContext : DbContext { [...] } 

Neben der direkten Angabe des Typs der DbConfiguration-Implementierung kann der Entwickler auch einen String angeben, der die vollständige Typbezeichnung inkl. des Namens der sich darin befindlichen Assembly beinhaltet. Wie unter .NET üblich, wird hierzu das Format Namespace.Klassenname, Assymblyname verwendet.

Abgesehen davon kann der Entwickler auch auf globaler Ebene eine DbConfiguration angeben und damit alle anderen Angaben überschatten. Dazu verwendet er entweder die statische Methode DbConfiguration.SetConfiguration oder den folgenden Konfigurationseintrag:

<entityFramework
  codeConfigurationType="MyNamespace.MyDbConfiguration, MyAssembly">
  [...]
</entityFramework>

Alternativ zur hier beschriebenen codebasierten Konfiguration stehen für ausgewählte Aspekte nach wie vor die mit Entity Framework 4.1 eingeführten Möglichkeiten zur Konfiguration über app.config bzw. web.config zur Verfügung. Dabei gilt die Regel, dass Einstellungen in diesen Dateien analoge Einstellungen überschatten, die per Code getroffen wurden.

Tracing

Gerade wenn es darum geht, eine Datenbankanwendung zu optimieren oder Fehler zu finden, ist es für den Entwickler wichtig zu wissen, welche SQL-Befehle Entity Framework zur Datenbank sendet. In der Vergangenheit war dies mit Board-Mitteln nur sehr schwer möglich, weswegen der Entwickler entweder auf datenbankseitige Tracing-Mechanismen (z. B. SQL Server Profiler) oder auf kostenpflichtige Werkzeuge, die sich auf Treiberebene ins Entity Framework einklinkten (z. B. Entity Framework Profiler [2]), ausweichen musste. Künftig wird man weniger häufig zu diesen Werkzeugen greifen müssen, da Entity Framework 6 nun über sämtliche an die Datenbank gesendeten SQL-Anweisungen informiert werden kann. Dazu bietet der DbContext über Database.Log ein Delegate vom Typ Action<String> an. Registriert der Entwickler bei diesem Delegate eine Methode, die einen String entgegennimmt, wird diese immer dann aufgerufen, wenn eine SQL-Anweisung zur Datenbank gesendet wird. Im Zuge dessen übergibt Entity Framework die SQL-Anweisung als String.

Interceptoren

Der im letzten Abschnitt beschriebene Tracing-Mechanismus basiert auf einem viel mächtigeren Konzept, das ebenfalls mit Version 6 eingeführt wurde: Command Interceptoren. Unter einem Interceptor versteht man im Allgemeinen eine Komponente, die Aktionen eines Frameworks abfängt und vor, nach bzw. anstelle von ihnen eigene Aktionen zur Ausführung bringt. Bei den Command Interceptoren ab Entity Framework 6 handelt es sich um solche, die das Abfangen von zur Datenbank gesendeten Anweisungen erlauben. Zur Implementierung eines solchen Interceptors stellt der Entwickler eine Realisierung des Interface IDbCommandInterceptor zur Verfügung. Dieses Interface weist sechs Methoden auf, die Entity Framework jeweils vor bzw. nach dem Ausführen einer SQL-Anweisung zur Ausführung bringt. Einen Überblick über diese Methoden bietet Tabelle 1.

Methode

Beschreibung

NonQueryExecuting

Wird ausgeführt, bevor Entity Framework eine Anweisung zur Datenbank sendet, die keine Ergebnismenge zurückgibt. Beispiele hierfür sind INSERT-, UPDATE- oder DELETE-Anweisungen.

NonQueryExecuted

Wird ausgeführt, nachdem Entity Framework eine Anweisung, die keine Ergebnismenge zurückgibt, zur Datenbank gesendet und diese die Anweisung ausgeführt hat. Innerhalb dieser Methode liegt bereits die Anzahl der Zeilen vor, die von dieser Anweisung betroffen waren.

ReaderExecuting

Wird ausgeführt, bevor Entity Framework eine Anweisung zur Datenbank sendet, die eine Ergebnismenge zurückgibt. Ein Beispiel hierfür ist eine SELECT-Anweisung.

ReaderExecuted

Wird ausgeführt, nachdem Entity Framework eine Anweisung, die keine Ergebnismenge zurückgibt, zur Datenbank gesendet und diese die Anweisung ausgeführt hat. Innerhalb dieser Methode liegt bereits die abgefragte Ergebnismenge vor.

ScalarExecuting

Wird ausgeführt, bevor Entity Framework eine Anweisung zur Datenbank sendet, die einen einzelnen (skalaren) Wert zurückgibt (z. B. SELECT COUNT(*) FROM …).

ScalarExecuted

Wird ausgeführt, nachdem Entity Framework eine Anweisung, die einen einzelnen (skalaren) Wert zurückgibt, zur Datenbank gesendet und diese die Anweisung ausgeführt hat. Innerhalb dieser Methode liegt der abgefragte Wert bereits vor.

Tabelle 1: Methoden von „IDbCommandInterceptor“

Sä...

headline from sands settings