Azure Notification Hub

Ieri (12 Febbraio 2015) al Mobile Camp di Roma ho parlato di Azure Notification Hub, un servizio multipiattaforma di Azure che vi permette di gestire le notifiche push verso le vostre app su qualsiasi piattaforma mobile in poche righe di codice.

Rendete vive ed interessanti le vostre app, aggiungete notifiche push con questo servizio facilissimo da implementare e da gestire e soprattutto gratuito fino ad un milione di notifiche al mese.

Trovate tutti i dettagli nella mia presentazione disponibile su SlideShare

JSON for Dummies (parte 3)

In questo terzo post della serie JSON for Dummies (qui la parte 1 e la parte 2) vedremo una implementazione più elegante del processo di deserializzazione di dati JSON provenienti da un servizio REST.

Creeremo una funzione asincrona generica che si occupi di connettersi al servizio remoto, scaricare i dati e deserializzarli nel tipo corretto. La prima modifica è che useremo il metodo GetAsync() di HttpClient invece del metodo GetStringAsync(). In questo modo avremo una risposta del tipo HttpResponseMessage  che espone proprietà utili a stabilire l’esito della connessione. In questa prima implementazione Controlleremo che lo StatusCode della risposta sia positivo prima di continuare. In caso contrario lanceremo una eccezione. Dopo aver verificato l’esito positivo dell’operazione possiamo deserializzare il contenuto della risposta con ReadAsStringAsync().

public async Task<T> GetAsync<T> (Uri uri)
{
    using (var http = new HttpClient())
    {
         http.DefaultRequestHeaders.Add("Accept", "application/json");
         var response = await http.GetAsync(uri);
         if (response.StatusCode != System.Net.HttpStatusCode.OK)
         throw new Exception(response.StatusCode.ToString());
         string json = await response.Content.ReadAsStringAsync();
         return JsonConvert.DeserializeObject<T>(json);
    }
}

Grazie all’uso di HttpResponseMessage  possiamo rendere ulteriormente compatto il codice sostituendo il controllo dell’esito della richiesta  (tutta la struttura dell’if) con

response.EnsureSuccessStatusCode();

dato che il metodo EnsureSuccessStatusCode() restituisce l’HttpResponseMessage in caso di esito positivo, la nostra funzione finale può essere scritta in questo modo:

public static async Task<T> GetAsync<T> (Uri uri)
{
using (var http = new HttpClient())
{
http.DefaultRequestHeaders.Add(“Accept”, “application/json”);
var response = await http.GetAsync(uri);
string json = await response.EnsureSuccessStatusCode().Content.ReadAsStringAsync();
return JsonConvert.DeserializeObject<T>(json);
}
}

In questo modo basterà richiamare la funzione appena definita sostituendo T con il tipo di oggetto da deserializzare e uri con la url del servizio

MyStruct struct = await GetAsyncAuthenticated<MyStruct>(uri);

Nel prossimo episodio vedremo come connettersi a servizi REST autenticati.

ASP.NET Web API for Dummies

Dopo avere visto come utilizzare il formato JSON per scambiare dati tra la nostra applicazione e un servizio remoto, in questa nuova serie for dummies vedremo come creare un servizio remoto che possa servire dati alla nostra, o ad altre applicazioni.

Notiamo subito che basandosi i servizi REST, di questo stiamo parlando, sullo scambio di file di testo tramite semplici chiamate HTTP, la tecnologia che usiamo nella creazione del servizio remoto non è in nessun modo vincolata alla tecnologia usata nella creazione dell’app.

Utilizzeremo un progetto Web Api di ASP.NET MVC che potrà essere ospitato su un qualsiasi servizio web con IIS. Noi utilizzeremo Azure, il servizio cloud di Microsoft, che permette di creare gratuitamente fino a 10 siti web.

Da Visual Studio creiamo dunque un nuovo progetto web di tipo applicazione Web ASP.NET (Se avete VS 2013 questo è l’unico tipo di progetto web che potete creare, se invece avete Visual Studio 2012 dovrete scegliere un’applicazione MVC4).

Cattura di schermata (3)

