Neu in MVC 6: Das Konfigurationsmodell und das Programmiermodell.

Transkript

1 Web API unter MVC 6 Der sechste Streich Neu in MVC 6: Das Konfigurationsmodell und das Programmiermodell. Das HTTP-Protokoll eignet sich nicht halten werden. Jede Client-Anwendung nur zum Bereitstellen von Webseiten. nutzt dieses Web API, um Daten aufzunehmen, Es kann vielmehr als eine leistungs- fähige Plattform zum Erstellen von APIs angesehen werden, mit deren Hilfe Webdienste und Daten bereitgestellt werden können. HTTP lässt sich einfach und flexibel einsetzen. HTTP-Dienste können zu ändern oder zu löschen. Sofähige bald Änderungen anfallen, kann dies jetzt zentral erledigt werden. Die Konzepte aus der MVC-Welt, wie Controller, Actions, Filters und Model, machen dies möglich [1]. von einer Vielzahl von Clients (Browser, Mobilgeräte und Desktop-Anwendungen) genutzt werden. Moderne Anwendungen sind Apps, die auf den verschiedensten Plattformen laufen, und ASP. NET MVC 6 ist ein Framework, um Web APIs auf Basis von.net zu erstellen. Ohne Nutzung eines solchen Frameworks fällt die Basisarchitektur ziemlich umfangreich aus, da jede Client-Anwendung mit der entsprechenden Geschäftslogik ausgestattet werden muss. Im Solution Explorer sehen Sie, dass MVC 6 über eine neue Projektstruktur verfügt (Bild 2) MVC 6 Da MVC, Web API und Web Pages über komplementäre Funktionalitäten verfügen, werden diese häufig zusammen genutzt, um eine Lösung zu realisieren. Bisher standen diese separat zur Verfügung und bei der Programmierung mussten Inkonsistenzen berücksichtigt werden. MVC 6 stellt diese nun unter einem einheitlichen Entwicklungsmodell (Programming Model) zur Verfügung. Sobald eine Änderungsanforderung So lassen sich jetzt Applikationen erstellen, her einkommt, muss der Client angepasst werden. Dies ist fehleranfällig und führt zu unnötigem Aufwand. Wenn hingegen eine Architektur mit zentralem wobei beim Realisieren von Be- nutzeroberfläche oder Webservices keinerlei Unterschiede bei der Programmierung beachtet werden müssen. Web API genutzt wird, kann die Geschäftslogik zentral ge- Hier wählen Sie das Template ASP.NET 5 Preview Web API aus (Bild 1) Erstellen eines Projekts Um einen ASP.NET 5 Web API Web Service zu erstellen, legen Sie zuerst unter Visual Studio 2015 ein neues Projekt mit der Befehlsfolge File New Project an. In der linken Baumhierarchie wählen Sie die Sprache Visual C# und den Unterpunkt Web aus. Nun ist im Hauptfenster die Projektschablone (Template) ASP.NET Web Application auswählbar. Zusätzlich ist hier noch das.net Framework Version 4.6 auszuwählen. Als Projektnamen geben Sie für das Artikelbeispiel MVC6WebAPI ein und beenden den Dialog über die OK- Schaltfläche. Im Folgedialog wird dann eine Vielzahl von Templates zur Auswahl bereitgestellt (Bild 1). Aus Gründen der Vereinfachung entscheiden wir uns hier für den Eintrag ASP.NET 5 Preview WebAPI und beenden den Dialog wieder mit

