Unlimited Plugins, WordPress themes, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Code
  2. ASP.NET

Erstellen einer ASP.NET MVC4-Anwendung mit EF und WebAPI

Read Time: 18 mins

German (Deutsch) translation by Władysław Łucyszyn (you can also view the original English article)

ASP.NET MVC hat einen langen Weg zurückgelegt, seit "The Gu" 2007 während einer Flugzeugfahrt zu einer Konferenz einige Ideen aufgeschrieben hat. In knapp vier Jahren hat ASP.NET MVC seine vierte Veröffentlichung gesehen und bietet Entwicklern eine Umgebung das erleichtert die Entwicklung, rationalisiert Prozesse und fördert moderne Muster.


Eintauchen

Direkt einzusteigen ist eine der besten Möglichkeiten, neue Technologien in den Griff zu bekommen. Lassen Sie uns weitermachen und direkt in die Codez eintauchen!

Aufstellen

Ich werde Visual Studio 2012 Release Candidate verwenden, das hier verfügbar ist. Ich empfehle auch, SQL Server 2012 herunterzuladen, da das neue Management Studio eine dringend benötigte Verbesserung gegenüber früheren Versionen darstellt.

Sobald VS 2012 betriebsbereit ist, erstellen Sie ein neues Projekt. Gehen Sie zu Datei -> Neues Projekt und wählen Sie eine Internetanwendung aus. Es ist keine perfekte Vorlage, aber es wird die Arbeit erledigen.

Project OptionsProject OptionsProject Options

Hinweis: Der Code für diese Demoanwendung befindet sich in einem Github-Repository. Ich werde nicht jedes einzelne Stück Code in dieser App durchgehen, aber Sie werden am Ende dieses Tutorials ein gutes Verständnis einer MVC4-Anwendung haben.

Entity Framework

Ich werde Entity Framework (EF) Code First für das Datenmodell verwenden. Mit EF Code First können wir Datenbanktabellen mit nur wenigen Plain Old CLR Objects (POCO) generieren. Außerdem können wir mit EF LINQ to Entities und Lambda-Ausdrücke verwenden, was das Abfragen und Ausgeben von Befehlen vereinfacht. Ein Win-Win!

Unsere Anwendung wird eine Überprüfungsseite für die Überprüfung von ... Sachen sein. Daher muss das Datenmodell alle notwendigen Details für eine einzelne Überprüfung enthalten. Wir beginnen mit einer Klasse namens Review. Schreiben Sie die folgende Klasse in eine eigene Datei im Models-Verzeichnis:

Die Review-Klasse verfügt über ihre Id (den Primärschlüssel), die Content-Eigenschaft zum Speichern der Bewertung, ein Topic, z. B. einen Restaurantnamen (oder einen beliebigen Namen einer Organisation), eine Email-Eigenschaft und ein IsAnonymous-Flag, um anzuzeigen, ob der Überprüfer anonym ist. Die CategoryId und die Category-Eigenschaften erstellen eine Fremdschlüsselbeziehung, um eine Bewertung an eine Category zu binden (zB: Ärzte, Zahnärzte usw.). Und zuletzt ist eine Sammlung von Comment-Objekten.

Schreiben Sie nun die Klasse Comment. Fügen Sie die neue Klasse erneut zum Models-Verzeichnis hinzu:

Die Kommentarklasse hat eine Id-Eigenschaft für den Primärschlüssel, Content des Kommentars, eine Email-Eigenschaft und ein IsAnonymous-Flag für Benutzer. Dann gibt es die Eigenschaften ReviewId und Review, um eine Fremdschlüsselbeziehung zwischen Kommentaren und Bewertungen zu erstellen.

Zuletzt ist die Category-Klasse. Hier ist sein Code:

Diese Klasse ist selbsterklärend.

Sie haben wahrscheinlich bemerkt, dass die Datenanmerkung [Required] in den obigen Klassen häufig verwendet wird. Diese bezeichnen ein Feld in der Datenbank, das keine NULL-Werte zulässt, und stellen später eine Validierung bereit. Sie können auch Ihre eigenen benutzerdefinierten Validierung-Attribute erstellen, wenn Sie dies wünschen. Zusätzlich zu [Required] haben wir für einige Eigenschaften auch das Schlüsselwort virtual verwendet; diese Eigenschaften bezeichnen Fremdschlüsselbeziehungen mit anderen Tabellen.

