Archiv der Kategorie: DI und IoC

Leichtgewichtige Controller – wohin mit meiner Controllerlogik


Auch wenn man bisher nur an kleineren ASP.NET MVC Projekten gearbeitet hat, kann der Code in einem Controller sehr schnell, sehr unübersichtlich werden. Denn im Controller wird meist zu viel Logik “abgelegt”, die sich eigentlich sehr gut auslagern lässt.

In meinen Webprojekten versuche ich, dass ein Controller nur prüft ob der Modelstate Valide ist und um dann den passenden View aufzurufen/laden (“routen”) . Das Laden der Viewmodeldaten übernimmt bei mir dann entweder Variante 1, “das intelligente Model” oder Variante 2 der “Modelbuilder”, natürlich immer nur eine Variante pro Projekt. Damit erhält man einen sehr übersichtlichen und leichtgewichtigen Controller.

Variante 1: Das intelligente Model

Hier enthält das jeweilige Viewmodel, nicht nur die Properties die angezeigt werden sollen für den jeweiligen View, sondern es enthält ebenfalls die Logik sich selbst mit Daten zu füllen oder sich selbst zu speichern. Bei dieser Variante erntet man oft Kritik, da viele die starre Meinung vertreten, das ein Model niemals Logik enthalten sollte. Dem stimme ich prinzipiell auch zu, aber ich finde hier stellt es eine gute Alternative dar, auch dem Model mal etwas Logik zu verpassen.

In meinem Fall benutzte ich Dependency Injection (Ninject) um im Controller das passende Repository einzubinden. Das Repository übergebe ich dem Model in der jeweiligen Funktion, wo das Repository benötigt wird. Wichtig ist das man darauf achtet, wenn es sich um ein Postbackmodel handelt, das ein Parameterloser Konstruktor existiert, sonst kann der Modelbinder von .NET keine Instanz erstellen und das Model mit Daten füllen.

public class AutoController : Controller
{
    #region Injections
    [Inject]
    public IAutoRespository AutoRespository { protected get; set; }
    #endregion

    #region View Functions
    public ActionResult AutoList()
    {
        AutoListModel model = new AutoListModel();
        model.Load(AutoRespository);
        return View("AutoList", "Auto", model);
    }

    public ActionResult AutoView(int id)
    {
        AutoViewModel model = new AutoViewModel();
        model.Load(id, AutoRespository);
        return View("AutoView", "Auto", model);
    }

    public ActionResult AutoEdit(int id)
    {
        AutoEditModel model = new AutoEditModel();
        model.Load(id, AutoRespository);
        return View("AutoEdit", "Auto", model);
    }

    [HttpPost]
    public ActionResult AutoSave(AutoEditModel model)
    {
        if (ModelState.IsValid)
        {
            model.SaveOrUpdate(AutoRespository);
            RedirectToAction("AutoView", "Auto", new {id = model.Id});
        }

        return View();
    }
    #endregion
}

Dann z.B. noch das passende AutoEditModel welches eine “Load” und eine “SaveOrUpdate” Methode enthält um sich selbst mit Daten zu füllen oder sich selbst zu speichern.

public class AutoEditModel : IAutoEditModel
{
    #region Member
    public int Id { get; set; }

    [Required]
    public string Marke { get; set; }

    [Required]
    public string Nummernschild { get; set; }
    #endregion

    #region Public Functions
    public void Load()
    {
        Marke = string.Empty;
        Nummernschild = string.Empty;
        Id = 0;
    }

    /// <summary>
    /// Füllen unseres Models mit den passenden Daten.
    /// </summary>
    /// Autorepository für die Abfragen
    public void Load(int autoId, IAutoRespository autoRespository)
    {
        try
        {
            var auto = autoRespository.Load(autoId);
            if (auto == null)
            {
                //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
                return;
            }

            Id = autoId;
            Marke = auto.Marke;
            Nummernschild = auto.Nummernschild;
        }
        catch (Exception exception)
        {
            //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
        }
    }

    /// <summary>
    /// Speichern oder Aktualisieren der aktuellen Modeldaten
    /// </summary>
    public void SaveOrUpdate(IAutoRespository autoRespository)
    {
        try
        {
            Auto auto = new Auto();
            auto.Id = Id;
            auto.Marke = Marke;
            auto.Nummernschild = Nummernschild;

            var savedAuto = autoRespository.AddOrUpdateAuto(auto);
            Id = savedAuto.Id;
        }
        catch (Exception exception)
        {
            //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
        }
    }
    #endregion
}

Es ist auch möglich die Models noch weiter aufzuteilen, das man ein Model zum Füllen/Anzeigen des “Editmodels” hat und ein “Postbackmodel” zum Speichern der Daten. Im Beispiel handelt es sich um ein Model welches als Anzeige- und Postbackmodel benutzt wird. Die Viewmodels können auch sehr gut mit Unit Tests getestet werden, da im Normalfall keinen Verweis auf den HTTP Context enthalten ist und alle notwendigen Abhängigkeiten wie das Repository bei Bedarf entsprechend übergeben werden.

