Archiv für den Monat September 2014

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