Um die entsprechenden Tabellen für diese Klassen zu erstellen, müssen Sie eine DbContext-Klasse erstellen. Der folgende Code erstellt eine Kontextklasse namens ReviewedContext:

Mit EF Code First können wir Datenbanktabellen mit nur wenigen Plain Old CLR Objects (POCO) generieren.

Jede Eigenschaft dieser Klasse entspricht beim Generieren der Datenbank einer Tabelle. Configuration.ProxyCreationEnabled = false; stellt sicher, dass die Entitäten als Objekte ihrer jeweiligen Klassen und nicht als Proxys abgerufen werden, was das Debuggen erheblich vereinfacht.

Als nächstes richten wir einen Datenbankinitialisierer ein. Ein Initialisierer stellt sicher, dass die Datenbank korrekt erstellt wird, wenn das Datenmodell geändert wird. Ohne Initialisierer müssen Sie die Datenbank manuell löschen, wenn Sie eine Änderung an einem Ihrer POCOs vornehmen. Es stehen verschiedene Arten von Initialisierern zur Auswahl: DropCreateDatabaseAlways und DropCreateDatabaseIfModelChanges. Die Namen sind selbsterklärend. Wir werden DropCreateDatabaseIfModelChanges verwenden.

Die Initialisierer DropCreateDatabaseAlways und DropCreateDatabaseIfModelChanges haben einen Nebeneffekt: Sie löschen die Tabellen (und damit die Daten) in der Datenbank, wenn sich die Modellstruktur ändert. EF Code First bietet jedoch eine dritte Möglichkeit zum Generieren von Datenbanken: Migrationen. Diese neue Funktion verfolgt Änderungen an der Datenbank und verliert keine Daten, wenn sich die POCO-Klassen ändern.

Hier ist der Code für unseren Initialisierer:

Die ReviewedContextInitializer-Klasse überschreibt die Seed()-Methode. Dies gibt uns die Möglichkeit, unsere Datenbank mit einigen Testdaten zu füllen. Jetzt müssen wir die Datei Global.asax besuchen und die folgende Zeile zur Methode Application_Start() hinzufügen:

Lassen Sie uns einige Repositorys zum Abrufen von Daten aus der Datenbank erstellen, und wir werden mit Ninject fortfahren und Dependency Injection (DI) einrichten. Wenn Sie nicht genau wissen, was DI oder Inversion of Control (IoC) sind, dann nehmen Sie sich einen Moment Zeit, um diesen Artikel zu lesen.

Grundsätzlich besteht die Idee der Abhängigkeitsinjektion darin, eine konkrete Abhängigkeit in eine Klasse zu injizieren, im Gegensatz zur harten Codierung der Klasse, um von der konkreten Abhängigkeit abhängig zu sein. Mit anderen Worten, es ist eine Entkopplung einer konkreten Klasse von einer anderen. Wenn das immer noch schlammklar ist, schauen wir uns ein kurzes Beispiel an:

Dieser Code erstellt eine Klasse namens Foo. Es hängt von der Funktionalität eines Objekts vom Typ Bar ab, und das Bar-Objekt wird innerhalb der Foo-Klasse erstellt. Dies kann schwierig zu warten und zu testen sein, weil:

  • Foo und Bar sind eng miteinander verbunden. Infolgedessen ist die Wartung nicht ideal.
  • Foo ist von einer bestimmten Implementierung von Bar abhängig, was Unit-Tests erschwert.

Dieser Code kann mit nur wenigen Modifikationen verbessert werden. Schauen Sie sich die überarbeitete Foo-Klasse an:

In knapp vier Jahren hat ASP.NET MVC seine vierte Veröffentlichung...

Nun ist die Foo-Klasse nicht von einer bestimmten Implementierung von Bar abhängig. Stattdessen wird Foo über dessen Konstruktor ein Objekt einer Klasse geliefert, die die IBar-Schnittstelle implementiert. Dieser Ansatz verbessert die Wartbarkeit erheblich und ermöglicht es uns gleichzeitig, jedes IBar-Objekt einzufügen, was es einfacher macht, unseren Code zu testen.

Nachdem wir diese kurze Beschreibung aus dem Weg geräumt haben, bringen wir Ninject zum Laufen. Starten Sie die Paketmanager-Konsole und führen Sie Install-Package Ninject.MVC3 aus. Dadurch wird Ninject zu unserem Projekt hinzugefügt.

Das erste Repository, das wir erstellen, ist das ReviewsRepository, und es implementiert die IReviewRepository-Schnittstelle. Hier ist die Schnittstelle:

