{"id":18425,"date":"2024-03-15T16:53:57","date_gmt":"2024-03-15T16:53:57","guid":{"rendered":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/"},"modified":"2024-03-21T13:16:35","modified_gmt":"2024-03-21T13:16:35","slug":"how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice","status":"publish","type":"post","link":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/","title":{"rendered":"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?"},"content":{"rendered":"

To make asynchronous calls to microservices using WebClient in Spring Cloud Gateway, follow these steps:<\/p>\n

    \n
  1. Add dependencies: include the dependencies for WebClient and Spring Cloud Gateway in the project’s pom.xml file.<\/li>\n<\/ol>\n
    <dependencies<\/span>><\/span>\r\n    <!-- Spring Cloud Gateway --><\/span>\r\n    <dependency<\/span>><\/span>\r\n        <groupId<\/span>><\/span>org.springframework.cloud<\/groupId<\/span>><\/span>\r\n        <artifactId<\/span>><\/span>spring-cloud-starter-gateway<\/artifactId<\/span>><\/span>\r\n    <\/dependency<\/span>><\/span>\r\n\r\n    <!-- WebClient --><\/span>\r\n    <dependency<\/span>><\/span>\r\n        <groupId<\/span>><\/span>org.springframework.boot<\/groupId<\/span>><\/span>\r\n        <artifactId<\/span>><\/span>spring-boot-starter-webflux<\/artifactId<\/span>><\/span>\r\n    <\/dependency<\/span>><\/span>\r\n<\/dependencies<\/span>><\/span>\r\n<\/code><\/pre>\n
      \n
    1. Create a GatewayFilter: Create a GatewayFilter to handle requests and use WebClient to asynchronously call the microservice.<\/li>\n<\/ol>\n
      @Component<\/span>\r\npublic<\/span> class<\/span> MyGatewayFilter<\/span> implements<\/span> GlobalFilter<\/span>, Ordered {\r\n\r\n    private<\/span> final<\/span> WebClient webClient;\r\n\r\n    public<\/span> MyGatewayFilter<\/span>(WebClient.Builder webClientBuilder)<\/span> {\r\n        this<\/span>.webClient = webClientBuilder.build();\r\n    }\r\n\r\n    @Override<\/span>\r\n    public<\/span> Mono<Void> filter<\/span>(ServerWebExchange exchange, GatewayFilterChain chain)<\/span> {\r\n        \/\/ \u5f02\u6b65\u8c03\u7528\u5fae\u670d\u52a1<\/span>\r\n        Mono<ClientResponse> responseMono = webClient.get()\r\n                .uri(\"http:\/\/microservice\/service\"<\/span>)\r\n                .exchange();\r\n\r\n        \/\/ \u5904\u7406\u54cd\u5e94<\/span>\r\n        return<\/span> responseMono.flatMap(response -> {\r\n            \/\/ \u590d\u5236\u54cd\u5e94\u72b6\u6001\u7801\u3001\u5934\u90e8\u4fe1\u606f\u7b49<\/span>\r\n            ServerHttpResponse<\/span> serverResponse<\/span> =<\/span> exchange.getResponse();\r\n            serverResponse.setStatusCode(response.statusCode());\r\n            serverResponse.getHeaders().putAll(response.headers().asHttpHeaders());\r\n\r\n            \/\/ \u8f6c\u53d1\u54cd\u5e94\u4f53<\/span>\r\n            return<\/span> response.bodyToMono(String.class)\r\n                    .flatMap(body -> {\r\n                        serverResponse.getHeaders().setContentLength(body.length());\r\n                        return<\/span> serverResponse.writeWith(Mono.just(serverResponse.bufferFactory().wrap(body.getBytes())));\r\n                    });\r\n        });\r\n    }\r\n\r\n    @Override<\/span>\r\n    public<\/span> int<\/span> getOrder<\/span>()<\/span> {\r\n        return<\/span> -1<\/span>;\r\n    }\r\n}\r\n<\/code><\/pre>\n
        \n
      1. Configure a GatewayFilter: Set up the GatewayFilter in the application’s configuration file.<\/li>\n<\/ol>\n
        spring:<\/span>\r\n  cloud:<\/span>\r\n    gateway:<\/span>\r\n      routes:<\/span>\r\n        -<\/span> id:<\/span> my_route<\/span>\r\n          uri:<\/span> http:\/\/localhost:8080\/<\/span>\r\n          filters:<\/span>\r\n            -<\/span> MyGatewayFilter<\/span>\r\n<\/code><\/pre>\n
        In this way, when routing with Spring Cloud Gateway, the MyGatewayFilter will be automatically invoked to handle the request and use WebClient to asynchronously call the microservices.<\/p>\n","protected":false},"excerpt":{"rendered":"
        To make asynchronous calls to microservices using WebClient in Spring Cloud Gateway, follow these steps: Add dependencies: include the dependencies for WebClient and Spring Cloud Gateway in the project’s pom.xml file. <dependencies> <!– Spring Cloud Gateway –> <dependency> <groupId>org.springframework.cloud<\/groupId> <artifactId>spring-cloud-starter-gateway<\/artifactId> <\/dependency> <!– WebClient –> <dependency> <groupId>org.springframework.boot<\/groupId> <artifactId>spring-boot-starter-webflux<\/artifactId> <\/dependency> <\/dependencies> Create a GatewayFilter: Create a GatewayFilter […]<\/p>\n","protected":false},"author":6,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_import_markdown_pro_load_document_selector":0,"_import_markdown_pro_submit_text_textarea":"","footnotes":""},"categories":[1],"tags":[],"class_list":["post-18425","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"yoast_head":"\nHow to use WebClient in SpringCloud gateway to asynchronously call a microservice? - Blog - Silicon Cloud<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?\" \/>\n<meta property=\"og:description\" content=\"To make asynchronous calls to microservices using WebClient in Spring Cloud Gateway, follow these steps: Add dependencies: include the dependencies for WebClient and Spring Cloud Gateway in the project’s pom.xml file. <dependencies> <!-- Spring Cloud Gateway --> <dependency> <groupId>org.springframework.cloud<\/groupId> <artifactId>spring-cloud-starter-gateway<\/artifactId> <\/dependency> <!-- WebClient --> <dependency> <groupId>org.springframework.boot<\/groupId> <artifactId>spring-boot-starter-webflux<\/artifactId> <\/dependency> <\/dependencies> Create a GatewayFilter: Create a GatewayFilter […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\" \/>\n<meta property=\"og:site_name\" content=\"Blog - Silicon Cloud\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\" \/>\n<meta property=\"article:published_time\" content=\"2024-03-15T16:53:57+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-03-21T13:16:35+00:00\" \/>\n<meta name=\"author\" content=\"Benjamin Taylor\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:site\" content=\"@SiliCloudGlobal\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Benjamin Taylor\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\"},\"author\":{\"name\":\"Benjamin Taylor\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/ac801fe9549a25960ce48aa2e0a691c9\"},\"headline\":\"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?\",\"datePublished\":\"2024-03-15T16:53:57+00:00\",\"dateModified\":\"2024-03-21T13:16:35+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\"},\"wordCount\":102,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\",\"name\":\"How to use WebClient in SpringCloud gateway to asynchronously call a microservice? - Blog - Silicon Cloud\",\"isPartOf\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\"},\"datePublished\":\"2024-03-15T16:53:57+00:00\",\"dateModified\":\"2024-03-21T13:16:35+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.silicloud.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#website\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"name\":\"Silicon Cloud Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\"},\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#organization\",\"name\":\"Silicon Cloud Blog\",\"url\":\"https:\/\/www.silicloud.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"contentUrl\":\"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png\",\"width\":1024,\"height\":1024,\"caption\":\"Silicon Cloud Blog\"},\"image\":{\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/SiliCloudGlobal\/\",\"https:\/\/twitter.com\/SiliCloudGlobal\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/ac801fe9549a25960ce48aa2e0a691c9\",\"name\":\"Benjamin Taylor\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/ec2e3d3e2d525fd148047c4520ae7c1cdccd1f4b48a1a488422b31f04f345c14?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/ec2e3d3e2d525fd148047c4520ae7c1cdccd1f4b48a1a488422b31f04f345c14?s=96&d=mm&r=g\",\"caption\":\"Benjamin Taylor\"},\"url\":\"https:\/\/www.silicloud.com\/blog\/author\/benjamintaylor\/\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","yoast_head_json":{"title":"How to use WebClient in SpringCloud gateway to asynchronously call a microservice? - Blog - Silicon Cloud","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/","og_locale":"en_US","og_type":"article","og_title":"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?","og_description":"To make asynchronous calls to microservices using WebClient in Spring Cloud Gateway, follow these steps: Add dependencies: include the dependencies for WebClient and Spring Cloud Gateway in the project’s pom.xml file. <dependencies> <!-- Spring Cloud Gateway --> <dependency> <groupId>org.springframework.cloud<\/groupId> <artifactId>spring-cloud-starter-gateway<\/artifactId> <\/dependency> <!-- WebClient --> <dependency> <groupId>org.springframework.boot<\/groupId> <artifactId>spring-boot-starter-webflux<\/artifactId> <\/dependency> <\/dependencies> Create a GatewayFilter: Create a GatewayFilter […]","og_url":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/","og_site_name":"Blog - Silicon Cloud","article_publisher":"https:\/\/www.facebook.com\/SiliCloudGlobal\/","article_published_time":"2024-03-15T16:53:57+00:00","article_modified_time":"2024-03-21T13:16:35+00:00","author":"Benjamin Taylor","twitter_card":"summary_large_image","twitter_creator":"@SiliCloudGlobal","twitter_site":"@SiliCloudGlobal","twitter_misc":{"Written by":"Benjamin Taylor","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/#article","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/"},"author":{"name":"Benjamin Taylor","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/ac801fe9549a25960ce48aa2e0a691c9"},"headline":"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?","datePublished":"2024-03-15T16:53:57+00:00","dateModified":"2024-03-21T13:16:35+00:00","mainEntityOfPage":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/"},"wordCount":102,"commentCount":0,"publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/","url":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/","name":"How to use WebClient in SpringCloud gateway to asynchronously call a microservice? - Blog - Silicon Cloud","isPartOf":{"@id":"https:\/\/www.silicloud.com\/blog\/#website"},"datePublished":"2024-03-15T16:53:57+00:00","dateModified":"2024-03-21T13:16:35+00:00","breadcrumb":{"@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.silicloud.com\/blog\/how-to-use-webclient-in-springcloud-gateway-to-asynchronously-call-a-microservice\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.silicloud.com\/blog\/"},{"@type":"ListItem","position":2,"name":"How to use WebClient in SpringCloud gateway to asynchronously call a microservice?"}]},{"@type":"WebSite","@id":"https:\/\/www.silicloud.com\/blog\/#website","url":"https:\/\/www.silicloud.com\/blog\/","name":"Silicon Cloud Blog","description":"","publisher":{"@id":"https:\/\/www.silicloud.com\/blog\/#organization"},"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.silicloud.com\/blog\/#organization","name":"Silicon Cloud Blog","url":"https:\/\/www.silicloud.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","contentUrl":"https:\/\/www.silicloud.com\/blog\/wp-content\/uploads\/2023\/11\/EN-SILICON-Full.png","width":1024,"height":1024,"caption":"Silicon Cloud Blog"},"image":{"@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/SiliCloudGlobal\/","https:\/\/twitter.com\/SiliCloudGlobal"]},{"@type":"Person","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/ac801fe9549a25960ce48aa2e0a691c9","name":"Benjamin Taylor","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.silicloud.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/ec2e3d3e2d525fd148047c4520ae7c1cdccd1f4b48a1a488422b31f04f345c14?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/ec2e3d3e2d525fd148047c4520ae7c1cdccd1f4b48a1a488422b31f04f345c14?s=96&d=mm&r=g","caption":"Benjamin Taylor"},"url":"https:\/\/www.silicloud.com\/blog\/author\/benjamintaylor\/"}]}},"_links":{"self":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/18425","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/users\/6"}],"replies":[{"embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/comments?post=18425"}],"version-history":[{"count":1,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/18425\/revisions"}],"predecessor-version":[{"id":52103,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/posts\/18425\/revisions\/52103"}],"wp:attachment":[{"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/media?parent=18425"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/categories?post=18425"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.silicloud.com\/blog\/wp-json\/wp\/v2\/tags?post=18425"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}