2 OK. Nun wird Ihnen die Projektstruktur im Solution Explorer angezeigt (Bild 2). Projekteinstellungen Sofort wird ersichtlich, dass sich die Projektstruktur unter ASP.NET 5 verändert hat. Dort sind jetzt die Dateien global.json, project.json und Startup.cs zu finden. Die Projekt-Einstellungen werden unter der Datei project.json angegeben. Dort werden unter Dependencies alle NuGet-Pakete und Klassenbibliotheken aufgenommen, welche für das Projekt notwendig sind (Bild 3). Da MVC 6 zum Einsatz kommen soll, ist hier das Paket Microsoft.AspNet.MVC anzugeben. Das Core-Paket stellt alle notwendigen Komponenten für MVC 6 und Web API zur Verfügung. Sobald Sie beginnen, den Namen des Pakets einzutippen, wird IntelliSense aktiv und zeigt Ihnen alle verfügbaren Pakete an (Bild 4). Anschließend ist noch die Versionsnummer auszuwählen, in unserem Fall beta3 siehe auch Bild 5. Die Datei project.json enthält die Projekteinstellungen (Bild 3) Da die entstehende Web-API-Applikation auf dem IIS Express gehostet werden soll, wird noch das IIS-Paket benötigt, das bereits ausgewählt ist. Die Konfiguration von IIS Express kann direkt in Visual Studio erfolgen (Bild 6). Innerhalb der Datei global.json werden alle Projekt-Referenzen angegeben. Somit können Projekte auf andere Projekte zugreifen. Um das neue Konfigurationsmodell von MVC 6 nutzen zu können, muss das Paket Microsoft.Framework.Configuration- Model.Json angegeben werden. Dies erlaubt es, die Konfiguration mithilfe einer Datei im JSON-Format vorzunehmen, was eine bedeutende Arbeitserleichterung darstellt. Erster Testlauf Anschließend starten Sie in Visual Studio durch Drücken der Funktionstaste [F5] eine erste Debugging-Sitzung. Visual $ $ Listing 1: Startup.cs using Microsoft.AspNet.Builder; using Microsoft.AspNet.Hosting; using Microsoft.Framework.DependencyInjection; using Microsoft.AspNet.Mvc; using System.Configuration; using Newtonsoft.Json; namespace MVC6WebAPI public class Startup public void ConfigureServices( IServiceCollection services) services.addmvc(); public void Configure(IApplicationBuilder app) // Add MVC to the request pipeline. app.usemvc(routes => routes.maproute( name: "default", template: "controller/action/id?", defaults: new controller = "Home", action = "Index" ); routes.maproute( name: "movies", template: "controller/action", defaults: new controller = "Movies", action = "Get" ); );

3 Studio startet daraufhin den Browser und ruft den URL localhost mit entsprechender Port-Adresse ab. Gegenwärtig ist hier noch nichts zu sehen, da noch nicht angegeben wurde, was beim Start der Anwendung passieren soll. Die Anwendung konfigurieren In der Datei Startup.cs, welche die Klasse Startup enthält, wird schließlich der Start der Anwendung implementiert, siehe dazu Listing 1. Sobald der Konstruktor von Start up aufgerufen wurde, bauen die folgenden beiden Methoden die Laufzeitumgebung auf. Die erste Methode namens Welche Pakete im aktuellen Projekt verwendet werden, kann Visual Studio grafisch ConfigureServices hat die Aufgabe anzugeben, welche Komponenten per Depen- anzeigen (Bild 5) dency Injection erzeugt werden sollen. Das Kommando services.addmvc sorgt dafür, dass MVC 6 genutzt werden kann. Als zweite Methode wird Configure aufgerufen, worüber die Konfiguration der ASP.NET-Pipeline durchgeführt wird. Hier können einzelne Optionen der Komponenten konfiguriert werden. Über app.usemvc wird die Komponente in die Pipeline aufgenommen. Im vorliegenden Beispiel wird an diese Methode eine Routen-Konfiguration per Lambda-Ausdruck übergeben. So wird die Default-Routing-Angabe von ASP.NET MVC angepasst. Diese richtet die neue Route mit der Methode MapRoute ein. Dabei legt der Parameter name einen eindeutigen Namen für die Route fest. Der Parameter template bestimmt, wie der URL-Abruf erfolgen kann. Das im Platzhalter id? enthaltene Fragezeichen gibt an, dass der damit ausgedrückte Routing- Parameter optional ist. Mit dem Parameter defaults legt die Routen-Konfiguration fest, welcher Controller verwendet und welche Action ausgelöst werden soll, wenn der Aufrufer diese nicht explizit in der URL festlegt. Die angegebenen Werte Home und Index innerhalb der Projektvorlage führen zur Startseite der Webanwendung. Auch alle weiteren erforderlichen Routen kann der Entwickler hier definieren. Die Modellklasse Die für diesen Artikel angelegte Beispielanwendung soll eine Sammlung von Filmen anzeigen. Dem MVC-Konzept folgend wird dafür zunächst ein Modell benötigt, das jetzt erstellt werden soll. Dafür wird zuerst der Ordner Models angelegt. Hierzu wählen Sie das Projekt mit der rechten Maustaste aus und $ $ Listing 2: Die Klasse Movie using System; using System.ComponentModel.DataAnnotations; namespace MVC6WebAPI.Models public class Movie public int ID get; set; IntelliSense macht hilfreiche Vorschläge bei der Eingabe von Paketkennungen (Bild 4) [Required] public string Title get; set; public DateTime ReleaseDate get; set; public string Genre get; set;