Diese Schnittstelle stellt sicher, dass unsere Review-Repositorys die grundlegenden CRUD-Operationen bereitstellen. Wir haben auch den Nutzen, Bewertungen nach einer bestimmten Kategorie abzurufen sowie die Kommentare zu einer bestimmten Bewertung abzurufen. Lassen Sie uns nun eine konkrete Klasse schreiben, die diese Schnittstelle implementiert:

WebAPI ist ein MVC-ähnliches Framework, mit dem wir einfach eine RESTful-API erstellen können...

Dieses Repository basiert auf einem ReviewedContext-Objekt, das als Klassenvariable gespeichert wird. Dadurch können wir LINQ in allen Methoden des Repositorys verwenden, was die Datenbankinteraktion vereinfacht.

WebAPI hat eine nette Funktion, mit der wir unser eigenes DI-Framework hinzufügen können. Diese Funktion würde den Rahmen dieses Tutorials sprengen, also lesen Sie unbedingt diesen Artikel, um dieses Setup zu erhalten.

Einer der wichtigsten Speicherorte für unseren Code ist der Ordner App_Start, der eine Datei namens NinjectCommonWeb.cs enthält (bei der Installation von Ninject wird diese Datei automatisch zu App_Start hinzugefügt). Diese Datei enthält eine statische Klasse namens NinjectWebCommon und eine Methode namens RegisterServices(). Fügen Sie in dieser Methode den folgenden Code hinzu:

Die ersten drei Anweisungen binden eine Schnittstelle an eine konkrete Implementierung der Schnittstelle, und die vierte Zeile richtet die DI für WebAPI ein (die im oben genannten Artikel behandelte Funktion).

WebAPI

Lassen Sie uns nun die Controller für die API erstellen. WebAPI ist ein MVC-ähnliches Framework, mit dem wir einfach einen RESTful-Dienst erstellen können, und es kann innerhalb einer MVC4-Anwendung, in einem eigenen Projekt ausgeführt oder außerhalb von IIS selbst gehostet werden. Aber das ist nicht alles; Es hat viele andere Funktionen, wie zum Beispiel: Inhaltsverhandlung (um die Daten automatisch in ein beliebiges Format zu serialisieren), Modellbindung, Validierung und vieles mehr.

Wir müssen zuerst einen Endpunkt mit WebAPI erstellen, und wir tun dies, indem wir eine Klasse erstellen, die ApiController erbt. Damit anzufangen ist recht einfach. Visual Studio 2012 verfügt über ein neues Feature, das einen neuen, teilweise gerüsteten Controller erstellt.

Create ApiControllerCreate ApiControllerCreate ApiController

Dadurch wird eine Controller-Klasse mit einigen bereits für Sie definierten Methoden erstellt. Hier ist ein Beispiel:

Die Methodennamen entsprechen dem HTTP-Verb, das sie repräsentieren. Wir erstellen jetzt die ReviewsController-Klasse. Der Code ist etwas lang, aber ziemlich einfach.

Dieser Code verwendet IReviewRepository- und ICategoriesRepository-Objekte, um die entsprechende Aktion auszuführen (zB: Abrufen von Daten für GET-Anforderungen, Hinzufügen von Daten mit POST-Anforderungen usw.). Diese Repositorys werden mit Ninject über Constructor Injection injiziert.

Wenn Sie Fiddler noch nicht haben, holen Sie es sich jetzt – auch wenn Sie kein .NET-Entwickler sind.

Beachten Sie, dass einige der Methoden unterschiedliche Datentypen zurückgeben. WebAPI gibt uns die Möglichkeit, einen Nicht-String-Datentyp (wie IEnumerable<Review>) zurückzugeben und das Objekt zu serialisieren, um es in der Serverantwort zu senden. Sie können auch die neue HttpResonseMessage-Klasse verwenden, um zusammen mit den zurückgegebenen Daten einen bestimmten HTTP-Statuscode zurückzugeben. Eine Möglichkeit zum Erstellen eines HttpResponseMessage-Objekts besteht darin, Request.CreateResponse(responseCode, data) aufzurufen.