Come modello scegliamo Web Api tra quelli disponibili.
Modifichiamo l’autenticazione impostando nessuna autenticazione.
Se avete un acount Azure possiamo gestire direttamente anche la connessione con il servizio cloud impostando la sottoscrizione su cui volete pubblicare il vostro sito web, ma questo lo vedremo in un’altra occasione. Per il momento deselezionate Host nel cloud

Cattura di schermata (2)

A questo punto il vostro servizio web è pronto. Se avviate il progetto con F5 il sito web verrà lanciato nel server IIS locale, pronto a rispondere alle chiamate remote. Il template MVC costruisce per voi tutto il sito web, compresa pagina di documentazione delle API.

image

Cliccando sulla barra in alto su API arriverete a questa pagina, in cui avete la documentazione della Web API creata di default dal template, che in seguito andremo a modificare. Come si vede, il template predispone due metodi GET, un metodo POST, uno PUT e un DELETE.

image

Per invocare il servizio potete scrivere l’indirizzo del server completato con l’indirizzo dell’API. Nel mio caso l’indirizzo della prima funzione GET è http://localhost:49039/api/Values che vi restituirà, indovinate? Un file JSON.

Il file restituito Values.json ha il seguente contenuto

[“value1″,”value2”]

Il codice che definisce le funzioni restituite dai metodi HTTP è racchiuso in una classe che eredita dalla classe ApiController. Nello specifico la classe è ValuesController, nel file ValuesController.cs nella cartella Controllers del progetto, e la funzione è

public IEnumerable<string> Get()
        {
            return new string[] { “value1”, “value2” };
        }

Come vedete la funzione restituisce un oggetto di tipo array di stringhe, che viene serializzato automaticamente in JSON e scritto nel file di uscita.

A questo punto vogliamo aggiungere un nuovo controller che chiameremo TestController. Clicchiamo con il tasto destro sulla cartella controller e scegliamo la voce
Aggiungi –> Controller

Scegliete Controller Web API con azioni di lettura/scrittura e date un nome al vostro controller. Il prefisso davanti alla parola Controller sarà il nome della vostra Web API (nel nostro caso Test. Aggiungiamo anche nella cartella Models  le classi che abbiamo già utilizzato nell’esempio di JSON for Dummies

public class MyStruct
    {
        public string Title { get; set; }
        public string Name { get; set; }
        public List<MyItem> List { get; set; }
    }

    public class MyItem
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public string Description { get; set; }
    }

A questo punto possiamo creare un nuovo oggetto di tipo MyStruct nel costruttore del Controller

public TestController()
        {
            Struct = new MyStruct()
            {
                Title = “test”,
                Name = “name”,
                List = new List<MyItem>()
                {
                    new MyItem(){Id = 0, Name=”name0″, Description= “description0”},
                    new MyItem(){Id = 1, Name=”name1″, Description= “description1”},
                    new MyItem(){Id = 2, Name=”name2″, Description= “description2”},
                }
            };
        }

e modificare il metodo Get() in modo che restituisca proprio il nostro oggetto Struct

public MyStruct Get()
        {
            return Struct;
        }

Lanciando il servizio web nella pagina di documentazione delle API è apparsa la nuova API Test con i suoi metodi

image

Cliccando sulla funzione GET api/Test da noi modificata vedrete la documentazione degli oggetti restituiti ed anche un esempio del file JSON ed XML generati dal servizio.

image

A questo punto possiamo commentare o cancellare le funzioni che non abbiamo implementato ed anche cancellare il controller di default ValuesController.cs.

L’ultimo tocco riguarda come migliorare la documentazione. Nella pagina che espone tutti i metodi delle Web API nel campo Descrizione è sempre riportato No Description Available. Per personalizzare la descrizione dobbiamo eseguire le seguenti operazioni:

1. Togliere il commento dalla riga

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath(“~/App_Data/XmlDocument.xml”)));

nel file Areas\HelpPage\App_Start\HelpPageConfig.cs 

2. Aggiungere il percorso del file XML App_Data/XmlDocument.xml  indicato in questa riga nelle proprietà del progetto web al tab Compila nell’opzione File di Documentazione XML.

image