4 Die Konfiguration des IIS kann direkt in Visual Studio erledigt werden (Bild 6) wählen den Kontextmenü-Punkt Add New Folder. Anschließend klicken Sie im Kontextmenü dieses Ordners auf den Punkt Add New Item. Nun wird der Eintrag Class ausgewählt und im Dialog der Klassenname Movie eingegeben. Die Klasse soll über die Variablen ID, Title, ReleaseDate und Genre verfügen. Jede der Variablen kann über die entsprechende get- oder set-methode gesetzt oder abgefragt werden. Den Quelltext der Klasse Movie finden Sie in Listing 2. Die Controller-Klasse Die Controller-Klasse ist im Konzept von MVC dafür vorgesehen, HTTP-Anfragen zu bearbeiten. Mit ASP.NET 5 erbt der Web API Controller von der Klasse Controller und nicht mehr von der Klasse ApiController. Um die Klasse zu erstellen, wählen Sie den Ordner Controllers und führen in dessen Kontextmenü wieder den Punkt Add New Item aus. Hier wird dann Web API Controller Class ausgewählt (Bild 7) und MoviesController als Name eingegeben. Zu Beginn des Controller-Templates ist die Zeile [Route( api/[controller ])] zu finden. Diese dient als URL- Schablone für den Controller. Jede HTTP-Anfrage, die der Schablone entspricht, wird an den Controller weitergeleitet. Die Angabe [controller] bedeutet, dass der Klassenname des Controllers ohne das Controller-Suffix verwendet wird. Nun muss das Modell noch mit Daten gefüllt werden. Dies wird ebenfalls im Controller erledigt. Zunächst wird dafür mittels new-operator eine List-Instanz vom Typ Movie erzeugt und in diese Liste werden die einzelnen Movie-Ein- $ $ Listing 3: Die Controller-Klasse using System; using Microsoft.AspNet.Mvc; using MVC6WebAPI.Models; namespace MVC6WebAPI.Controllers // GET(id) liefert einen bestimmten Eintrag public Movie Get(int id) return movies.singleordefault(m => m.id == id); [Route("api/[controller]")] public class MoviesController : ApiController // Hier werden die Modell-Daten erzeugt List<Movie> movies = new List<Movie> new Movie ID = 1, Title = "Taken", Genre = "Action", ReleaseDate = new DateTime(2008,9,26), new Movie ID = 2, Title = "Django Unchained", Genre = "Western", ReleaseDate = new DateTime(2013,1,18) ; // GET liefert alle Einträge zurück public IEnumerable<Movie> Get() return movies; // POST legt einen Movie-Eintrag an public void Post([FromBody]Movie movie) movies.add(movie); // PUT überschreibt einen Eintrag public void Put(int id, [FromBody]Movie movie) Movie existingmovie = movies.singleordefault(m => m.id == id); existingmovie.title = movie.title; existingmovie.genre = movie.genre; existingmovie.releasedate = movie.releasedate; // DELETE löscht einen Eintrag public void Delete(int id) movies.remove(movies.singleordefault( m => m.id == id)); // Save changes