Wir können unser WebAPI-Projekt mit einem Tool wie Fiddler2 richtig testen. Wenn Sie Fiddler noch nicht haben, holen Sie es sich jetzt – auch wenn Sie kein .NET-Entwickler sind. Fiddler ist ein fantastisches HTTP-Debugging-Tool. Sobald Sie Fiddler ausführen, klicken Sie auf RequestBuilder und geben Sie die API-URL ein, die Sie testen möchten. Wählen Sie dann den entsprechenden Anforderungstyp aus. Wenn Sie eine POST-Anfrage stellen, geben Sie unbedingt einen Content-Type: application/json-Header an und fügen Sie dann eine gültige JSON-Struktur in den Anfragetext ein. Das folgende Bild zeigt eine unformatierte JSON POST-Anfrage an die api/reviews-URL:

Wenn Sie die Anfrage senden, sehen Sie etwa das folgende Bild:

Beachten Sie, dass der Statuscode der POST-Anforderung 201 ist. Die WebAPI leistet hervorragende Arbeit, um den richtigen Statuscode für einen RESTfull-Webdienst zurückzugeben. Viel Spaß mit Fiddler2, es ist ein fantastisches Werkzeug!

Mit WebAPI können Sie das Routing für die Controller festlegen (genau wie MVC). In MVC4 wird dem Ordner App_Start eine Datei RouteConfig.cs hinzugefügt. Routen für ein WebAPI-Projekt sind wie MVC-Routen.

Die DefaultApi-Route wird automatisch von Visual Studio generiert. Die anderen beiden Routen sind benutzerdefiniert und werden bestimmten Methoden auf dem Reviews-Controller zugeordnet. Es gibt viele Artikel und Tutorials, die gute Informationen zum Routing bieten. Achten Sie darauf, dieses zu überprüfen.

MVC4

Das deckt viel von dem ab, was WebAPI zu bieten hat. Als Nächstes schreiben wir einige Methoden zum Anzeigen der Daten. Wir werden die API in Kürze verbrauchen, aber vorerst verwenden wir die Repositorys in unserem HomeController. Ein HomeController wurde von Visual Studio erstellt; Lassen Sie uns einfach seine Methoden ändern, um die Daten anzuzeigen. Lassen Sie uns zunächst eine Liste der Kategorien in der Index-Methode abrufen.

Hier verwenden wir weiterhin DI, indem wir die Repositorys als Parameter für den HomeController-Konstruktor akzeptieren. Ninject spritzt uns automatisch die passenden Betonklassen ein. Als Nächstes fügen wir der Index-Ansicht etwas Code hinzu, um die Kategorien anzuzeigen:

Dadurch wird eine Liste von Kategorien erstellt, auf die Benutzer klicken können. Fügen Sie nun HomeController eine neue Methode hinzu, die eine Review abruft. Wir nennen diese Methode Reviews, die hier gezeigt werden:

Da für /{controller}/{action}/{id} bereits eine Route existiert, können Sie eine URL wie Home/Reviews/Doctors verwenden. Die Routing-Engine übergibt "Doctors" als id-Parameter an die Reviews-Methode. Wir verwenden die id als Kategorie und rufen alle Bewertungen ab, die dieser Kategorie zugeordnet sind. Wenn jedoch keine Kategorie angegeben ist, rufen wir einfach alle Bewertungen in der Datenbank ab. Sobald wir alle Bewertungen haben, übergeben wir die Bewertungsliste an die Ansicht. Schauen wir uns jetzt die Ansicht an:

Dieser Code verwendet eine neue Funktion von MVC4. Das class-Attribut des <ul/>-Elements wird nicht im HTML-Code angezeigt, wenn hasComments null ist. Lesen Sie hier mehr über diese Funktion.

JavaScript

Keine moderne Web-App ist ohne JavaScript vollständig, und wir verwenden es, um unseren WebAPI-Dienst zu nutzen. Dafür verwenden wir Backbone.js; Also, gehen Sie weiter und laden Sie Backbone und seine Abhängigkeit Underscore herunter. Legen Sie die JavaScript-Dateien im Verzeichnis Scripts ab.

Wir werden eine weitere neue MVC4-Funktion namens Skriptbündelung nutzen. Im Ordner App_Start finden Sie die Datei BundleConfig.cs. In dieser Datei können Sie MVC4 so konfigurieren, dass JavaScript-Dateien gebündelt werden. Öffnen Sie es und fügen Sie ein neues Bündel wie folgt hinzu:

Fügen Sie dann in der Datei /Views/Shared/_Layout.cshtml am unteren Rand des Seitentexts Folgendes hinzu:

Dadurch werden Ihre Skripts gebündelt, wenn sich Ihre Anwendung im Debug-Modus befindet, oder lassen Sie sie mit deaktivierter Funktion in Ruhe.

Der MVC4-Code, den wir zum Abrufen der Überprüfungsliste geschrieben haben, ist eine gute Möglichkeit, sie anzuzeigen, aber die ganze neue Hawtness verwendet Ajax. Lassen Sie uns den Code so umgestalten, dass er Backbone.js verwendet. Über JavaScript rufen wir die Ansichten asynchron ab, nachdem die Seite geladen wurde. Erstellen Sie im scripts-Ordner eine neue Datei namens home.js. Fügen Sie dieser Datei den folgenden Code hinzu:

Dies sind die JavaScript-Datenmodelle, die jeweils einer URL zum Abrufen von Daten vom WebAPI-Dienst entsprechen. Schreiben wir nun die Ansicht:

Diese Ansicht gilt für die gesamte Liste der Bewertungen. Wenn die Methode fetch() der Sammlung aufgerufen wird, löst sie das reset-Ereignis aus und ruft dann render() auf. Der dritte Parameter, der an die on()-Methode übergeben wird, ist der Gültigkeitsbereich oder was this im render()-Callback sein wird. Rufen Sie in der Methode render() die Methode each() der Sammlung auf und übergeben Sie die Methode renderItem(). Die Methode renderItem() wird für jedes Element in der Sammlung aufgerufen, wodurch für jede Überprüfung ein neues ReviewItem generiert wird.

Der Code für ReviewItem folgt:

WebAPI ist eine fantastische Ergänzung zum ASP.NET-Stack; eine funktionsreiche REST-basierte API war noch nie so einfach.

Die ReviewItem-Ansicht ist für das Rendern jeder einzelnen Überprüfung verantwortlich. Die Methode initialize() kompiliert die Vorlage, die zum Anzeigen jeder Überprüfung verwendet wird; Diese Vorlage befindet sich in einem <script/>-Element. Backbone zieht die Vorlage aus dem <script/>-Element und kombiniert sie mit der Überprüfung.

Außerdem ist ein click-Event-Handler eingerichtet, um die Kommentare für jede Überprüfung zu laden. Wenn auf den Link geklickt wird, wird die Methode getComments() aufgerufen, die die Kommentare abruft, indem eine Id an den WebAPI-Dienst übergeben wird. Die Methode fetch() ist lediglich eine Abstraktion der $.ajax-Methode von jQuery, sodass normale Ajax-Parameter wie data im fetch()-Aufruf übergeben werden können. Schließlich wird die Methode loadComments() ausgelöst und eine neue CommentItem-Ansicht für jeden zurückgegebenen Kommentar erstellt. Der tagName in dieser Ansicht stellt sicher, dass die Ansicht mit einem <li/> als $el-Eigenschaft erstellt wird.

Sehen wir uns als Nächstes die CommentItem-Ansicht an:

Dies ist eine einfache Ansicht, die jeden Kommentar rendert. Ändern wir nun die Ansicht Review.cshtml wie folgt:

Beachten Sie die @section scripts im obigen Code. Dies ist keine neue Funktion von MVC4, aber es ist ein großartiges Werkzeug, um bestimmte Teile von JavaScript zu rendern. In der Datei _layout.cshtml gibt es auch eine @RenderSection("scripts", required: false), die den in der Ansicht definierten Abschnitt rendert. Die <script/>-Elemente sind Unterstrichvorlagen zum Rendern von Inhalten. Sie folgen einer Ruby-ähnlichen Syntax, und alles innerhalb von <% %> wird als Anweisung ausgewertet. Alles innerhalb von <%= %> wird in HTML ausgegeben. Schleifen und bedingte Anweisungen können wie folgt verwendet werden:

Das ist die Vorlage. Um es zu verwenden, gehen Sie wie folgt vor:

Es gibt viele JavaScript-Templating-Frameworks im Web: Handlebars.js, mustache.js und Hogan.js sind sehr beliebt. Seien Sie sicher und überprüfen Sie sie und wählen Sie diejenige aus, die für Sie funktioniert.

Abschluss

WebAPI ist eine fantastische Ergänzung zum ASP.NET-Stack; eine funktionsreiche REST-basierte API war noch nie so einfach. Es gibt viele großartige neue Funktionen in MVC4. Seien Sie sicher und überprüfen Sie sie! Wie bereits erwähnt, ist der Code für dieses Beispiel auf Github verfügbar. Das war's!

Advertisement
Did you find this post useful?
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.