Von der Datenbank zur Oberfläche mit .NET Teil 1

Diese Serie konnte ich mangels Zeit noch nicht fortsetzen.
Deshalb möchte ich aber trotzdem diesen Teil veröffentlichen.
Wer Interesse am Source hat kann mir gerne schreiben.

Dies soll der erste Teil einer begleitenden Serie zu einer Artikel Serie auf Heise-Developer werden. In der Artikelserie „Von der Datenbank bis zur Oberfläche mit .NET“ wird der schichtweise Aufbau einer .NET-Anwendung dargestellt. Für mich zeigt diese Artikelserie ein Thema auf, dass für mich im Moment sehr relevant ist.

Der Original-Artikel verwendet den Model-First-Ansatz, um mit dem Entity Framework den Datenzugriff zu abstrahieren. Dadurch muss mit T4-Templates gearbeitet werden und es gibt, wie der Artikel erwähnt außerdem einen Fehler in der deutschen Version von Visual Studio, der einem das Leben schwer macht. Ein relativ neuer Ansatz ist Code-First, bei dem man nur Code schreibt. Daraus kann dann die Datenbank erstellt werden. Um keine Datenbankinstallation zu benötigen wird in diesem Beispiel Microsoft SQL Server Compact 4.0 verwendet. Die Datenbank wird vom Entity Framework erstellt. Außerdem wird das Beispiel in VB.Net erstellt, da sehr viele Beispiele im Internet in C# sind und wenige in VB.Net. Warum sollten die C#-Entwickler nicht auch mal einen Konverter benutzen. Dieser Artikel folgt der Struktur des Original-Artikels und beschreibt dabei die Unterschiede zwischen den Ansätzen.

WWWings_GO

Der Original-Artikel beginnt mit dem Klassenbibliotheksprojekt WWWings_GO. GO steht für Geschäftsobjekte. Die Abbildung im Original-Artikel zeigt den Aufbau sehr schön. Im Original wird nun das Datenmodell mit dem Designer von Visual Studio erzeugt. Für Code-First ist dies nicht notwendig. Hier werden einfache Objekte erstellt. Die Objekte müssen öffentliche Properties anbieten, welche später zu Datenbankfeldern werden. Verknüpfungen zwischen den Objekten werden ebenfalls durch einfache Properties erreicht. Für Beziehungen des Typs 1-zu-n und n-zu-m werden entsprechende Listen als Typ genutzt.
Für Werttypen, wie Date oder Integer, welche später in der Datenbank mit NULL belegt werden sollen, nutzt man den generischen Typ Nullable(Of T). Im Beispiel ist die Klasse Flug zu sehen.

Public Class Flug
    Public Property ID As Integer
    Public Property Abflugort As String
    Public Property Zielort As String
    Public Property Datum As Date
    Public Property Plaetze As Integer
    Public Property FreiePlaetze As Integer
    Public Property Passagiere As IList(Of Passagier)
    Public Property Pilot As Pilot

    Public ReadOnly Property Route() As String
        Get
            Return Me.Abflugort & " -> " & Me.Zielort
        End Get
    End Property
    Public Overrides Function ToString() As String
        Return "Flug #" & Me.ID & ": " & Me.Route & ": " & Me.FreiePlaetze & " von " & Me.Plaetze & " frei."
    End Function
End Class

Besonders interessant ist, dass diese Klassenbibliothek keine besonderen Abhängigkeiten hat. Weder das Entity Framework, noch SQL Server CE müssen von diesem Projekt aus referenziert werden. Die Objekte sind einfach und schnell zu verstehen. Der Original-Artikel erstellt sowohl Datenzugriff und Objekte in diesem Projekt und verschiebt sie danach mit einem Trick in die Datenzugriffsschicht. Mit Code-First ist kein Trick notwendig!

WWWings_DZS

