Archiv der Kategorie: Entity Framework 5

SimpleMembership mit ASP.NET MVC4 und EF


Wenn es mal wieder schnell gehen soll und man nicht viel Zeit in eine eigene Benutzerverwaltung investieren möchte, dann ist man beim SimpleMembership Provider für ASP.NET Projekte genau richtig.

Aber was macht bzw. ist der SimpleMembership Provider eigentlich?

Wenn man eine neue ASP.NET MVC4 Webseite für das Internet erstellt, dann ist hier bereits der SimpleMembership Provider “enthalten” und muss nur noch entsprechend konfiguriert werden. Dabei stellt der Provider bereits fertige Funktionen wie “WebSecurity.CreateUserAndAccount”, “WebSecurity.Login”, … zur Verfügung. Der Provider erstellt beim erstmaligen Ausführen eigene Tabellen in der angegebenen Datenbank und verwaltet damit die passenden Passwörter, Rollen, … Damit ist eine einfache Nutzerverwaltung innerhalb von ein paar Minuten konfiguriert und man hat Zugriff auf alle wichtigen Funktionen die man für eine einfache Benutzerverwaltung benötigt.

Man muss bei älteren Webprojekten zusätzlich aufpassen, denn es gibt einen “alten” MemberShip Provider aus ASP.NET 2.0 Zeiten welcher anders implementiert wird, hier muss man die Datenbanktabellen z.B. über ein extra Tool anlegen, außerdem wird kein OAuth unterstützt.

Einen sehr ausführlichen Artikel zum Thema SimpleMembership hat z.B. Jon Galloway geschrieben, dieser Artikel verschafft einen sehr guten Überblick über die Thematik.

Einbinden des SimpleMembership Providers in ein ASP.NET MVC Projekt mit EF

Im Folgenden will ich kurz erläutern wie man den bereits “fertigen” SimplemMembership Provider in einem MVC4 Projekt mit EF einrichtet und einige “unnötige” Abhängigkeiten wie einen zusätzlichen DB Context entfernt.

Dazu erstellen wir zuerst ein neues ASP.NET MVC4 Internet Projekt.

image

In dem neu erstellten ASP.NET MVC Projekt gibt es unter Filters die Datei “InitializeSimpleMembershipAttribute.cs” hier findet man den folgenden Aufruf:


 WebSecurity.InitializeDatabaseConnection("DefaultConnection", "UserProfile", "UserId", "UserName", autoCreateTables: true);

In diesen Aufruf tragen wir später unseren passenden Connectionstring und die Tabelle sowie die Spaltennamen für UserID und UserName ein.

image

Als nächstes legen wir erst einmal ein EF5 Model an in einer extra Klassenbibliothek an

image

Dafür wählen wir ein leeres Model

image

und erstellen eine neue Entität für das Model, den “Member” dieser wird später benötigt um unserem SimpleMembership Provider zu sagen wo der Username und die passende UserId stehen.

image

Da ich in meinen Projekten nie auf den eingebauten Connectionstring zurückgreife, sondern diesen lieber selbst “zusammenbaue” fügen wir unserer Klassenbibliothek in der sich das EF Model befindet noch eine weitere Datei “MemberModelContainer.cs” hinzu die unseren Context um einen weiteren Konstruktor erweitert. Diesem Konstruktor können wir direkt einen ConnectionString übergeben, den wir selbst zusammengebaut haben.

image

public partial class MemberModelContainer
{
    public MemberModelContainer(string connectionString) : base(connectionString)
    {
    }
}

Jetzt fügen wir unserer Webseite einen Verweis auf unser neues Projekt “Member.EF.Model” hinzu und erweitern die Web.config unter den appSettings um die folgenden Werte:


Damit wir jetzt überall auch auf unser Model zugreifen können, erstellen wir eine weitere Helper Klasse “CurrentHttpContext” die uns für den jeweiligen Request das aktuelle EF Model zur Verfügung stellt, mit den angegebenen Verbindungsdaten aus der Web.config.

