Problem Details RFC 7807 e risposte di errore coerenti
Restituisca payload di errore strutturati conformi a RFC 7807 usando ProblemDetail di Spring 6.
Problem Details RFC 7807 e risposte di errore coerenti è una lezione Java Academy gratuita su CoddyKit. Questa è la lezione 4 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 Java Academy, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Java Academy include 4 lezioni in totale.
Che cos'è RFC 7807?
RFC 7807, "Dettagli dei problemi per le API HTTP", definisce un formato JSON standard per le risposte di errore. Evita formati di errore personalizzati per ogni API e offre ai client una struttura prevedibile da analizzare.
Campi di RFC 7807
Campi standard: type (URI che identifica il problema), title (riepilogo leggibile), status (codice di stato HTTP), detail (spiegazione specifica), instance (URI dell'occorrenza specifica).
{
"type": "https://api.example.com/errors/not-found",
"title": "Resource Not Found",
"status": 404,
"detail": "User with id 42 does not exist.",
"instance": "/api/users/42"
}ProblemDetail in Spring 6
Spring 6 / Spring Boot 3 include il supporto integrato per ProblemDetail. Restituisca ProblemDetail dai gestori delle eccezioni oppure utilizzi ErrorResponseException.
import org.springframework.http.ProblemDetail;
@ExceptionHandler(ResourceNotFoundException.class)
public ProblemDetail handleNotFound(ResourceNotFoundException ex, HttpServletRequest req) {
ProblemDetail pd = ProblemDetail.forStatusAndDetail(HttpStatus.NOT_FOUND, ex.getMessage());
pd.setType(URI.create("https://api.example.com/errors/not-found"));
pd.setTitle("Resource Not Found");
pd.setInstance(URI.create(req.getRequestURI()));
return pd;
}Aggiunta di estensioni personalizzate
ProblemDetail supporta proprietà di estensione tramite setProperty(key, value) per dettagli specifici del dominio, come codici di errore o errori dei campi.
ProblemDetail pd = ProblemDetail.forStatus(HttpStatus.BAD_REQUEST);
pd.setTitle("Validation Failed");
pd.setProperty("errors", fieldErrors); // custom extension
pd.setProperty("timestamp", Instant.now());Abilitazione di RFC 7807 per Spring MVC
Abiliti ProblemDetail per tutte le eccezioni integrate di Spring impostando spring.mvc.problemdetails.enabled=true in application.properties. Spring incapsula quindi automaticamente le eccezioni standard (404, 405 e così via) nel formato RFC 7807.
# application.properties:
spring.mvc.problemdetails.enabled=trueErrorResponseException
Lanci ErrorResponseException dal codice del servizio per produrre una risposta RFC 7807 senza un metodo gestore: Spring MVC la intercetta e la formatta.
throw new ErrorResponseException(HttpStatus.CONFLICT,
ProblemDetail.forStatusAndDetail(HttpStatus.CONFLICT,
"Email already exists: " + email), null);Sottoclasse personalizzata di ProblemDetail
Crei una sottoclasse specifica del dominio di ProblemDetail per aggiungere campi di estensione tipizzati e mantenere pulito il codice dei gestori.
public class ValidationProblemDetail extends ProblemDetail {
private final Map<String, String> fieldErrors;
public ValidationProblemDetail(Map<String, String> errors) {
super(HttpStatus.BAD_REQUEST.value());
this.fieldErrors = errors;
setTitle("Validation Failed");
setProperty("fieldErrors", errors);
}
}Tipo di contenuto: application/problem+json
Le risposte RFC 7807 devono utilizzare il tipo di contenuto application/problem+json, in modo che i client possano distinguere le risposte di errore dai normali payload JSON.
return ResponseEntity.status(HttpStatus.NOT_FOUND)
.contentType(MediaType.APPLICATION_PROBLEM_JSON)
.body(pd);Checklist per una struttura degli errori coerente
Una buona API per gli errori include: (1) URI del tipo leggibile dalle macchine, (2) titolo leggibile dalle persone, (3) codice di stato HTTP esatto, (4) messaggio di dettaglio specifico, (5) URI dell'istanza della richiesta, (6) campi di estensione opzionali (timestamp, traceId, errori dei campi).
ID di traccia per l'osservabilità
Aggiunga l'ID di traccia della richiesta (da Micrometer Tracing o MDC) come proprietà di estensione, così gli sviluppatori possono correlare i log degli errori con la richiesta specifica che ha causato il problema.
pd.setProperty("traceId", MDC.get("traceId"));
pd.setProperty("timestamp", Instant.now());Test dei dettagli dei problemi
Nei test @WebMvcTest, verifichi che il tipo di contenuto della risposta sia application/problem+json e che i campi JSON come status, title e detail corrispondano ai valori attesi.
mockMvc.perform(get("/api/users/999"))
.andExpect(status().isNotFound())
.andExpect(content().contentType("application/problem+json"))
.andExpect(jsonPath("$.status").value(404))
.andExpect(jsonPath("$.title").value("Resource Not Found"));Verifica rapida
Quale proprietà di Spring Boot abilita RFC 7807 per le eccezioni integrate di Spring MVC?
Riepilogo
RFC 7807 standardizza le risposte JSON di errore con i campi type, title, status, detail e instance. Spring 6 fornisce ProblemDetail e ErrorResponseException. Abiliti il supporto con spring.mvc.problemdetails.enabled=true. Aggiunga traceId e timestamp come estensioni per l'osservabilità.
Impara Java con un tutor IA — gratis
Scrivi ed esegui vero codice nel tuo browser, ricevi aiuto istantaneo da un tutor IA disponibile 24/7, e riprendi da dove hai lasciato sul web o nell'app.
- Corsi
- 104
- Lezioni
- 374
Domande Frequenti
La lezione «Problem Details RFC 7807 e risposte di errore coerenti» è gratuita?
Sì — il testo completo di «Problem Details RFC 7807 e risposte di errore coerenti» è 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 Java Academy, passa a CoddyKit PRO. Il corso Java Academy include 4 lezioni in totale.
Cosa imparerò in «Problem Details RFC 7807 e risposte di errore coerenti»?
Restituisca payload di errore strutturati conformi a RFC 7807 usando ProblemDetail di Spring 6. Eserciti Java Academy 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 Java Academy?
Non è richiesta alcuna esperienza precedente. Java Academy su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 4 di 4.
Quanto tempo richiede la lezione «Problem Details RFC 7807 e risposte di errore coerenti»?
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 Java Academy?
Sì. Ogni lezione Java Academy 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
- Validazione dei bean: @NotNull, @Size, @Pattern
- Annotazioni di vincoli personalizzate
- Gestione globale delle eccezioni con @ControllerAdvice
- Problem Details RFC 7807 e risposte di errore coerenti