3. Aggiungere commenti dentro il codice, sia nel controller che nelle classi, ad es.

        /// <summary>
        /// Descrizione funzione
        /// </summary>
        /// <returns>
        ///  output description
        /// </returns>
        public MyStruct Get()
       {
              …
       }

Basta scrivere /// e Visual Studio creerà la struttura per noi. Compilando e avviando il progetto anche la pagina di documentazione sarà completa.

In questo modo possiamo spostare parte della logica della nostra app in un servizio remoto e possiamo quindi aggiornare i contenuti della nostra app senza dover pubblicare una nuova versione.

E anche per oggi abbiamo terminato.

JSON for Dummies (parte 2)

Abbiamo visto cosa è il formato JSON e come trasformare un oggetto di una classe custom in e da un oggetto JSON.

A questo punto vediamo un caso di utilizzo reale. Tipicamente vogliamo popolare la nostra app con dati che provengono da un servizio remoto. Prendiamo ad esempio questo sito http://www.geonames.org/export/JSON-webservices.html (ho semplicemente cercato con Bing “json sample web service”) che espone alcuni servizi REST restituendo i dati in formato JSON oppure XML.

Se con un browser apriamo l’indirizzo http://api.geonames.org/citiesJSON?north=44.1&south=-9.9&east=-22.4&west=55.2&lang=de&username=demo  otteniamo in download il file citiesJSON.json. L’idea è quella di scaricare questo file alla nostra app e deserializzare questo file per popolare un oggetto nella nostra app.

Per poter fare questo però abbiamo bisogno di definire una classe che corrisponda alla struttura dati contenuta nel file json. Potremmo analizzare il file citiesJSON.json ed estrapolare la struttura della classe da costruire. Le proprietà vengono serializzate come coppie nome:valore, dove il nome è sempre una stringa e il valore può essere un numero, una stringa o un null. Una coppia di parentesi graffe {} corrisponde ad un oggetto, una coppia di quadre [] corrisponde ad un array i cui elementi (oggetti delimitati da {}) sono separati da virgole.

Oppure possiamo utilizzare una funzione di Visual Studio molto comoda. Aprite il file JSON e copiatene il contenuto in memoria. Create una nuova classe e cancellate tutto il contenuto. Andate su Modifica –> Incolla Speciale –> Incolla JSON come classi.

Magicamente Visual Studio crea la classe (tutte le classi, in realtà) necessaria a decodificare il file json. Le proprietà della classe devono avere lo stesso nome con cui sono definite dentro il file JSON. Non è necessario che la classe per deserializzare abbia tutte le proprietà definite nel file JSON (i campi mancanti semplicemente non vengono deserializzati).

A questo punto possiamo scaricare il file. Utilizzerò HttpClient (lo trovate su Nuget). Ricordate che le chiamate a servizi remoti vanno fatte asincrone (utilizzando await) e quindi invocate all’interno di funzioni async.

HttpClient client = new HttpClient();

string outstring = await client.GetStringAsync(“http://api.geonames.org/citiesJSON?north=44.1&south=-9.9&east=-22.4&west=55.2&lang=de&username=demo”);

Rootobject deserializedObject = JsonConvert.DeserializeObject<Rootobject>(outstring);

Tutto qui. I dati che arrivano dal servizio remoto (qualunque cosa ci sia dentro), senza saper quasi nulla del servizio e dei dati, sono nella nostra app, pronti ad essere messi in binding.

Ma possiamo fare ancora qualcosa di meglio. Non siete costretti ad utilizzare i nomi delle proprietà o delle classi annidate così come sono nel file json (tutti minuscoli, per esempio). Nella definizione delle proprietà possiamo mettere tra parentesi quadre il nome della proprietà JSON che vogliamo deserializzare in modo da dare alla proprietà della nostra classe il valore che vogliamo.

[JsonProperty(“geonames”)]
public Geoname[] NomeCheVogliamo { get; set; }

Ricordiamoci di inserire using Newtonsoft.Json; nella nostra classe altrimenti non potremo usare JsonProperty.

TIP: Un tool per generare classi C# da JSON (ma anche VB.NET o Typescript) più potente di quello integrato in Visual Studio potete trovarlo qui https://jsonclassgenerator.codeplex.com/