Die Magie von ASP.NET MVC-Anwendungen mit Klassendiagrammen dokumentieren

Framework als Basis von ASP.NET MVC

ASP.NET MVC-Anwendungen bringen ein Framework mit, mit dessen Hilfe wir unsere Anwendungen nach dem Model-View-Controller-Muster einfacher bauen können.

Wir müssen uns nur an ein paar grundlegende Regeln halten, z.B. müssen die Controller-Klassen zur Steuerung der Anwendung im Ordner Controllers und die fachlichen Klassen, die z.B. die zu speichernden Objekte repräsentieren, unterhalb von Models abgelegt werden. Die Webseiten werden in Form von *.aspx-Seiten unterhalb des Ordners View abgelegt. Das sind die grundlegenden Regeln – natürlich gibt es noch einige weitere Kleinigkeiten zu beachten, aber man merkt schon an diesen Beispielen worum es im Prinzip geht.

Magie von ASP.NET MVC

Was dann folgt, wirkt wie Magie: Öffnet man im Browser eine URL die zu unserer Anwendung gehört, wird der richtige Controller gefunden, dessen Operationen werden aufgerufen, Daten fließen in die View, eine Webseite wird geöffnet und zeigt die alles schön an. Das ist wirklich eine tolle Sache! Aber es ergibt sich folgendes Problem:

Wie kann man eine Anwendung, die auf der Magie eines Frameworks beruht, mit UML-Klassendiagrammen dokumentieren?

Die Antwort ist ganz einfach und zwei Teile:

Antwort – Teil 1

Die UML hat kein Modellelement, um Magie darzustellen. Also belassen Sie es bei der Dokumentation der von Ihnen selbst programmierten Klassen. Die Magie ergibt sich aus dem Framework, das Sie nicht dokumentieren müssen. Erstellen Sie deshalb zunächst ein Diagramm, das die Model-Klassen mit ihren Beziehungen zeigt.

Model-Klassen in ASP.NET MVC-Anwendung

Erstellen Sie dann ein Klassendiagramm, das die Controller-Klassen zeigt. Es gibt in der Regel keine Beziehungen zwischen den Controllern. Aber alle Controller haben dieselbe Oberklasse, die Sie mit dem MVC-Framework verbindet. Stellen Sie also die Controller-Klassen mit Ihrer gemeinsamen Oberklasse dar.

Controller-Klassen in ASP.NET MVC-Anwendung

Für die Views können Sie kein Klassendiagramm erstellen, weil es sich um Webseiten handelt, die leider nicht in den Klassendiagrammen eines Visual Studio MVC-Projekts dargestellt werden können. Hier reicht es aus, wenn Sie die Projektstruktur aufklappen und die in den Ordnern enthaltenen Dateien zeigen.

mvc-dokumentieren_view

Antwort Teil 2

Sie sollten (z.B. in Abschlussarbeiten) die Gelegenheit nicht verpassen, Ihr Wissen über das MVC-Muster umfassend darzustellen. Deshalb ist ein Klassendiagramm, das das MVC-Muster erklärt, eigentlich unerlässlich. Das geht im Visual Studio am besten, wenn Sie zusätzlich zu ihren vorhandenen Projekten ein weiteres Modellierungsprojekt „Entwurf“ zu Ihrer Projektmappe hinzufügen. In diesem Modellierprojekt erstellen Sie dann ein Klassendiagramm, mit dem Sie das generelle MVC-Muster darstellen.

mvc-dokumentieren_modellierungsprojekt-entwurf-allg-muster

Legen das neue Klassendiagramm wirklich im Modellierungsprojekt an, denn wenn Sie es im MVC-Projekt anlegen, würden die dort modellierten Klassen auch gleich als Quellcode in *.vb-Dateien im Projekt erzeugt. Das könnte die Struktur des kaputtmachen, die wir zur Einhaltung der Regeln aber brauchen.

Sehen Sie sich die Unterlagen aus der Vorlesung oder dem Seminar an, wie dort das MVC-Muster modelliert wurde. Erstellen Sie ein entsprechendes Klassendiagramm und erläutern Sie es in der schriftlichen Dokumentation, bevor Sie die in Ihrem ASP.NET MVC-Projekt einzeln modellierten Controller- und Model-Klassendiagramme darstellen und erklären. Für die Erläuterungen zu den Views reicht es aus, wenn Sie die Projektstruktur aufklappen und die in den Ordnern enthaltenen Dateien zeigen.

Schreibe einen Kommentar