Scala for Backend Engineering & Functional Programming · Lezione

Route e HttpRoutes

Definisca endpoint in modo funzionale.

Route e HttpRoutes è una lezione Scala for Backend Engineering & Functional Programming gratuita su CoddyKit. Questa è la lezione 1 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Scala for Backend Engineering & Functional Programming, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Scala for Backend Engineering & Functional Programming include 4 lezioni in totale.

Che cos'è http4s

http4s è una libreria HTTP puramente funzionale per Scala, costruita su cats-effect e sugli stream fs2. Le richieste e le risposte sono valori immutabili e gli effetti vengono rappresentati in un tipo effetto polimorfico F[_], come IO.

Invece di modificare un servlet, descrive un servizio HTTP come una funzione da una richiesta a una risposta opzionale ed effetto.

Il tipo HttpRoutes

L'astrazione principale è HttpRoutes[F], un alias per Kleisli[OptionT[F, *], Request[F], Response[F]]. OptionT rappresenta una route che potrebbe non corrispondere, restituendo nessuna risposta.

Raramente scriverà questa firma a mano. Invece, costruisca le route con il costruttore HttpRoutes.of e una funzione parziale.

import cats.effect.IO
import org.http4s._
import org.http4s.dsl.io._

val routes: HttpRoutes[IO] = HttpRoutes.of[IO] {
  case GET -> Root / "hello" => Ok("hi")
}

La DSL di http4s

L'import della DSL org.http4s.dsl.io._ mette a disposizione estrattori di pattern come GET, Root e il separatore di percorso /, oltre a builder di risposta come Ok e NotFound.

Una route è una PartialFunction[Request[F], F[Response[F]]]. I casi che non corrispondono proseguono semplicemente la valutazione.

import org.http4s.dsl.io._

HttpRoutes.of[IO] {
  case GET -> Root => Ok("root")
  case GET -> Root / "ping" => Ok("pong")
}

Corrispondenza dei percorsi

I pattern dei percorsi si leggono da sinistra a destra. Root rappresenta la barra iniziale e ogni / "segment" corrisponde a un singolo segmento letterale del percorso.

La freccia -> separa il metodo HTTP dal percorso. Quindi GET -> Root / "users" corrisponde a GET /users.

HttpRoutes.of[IO] {
  case GET -> Root / "users" => Ok("all users")
  case GET -> Root / "users" / "me" => Ok("current user")
}

Variabili del percorso

Un binder minuscolo non qualificato in un percorso cattura quel segmento come String. Qui id associa qualunque valore compaia dopo /users/.

I segmenti catturati sono sempre stringhe; li analizzi autonomamente nei tipi più ricchi oppure usi gli oggetti estrattori mostrati di seguito.

HttpRoutes.of[IO] {
  case GET -> Root / "users" / id =>
    Ok(s"user $id")
}

Estrattori tipizzati del percorso

http4s fornisce estrattori come IntVar e LongVar, che corrispondono solo quando il segmento può essere analizzato nel rispettivo tipo. Un segmento non numerico fa proseguire la valutazione verso il caso successivo.

Può definire estrattori personalizzati con un unapply per tipi di dominio come gli UUID.

HttpRoutes.of[IO] {
  case GET -> Root / "users" / IntVar(id) =>
    Ok(s"numeric user $id")
}

Corrispondenza dei metodi

L'estrattore del metodo prima di -> può essere uno tra GET, POST, PUT, DELETE, PATCH e altri. Lo stesso percorso con metodi diversi diventa un caso distinto.

Se il percorso corrisponde ma il metodo no, http4s risponde automaticamente con 405 Method Not Allowed.

HttpRoutes.of[IO] {
  case GET -> Root / "items" => Ok("list")
  case POST -> Root / "items" => Created("made")
  case DELETE -> Root / "items" / IntVar(i) => NoContent()
}

Combinazione delle route

Poiché HttpRoutes[F] forma un SemigroupK, può comporre più gruppi di route con l'operatore <+>. Vince il primo gruppo che produce una risposta.

Può così suddividere le route per funzionalità in valori separati e unirle in un unico punto.

import cats.syntax.semigroupk._

val all = userRoutes <+> itemRoutes <+> healthRoutes

Dalle route a HttpApp

Un server ha bisogno di una funzione totale, non parziale. HttpRoutes[F] viene convertito in HttpApp[F] con .orNotFound, che fornisce un 404 quando nessuna route corrisponde.

HttpApp[F] è Kleisli[F, Request[F], Response[F]] e restituisce sempre una risposta.

import org.http4s.HttpApp

val app: HttpApp[IO] = routes.orNotFound

Wrapping tramite middleware

I middleware sono funzioni HttpRoutes[F] => HttpRoutes[F] (o applicate a HttpApp). Avvolgono un servizio per aggiungere logging, CORS, gzip o autenticazione senza modificare la logica delle route.

Tra gli esempi integrati figurano Logger, CORS e GZip di org.http4s.server.middleware.

import org.http4s.server.middleware.Logger

val logged = Logger.httpApp(logHeaders = true, logBody = false)(app)

Parametri di query nelle route

I parametri di query vengono confrontati con oggetti matcher che estendono QueryParamDecoderMatcher. Compaiono dopo un :? nel pattern del percorso.

Usi OptionalQueryParamDecoderMatcher per i parametri che possono essere assenti: otterrà un Option.

object NameParam extends QueryParamDecoderMatcher[String]("name")

HttpRoutes.of[IO] {
  case GET -> Root / "hi" :? NameParam(n) => Ok(s"hi $n")
}

Verifica rapida

Verifichi la propria comprensione della composizione delle route.

Riepilogo

Ha costruito route con HttpRoutes.of e la DSL, ha fatto corrispondere metodi e percorsi, ha catturato variabili con IntVar e i matcher e ha composto gruppi con <+>.

Le route sono parziali; .orNotFound le trasforma in una HttpApp totale e i middleware avvolgono i servizi per gestire aspetti trasversali.

Domande Frequenti

La lezione «Route e HttpRoutes» è gratuita?

Sì — il testo completo di «Route e HttpRoutes» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Scala for Backend Engineering & Functional Programming, passa a CoddyKit PRO. Il corso Scala for Backend Engineering & Functional Programming include 4 lezioni in totale.

Cosa imparerò in «Route e HttpRoutes»?

Definisca endpoint in modo funzionale. Eserciti Scala for Backend Engineering & Functional Programming con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Scala for Backend Engineering & Functional Programming?

Non è richiesta alcuna esperienza precedente. Scala for Backend Engineering & Functional Programming su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 1 di 4.

Quanto tempo richiede la lezione «Route e HttpRoutes»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Scala for Backend Engineering & Functional Programming?

Sì. Ogni lezione Scala for Backend Engineering & Functional Programming include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

← Torna a Scala for Backend Engineering & Functional Programming