public class CurrentHttpContext
{
    #region Properties
    private static string m_httpContextName = "EFDataModelHttpContextName";
    #endregion

    ///
    /// Gibt den aktuellen DataModelContainer für diesen Request zurück.
    ///
    public static MemberModelContainer GetDataModel()
    {
         //Den aktuellen dataContext nur für den aktuellen Request speichern
        if (HttpContext.Current.Items[m_httpContextName] == null)
        {
            //Connectionstring wird anhand des ModelNamens aus der web.config geladen
            MemberModelContainer efModelContainer = new MemberModelContainer(GetConnectionString("MemberModel"));
            HttpContext.Current.Items.Add(m_httpContextName, efModelContainer);
        }

        return (MemberModelContainer)HttpContext.Current.Items[m_httpContextName];
    }

    ///
    /// Gibt den Connectionstring zur DB zurück für das EntityFramework
    ///
    public static string GetConnectionString(string modelName)
    {
        //Initialize the EntityConnectionStringBuilder.
        EntityConnectionStringBuilder entityBuilder = new EntityConnectionStringBuilder();
        //Providernamen setzten
        entityBuilder.Provider = "System.Data.SqlClient";
        //Connectionstring setzten
        entityBuilder.ProviderConnectionString = GetSqlBuilder().ToString();
        //Metadaten setzten.
        entityBuilder.Metadata = string.Format(@"res://*/{0}.csdl|res://*/{0}.ssdl|res://*/{0}.msl", modelName);
        return entityBuilder.ConnectionString;
    }

    public static SqlConnectionStringBuilder GetSqlBuilder()
    {
        SqlConnectionStringBuilder sqlBuilder = new SqlConnectionStringBuilder();
        //Die Zugangsdaten aus der Web.Config laden, nicht den Connectionstring verwenden.
        sqlBuilder.DataSource = ConfigurationManager.AppSettings["DBDataSource"]; ;
        sqlBuilder.InitialCatalog = ConfigurationManager.AppSettings["DBCatalog"]; ;
        sqlBuilder.UserID = ConfigurationManager.AppSettings["DBUser"];
        sqlBuilder.Password = ConfigurationManager.AppSettings["DBPassword"];
        //Wichtige Option damit mehrere Abfragen geöffnet werden können
        //um Subabfragen ausführen zu können von Untergordneten Projekten
        sqlBuilder.MultipleActiveResultSets = true;
        sqlBuilder.IntegratedSecurity = false;
        //Dient zur Identifizierung der DB Connection/Application wenn man z.B: Fehler auf dem DB Server sucht.
        sqlBuilder.ApplicationName = "MemberManagement";

        return sqlBuilder;
    }
}

Jetzt können wir überall auf unsere eigenen Modeldaten zugreifen. Als nächstes erstellen wir die passende Datenbank aus unseren Modeldaten. Um unsere DB zu erstellen, fügen wir einfach in der Global.asax unter “Application_Start” folgendes hinzu:

MemberModelContainer container = new MemberModelContainer(CurrentHttpContext.GetConnectionString("MemberModel"));
container.Database.CreateIfNotExists();

(Privat nutze ich diese Funktion nur wenn ich entwickle, im Livebetrieb erstelle ich mir das passende SQL Script über das edmx Model und erstelle darüber meine Datenbank einmalig.)

Jetzt konfigurieren wir noch die Standardeinstellungen des SimpleMembership Providers und entfernen Code der nicht benötigt wird.

Als erstes bearbeiten wir die Datei “InitializeSimpleMembershipAttribute.cs”, hier wird einiges in die Global.asax ausgelagert, dazu gehört auch der Funktionsaufruf “LazyInitializer.EnsureInitialized”, denn diese Zeile muss nur einmal ausgeführt werden und dies lässt sich in der Global.asax im Application_Start am besten umsetzten.

