Spring Boot 4 Complete Guide · Урок

Ответы с описанием проблемы RFC 7807

Стандартизируйте машиночитаемые данные ошибок с помощью ProblemDetail и поддержки ErrorResponse в Spring.

«Ответы с описанием проблемы RFC 7807» — бесплатный урок Spring Boot 4 Complete Guide на CoddyKit. Это урок 4 из 4. Ты можешь прочитать весь урок бесплатно ниже — а потом практиковать его прямо в браузере с встроенным редактором кода и ИИ-репетитором 24/7. Это часть пути обучения Spring Boot 4 Complete Guide, и твой прогресс синхронизируется между веб-версией и приложением CoddyKit. Курс Spring Boot 4 Complete Guide содержит 4 уроков всего.

Части этого урока еще не переведены и отображаются на английском.

Why Standardize Error Responses?

When an API fails, clients need a predictable, machine-readable error body. Hand-rolled JSON like {"error": "bad"} varies per endpoint and breaks integrations.

RFC 7807 ("Problem Details for HTTP APIs") defines a single, standard shape for error payloads. Spring Boot has first-class support for it through the ProblemDetail class and the ErrorResponse contract.

Consistent across every endpoint
Self-documenting via a type URI
Extensible with custom properties

The RFC 7807 Media Type and Fields

A Problem Detail response uses the media type application/problem+json and contains these standard members:

type — a URI identifying the problem category (defaults to about:blank)
title — a short, human-readable summary
status — the HTTP status code (e.g. 404)
detail — a human-readable explanation specific to this occurrence
instance — a URI identifying the specific occurrence (often the request path)

You may also add custom extension members like errorCode or timestamp.

A Sample Problem+JSON Body

Here is what a client actually receives. Note the application/problem+json content type and the standard fields, plus an extension member errorCode.

{
  "type": "https://api.shop.com/problems/out-of-stock",
  "title": "Out of Stock",
  "status": 409,
  "detail": "Product 42 has only 3 units left, but 5 were requested.",
  "instance": "/api/orders",
  "errorCode": "INVENTORY_SHORTAGE"
}

Building a ProblemDetail Programmatically

Spring's ProblemDetail is a simple value object. Use the static factory forStatus() or forStatusAndDetail(), then enrich it with setters.

You can attach custom members via setProperty(name, value). This object serializes directly to application/problem+json.

ProblemDetail problem = ProblemDetail.forStatusAndDetail(
        HttpStatus.NOT_FOUND,
        "Product 42 was not found");
problem.setTitle("Product Not Found");
problem.setType(URI.create("https://api.shop.com/problems/not-found"));
problem.setInstance(URI.create("/api/products/42"));
problem.setProperty("errorCode", "PRODUCT_NOT_FOUND");

Returning ProblemDetail from a Controller

A controller method can return a ProblemDetail directly, or wrap it in a ResponseEntity for full control of headers. Spring sets the status from the ProblemDetail and serializes the body as problem+json.

@GetMapping("/products/{id}")
public ResponseEntity<ProblemDetail> getProduct(@PathVariable Long id) {
    return productRepo.findById(id)
        .map(p -> ResponseEntity.ok().<ProblemDetail>build())
        .orElseGet(() -> {
            ProblemDetail pd = ProblemDetail.forStatusAndDetail(
                HttpStatus.NOT_FOUND, "No product with id " + id);
            pd.setTitle("Product Not Found");
            return ResponseEntity.status(404).body(pd);
        });
}

The ErrorResponse Contract

Returning ProblemDetail manually works, but Spring prefers exceptions to carry their own problem detail. The ErrorResponse interface couples an HTTP status, headers, and a ProblemDetail body.

Spring MVC automatically renders any thrown exception that implements ErrorResponse as problem+json. The convenience class ErrorResponseException is a ready-made implementation you can throw directly.

ProblemDetail pd = ProblemDetail.forStatusAndDetail(
        HttpStatus.CONFLICT, "Email already registered");
pd.setTitle("Duplicate Email");
pd.setProperty("errorCode", "DUPLICATE_EMAIL");

throw new ErrorResponseException(HttpStatus.CONFLICT, pd, null);

Custom Exceptions Implementing ErrorResponse

For domain errors, implement ErrorResponse on your own exception. By extending ErrorResponseException, you inherit status, headers, and body handling, and just supply a configured ProblemDetail.

This keeps error definitions next to the domain logic and out of controllers.

public class OutOfStockException extends ErrorResponseException {

    public OutOfStockException(long productId, int available, int requested) {
        super(HttpStatus.CONFLICT, asProblemDetail(productId, available, requested), null);
    }

    private static ProblemDetail asProblemDetail(long id, int avail, int req) {
        ProblemDetail pd = ProblemDetail.forStatusAndDetail(
            HttpStatus.CONFLICT,
            "Product " + id + " has only " + avail + " left, but " + req + " requested.");
        pd.setType(URI.create("https://api.shop.com/problems/out-of-stock"));
        pd.setTitle("Out of Stock");
        pd.setProperty("errorCode", "INVENTORY_SHORTAGE");
        return pd;
    }
}

Centralizing with @ControllerAdvice

The cleanest pattern: throw plain domain exceptions, then convert them to ProblemDetail in one place using @RestControllerAdvice and @ExceptionHandler.

The handler returns a ProblemDetail; Spring applies the status and problem+json content type automatically.

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ProductNotFoundException.class)
    public ProblemDetail handleNotFound(ProductNotFoundException ex) {
        ProblemDetail pd = ProblemDetail.forStatusAndDetail(
            HttpStatus.NOT_FOUND, ex.getMessage());
        pd.setTitle("Product Not Found");
        pd.setType(URI.create("https://api.shop.com/problems/not-found"));
        pd.setProperty("errorCode", "PRODUCT_NOT_FOUND");
        return pd;
    }
}

Extending ResponseEntityExceptionHandler

Spring's built-in exceptions (validation failures, unreadable bodies, missing parameters) are handled by ResponseEntityExceptionHandler. Since Spring Boot 3, these already produce ProblemDetail bodies.

Extend it in your advice to override or enrich the defaults while keeping framework error handling consistent.

@RestControllerAdvice
public class ApiExceptionHandler extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(
            MethodArgumentNotValidException ex, HttpHeaders headers,
            HttpStatusCode status, WebRequest request) {

        ProblemDetail pd = ex.getBody();
        pd.setTitle("Validation Failed");
        pd.setProperty("errorCode", "VALIDATION_ERROR");
        return handleExceptionInternal(ex, pd, headers, status, request);
    }
}

Adding Standard Extension Properties

Common extensions include a timestamp and a traceId for log correlation. Add them in one place so every error carries them.

Use setProperty with serializable values; Instant serializes to an ISO-8601 string by default.

ProblemDetail pd = ProblemDetail.forStatusAndDetail(
        HttpStatus.BAD_REQUEST, "Quantity must be positive");
pd.setTitle("Invalid Quantity");
pd.setProperty("timestamp", Instant.now());
pd.setProperty("traceId", MDC.get("traceId"));
pd.setProperty("errorCode", "INVALID_QUANTITY");

Configuring Defaults in application.yml

Spring can include extra context automatically. Enabling these properties makes the framework attach standard details without code changes.

spring.mvc.problemdetails.enabled=true turns on problem+json for built-in exceptions (default in Boot 3+)
server.error.include-message and include-binding-errors control how much detail is exposed

Keep sensitive details out of production responses by tuning these flags.

spring:
  mvc:
    problemdetails:
      enabled: true
server:
  error:
    include-message: on_param
    include-binding-errors: on_param
    include-stacktrace: never

Quick Check: Choosing the Right Pattern

You have several domain exceptions (not-found, conflict, forbidden) and want every error across all controllers to emit consistent application/problem+json with shared extensions like traceId. What is the recommended Spring approach?

Recap: RFC 7807 in Spring Boot

You learned how to standardize error payloads with RFC 7807:

ProblemDetail is the value object for application/problem+json, with type, title, status, detail, instance plus custom properties.
ErrorResponse / ErrorResponseException let exceptions carry their own problem detail.
@RestControllerAdvice centralizes conversion of domain exceptions into ProblemDetail.
ResponseEntityExceptionHandler already renders Spring's built-in exceptions as problem+json, and can be extended.
Add extensions like errorCode, timestamp, and traceId, and tune exposure via application.yml.

The result: a single, predictable, machine-readable error contract across your whole API.

Часто задаваемые вопросы

Урок «Ответы с описанием проблемы RFC 7807» бесплатный?

Да — полный текст урока «Ответы с описанием проблемы RFC 7807» бесплатно доступен здесь в веб-версии. Чтобы практиковать его интерактивно (встроенный редактор кода и ИИ-репетитор 24/7) и разблокировать остальной курс Spring Boot 4 Complete Guide, подпишись на CoddyKit PRO. Курс Spring Boot 4 Complete Guide содержит 4 уроков всего.

Чему я научусь в уроке «Ответы с описанием проблемы RFC 7807»?

Стандартизируйте машиночитаемые данные ошибок с помощью ProblemDetail и поддержки ErrorResponse в Spring. Ты практикуешь Spring Boot 4 Complete Guide с помощью реального кода, который запускаешь прямо в браузере, и ИИ-репетитор 24/7 отвечает на твои вопросы во время урока.

Нужен ли мне опыт, чтобы начать Spring Boot 4 Complete Guide?

Предыдущий опыт не требуется. Spring Boot 4 Complete Guide на CoddyKit структурирован для всех уровней — от новичков до продвинутых, поэтому ты можешь начать отсюда или с самого начала и учиться в своем темпе. Это урок 4 из 4.

Сколько времени занимает урок «Ответы с описанием проблемы RFC 7807»?

Большинство уроков CoddyKit занимают около 5–10 минут. Каждый из них компактный и интерактивный, поэтому ты постоянно делаешь прогресс и продолжаешь с того же места в веб-версии и приложении.

Можно ли писать и запускать код в этом уроке Spring Boot 4 Complete Guide?

Да. Каждый урок Spring Boot 4 Complete Guide включает встроенный редактор кода, поэтому ты пишешь и запускаешь реальный код прямо в браузере и получаешь моментальную обратную связь от AI — локальная установка не требуется.

Все уроки этого курса

Ограничения проверки компонентов и группы ограничений
Создание пользовательских аннотаций ограничений
Глобальная обработка исключений с @ControllerAdvice
Ответы с описанием проблемы RFC 7807

← Назад к Spring Boot 4 Complete Guide