Wenn man wie bereits erwähnt, die Models sehr strikt in Anzeige- und Postbackmodels trennt, dann ist es auch kein Problem im Controller zumindest die Anzeigemodels direkt mit zu Injecten.

In der Solution selbst sieht die Ordner- und Dateistruktur dann z.B. folgendermaßen aus.

image

Variante 2: Modelbuilder

In Variante 2 wird wieder alles strikt getrennt und man hat ein sauberes Model und einen sauberen Controller. Hier wird ein Modelbuilder erstellt der die Daten für unsere entsprechenden Models lädt oder speichert. Hier muss man selbst prüfen ob man für jedes Viewmodel einen eigenen Modelbuilder erstellt oder wie in meinem Beispiel, nur einen Modelbuilder.

Es wird der Modelbuilder in den Controller injected und das Repository wird hier direkt in den Modelbuilder injected.

public class PersonController : Controller
{
    #region Initialize
    public PersonController(IPersonModelBuilder personModelBuilder)
    {
        if (personModelBuilder == null)
        {
            throw new NullReferenceException("PersonModelBuilder ist Null.");
        }

        _personModelBuilder = personModelBuilder;
    }

    private IPersonModelBuilder _personModelBuilder;
    #endregion

    #region Views
    /// <summary>
    /// Model mit einem leeren PersonenModel anlegen
    /// </summary>
    public ActionResult AddPerson()
    {   
       return View(_personModelBuilder.Load());
    }
    
    /// <summary>
    /// Erstellen einer neuen Person
    /// </summary>
    [HttpPost]
    public ActionResult AddPerson(PersonEditModel editModel)
    {
        if (ModelState.IsValid)
        {
            _personModelBuilder.AddOrSavePerson(editModel);
            return RedirectToAction("PersonList");
        }

        return View(editModel);
    }

    /// <summary>
    /// Bearbeiten einer einzelnen Person mit der übergebenen Id
    /// </summary>
    public ActionResult EditPerson(int id)
    {
        return View(_personModelBuilder.Load(id));
    }

    /// <summary>
    /// Speichern der Personendaten die übergeben wurden im Post
    /// </summary>
    [HttpPost]
    public ActionResult EditPerson(PersonEditModel editModel)
    {
        if (ModelState.IsValid)
        {
            _personModelBuilder.AddOrSavePerson(editModel);
            return RedirectToAction("Person", "Person", new {id = editModel.Id});
        }

        return View(editModel);
    }

    /// <summary>
    /// Anzeigen der Details einer einzelnen Person
    /// </summary>
    public ActionResult Person(int id)
    {
        return View(_personModelBuilder.Load(id));
    }

    /// <summary>
    /// Laden aller Personen 
    /// </summary>
    public ActionResult PersonList()
    {
        return View();
    }
    #endregion 
}

Der Modelbuilder Selbst enthält in meinem Fall alle wichtigen Funktionen zum Füllen der entsprechenden Personen Models. Hier werden die Daten vom Repository auf das passende Viewmodel gemappt bzw. die entsprechenden Daten gespeichert.

public class PersonModelBuilder : IPersonModelBuilder
{
    #region Initialize
    /// <summary>
    /// Initialize und der ModelContainer wird per Di übergeben.
    /// </summary>
    public PersonModelBuilder(IPersonRespository personRespository)
    {
        if (personRespository == null)
        {
            throw new NullReferenceException("PersonRespository ist Null.");
        }
        _personRespository = personRespository;
    }

    private IPersonRespository _personRespository;
    #endregion

    #region Public Functions
    /// <summary>
    /// Laden aller Personendaten
    /// </summary>
    public PersonListModel LoadAllPersons()
    {
        PersonListModel model = new PersonListModel();
        try
        {
            //abrufen der Personendaten aus der Datenbank
            var persons = _personRespository.AllPersons();

            //Füllen unseres ListModels mit den passenden Personendaten
            foreach (EfModel.Person person in persons)
            {
                PersonViewModel viewModelPerson = new PersonViewModel();
                MapPersonViewModel(viewModelPerson, person);
                model.PersonList.Add(viewModelPerson);
            }

            model.AnzahlAllerAutos = 10;
        }
        catch (Exception exception)
        {
            //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
        }
        return model;
    }

    /// <summary>
    /// Laden eines leeren ViewModels
    /// </summary>
    public PersonViewModel Load()
    {
        PersonViewModel model = new PersonViewModel();
        try
        {
            model.Alter = 18;
            model.Nachname = string.Empty;
            model.Vorname = string.Empty;
            model.Id = 0;

            //Da Neues Objekt, kann es auch keine Autos haben :-)
            model.AnzahlAutos = 0;
            model.IsAltePerson = model.Alter &gt; 30;
        }
        catch (Exception exception)
        {
            //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
        }
        return model;
    }