Damit sieht die “InitializeSimpleMembershipAttribute.cs” am Ende folgendermaßen aus:

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
public sealed class InitializeSimpleMembershipAttribute : ActionFilterAttribute
{
    public class SimpleMembershipInitializer
    {
        public SimpleMembershipInitializer()
        {
            try
            {
                  WebSecurity.InitializeDatabaseConnection(CurrentHttpContext.GetSqlBuilder().ConnectionString, "System.Data.SqlClient", "MemberSet", "Id", "Username", autoCreateTables: true);
            }
            catch (Exception ex)
            {
                throw new InvalidOperationException("The ASP.NET Simple Membership database could not be initialized. For more information, please see http://go.microsoft.com/fwlink/?LinkId=256588", ex);
            }
        }
    }
}

Wichtig ist in der Funktion “SimpleMembershipInitializer” der Aufruf für

WebSecurity.InitializeDatabaseConnection(CurrentHttpContext.GetSqlBuilder().ConnectionString, „System.Data.SqlClient“, „MemberSet“, „Id“, „Username“, autoCreateTables: true);” Hier wird unser Connectionstring angegeben, sowie der Name der Tabelle in der die Userdaten gespeichert werden und die Spalte mit der “UserId” sowie mit dem “Benutzernamen”. Diese Funktion muss entsprechend eurer eigenen Modeldaten angepasst werden. Außerdem erstellt, diese Funktion auch die passenden DB Tabellen die der SimpleMembership Provider benötigt.

Aufgrund dieser Informationen, ist der Provider dann in der Lage alle wichtigen Funktionen wie Login, Logout, Register, … uns in einem einfachen Aufruf zur Verfügung zu stellen.

Über die Klasse “WebSecurity” haben wir Zugriff auf alle wichtigen Account Funktionen und über die Klasse “Roles” haben wir Zugriff auf die Rollenverwaltung für die User, die der SimpleMembership Provider ebenfalls enthält.

Die angepasste Global.asax sieht dann folgendermaßen aus:

public class MvcApplication : System.Web.HttpApplication
{
    private static InitializeSimpleMembershipAttribute.SimpleMembershipInitializer _initializer;
    private static object _initializerLock = new object();
    private static bool _isInitialized;

    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();

        WebApiConfig.Register(GlobalConfiguration.Configuration);
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
        AuthConfig.RegisterAuth();

        MemberModelContainer container = new MemberModelContainer(CurrentHttpContext.GetConnectionString("MemberModel"));
        container.Database.CreateIfNotExists();

        LazyInitializer.EnsureInitialized(ref _initializer, ref _isInitialized, ref _initializerLock);

    }
}

Außerdem kann der folgende Code aus der “AccountModel.cs” entfernt werden, da wir unser eigenes Model und eigenen DB Context verwenden:

