Action tipizzate in un controller Web API di ASP.NET Core 2.1

di , in ASP.NET Core,

Negli script precedenti abbiamo introdotto alcune novità di ASP.NET Core 2.1 relative a Web API e, in particolare, abbiamo accennato all'esistenza di una nuova classe ActionResult<T>.

Grazie a quest'ultima, possiamo finalmente realizzare action Web API fortemente tipizzate, senza rinunciare alla flessibilità di controllare l'effettivo contenuto della risposta.

Sin dalla sua introduzione, infatti, Web API supporta la restituzione di tipi nativi:

public Person GetById(int id)
{
  return new Person>();
}

Tuttavia, il metodo precedente non consente di restituire risposte differenti da un'istanza di Person; nel caso in cui la Person richiesta non esiste, per esempio, vorremo poter restituire un errore 404.

Fino alla precedente versione di ASP.NET Core, l'unica alternativa era usare IActionResult come tipo della risposta:

public IActionResult GetById(int id)
{ 
  Person result = personService.GetById(id);

  if (result == null)
  {
    return this.NotFound();
  }

  return this.Ok(result);
}

Questo approccio ovviamente soffre di un problema di tipizzazione: il metodo Ok, infatti, accetta un qualsiasi tipo in input, e pertanto perdiamo il controllo a compile time sulla correttezza del risultato.

Con ASP.NET Core 2.1, abbiamo a disposizione il nuovo tipo ActionResult<T>, che ci permette di riscrivere il metodo precedente in questo modo, forzando una validazione del tipo del risultato:

public ActionResult<Person> GetById(int id)
{
    Person result = personService.GetById(id);

    if (result == null)
    {
        return this.NotFound();
    }

    // ogni tipo diverso da Person genera un errore di compilazione
    return result;
}

Come è possibile che il metodo in alto compili, visto che stiamo restituendo un oggetto di tipo Person invece che ActionResult? Per avere la risposta, dobbiamo sbirciare all'interno della definizione di ActionResult<T>.

public sealed class ActionResult<TValue> : IConvertToActionResult
{
    // ... altro codice qui ...

    public static implicit operator ActionResult<TValue>(TValue value);
    public static implicit operator ActionResult<TValue>(ActionResult result);
}

Come possiamo notare, essa ridefinisce due implicit conversion operator:

  • il primo, è proprio quello che ci consente di restituire un oggetto di tipo Person anche se la action si aspetta un ActionResult
  • Il secondo, invece, ci permette di ritornare anche un qualsiasi altro ActionResult, se necessario, come NotFoundResult o BadRequestResult.

Commenti

Visualizza/aggiungi commenti

Action tipizzate in un controller Web API di ASP.NET Core 2.1 (#1300) 1010 1
| Condividi su: Twitter, Facebook, LinkedIn, Google+

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi