как правильно обращаться с ошибками в spring-webflux

Я занимаюсь некоторыми исследованиями, используя spring-webflux, и мне нравится понимать, как правильно обращаться с ошибками с помощью функций маршрутизатора.

Я создал небольшой проект для тестирования нескольких сценариев, и мне нравится получать отзывы об этом, и посмотреть, что делают другие люди.

Пока что я делаю.

Предоставление следующей функции маршрутизации:

@Component
public class HelloRouter {
    @Bean
    RouterFunction<?> helloRouterFunction() {
        HelloHandler handler = new HelloHandler();
        ErrorHandler error = new ErrorHandler();

        return nest(path("/hello"),
                nest(accept(APPLICATION_JSON),
                        route(GET("/"), handler::defaultHello)
                                .andRoute(POST("/"), handler::postHello)
                                .andRoute(GET("/{name}"), handler::getHello)
                )).andOther(route(RequestPredicates.all(), error::notFound));
    }
}

Я делаю это на моем обработчике

class HelloHandler {

    private ErrorHandler error;

    private static final String DEFAULT_VALUE = "world";

    HelloHandler() {
        error = new ErrorHandler();
    }

    private Mono<ServerResponse> getResponse(String value) {
        if (value.equals("")) {
            return Mono.error(new InvalidParametersException("bad parameters"));
        }
        return ServerResponse.ok().body(Mono.just(new HelloResponse(value)), HelloResponse.class);
    }

    Mono<ServerResponse> defaultHello(ServerRequest request) {
        return getResponse(DEFAULT_VALUE);
    }

    Mono<ServerResponse> getHello(ServerRequest request) {
        return getResponse(request.pathVariable("name"));
    }

    Mono<ServerResponse> postHello(ServerRequest request) {
        return request.bodyToMono(HelloRequest.class).flatMap(helloRequest -> getResponse(helloRequest.getName()))
                .onErrorResume(error::badRequest);
    }
}

Их обработчик ошибок делает:

class ErrorHandler {

    private static Logger logger = LoggerFactory.getLogger(ErrorHandler.class);

    private static BiFunction<HttpStatus,String,Mono<ServerResponse>> response =
    (status,value)-> ServerResponse.status(status).body(Mono.just(new ErrorResponse(value)),
            ErrorResponse.class);

    Mono<ServerResponse> notFound(ServerRequest request){
        return response.apply(HttpStatus.NOT_FOUND, "not found");
    }

    Mono<ServerResponse> badRequest(Throwable error){
        logger.error("error raised", error);
        return response.apply(HttpStatus.BAD_REQUEST, error.getMessage());
    }
}

Вот полный образец репо:

https://github.com/LearningByExample/reactive-ms-example

ОТВЕТЫ

Ответ 1

Spring 5 предоставляет WebHandler, а в JavaDoc есть строка:

Используйте HttpWebHandlerAdapter для адаптации WebHandler к HttpHandler. WebHttpHandlerBuilder предоставляет удобный способ сделать это, а также дополнительно настраивать один или несколько фильтров и/или обработчиков исключений.

В настоящее время официальная документация предполагает, что мы должны заключить функцию маршрутизатора в HttpHandler перед загрузкой любого сервера:

HttpHandler httpHandler = RouterFunctions.toHttpHandler(routerFunction);

С помощью WebHttpHandlerBuilder мы можем настроить собственные обработчики исключений:

HttpHandler httpHandler = WebHttpHandlerBuilder.webHandler(toHttpHandler(routerFunction))
  .prependExceptionHandler((serverWebExchange, exception) -> {

      /* custom handling goes here */
      return null;

  }).build();

Ответ 2

Если вы считаете, что функции маршрутизатора не подходят для обработки исключений, вы выкидываете HTTP-исключения, что приведет к правильным HTTP-кодам ошибок. Для Spring-Boot (также webflux) это:

  import org.springframework.http.HttpStatus;
  import org.springframework.web.server.ResponseStatusException;
  .
  .
  . 

  new ResponseStatusException(HttpStatus.NOT_FOUND,  "Collection not found");})

Весенние ценные бумаги AccessDeniedException также будут обрабатываться правильно (коды ответов 403/401).

Если у вас есть микросервис и вы хотите использовать REST для этого, это может быть хорошим вариантом, поскольку эти исключения HTTP довольно близки к бизнес-логике и в этом случае должны быть расположены рядом с бизнес-логикой. А поскольку в микросервисе вам не нужно много бизнес-логики и исключений, это тоже не должно загромождать ваш код... (но, конечно, все зависит).

Ответ 3

Почему бы не сделать это по-старому, бросив исключения из функций обработчика и внедряя свой собственный WebExceptionHandler, чтобы поймать их всех:

@Component
class ExceptionHandler : WebExceptionHandler {
    override fun handle(exchange: ServerWebExchange?, ex: Throwable?): Mono<Void> {
        /* Handle different exceptions here */
        when(ex!!) {
            is NoSuchElementException -> exchange!!.response.statusCode = HttpStatus.NOT_FOUND
            is Exception -> exchange!!.response.statusCode = HttpStatus.INTERNAL_SERVER_ERROR
        }

        /* Do common thing like logging etc... */

        return Mono.empty()
    }
}

Вышеприведенный пример находится в Kotlin, так как я просто копировал его из проекта, над которым я сейчас работаю, и поскольку исходный вопрос не был помечен для java в любом случае.

Ответ 4

Быстрый способ отображать исключения из статуса ответа HTTP - это бросить org.springframework.web.server.ResponseStatusException/или создать свои собственные подклассы...

Полный контроль над статусом ответа HTTP + весной добавит тело ответа с возможностью добавить reason.

В Котлине это выглядело так же просто, как

@Component
class MyHandler(private val myRepository: MyRepository) {

    fun getById(req: ServerRequest) = req.pathVariable("id").toMono()
            .map { id -> uuidFromString(id) }  // throws ResponseStatusException
            .flatMap { id -> noteRepository.findById(id) }
            .flatMap { entity -> ok().json().body(entity.toMono()) }
            .switchIfEmpty(notFound().build())  // produces 404 if not found

}

fun uuidFromString(id: String?) = try { UUID.fromString(id) } catch (e: Throwable) { throw BadRequestStatusException(e.localizedMessage) }

class BadRequestStatusException(reason: String) : ResponseStatusException(HttpStatus.BAD_REQUEST, reason)

Тело ответа:

{
    "timestamp": 1529138182607,
    "path": "/api/notes/f7b.491bc-5c86-4fe6-9ad7-111",
    "status": 400,
    "error": "Bad Request",
    "message": "For input string: \"f7b.491bc\""
}

Ответ 5

То, что я сейчас делаю, просто предоставляет bean-компонент моего WebExceptionHandler:

@Bean
@Order(0)
public WebExceptionHandler responseStatusExceptionHandler() {
    return new MyWebExceptionHandler();
}

Преимущество, чем создание самого HttpHandler заключается в том, что я лучше интегрируюсь с WebFluxConfigurer если я предоставляю свой собственный ServerCodecConfigurer например, или используя SpringSecurity

Ответ 6

Вы можете написать глобальный обработчик исключений с пользовательскими данными ответа и кодом ответа следующим образом. Код находится в Котлине. Но вы можете легко преобразовать его в Java:

@Component
@Order(-2)
class GlobalWebExceptionHandler(
  private val objectMapper: ObjectMapper
) : ErrorWebExceptionHandler {

  override fun handle(exchange: ServerWebExchange, ex: Throwable): Mono<Void> {

    val response = when (ex) {
      // buildIOExceptionMessage should build relevant exception message as a serialisable object
      is IOException -> buildIOExceptionMessage(ex)
      else -> buildExceptionMessage(ex)
    }

    // Or you can also set them inside while conditions
    exchange.response.headers.contentType = MediaType.APPLICATION_PROBLEM_JSON
    exchange.response.statusCode = HttpStatus.valueOf(response.status)
    val bytes = objectMapper.writeValueAsBytes(response)
    val buffer = exchange.response.bufferFactory().wrap(bytes)
    return exchange.response.writeWith(Mono.just(buffer))
  }
}