public class UsersContext : DbContext
 {
        public UsersContext()
            : base("DefaultConnection")
        {
        }

        public DbSet UserProfiles { get; set; }
  }

    [Table("UserProfile")]
    public class UserProfile
    {
        [Key]
        [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
        public int UserId { get; set; }
        public string UserName { get; set; }
    }

In der “AccountController.cs” muss noch die Funktion “ExternalLoginConfirmation” auf unser Model angepasst werden

[HttpPost]
[AllowAnonymous]
[ValidateAntiForgeryToken]
public ActionResult ExternalLoginConfirmation(RegisterExternalLoginModel model, string returnUrl)
{
    string provider = null;
    string providerUserId = null;

    if (User.Identity.IsAuthenticated || !OAuthWebSecurity.TryDeserializeProviderUserId(model.ExternalLoginData, out provider, out providerUserId))
    {
        return RedirectToAction("Manage");
    }

    if (ModelState.IsValid)
    {
        // Insert a new user into the database
        using (MemberModelContainer db = CurrentHttpContext.GetDataModel())
        {
            var user = db.MemberSet.FirstOrDefault(u => u.Username.ToLower() == model.UserName.ToLower());
            // Check if user already exists
            if (user == null)
            {
                // Insert name into the profile table
                db.MemberSet.Add(new global::Member.EF.Model.Member() { Username  = model.UserName, Vorname = "", Nachname = ""});
                db.SaveChanges();

                OAuthWebSecurity.CreateOrUpdateAccount(provider, providerUserId, model.UserName);
                OAuthWebSecurity.Login(provider, providerUserId, createPersistentCookie: false);

                return RedirectToLocal(returnUrl);
            }
            else
            {
                ModelState.AddModelError("UserName", "User name already exists. Please enter a different user name.");
            }
        }
    }

    ViewBag.ProviderDisplayName = OAuthWebSecurity.GetOAuthClientData(provider).DisplayName;
    ViewBag.ReturnUrl = returnUrl;
    return View(model);
}

Und die Registerfunktion muss ebenfalls angepasst werden, denn hier muss der Vorname und Nachname mit in der DB eingetragen werden, sonst kommt es zu einem Fehler beim Anlegen des Users.

[HttpPost]
[AllowAnonymous]
[ValidateAntiForgeryToken]
public ActionResult Register(RegisterModel model)
{
    if (ModelState.IsValid)
    {
        // Attempt to register the user
        try
        {
            //TODO  RegisterModel und View um Vorname und Nachname erweitern, dann kann dies hier mit ausgfüllt werden.
            WebSecurity.CreateUserAndAccount(model.UserName, model.Password, new { Vorname = "TestVorname", Nachname="TestNachname" });
            WebSecurity.Login(model.UserName, model.Password);
            return RedirectToAction("Index", "Home");
        }
        catch (MembershipCreateUserException e)
        {
            ModelState.AddModelError("", ErrorCodeToString(e.StatusCode));
        }
    }

    // If we got this far, something failed, redisplay form
    return View(model);
}

Außerdem kann das Attribut “[InitializeSimpleMembership]” über der AccountController Klasse entfernt werden, denn die Initialisierung des SimpleMembership Providers, findet jetzt in der Global.asax statt.

Wenn wir jetzt unsere Webseite entsprechend ausführen und einen neuen User Registrieren, sieht unsere Datenbank dann folgendermaßen aus:

image

Die Tabelle “dbo.MemberSet” wurde von unserem EF Model angelegt und die restlichen Tabellen vom SimpleMembership Provider.

Dipendency Injection und TDD mit dem SimpleMembership Provider

Da der SimpleMembership Provider nicht über einen Konstruktor initialisiert werden kann, ist es nicht möglich diesen per DI zu initialisieren. Da ich versuche in meinen aktuellen Projekten auf DI zu setzten, überlege ich aktuell ob ich wirklich auf den SimpleMembership Provider setzte oder einfach ein eigenes UserRepository erstelle, wer hier bereits entsprechende Erfahrungen gemacht hat, würde ich mich über einen Kommentar freuen.

Um den SimpleMembership Provider zu testen, habe ich nur den folgenden Artikel gefunden, der angibt wie man den SimpleMembership Provider zumindest “testen” kann.

Auch den folgenden Artikel darüber ob man auf den SimpleMembership Provider setzten sollte fand ich zumindest sehr informativ.

Das fertige Projekt kann wie immer über meinen Codeplex Account angeschaut werden unter:

MVC –> SimpleMembershipProvider

Projektupdate von EF4 .Net 4.0 auf EF5 .Net 4.5


Bei diesem Beitrag handelt es sich nur um die Erfahrungen die ich bei einem Update meiner Projekte gemacht habe. Ich musste keine weitere Recherche Unternehmen, da das Update bei mir “Problemlos” verlaufen ist. Daher werde ich hier nur die Schritte aufzählen die ich durchgeführt habe um das Update auszuführen.

Ich habe dabei ein EF4.x Projekt mit .Net 4.0 mit DBContext upgegraded.

  • Upgrade des Projektes in dem das EF Projekt enthalten ist auf .Net 4.5 in den Projekteigenschaften. EF5 läuft zwar auch mit .Net 4.0 aber hier werden z.B: keine Enums unterstützt, diese stehen nur zur Verfügung wenn auch .Net 4.5 genutzt wird.

image

  • Installation des EF5 RC für das EF Projekt mit Hilfe der NuGet Konsole (-pre steht hier für Prerelease). Ein Update war bei mir nicht möglich, hier kam eine Fehlermeldung das er das “alte” Packet nicht finden konnte obwohl ich auch EF4 mit NuGet installiert hatte. aber eine Installation war auch problemlos möglich.
PM> Install-Package -ProjectName EFDataModel EntityFramework -pre
  • Löschen des alten EF4 Eintrages aus der “packages.config”, damit dort als EF Eintrag nur noch der EF5 Eintrag enthalten ist.
  • Da ich bei mir den DBContext verwendet habe, musste ich noch die beiden Dateien “MeinEFName.Context.tt” und “MeinEFName.tt” aus dem Projekt entfernen. Denn diese müssen mit einem neuen DBContext Generator für EF5 erstellt werden. Dazu musste ich eine Erweiterung installieren “EF 5.x DbContext Generator for C#”.

image

  • Erstellen der neuen *.tt Dateien über das edmx Model “Codegenerierungselement hinzufügen” und Auswählen des passenden Code Generators für EF5. Danach waren auch die *.tt Dateien wieder auf dem aktuellen Stand.

image

image

  • Upgrade war damit abgeschlossen und alles funktionierte bei mir wieder wie vorher.

EF5 – “model first” Datenbank Updates mit VS 2012


Nach einem guten Abend an Recherchearbeit, um herauszufinden ob es möglich ist, dass man evtl. direkt im EF5 Framework oder über EF Tools die Möglichkeit hat für den “model first” Ansatz seine Datenbank nach einer Modeländerung zu aktualisieren. Habe ich leider keine Integrierte Lösung finden können. Wenn hier jemand andere Erfahrungen gemacht hat, dann freue ich mich hier sehr über einen passenden Lösungsvorschlag oder Ansatz.

Außerdem habe ich einen Feature Request auf der EF Seite dafür gestartet und ich freue mich über jeden Vote, den ich bekommen kann für den Request, Voten könnt Ihr ohne euch anzumelden auf der folgenden Seite:

http://data.uservoice.com/forums/72025-entity-framework-feature-suggestions/suggestions/3065564-ef5-model-first-genrate-db-update-script

Visual Studio – SQL Schemavergleich zum Aktualisieren der Datenbank

Die einzige Lösung die ich hier aktuell vorschlagen kann, ist es den Integrierten Schemavergleich im Visual Studio für Datenbankupdates zu nutzen.

Nachteile dieser Lösung:

  • Nicht direkt in den EF Modellierungsprozess eingebunden
  • Man benötigt zwei Datenbanken – einmal die Originaldatenbank die aktualisiert werden soll und dann die neue Datenbank mit allen Updates, damit ein Vergleich erstellt werden kann mit der Originaldatenbank.

Wichtige Hinweise beim Durchführen von Modelländerungen im edmx Model

Außerdem muss darauf geachtet werden, wenn man in einem edmx Modell einer Klasse neue Member hinzufügt. Hier muss “Null” angegeben werden oder ein Default Wert hinterlegt werden. Denn sonst kann später kein Updatescript vom Schemavergleich erstellt werden. Im edmx Model können zwar Standardwerte eingestellt werden, diese werden jedoch nicht im generierten SQL eingebunden. Daher muss dies von Hand angepasst werden.

Im Folgenden lege ich für den Namen den Standardwert “Maus” fest, wenn man dann aber über

image

“Datenbank aus Modell generieren” das passende SQL Script generieren lässt,

image

dann sieht der Teil in dem die Tabelle angelegt wird folgendermaßen aus:

-- Creating table 'TiereSatz'
CREATE TABLE [dbo].[TiereSatz] (
    [ID] int IDENTITY(1,1) NOT NULL,
    [Name] nvarchar(max)  NOT NULL,
    [Art] nvarchar(max)  NOT NULL
);

Hier wird aber das Folgende Script benötigt, damit später auch ein Updatescript erstellt werden kann, denn wenn in der jeweiligen Tabelle der späteren Zieldatenbank bereits Werte enthalten sind, kann kein Update durchgeführt werden. Da z.B. schon die Tabelle existierte mit dem Member “Art” und hier bereits Werte eingetragen sind muss bei einem Update entweder der default Wert gesetzt werden oder null zugelassen sein für die neue Spalte “Name”.

-- Creating table 'TiereSatz'
CREATE TABLE [dbo].[TiereSatz] (
    [ID] int IDENTITY(1,1) NOT NULL,
    [Name] nvarchar(max)  NOT NULL default 'Maus',
    [Art] nvarchar(max)  NOT NULL
);

Der “Name” kann auch ”Null” sein, dann gibt es keine Probleme beim Hinzufügen der Spalte, wenn man im Designer “Null-Werte zulassen” auf “True” stellt, dann wird das folgende Script generiert welches auch funktioniert.

-- Creating table 'TiereSatz'
CREATE TABLE [dbo].[TiereSatz] (
    [ID] int IDENTITY(1,1) NOT NULL,
    [Name] nvarchar(max)  NULL,
    [Art] nvarchar(max)  NOT NULL
);

Erstellen des Schema Vergleiches mit Visual Studio und Updaten der DB

Sobald beide Datenbanken eingerichtet sind, zum einen die “alte” Datenbank die aktualisiert werden soll und die “neue” Datenbank in der alle Änderungen enthalten sind, dann können wir im Visual Studio im Menü einen neuen Schemavergleich erstellen.

image

Hier kann man jetzt das Ziel und die Quelldatenbank auswählen

image

Die Quelle ist bei uns die “neue” Datenbank die alle Updates enthält und das Ziel ist bei und die “alte” Datenbank in der die Änderungen durchgeführt werden sollen.

Die Auswahl der passenden DB findet über ein einfaches Menü statt.

image

und sobald beide Datenbanken ausgewählt wurden, steht die Funktion “Vergleichen” zur Verfügung

image

Wenn der Vergleich ausgeführt wurde, steht einem die Aktualisieren Funktion zur Verfügung oder das Erstellen eines SQL Scripts, welches man sich anschauen kann und dann meist schon in den ersten Zeilen erkennt ob es ein erfolgreiches update wird oder nicht.

image

Wenn man auf aktualisieren klickt, sieht man im VS dann auch ob alles geklappt hat

image

Jetzt sind beide Datenbanken auf dem „gleichen” Stand, was zumindest die Tabellen und Verknüpfungen betrifft.

Beispiel für einen Fehlschlag des Updates:

Wenn eine Aktualisierung fehlschlägt, empfehle ich das man sich das Update Script ausgeben lässt, damit man sieht wo der Fehler aufgetreten ist.

Das folgende generierte SQL Update Script kann nicht erfolgreich ausgeführt werden, da ich in der Tiertabelle die Spalte “Name” auf “Not Null” gesetzt habe. Hier kann man sehr gut erkennen wo der Fehler liegt und man kann dann im edmx Model oder dem Script für das Erstellen der neuen Datenbank die passenden Änderungen vornehmen und hier wieder testen ob ein Update möglich ist.

/*
Die Spalte "[dbo].[TiereSatz].[Vorname]" in der Tabelle "[dbo].[TiereSatz]" muss hinzugefügt werden,
besitzt jedoch keinen Standardwert und unterstützt keine NULL-Werte. Wenn die Tabelle Daten enthält,
funktioniert das ALTER-Skript nicht. Um dieses Problem zu vermeiden, müssen Sie der Spalte einen
 Standardwert hinzufügen, sie so kennzeichnen, dass NULL-Werte zulässig sind, oder die Generierung
 von intelligenten Standardwerten als Bereitstellungsoption aktivieren.
*/

IF EXISTS (select top 1 1 from [dbo].[TiereSatz])
    RAISERROR (N'Zeilen wurden erkannt. Das Schemaupdate wird beendet, da es möglicherweise zu einem Datenverlust kommt.', 16, 127) WITH NOWAIT
GO