    /// <summary>
    /// Laden einer Person mit der übergebenen PersonenId
    /// </summary>
    /// Id der Person die geladen werden soll
    public PersonViewModel Load(int personId)
    {
        PersonViewModel model = new PersonViewModel();
        try
        {
            var dbPerson = _personRespository.Load(personId);
            if (dbPerson == null)
            {
                //TODO Fehlermeldung das die Person nicht gefunden werden konnte.
                return model;
            }

            MapPersonViewModel(model, dbPerson);
        }
        catch (Exception exception)
        {
            //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
        }
        return model;
    }

    /// <summary>
    /// Erstellen oder Updaten des übergebenen PersonenEditModels
    /// </summary>
    public PersonViewModel AddOrSavePerson(PersonEditModel editModel)
    {
        PersonViewModel viewModel = new PersonViewModel();
        try
        {
            EfModel.Person person = new EfModel.Person();
            person.Id = editModel.Id;
            person.Nachname = editModel.Nachname;
            person.Vorname = editModel.Vorname;
            person.Benutzername = editModel.Benutzername;
            person.Alter = editModel.Alter;

            var dbPers = _personRespository.AddOrUpdatePerson(person);
            MapPersonViewModel(viewModel, dbPers);
        }
        catch (Exception exception)
        {
            //TODO Fehlermeldungen kapseln, damit diese entsprechend im View angezeigt werden kann.
        }
        return viewModel;
    }
    #endregion

    #region private Functions
    /// <summary>
    /// Mappen unserer DB Person auf das aktuelle ViewModel
    /// </summary>
    /// unser aktuelles ViewModel
    /// DB Personen Objekt
    private void MapPersonViewModel(PersonViewModel viewModel, EfModel.Person person)
    {
        viewModel.Alter = person.Alter;
        viewModel.Nachname = person.Nachname;
        viewModel.Vorname = person.Vorname;
        viewModel.Benutzername = person.Benutzername;
        viewModel.Id = person.Id;
        viewModel.AnzahlAutos = 10;
        viewModel.IsAltePerson = person.Alter &gt; 30;
    }
    #endregion
}

Das Model ist in der Modelbuilder Varianten wieder nur ein simples Viewmodel, nur mit Properties.

public class PersonEditModel
{
    #region Member
    public int Id { get; set; }

    [Required]
    public string Vorname { get; set; }

    [Required]
    public string Nachname { get; set; }

    [Required]
    public string Benutzername { get; set; }

    public int Alter { get; set; }
    #endregion
}

Die Ordner- und Dateistruktur in der Solution sieht in der Modelbuildervariante z.B. folgendermaßen aus.

image

Zusammenfassung

Beide Varianten lösen natürlich wieder nur einen kleinen Teil der “Probleme” auf die man beim Erstellen von Viewmodels mit der Zeit stößt und sicherlich müssen beide Varianten auch noch an die jeweilige Implementierung angepasst werden. Wenn man sich aber erst einmal daran gewöhnt hat, das ein Controller auch wirklich sauber und übersichtlich aussehen kann, dann benutzt man seine Bevorzugte saubere Implementierung in all seinen Webprojekten.

Ich habe bisher mit beiden Varianten gearbeitet und ziehe aktuell die mit dem Modelbuilder vor, da man hier den Modelbuilder in den Controller injected und man den Controller sehr leicht mit Unit Tests testen kann.

Da es sich hier nur um ein Beispiel handelt wie beide Varianten prinzipiell umgesetzt werden, handelt es sich um sehr “einfache” Beispiele die im Detail natürlich noch besser umgesetzt werden können.

Ein einfaches Beispiel mit den Passenden Models und Controllern findet man in meinem Codeplex Account. Wenn man bei Google mehr über das Thema erfahren möchte, sucht man am besten nach “Thin / Skinny Controller .NET MVC” hier gibt auch einige Beispiele mit Pros und Cons zu den einzelnen Varianten.

Sollte ich noch weitere Möglichkeiten für einen übersichtlicheren Controller übersehen haben, dann freue ich mich immer gerne über entsprechende Hinweise in den Kommentaren.

Advertisements

ASP.NET MVC und Dependency Injection für Views – Part 3


Einen View mit Dependency Injection (Di) zu initialisieren ist möglich, sollte aber nicht prinzipiell verwendet werden, sondern nur wenn z.B. ein Lokalisierungsservice direkt Strings auf dem View ausgeben und übersetzten soll. Denn im View soll normalerweise keine Logik untergebracht werden, sondern nur zur reinen Anzeige der Modeldaten dienen.

Um einen View mit Hilfe von Di zu initialisieren sind die folgenden Schritte notwendig.

Überschreiben der Standardklasse für die ViewCreation “WebViewPage”, dafür müssen wir unsere eigene Klasse anlegen die von “WebViewPage” ableitet.

 public abstract class CustomDiWebViewPage<TModel> : WebViewPage<TModel>
    {
        /// <summary>
        /// Lokalisation Interface, welches per Property Injektion vom DiFramework initialisiert wird.
        /// </summary>
        public ILocalizeable Localizeable { get; set; }
    }

