{"id":15125,"date":"2023-12-04T11:52:27","date_gmt":"2023-12-04T19:52:27","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=15125"},"modified":"2023-12-12T12:52:52","modified_gmt":"2023-12-12T20:52:52","slug":"spring-webclient-429-ratelimit-errors","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/spring-webclient-429-ratelimit-errors\/","title":{"rendered":"Gesti\u00f3n de errores 429 RateLimit con Spring WebClient"},"content":{"rendered":"

Recientemente me he hecho cargo del mantenimiento de un Spring Boot<\/a> proyecto. Este proyecto tiene algunas L\u00edmite de tarifa <\/em>errores en los registros cuando la aplicaci\u00f3n se pon\u00eda en contacto con una API REST remota. Resulta que esta aplicaci\u00f3n tambi\u00e9n utilizaba el m\u00e9todo s\u00edncrono y bloqueante Plantilla RestTemplate<\/em> para realizar las llamadas a la API, en lugar del m\u00e1s reciente Spring WebClient<\/em>que resulta que utiliza la API Reactor bajo el cap\u00f3.<\/span><\/p>\n

\u00bfY sabes qu\u00e9 es lo mejor de Reactor y del uso de APIs Reactivas en general? Hace que programar con Data Stream sea muy f\u00e1cil. Lo que tambi\u00e9n significa que facilita la implementaci\u00f3n de estrategias de reintento.<\/span><\/p>\n

Hablemos primero del error en el registro. Lo que obtuve se parec\u00eda a esto:<\/span><\/p>\n

org.springframework.web.client.HttpClientErrorException$TooManyRequests: 429 Too Many Requests: [{\"response_type\":\"ERROR\",\"message\":\"Number of requests has exceeded the 1 minute limit\"}]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.HttpClientErrorException.create(HttpClientErrorException.java:137) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.DefaultResponseErrorHandler.handleError(DefaultResponseErrorHandler.java:184) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.DefaultResponseErrorHandler.handleError(DefaultResponseErrorHandler.java:125) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.ResponseErrorHandler.handleError(ResponseErrorHandler.java:63) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.RestTemplate.handleResponse(RestTemplate.java:782) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.RestTemplate.doExecute(RestTemplate.java:740) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.RestTemplate.execute(RestTemplate.java:674) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.web.client.RestTemplate.getForObject(RestTemplate.java:315) ~[spring-web-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at com.couchbase.training.couchlms.repository.LmsRepository.getCourseModules(LmsRepository.java:102) ~[classes!\/:0.0.40-SNAPSHOT]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at com.couchbase.training.couchlms.services.LmsProcessor.processCourseModules(LmsProcessor.java:147) [classes!\/:0.0.40-SNAPSHOT]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at com.couchbase.training.couchlms.services.LmsProcessor.processCourses(LmsProcessor.java:91) [classes!\/:0.0.40-SNAPSHOT]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at com.couchbase.training.couchlms.config.SchedulingConfig.scheduledCoursesPuller(SchedulingConfig.java:45) [classes!\/:0.0.40-SNAPSHOT]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.scheduling.support.ScheduledMethodRunnable.run(ScheduledMethodRunnable.java:84) [spring-context-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at org.springframework.scheduling.support.DelegatingErrorHandlingRunnable.run(DelegatingErrorHandlingRunnable.java:54) [spring-context-5.2.9.RELEASE.jar!\/:5.2.9.RELEASE]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:511) [na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.util.concurrent.FutureTask.runAndReset(FutureTask.java:308) [na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.access$301(ScheduledThreadPoolExecutor.java:180) [na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.util.concurrent.ScheduledThreadPoolExecutor$ScheduledFutureTask.run(ScheduledThreadPoolExecutor.java:294) [na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1149) [na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:624) [na:1.8.0_252]\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0at java.lang.Thread.run(Thread.java:748) [na:1.8.0_252]<\/pre>\n
Como de costumbre, la parte interesante de las trazas de pila est\u00e1 en la parte superior. El error es <\/span>429 Demasiadas solicitudes<\/strong>y el mensaje dice que hay un L\u00edmite de velocidad de 1 minuto<\/strong>. Descomponiendo esto, el estado HTTP<\/span>\u00a0el c\u00f3digo devuelto es 429<\/span><\/a>. Se trata de un error de l\u00edmite de velocidad, lo que significa que la API indica a la persona que llama que ha enviado demasiadas peticiones. Por lo general, esto se puede resolver esperando un poco, e incluso podr\u00eda tener un Reintentar despu\u00e9s de<\/em>\u00a0en la respuesta que le indica cu\u00e1nto tiempo tiene que esperar. <\/span><\/p>\n
Veamos c\u00f3mo podemos obtener esa informaci\u00f3n con WebClient de Spring:<\/span><\/p>\n
.uri(ub -> ub.pathSegment(uri).queryParams(queryParams).build())\r\n.retrieve()\r\n.onStatus(\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0HttpStatus.TOO_MANY_REQUESTS::equals,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0response -> {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0List<String> header = response.headers().header(\"Retry-After\");\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0Integer delayInSeconds;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0if (!header.isEmpty()) {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0delayInSeconds = Integer.valueOf(header.get(0));\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0} else {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0delayInSeconds = 60;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0}\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return response.bodyToMono(String.class).map(msg -> new RateLimitException(msg, delayInSeconds));\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0})\r\n.bodyToMono(String.class)<\/pre>\n
Este c\u00f3digo est\u00e1 enviando un GET<\/em> petici\u00f3n. El WebClient nos permite echar un vistazo a la respuesta de la petici\u00f3n y reaccionar adecuadamente gracias a la funci\u00f3n onStatus<\/em> m\u00e9todo. El primer par\u00e1metro es un booleano utilizado para filtrar el c\u00f3digo de estado HTTP devuelto. Aqu\u00ed, cuando el c\u00f3digo de estado es 429, hacemos algo.<\/p>\n
Echamos un vistazo a la Respuesta<\/em> mirar si hay un Reintentar despu\u00e9s de<\/em> si es as\u00ed, inicializamos la cabecera delayInSeconds<\/em> si no, establecemos un valor por defecto de 60. Entonces podemos devolver el Respuesta<\/em> asignado a un RateLimitException<\/em>. El contenido del cuerpo se utilizar\u00e1 como mensaje de error y el delayInSeconds estar\u00e1 disponible en un campo separado. Echa un vistazo al c\u00f3digo de Excepci\u00f3n para m\u00e1s detalles:<\/span><\/p>\n
import java.time.Duration;\r\npublic class RateLimitException extends Throwable {\r\n\u00a0\u00a0\u00a0\u00a0private int retryAfterDelay = 60;\r\n\r\n\u00a0\u00a0\u00a0\u00a0public RateLimitException(String message) {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0super(message);\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\u00a0\u00a0\u00a0\u00a0public RateLimitException(String message, int retryAfterDelay) {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0super(message); this.retryAfterDelay = retryAfterDelay;\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\u00a0\u00a0\u00a0\u00a0public int getRetryAfterDelay() {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return retryAfterDelay;\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\u00a0\u00a0\u00a0\u00a0public Duration getRetryAfterDelayDuration() {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return Duration.ofSeconds(retryAfterDelay);\r\n\u00a0\u00a0\u00a0\u00a0}\r\n}<\/pre>\n
As\u00ed que lo que hay que hacer es capturar este error espec\u00edfico y luego volver a intentarlo despu\u00e9s de la duraci\u00f3n dada. Reactor lo hace f\u00e1cil proporcionando Reintentos<\/em> estrategias. Todo lo que tiene que hacer es llamar al reintentarCuando<\/em> m\u00e9todo:<\/span><\/p>\n
.bodyToMono(String.class)\r\n.retryWhen(Retry.withThrowable(throwableFlux -> {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return throwableFlux.filter(t -> t instanceof RateLimitException).map(t -> {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0RateLimitException rle = (RateLimitException) t;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return Retry.fixedDelay(1, rle.getRetryAfterDelayDuration());\r\n\u00a0\u00a0\u00a0\u00a0});<\/pre>\n
Existen diferentes Reintentar<\/em> podemos utilizar el m\u00e9todo withThrowable()<\/em> constructor. Da un Flux que debe contener el RateLimitException<\/em>. As\u00ed que empezamos aplicando un filtro para asegurarnos de ello. Luego mapeamos esa excepci\u00f3n al objeto Retry real. Aqu\u00ed es el Retry.fixedDelay<\/em> tomando como par\u00e1metros un m\u00e1ximo de intentos y una duraci\u00f3n. La duraci\u00f3n procede del RateLimitException<\/em> que se lanz\u00f3 antes.<\/span><\/p>\n
Con eso, cada vez que una petici\u00f3n devuelva un 429, el cliente esperar\u00e1 el tiempo apropiado hasta que reintente. Y fue mucho m\u00e1s f\u00e1cil de implementar con Reactor que usando try\/catch<\/em> con Spring's Plantilla RestTemplate<\/em>. S\u00e9 que la programaci\u00f3n reactiva puede ser un poco intimidante al principio, pero es una gran manera de gestionar flujos de datos como solicitudes y respuestas HTTP, o para gestionar las conexiones a bases de datos que soportan la programaci\u00f3n reactiva, como Couchbase<\/a>.<\/span><\/p>\n
\u00bfQuieres m\u00e1s ayuda e ideas?<\/p>\n