Als nächstes wird die Klassenbibliothek WWWings_DZS erstellt. Diese bekommt Verweise auf das Entity Framework, System.Data.Entity und WWWings_GO. Die wichtigste Klasse für das Entity Framework ist WWWingsModellContext. Diese wurde im Vergleich zum Original etwas umbenannt. Statt …Container heißt die Klasse hier …Context. Die Klasse erbt von DbContext aus dem Namespace System.Data.Entity. Im Beispiel sind die wichtigsten Bestandteile der Klasse zu sehen und anschließend erklärt.

Public Class WWWingsModellContext
    Inherits DbContext

    Public Sub New()
        System.Data.Entity.Database.SetInitializer(Of WWWingsModellContext)(New DropCreateDatabaseIfModelChanges(Of WWWingsModellContext))
    End Sub

    Public Property Fluege As DbSet(Of Flug)
    Public Property Personen As DbSet(Of Person)
    Public Property Piloten As DbSet(Of Pilot)
    Public Property Passagiere As DbSet(Of Passagier)

    Protected Overrides Sub OnModelCreating(modelBuilder As System.Data.Entity.DbModelBuilder)
        MyBase.OnModelCreating(modelBuilder)
        modelBuilder.Conventions.Remove(Of Conventions.PluralizingTableNameConvention)()

        modelBuilder.Entity(Of Person).ToTable("Personen")
        modelBuilder.Entity(Of Flug).ToTable("Fluege")

        modelBuilder.Entity(Of Person)().Property(Function(p) p.ID).HasDatabaseGeneratedOption(ComponentModel.DataAnnotations.DatabaseGeneratedOption.Identity)
        modelBuilder.Entity(Of Flug)().Property(Function(p) p.ID).HasDatabaseGeneratedOption(ComponentModel.DataAnnotations.DatabaseGeneratedOption.None)
    End Sub
End Class

Die Properties vom Typ DbSet(Of T) stellen Zugriffspunkte auf die entsprechenden Klassen dar. Sie werden vom Entity Framework zur Laufzeit automatisch  mit passenden Instanzen versehen. Die Methode OnModelCreating ist dafür verantwortlich das Mapping zwischen Datenbank und Objekten zu erstellen. Viele Eigenschaften des Mappings werden über Konventionen automatisch festgelegt. Innerhalb dieser Methode können solche Konventionen deaktiviert werden und das Mapping kann beeinflusst werden. Hier wird mit durch den DbModelBuilder eine Fluent-API angeboten. Im Beispiel wird die Konvention Tabellennamen in den Plural zu setzen abgeschaltet, da die Namen deutsch sind und bis jetzt nur der englische Plural unterstützt wird. Anschließend werden den Klassen Flug und Person entsprechende Tabellennamen zugewiesen. Danach wird für die Properties mit dem Namen ID beider Klassen die Datenbankautomatik eingestellt. Personen bekommen automatisch einen Schlüssel, Flüge nicht.

Im Konstruktor der Klasse WWWingsModellContext wird der Datenbankinitialisierer gesetzt. Ab Version 4.3 wird eine Datenbankmigration unterstützt werden. In den aktuellen Versionen gehen die Daten der Datenbank verloren. Der gewählte Datenbankinitialisierer prüft mittels eines Hash-Wertes, ob sich das Modell geändert hat. Ist dies der Fall, wird die Datenbank gelöscht und eine neue, passend zum neuen Modell erstellt. Wenn keine Datenbank existert wird sie entsprechend angelegt. Für solch ein Beispielprojekt oder kleine Tools ist das eine schöne Option. Für große Software nicht. Hier sollte der Initialisierer auf Nothing gesetzt werden. Dies signalisiert dem Entity Framework, dass man selbst die Datenbank erstellt. Erstellt wird die Datenbank beim ersten Zugriff auf diese.

WWWings_GL

Die dritte Klassenbibliothek ist die Geschäftslogik, welche die folgenden Referenzen braucht: WWWings_GO, WWWings_DZS und EntityFramework.

…. to be continued! ….