Achtung wichtig ist hier das “abstract”. Das Interface und die passende Implementierung stellen wir zur Verfügung und könnte z.B. folgendermaßen aussehen:

 public interface ILocalizeable
 {
        /// <summary>
        /// den passend Lokalisierten String zurückgeben
        /// </summary>
        /// <param name="name"></param>
        /// <returns></returns>
        string GetLocalizedString(string name);
 }

 /// <summary>
 /// Interface und Implementierung nur zu Demonstrationszwecken im gleichen Projekt!
 /// </summary>
 public class Localizeable : ILocalizeable
 {
     /// <summary>
     /// den passend Lokalisierten String zurückgeben
     /// </summary>
    public string GetLocalizedString(string name)
     {
         //TODO Lokalisierung entsprechend einbinden.
        return name + " localized";
     }
 }

Damit MVC auch weiß welche Klasse für das “anzeigen” des Views zuständig ist, gibt es hier zwei Möglichkeiten:

1. In der web.config, die sich im Views Verzeichnis befindet die Zeile mit “WebViewPage” durch unsere Benutzerdefinierte ViewPage ersetzen.

 <!--<pages pageBaseType="System.Web.Mvc.WebViewPage">-->
 <pages pageBaseType="User.Web.UI.Helper.CastleWindsor.CustomDiWebViewPage">
   <namespaces>
     <add namespace="System.Web.Mvc" />
     <add namespace="System.Web.Mvc.Ajax" />
     <add namespace="System.Web.Mvc.Html" />
     <add namespace="System.Web.Optimization"/>
     <add namespace="System.Web.Routing" />
     <add namespace="User.Web.UI" />
     <add namespace="User.Global.Resources" />
     <add namespace="User.Web.Common.WebAttributes" />
   </namespaces>
 </pages>

Jetzt wird bei jedem Rendern einer Seite unsere “CustomDiWebViewPage” verwendet.

2. Im View selbst nicht @model verwenden sondern über @inherits den View angeben über den die Seite gerendert werden soll z.B.:

@inherits User.Web.UI.Helper.CastleWindsor.CustomDiWebViewPage<User.Web.Models.Account.LoginModel>

 

Im View selbst kann dann einfach auf die Lokalisierung zugegriffen werden

@Localizeable.GetLocalizedString(„Test Lokalisierung“)

So jetzt zum wichtigsten Schritt, die Dependency Injection. Leider ist es mit Castle Windsor und einer CustomControllerFactory (älterer Post von mir über Di und Castle Windsor) nicht möglich einen View wie oben beschrieben zu Injecten.

Out of the Box wird das ganze aber z.B. von ninject unterstützt und mit Hilfe des NuGet Packages:

https://www.nuget.org/packages/Ninject.MVC3

muss für die Dependency Injection für einen View nur noch unsere Implementierung dem Interface zugewiesen werden im ninject DiKernel und alles weitere Funktioniert durch die Implementierung von IDependencyResolver von ninject. Wenn ich noch ermitteln kann, wie das ganze auch mit Castle Windsor funktioniert, werde ich den Post entsprechend anpassen.

Quellen:

http://bradwilson.typepad.com/blog/2010/07/service-location-pt3-views.html

http://sachabarbs.wordpress.com/2011/02/05/mvc-dependency-injection-into-views/

http://weblogs.asp.net/scottgu/archive/2010/10/19/asp-net-mvc-3-new-model-directive-support-in-razor.aspx

ASP.NET MVC und WebAPI über Dependency Injection Instanziieren (Castle Windsor) – Part 2


Wie ich bereits in meinem ersten Artikel zur Serie TDD erwähnt habe, verwende ich das Dependency Injection (DI) Framework Castle Windsor mit ASP.NET MVC um meine Controller entsprechend zu instanziieren.

Bei der Anwendung von DI mit ASP.NET MVC muss man unterscheiden zwischen den Standard Controllern (DefaultControllerFactory) und den WebAPI Controllern (IHttpControllerActivator). Daher ist für den jeweiligen Controller-Typ ist eine eigene Implementierung notwendig.

Was macht das DI Framework eigentlich für uns?

Anhand von Regeln, die man dem DI Container hinterlegt, kann das DI Framework selbstständig Instanzen von Klassen erstellen. Aufgrund dessen, gibt es im Programm nur noch eine zentrale Stelle an der Instanzen von Klassen erstellt werden. Auch hier gibt es Ausnahmen, dazu gehören z.B. einfache Datenhaltungsklassen. Nichtdestotrotz muss jeweils anhand des vorliegenden Problems geklärt werden, ob eine Instanz über DI übergeben werden muss oder evtl. lokal instanziiert werden kann.

In einem ASP.NET MVC Projekt befindet sich die zentrale Stelle für das Einbinden von Klasseninstanzen beim Erstellen eines Controllers. Da der Standard Controller aber parameterlos ist, muss im jeweiligen Controller einfach ein Konstruktor mit den gewünschten Parametern erstellt werden. Damit dieser Konstruktor dann auch aufgerufen und mit den passenden Abhängigkeiten instanziiert wird, muss das Erstellen der Controller von uns überschrieben werden. Das Instanziieren übernimmt dann Castle Windsor für uns, mit den von uns hinterlegten Regeln.

1. ASP.NET MVC DI mit Castle Windsor initialisieren

Wie bereits erwähnt, benötigen wir einen Castle Windsor Container indem wir unsere Regeln für das Instanziieren von Klassen, z.B. Controllern ablegen. Das Ganze muss in der Global.asax im “Application_Start” entsprechend aufgerufen werden.

private static IWindsorContainer Container { get; set; }

protected void Application_Start()
{
    ...
    //Erstellen unserer Castle Windsor Instanz die wir im gesamten Projekt benutzten
    Container = new WindsorContainer();
    //Hinzufügen unserer Konfigurationen zum Kontainer.
    Container.Install(new WebInstaller(connectionString), new LoggingInstaller());
    ...
}

Über den so genannten Installer von Castle Windsor können wir unsere einzelnen Regelpakete für den Container hinzufügen (registrieren). Der WebInstaller sieht z.B in Auszügen folgendermaßen aus und bezieht sich auf eines meiner Projekte. Wie die Regeln genau aussehen können und was zu beachten ist, kann man auch sehr gut in der Castle Windsor Dokumentation nachlesen.

///
/// Installer für alle wichtigen Webverweise
///
public class WebInstaller : IWindsorInstaller
{
    private  string ConnectionString { get; set; }

    ///
    /// Initialize WebInstaller
    ///
    /// Connectionstring übergeben, der für den Webinstaller benötigt wird.
    public WebInstaller(string connectionString)
    {
        ConnectionString = connectionString;
    }

    public void Install(IWindsorContainer container, IConfigurationStore store)
    {
        //Unseren EFModelContainer registrieren mit dem passenden Connectionstring dazu, ACHTUNG wir müssen die bereits erstellte Instanz verwenden,
        //da wir darauf auch bei einigen anderen statischen "Variablen" zugreifen, z.B. Rechteverwaltung und Co.
        container.Register(Component.For(typeof(MainModelContainer)).Instance(CurrentHttpContext.GetDataModel()).LifestylePerWebRequest());

        //Alle Queries Registrieren die sich in der Assembly "User.EF.Queries" befinden und jeweils ein passendes Interface enthalten wie
        //"IMemberQueries/MemberQueries" siehe auch: http://docs.castleproject.org/Windsor.Registering-components-by-conventions.ashx
         container.Register(Classes.FromAssemblyContaining().InNamespace("User.EF.Queries").WithService.DefaultInterfaces().LifestylePerWebRequest());

        //Alle Controller Registrieren die IController beinhalten/nutzen.
        container.Register(Classes.FromAssemblyContaining().BasedOn().LifestylePerWebRequest());
        //Alle WebAPI Controller verwenden IHttpController
        container.Register(Classes.FromAssemblyContaining().BasedOn().LifestylePerWebRequest());
        ....
      }
}

Nach dem Castle Windsor soweit vorbereitet ist und unseren Controller entsprechend instanziieren kann, benötigen wir unsere eigene ControllerFactory. Dafür muss eine neue Klasse erstellt werden, die von “DefaultControllerFactory” ableitet und der wir unseren Castle Windsor Container in einem eigenen Konstruktor übergeben können. Mit Hilfe von “this._container.Resolve(controllerType)” entscheidet Castle Windsor selbstständig welcher Controller aufgerufen wird und welche Abhängigkeiten erstellt sowie instanziiert werden müssen.

 public class CustomControllerFactory : DefaultControllerFactory
 {
     private readonly IWindsorContainer _container;

     ///
     /// Den Windsor Container für unser Projekt übergeben
     ///
     /// Unser aktueller Windsor Kontainer
     public CustomControllerFactory(IWindsorContainer container)
     {
         if (container == null)
         {
             throw new NullReferenceException("IWindsorContainer is Null");
         }

         _container = container;
     }

     ///
     /// Erstellen der passenden Controller Instanzen anhand unseres Containers werden die Instanzen automatisch aufgelöst.
     ///
     protected override IController GetControllerInstance(RequestContext requestContext, Type controllerType)
     {
         if (controllerType == null)
         {
             throw new HttpException(404, string.Format("The controller for path '{0}' could not be found.", requestContext.HttpContext.Request.Path));
         }

         //Unseren Controller auflösen per Castle Windsor
         var controller = (IController)this._container.Resolve(controllerType);

         return controller;
     }

     public override void ReleaseController(IController controller)
     {
         //Wenn der Controller "aufgelöst werden soll, dann auch den Controller aus dem Context entfernen.
         if (HttpContext.Current.Items.Contains(CurrentControllerIndexName))
         {
             HttpContext.Current.Items.Remove(CurrentControllerIndexName);
         }

         this._container.Release(controller);
     }
 }

Damit unsere neue Factory zum Erstellen von Controllern auch von ASP.NET MVC “gefunden” bzw. versendet werden kann, muss diese noch registriert werden. Dies geschieht auch in der global.asax im “Application_Start”

//Erstellen unserer CustomControllerFactory zum Instanziieren der Passenden Controller
var customControllerFactory = new CustomControllerFactory(Container);
//Unsere CustomControllerFactory als Standard Factory zum Erstellen von Controllern setzten, damit diese auch von MVC verwendet wird.
ControllerBuilder.Current.SetControllerFactory(customControllerFactory);

Wenn soweit alles eingestellt ist, kann ein MVC Controller z.B. auch folgenden Konstruktor besitzen, denn durch Castle Windsor werden alle Abhängigkeiten entsprechend aufgelöst und instanziiert übergeben.

 [CustomAuthorize]
 public class AccountController : ControllerBaseUser
 {
     #region Member
     ///
     /// Unser Repository für die Mitarbeiterabfragen
     ///
     private readonly IDiMembership _membership;

     ///
     /// User Repository für alle allgemeinen Abfragen fürs Web.
     ///
     private readonly IWebQuerySummary _webQueries;

     ///
     /// Mailverwaltung für die Accountverwaltung
     ///
     private readonly IAccountMails _accountMails;
     #endregion

     #region Initialize
     public AccountController(IDiMembership membership, IAccountMails accountMails, IWebQuerySummary webQueries)
     {
         if (membership == null)
         {
             throw new NullReferenceException("IDiMembership is Null");
         }

         if (accountMails == null)
         {
             throw new NullReferenceException("AccountMails is Null");
         }

         if (webQueries == null)
         {
             throw new NullReferenceException("WebQuery is Null");
         }

         _webQueries = webQueries;
         _accountMails = accountMails;
         _membership = membership;
     }
     #endregion

2. ASP.NET WebAPI mit Castle Windsor initialisieren

Leider funktioniert die DI der Standard Controller nicht bei den WebAPI Controllern. Damit auch die WebAPI Controller mit DI instanziiert werden können sind die folgenden Schritte notwendig.

Dabei kann natürlich auch in der WebAPI auf die gleichen DI Regeln wie bei den Standard Controllern zurückgegriffen werden. Wir müssen nur im WebInstaller aufpassen, dass wir auch eine Regel für die WebAPI Controller angeben, damit diese aufgelöst werden können.

//Alle WebAPI Controller verwenden IHttpController
container.Register(Classes.FromAssemblyContaining().BasedOn().LifestylePerWebRequest());

Dann kann auch der bereits angelegte Container für die Standard Controller auch für die WebAPI verwendet werden.

Die WebAPI benötigt eine eigene Controller Klasse, der wir unseren DI Container übergeben können und in der dann die WebAPI Controller entsprechend aufgelöst werden können.

///
/// Um die webApi auch über IoC nutzen zu können ist folgender Code notwendig.
/// Und dann muss das ganze über "GlobalConfiguration.Configuration" in der Global Assax registriert werden.
/// http://www.cafe-encounter.net/p1316/windsor-di-with-asp-net-webapi
///
public class CustomWebApiController : IHttpControllerActivator
{
    private readonly IWindsorContainer _container;

    public CustomWebApiController(IWindsorContainer container)
    {
        this._container = container;
    }

    public IHttpController Create(HttpRequestMessage request, HttpControllerDescriptor controllerDescriptor, Type controllerType)
    {
        var controller = (IHttpController)this._container.Resolve(controllerType);
        request.RegisterForDispose(new Release(() => this._container.Release(controller)));
        return controller;
    }

    private class Release : IDisposable
    {
        private readonly Action release;

        public Release(Action release)
        {
            this.release = release;
        }

        public void Dispose()
        {
            this.release();
        }
    }
}

Jetzt muss, wie bereits bei den Standard Controllern, unsere neue Klasse nur noch registriert werden, so dass sie die WebAPI Controller Instanzen anlegen kann. Dazu wird wieder in der Global.asax in der “Application_Start” die entsprechende Codezeile eingefügt.

GlobalConfiguration.Configuration.Services.Replace(typeof(IHttpControllerActivator), new CustomWebApiController(Container));

Und schon kann unser WebAPI Controller den folgenden Konstruktor enthalten.

 public class AdminApiController : ApiController
 {
     #region Member
     ///
     /// User Repository für alle allgemeinen Abfragen fürs Web.
     ///
     private readonly IWebQuerySummary _webQueries;
     #endregion

     #region Initialize
     public AdminApiController(IWebQuerySummary webQueries)
     {
         if (webQueries == null)
         {
             throw new NullReferenceException("WebQuery is Null");
         }

         _webQueries = webQueries;
     }
     #endregion
}

CodePlex

Mein bereits angefangenes Projekt findet Ihr wie immer unter Codeplex –> DiTemplates –> UserManagement

Quellen

http://www.cafe-encounter.net/p1316/windsor-di-with-asp-net-webapi

http://www.devtrends.co.uk/blog/how-not-to-do-dependency-injection-the-static-or-singleton-container

http://docs.castleproject.org/Windsor.Registering-components-by-conventions.ashx

ASP.NET MVC & TDD mit Unit Tests “Grundlagen” – Part 1


Wenn man sich das erste mal intensiv mit dem Thema Test Driven Development (TDD) auseinandersetzt, dann hat man es hier mit vielen Begriffen und evtl. neuen Technologien zu tun. Da ich bisher auch noch sehr frisch auf dem Gebiet des TDD unterwegs bin und ich meine aktuellen Entwicklungsversuche noch nicht als TDD bezeichnen würde, will ich hier einem kurzen Überblick über die verwendeten Begrifflichkeiten und Technologien geben auf die ich gestoßen bin und dann in einem späteren Artikel im Detail auf einzelne Umsetzungen eingehen.

Um einen ersten Einblick in die Entwicklung für TDD zu bekommen habe ich mir eine Projektvorlage für ein ASP.NET MVC4 Projekt mit Entity Framework 5 (EF5) “erstellt” mit den passenden Klassenbibliotheken für die Contracts (Interfaces), Webseite (Ui), Models, Entities, … (Grundprojekt kann bei mir unter Codeplex angeschaut werden).

Auf die folgenden Themen bin ich dabei gestoßen:

  • Dependency Injections (DI) und Inversion of Control (IoC)
  • DI Frameworks wie Castle Windsor, Unity, Autofac, …
  • Simplemembership Provider für eine einfache Userverwaltung
  • Unit of Work und Repository Design Pattern für die EF Umsetzung
  • Moq und shims bzw. stubs für die Unit Tests

Dependency Injections (DI) und Inversion of Control (IoC)

Diese beiden Begrifflichkeiten hängen eng mit einander zusammen und  ich wüsste spontan nicht wo der Unterschied lieg oder wie ich diesen erläutern sollte, daher nicht wundern, wenn diese beiden Begriffe euren Weg immer gemeinsam kreuzen.

Durch DI werden dem Konstruktor einer Klasse bereits wichtige Objekte übergeben und nicht mehr in der klasse selbst Instanziiert/erstellt. Die Umsetzung von DI ist auch möglich ohne ein entsprechendes DI Framework wie z.B. Castle Windsor, das wird dann z.B. auch “poor man’s dependency” genannt.

Um ASP.NET MVC mit DI umzusetzen z.B. für das DB Repository wird nur noch an einer Stelle und nicht mehr in jeder Klasse selbst eine Instanz unseres Repositories erstellt. In ASP.NET MVC wird hier die “Global.asax” verwendet und eine eigene ControllerFactory erstellt, welche von der DefaultControllerFactory ableitet und die Funktion „GetControllerInstance” überschreibt und die jeweils angefragte Controllerinstanz zurück gibt. Der Controller besteht dann nicht mehr aus einem Parameterlosen Konstruktor, sondern hat z.B. unser DB Repository als Parameter, welchen er Instanziiert übergeben bekommt. Dabei ist es immer wichtig das entweder Abstrakte Klassen oder Interfaces für die Übergabeparameter verwendet werden um später einfacher die Unit Tests erstellen zu können und um nicht immer von einer Implementierung abhängig zu sein. Hier lassen sich in den Tests dann einfacher eigene Testimplementierungen umsetzten.

DI Frameworks

DI Frameworks nehmen einem die Arbeit ab, wenn es darum geht z.B. einen Abhängigkeiten Baum aufzulösen. Denn man Definiert an einer Stelle im Programm welches Interface z.B. durch welche Klasse Instanziiert wird und wenn diese Klasse auch wieder eine Abhängigkeit besitzt und wir diese bereits definiert haben, dann wird diese ebenfalls automatisch aufgelöst. Hier lässt sich ebenfalls viel Zeit beim Definieren von Abhängigkeiten sparen, wenn man sich an eigene Namenskonventionen hält, denn diese lassen sich meist automatisch vom DI Framework auflösen. In unserer ASP.NET MVC Anwendung wird nur beim Erstellen des Controllers die passende Controllerinstanz in unsere eigenen ControllerFactory aufgelöst und die entsprechende Instanz zurückgegeben und an keiner weiteren Stelle wird das DI Framework benutzt um Objekte zu erstellen!

Wer einen guten Einblick in den Umgang mit DI und den zugehörigen Frameworks haben möchte, dem kann ich nur das Buch von Mark Seemann empfehlen “Dependency Injection in .NET” hier werden alle wichtigen Grundlagen was man beachten sollte und wie man DI umsetzt beschrieben.

Ich persönlich habe mich für die Umsetzung der DI Aufgaben für Castle Windsor entschieden, da ich bereits einmal damit Kontakt hatte und ich aktuell keine speziellen DI Aufgaben gesehen habe die ich damit nicht umsetzten könnte.

Simplemembership Provider für die Userverwaltung

An dieser Stelle muss ich vorab bereits einmal auf einen älteren Artikel “SimpleMembership mit ASP.NET MVC4 und EF” von mir verweisen, hier ist beschrieben wie man den SimpleMembership Provider einsetzt.

Denn ich habe mich in meinem Projekt gegen die Verwendung des SimpleMembership Providers entschieden. Da ich ein Beispielprojekt erstellen wollte in dem auch die Nutzerverwaltung per DI umgesetzt wird. Der Simplemembership Provider verwendet aber Statische Funktionen und hier ist keine DI möglich. Wer es nicht auf die Pure Umsetzung von DI anlegt, kann sicherlich problemlos auf den Simplemembership Provider zurückgreifen, so lange der Funktionsumfang ausreichend ist. Sollte man aber bereits zu beginn merken das man diesen erweitern muss, dann würde ich hier eher auf eine eigene Umsetzung setzten.

Unit of Work und Repository Design Pattern (EF)

Wenn man seine Projekte mit EF umsetzt und dann noch auf DI setzt, wird man schnell mit den Begriffen “Unit of Work” und “Repository Desing Pattern” in Kontakt kommen.

Da ich mich aber für EF5 entschieden habe und EF5 bereits diese Muster umsetzt mit dem DBContext, habe ich hier auf eine weitere Zwischenschicht verzichtet und keine zusätzliche “Unit of Work” bzw. “Repository Design Pattern” erstellt. Hier gibt es auch ein paar interessante Artikel zum Thema, ob man wirklich noch eine weitere Abstraktionsschicht benötigt.

http://cockneycoder.wordpress.com/2013/04/07/why-entity-framework-renders-the-repository-pattern-obsolete/
http://stackoverflow.com/questions/16467576/using-unitofwork-and-repository-pattern-with-entity-framework

Ob eine weitere Abstraktionsschicht hier wirklich notwendig ist, muss am Ende jeder für sich selbst entscheiden ob er den zusätzlichen Aufwand betreiben möchte.

Ich habe mich dafür bei der Erstellung des DBContext und für das Trennen der Entities vom Kontext entschieden, was sehr gut in dem Video Beitrag von Uli Armbruster “Entity Framework – Teil 1 DBContext und POCOS” erläutert wird.

Moq und shim bzw. stubs für die Unit Tests

Erst nach dem ich den ersten Teil meines Projektes erfolgreich erstellt hatte, war ich auch bereit für meine ersten Unit Tests, auch wenn dies nicht dem richtigen Vorgehen von TDD entspricht. In den Unit Tests selbst wird z.B. kein DI Framework verwendet, hier ernten wir nur die Früchte unserer Umsetzung in dem wir recht einfach unsere Objekte (Interfaces) Mocken können. Dabei ist es wichtig das wir alle Funktionen als Virtual deklariert, haben die wir mit moq mocken wollen.

Aber was ist Mocken eigentlich und was ist moq? Bei Unit Tests werden die Funktionen von Klassen gemockt auf die man in seiner zu testenden Funktion / Klasse zugreift, d.h. man kann angeben welche Rückgabewerte diese Funktionen liefern sollen, um damit den Funktionsablauf der Testfunktion zu bestimmen. Dafür gibt es unterschiedliche Mocking Frameworks und eines dieser Frameworks heißt “moq”, welches ich per NuGet in mein Testprojekt eingebunden habe.

Mit moq kann man aber nicht den Rückgabewert von allen Funktionsaufrufen anpassen, vor allem wenn es sich um System DLLs mit Statischen Funktionen handelt. Hier gibt es seit VS 2012 ab Premuim SP2 die Möglichkeit ganze DLLs zu “faken” siehe dazu z.B. “VS 2012 Fake DLLs für Tests (stubs und shims)”, die Integrierte MS Variante ist dabei die mir einzig bekannte Version die kostenlos ist um z.B. auch statische Funktionen zu faken/mocken.

Codeplex

Mein bereits angefangenes Projekt findet Ihr wie immer unter Codeplex –> DiTemplates –> UserManagement

Wie bereits weiter oben erwähnt, bin ich noch nicht so lange auf diesem Gebiet unterwegs und es gibt einfach unglaublich viel zu lesen über dieses Thema. Daher wenn jemand einen guten Vorschlag hat was ich evtl. falsch mache oder besser machen könnte, dann freue ich mich immer über einen guten Kommentar.

Auf die direkte Umsetzung einzelner Punkte werde ich in späteren Blogeinträgen genauer eingehen.

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