Sviluppare servizi web con WebApi e odata

Transcript

1 Sviluppare servizi web con WebApi e odata malta@vevy.com Articoli e codice: Blog: Profilo MVP:

2 Il Web Service «In principio era SOAP» Le quattro regole SOA di WCF I confini sono espliciti Definiti da un contratto, il loro attraversamento ha un costo I servizi sono autonomi Il contratto consente l'evoluzione dell'implementazione Sono pubblici solo lo schema e contratto Il formato neutro XML consente di sopravvivere alle tecnologie Le policy determinano capacità e requisiti del servizio

3 REST REpresentational State Transfer È uno stile architetturale Un'astrazione, una modalità di interazione con un Sistema Usa HTTP in toto come protocollo applicativo Impone un design stateless ogni richiesta è auto-descrittiva il client è detentore dello stato delle richieste Impone un basso accoppiamento ("loosely-coupled") il client conosce solo l'entry-point del server

4 Il «maturity level» di Leonard Richardson Livello 1 Molti Uri, singolo verb Livello 3 Hypermedia Livello 2 Molti Uri, molti verb Macchina a stati dell'applicazione CRUD SOAP (POST) Livello 0 Singolo Uri, singolo verb SOAP (POST)

5 Hypermedia Hypermedia as the engine of application state (HATEOAS) Il cambio di stato avviene eseguendo le 'request' reperite nelle 'response' del server sotto forma di Hyperlink Le risposte del server NON sono le entità Le risposte descrivono lo stato applicativo Le risposte contengono le entità

6 SOAP vs REST Contratto rigido problemi di versioning Metadati del servizio Descrive le policy Indicato quando basso numero di client client omogenei (.net, java, ) protocollo diverso da HTTP Hypermedia style scoperta dinamica Requisiti di un client HTTP ed entry-point Indicato quando alto numero di client client eterogenei client poco potenti (IoT) portabilità del servizio su altre piattaforme

7 Perché HTTP Permette alta scalabilità È un protocollo disconnesso È molto veloce Interamente implementato in kernel mode (HTTP.SYS) Non è (solo) un protocollo di trasporto ma anche un protocollo applicativo Lo standard descrive la semantica e i codici di ritorno L'infrastruttura IT è la stessa delle pagine web I Proxy per le politiche di Caching Gli apparati di routing e load balancing La security ha una lunga storia alle spalle (SSL)

8 Chi ha detto che http è 'lento'? 100 Persons con 1K blob 500 Persons senza blob GetPersons(100) scheme elapsed basichttp 5,719 wshttp 2,097 net.tcp 1,655 net.pipe 1,666 RIAsoap 5,972 GetPersons(100) scheme elapsed basichttp 5,829 wshttp 2,052 net.tcp 1,562 net.pipe 1,454 RIAsoap 5,706 GetPersons(500) scheme elapsed basichttp 8,353 wshttp 6,865 net.tcp 5,920 net.pipe 5,875 RIAsoap 8,476 GetPersons(500) scheme elapsed basichttp 8,387 wshttp 6,898 net.tcp 5,942 net.pipe 5,843 RIAsoap 8,563 MVCjson 88,848 WebAPIjson 82,198 * WebAPIbson 2,617 WebAPIxml 2,571 MVCjson 88,621 WebAPIjson 3,502 * WebAPIbson 1,762 WebAPIxml 2,634 MVCjson 8,537 WebAPIjson 4,932 * WebAPIbson 2,275 WebAPIxml 2,266 MVCjson 8,414 WebAPIjson 4,248 * WebAPIbson 4,719 WebAPIxml 2,266 (*) standard json (*) json.net (*) standard json (*) json.net

9 ASP.NET WEBAPI

10 WebAPI WebAPI è un framework per costruire servizi HTTP Si appoggia allo stack di asp.net Permette lo sviluppo di servizi REST Un servizio WebApi NON è automaticamente REST È flessibile e pluggabile Offre una pipeline semplice da espandere Usa concetti consolidati in asp.net MVC asp.net routing per mappare un URL ad un controller (classe) e action (metodo della classe controller)

11 Ciclo di vita di una richiesta pipeline WebAPI Client Request HTTP Server URI routing Execution Response URL Header Body (*) Verb /Values/1 Controller: ValuesController Action: Get Parameter: 1 HTTP Status code Headers Body

12 Configurazione 1. Global.asax.cs (modificato dal template) public class WebApiApplication : System.Web.HttpApplication { protected void Application_Start() { GlobalConfiguration.Configure(WebApiConfig.Register); } } 2. WebApiConfig.cs (generato dal template) Abilita due diverse possibilità di routing public static class WebApiConfig { public static void Register(HttpConfiguration config) { config.maphttpattributeroutes(); // abilita gli attribute } } config.routes.maphttproute( // aggiunge una route secondo un pattern name: "DefaultApi", routetemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } );

13 Gestire la request Grazie al routing vengono individuati La classe del controller Il nome della action (nome del metodo) da eseguire Il suffisso "Controller" è aggiunto per convenzione public class OrdersController : ApiController { public IHttpActionResult Get() { var ctx = new NorthwindContext(); var list = ctx.orders; return Ok(list); } }

14 Le tabelle di routing Possono essere mappati dalle tabelle di routing Occhio al nome O anche con l'attributo [FromBody] Possono essere aggiunti altri routing config.routes.maphttproute( name: "DefaultApi", routetemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } ); // public IHttpActionResult Get(long id) // PUT api/customers/5 public void Put(string id, [FromBody]Customer updatedcustomer) config.routes.maphttproute( name: "api2", routetemplate: "api/special/{action}"); public class SpecialController : ApiController { [HttpGet] public HttpResponseMessage Add(int x, int y) { var result = x + y; var response = this.request.createresponse( HttpStatusCode.OK, result); return response; } }

15 Attributi di Routing Abilitato via config.maphttpattributeroutes(); Eseguito via attribute: RoutePrefix e Route [RoutePrefix("api/Demo")] public class RafController : ApiController [Route("raf1")] public IHttpActionResult Get() Oppure direttamente sulla action specificando anche i parametri [Route("Orders/{id}/details")] public IEnumerable<Order> GetDetailsByOrder(int id) {... } Supporta numerosi formati tra cui le regex

16 Action È possibile rinominare le action [ActionName("NuovoNomeMetodo")] Oppure escluderle dalla selezione delle Action [NonAction] Il parametro di ritorno può essere Il type CLR desiderato IHttpActionResult HttpResponseMessage public class ResponseMessageResult : IHttpActionResult { public ResponseMessageResult(HttpResponseMessage response); public HttpResponseMessage Response { get; } public virtual Task<HttpResponseMessage> ExecuteAsync(CancellationToken ct); }

17 Verb I verb sono fondamentali perché rispondono alla semantica HTTP GET and HEAD devono solo leggere sono soggetti a cache! GET, HEAD, PUT and DELETE sono idempotenti La loro ripetizione non provoca la riesecuzione del comando POST Non è idempotente usato per le insert ha senso inserire più volte Associare un verb ad una action [HttpGet], [HttpPost], etc. [AcceptVerbs("GET", "HEAD")]

18 Errori, exceptions e HTTP Gli status code descrivono anche gli errori Le exception lato server sono convertite in errori HTTP È possibile aggiungere un messaggio all'errore HTTP/ Not Found Content-Type: application/json; charset=utf-8 Date: Thu, 09 Aug :27:18 GMT Content-Length: 51 { "Message": "Product with id = 12 not found" } Usando CreateResponse + HttpError var msg = string.format("product with id = {0} not found", id); HttpError err = new HttpError(msg); return Request.CreateResponse(HttpStatusCode.NotFound, err); Usando CreateErrorResponse var msg = string.format("product with id = {0} not found", id); return Request.CreateErrorResponse(HttpStatusCode.NotFound, msg);

19 Request controller action authoriz. IHttpControllerSelector Dato un HttpRequestMessage ritorna HttpControllerDescriptor IHttpActionSelector Dato un HttpControllerContext ritorna HttpActionDescription Principali Estendibilità IValueProvider IActionValueBinder IModelBinder binding IActionFilter OnActionExecuting Action filter Conversione in json, xml, o altro media type IExceptionFilter IActionFilter OnActionExecuted Response Formatting Exception filter Action filter Esecuzione

20 MediaTypeFormatter MediaTypeFormatter è la classe astratta per serializzare una response in qualsivoglia format I formatter già presenti nella pipeline: Json.net e Xml formatter bson e molti altri su nuget Uno nostro formatter custom derivando questa classe La scelta avviene dietro una negoziazione standard HTTP Il client manda un header "accept" Il server risponde con un "content-type"

21 OWIN & KATANA

22 OWIN, uno standard per unificare lo stack dei component web in.net Consente di eseguire le applicazioni su una moltitudine di differenti host Application OWIN middleware authentication, signalr,... OWIN Katana selfhost Katana IIS Nowin

23 Device + Services + + OWIN +...

24 ODATA

25 odata odata è un'insieme di specifiche create per esporre dati Hypermedia 'Active Record' CRUD Definizione della forma degli URI Molti Uri Operazioni di tipo CRUD per agire Singolo Uri sulle entità e le loro relazioni Il formato di uscita può essere AtomPub o Json Esiste già un ecosistema di client che usano questo protocollo Tra questi MS Office Excel e PowerQuery (ex PowerPivot) Per creare servizi che espongono odata: Microsoft ha deprecato i WCF Data Services Sta maturando lo stack odata per le WebAPI

26 Le version di odata odata v3 è un protocollo creato da Microsoft le cui specifiche sono rilasciate pubbliche odata v4 è stato ceduto a OASIS che lo ha standardizzato Differenze: La v4 introduce breaking-changes rispetto alla v3 La v4 semplifica molti costrutti La v3 è ancora la più diffusa tra i client esistenti La v3 e v4 possono co-esistere (namespace differenti)

27 Crazy Versioning Namespace versioning Microsoft.OData.Core ODataLib v4.0 Microsoft.Data.OData ODataLib v3.0 System.Web.OData OData v4.0 System.Web.Http.OData OData v3.0 A partire dalla v4 Extension methods spostati in System.Web.OData.Extensions MapODataRoute MapODataServiceRoute QueryableAttribute EnableQueryAttribute Se mischiate, l'errore più probabile è un HTTP 406 Su nuget i package si distinguono facilmente:

28 Endpoint dei metadati Totale antitesi con la filosofia Hypermedia Schema in format XML che descrive Entity (type system) EntitySet (collection di entity) Action (funzioni che cambiano lo stato dei dati) Da non confondersi con le Action di WebApi Function (funzioni readonly) Complex type (entity di appoggio a funzioni e action) Permette l'auto-generazione di client

29 La CRUD di odata GET Esegue la request di una collection, un singolo element o una proprietà risponde con il body e 200 (OK) POST Inserisce una singola entità risponde con 204 (no content) PUT modifica una singola entità risponde con 204 (no content) MERGE / PATCH modifica parziale di una singola entità risponde con 204 (no content) DELETE cancellazione di una singola entità risponde con 200 (OK)

30 Filtrare i dati ($filter) La QueryString definisce la query CompanyName) eq true numerosi operatori applicabili alla query Le query vengono tradotte in Expression Tree di Linq Il metodo si limita a ritornare un IQueryable<T> L'expression finale verrà tradotta in query SQL dall'orm Vantaggi principali: Query dinamiche Si evitano problem di SQL Injection Paginazione dei dati evitando così di stressare il DB

31 odata $filter cheat sheet espressioni [eq, ne], [lt, le], [gt, ge] $filter=name eq 'raf' or, and, not date day, month, year hour, minute, second matematica add, sub, mul, div, mod (+, -, *, /, %) $filter=price add 1 lt 10 (price+1) <10 round(price) floor(price) ceiling(price) Date date, time, totaloffsetminutes, now maxdatetime, mindatetime, totalseconds year, month, day hour, minute, second, fractionalseconds stringhe substringof('raf', name) eq true startswith(name, 'Raf') eq true endswith(name, 'ele') eq true indexof(name, 'Raf') eq 0 length(name) gt 0 replace(name, 'R', 'r') eq \"raf\" substring(name, 5) eq \"ele\" substring(name, 2, 2) eq \"ff\" tolower(name) eq \"raffaele\" toupper(name) eq \"RAFFAELE\" trim(name) \"raf\" concat('x', 'Raf') eq \"XRaf\" contains(name,'ff') Tipi isof cast Geo geo.distance, geo.intersects, geo.length Lambda any, all

32 Non solo filtri Operazione Operatore Esempio Count di un EntitySet (collection) $count Ordinamento $orderby asc/desc $orderby=name%desc Paginazione Formato del payload Proiezione Espansione grafo $top $skip $format $select $expand

33 odata e SOA Devices Servizi odata REST Data Access Layer Data Data Store Hidden Data Store tier Nota: ogni triangolo e' un set di servizi di una applicazione che usa gli stessi dati

34 Domande?