5 träge eingefügt. Am Ende der Controller-Klasse sind noch die einzelnen HTTP-Methoden zu implementieren. Dafür sind innerhalb der Klasse einzelne Bereiche vorgesehen. Im Bereich [HttpGet] werden Methoden zum Abfragen von Daten angegeben. Unter [HttpPost] ist Platz für Methoden zum Anlegen von Daten. Im Bereich [HttpPut] stehen die Methoden zum Aktualisieren vorhandener Daten und unter [HttpDelete] die Methoden zum Löschen von Daten. Listing 3 zeigt die Controller-Klasse inklusive ihrer Methoden. Get liefert alle verfügbaren Einträge zurück. Die Methode Get(int id) hat die Aufgabe, einen bestimmten Eintrag zurückzuliefern. Entsprechend werden die Methoden Post, Put und Delete implementiert. Die HTML-Seite erstellen Das MVC-Konzept erfordert jetzt jetzt nur noch eine Ansicht (View). Dazu wird eine einfache HTML-Seite aufgebaut, welche die Aufgabe übernimmt, entsprechende Aufrufe der Web API durchzuführen. Dazu wählen Sie den Ordner Views mit der rechten Maustaste aus, klicken im Kontextmenü auf Add New Item HTML-Page und geben anschließend den Code aus Listing 4 ein, um Web-API-Aufrufe durchführen zu können. Aufruf der Testseite Sobald Sie einen der Links anklicken, wird der Browser angeben, dass er das Ergebnis in einer Datei speichern will. Wenn Sie diese Datei innerhalb von Visual Studio öffnen, werden Sie sehen, dass die Daten im JSON-Format gespeichert wurden. Der Entwickler kann aber auch andere Formate unterstützen. Dafür muss jedoch ein spezieller Formatter implementiert werden Näheres dazu wird in einem gesonderten Artikel beschrieben werden. Im Beispiel würde sich das Binärformat (BSON) anbieten. Dieses liefert eine höhere Performance gegenüber JSON beim Serialisieren und Deserialisieren. Da $ $ Listing 4: Die View der MVC-Anwendung <!DOCTYPE html> <html> <head> <meta charset="utf-8" /> <title></title> </head> <body> Web API Test#1! Klicken Sie <a href="api/movies"> hier </a> um alle Einträge zu erhalten. Web API Test#2! Klicken Sie <a href="api/movies/3"> hier </a> um einen bestimmten Eintrag zu laden. </body> </html> Hier wählen Sie die Web API Controller Class aus (Bild 7) BSON eine Reihe von Datentypen außerhalb der JSON- Spezifikation unterstützt, wird damit zugleich die Typ-Kompatibilität gewahrt und eine leichtere Datenweiterverarbeitung ermöglicht. Zweiter Testlauf Um Web-API-Aufrufe leichter beziehungsweise flexibler durch führen zu können, lohnt es sich, auf das Programm Fiddler [2] zurückzugreifen. Man kann damit HTTP-Anfragen generieren und sich die erzeugte Antwort innerhalb von Fiddler direkt anschauen. Fiddler kann dabei unterschiedliche Ausgabeformate erzeugen, wenn das gewünschte Format bei der Anfrage im Kopfzeileneintrag Accept angegeben wird. Fazit Während der Entwickler in der Vergangenheit die Unterschiede zwischen ASP.NET MVC und ASP.NET Web API berücksichtigen musste, vereinfacht MVC 6 das Entwickeln von Webanwendungen spürbar. MVC 6 kann zum Erstellen von Webapplikationen als auch zum Realisieren von Web-API- Lösungen verwendet werden. Sobald der Entwickler sich an die neuen Konventionen gewöhnt hat, lassen sich solche Lösungen rasch umsetzen und verringern den Arbeitsaufwand enorm. [1] MVC, Model, View, Controler, [1] Fiddler, kostenloser Web-Debugging-Proxy, dnpcode Alexander Scheb arbeitet seit 15 Jahren als IT-Journalist und ist Certified Sun Programmer. Seine Spezialgebiete sind Softwareentwicklung und aktuelle Trends, aber auch Webtechnologien und Sicherheit. Sie erreichen ihn über A1510ASPNETMVC