欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

詳解Spring Cloud Gateway修改請求和響應body的內(nèi)容

 更新時間：2021年09月06日 09:39:48   作者：程序員欣宸  
這篇文章主要介紹了Spring Cloud Gateway修改請求和響應body的內(nèi)容的相關資料,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

歡迎訪問我的GitHub

這里分類和匯總了欣宸的全部原創(chuàng)(含配套源碼)：https://github.com/zq2599/blog_demos

本篇概覽

  • 作為《Spring Cloud Gateway實戰(zhàn)》系列的第九篇，咱們聊聊如何用Spring Cloud Gateway修改原始請求和響應內(nèi)容，以及修改過程中遇到的問題
  • 首先是修改請求body，如下圖，瀏覽器是請求發(fā)起方，真實參數(shù)只有user-id，經(jīng)過網(wǎng)關時被塞入字段user-name，于是，后臺服務收到的請求就帶有user-name字段了

在這里插入圖片描述

其次是修改響應，如下圖，服務提供方provider-hello的原始響應只有response-tag字段，經(jīng)過網(wǎng)關時被塞入了gateway-response-tag字段，最終瀏覽器收到的響應就是response-tag和gateway-response-tag兩個字段：

在這里插入圖片描述

總的來說，今天要做具體事情如下：

  1. 準備工作：在服務提供者的代碼中新增一個web接口，用于驗證Gateway的操作是否有效
  2. 介紹修改請求body和響應body的套路
  3. 按套路開發(fā)一個過濾器(filter)，用于修改請求的body
  4. 按套路開發(fā)一個過濾器(filter)，用于修改響應的body
  5. 思考和嘗試：如何從Gateway返回錯誤？

在實戰(zhàn)過程中，咱們順便搞清楚兩個問題：

  1. 代碼配置路由時，如何給一個路由添加多個filter？
  2. 代碼配置路由和yml配置是否可以混搭，兩者有沖突嗎？

源碼下載

名稱 鏈接 備注
項目主頁 https://github.com/zq2599/blog_demos 該項目在GitHub上的主頁
git倉庫地址(https) https://github.com/zq2599/blog_demos.git 該項目源碼的倉庫地址，https協(xié)議
git倉庫地址(ssh) git@github.com:zq2599/blog_demos.git 該項目源碼的倉庫地址，ssh協(xié)議

這個git項目中有多個文件夾，本篇的源碼在spring-cloud-tutorials文件夾下，如下圖紅框所示：

在這里插入圖片描述

spring-cloud-tutorials文件夾下有多個子工程，本篇的代碼是gateway-change-body，如下圖紅框所示：

在這里插入圖片描述

準備工作

為了觀察Gateway能否按預期去修改請求和響應的body，咱們給服務提供者provider-hello增加一個接口，代碼在Hello.java中，如下：

 @PostMapping("/change")
    public Map<String, Object> change(@RequestBody Map<String, Object> map) {
        map.put("response-tag", dateStr());
        return map;
    }
  • 可見新增的web接口很簡單：將收到的請求數(shù)據(jù)作為返回值，在里面添加了一個鍵值對，然后返回給請求方，有了這個接口，咱們就能通過觀察返回值來判斷Gateway對請求和響應的操作是否生效
  • 來試一下，先啟動nacos（provider-hello需要的）
  • 再運行provider-hello應用，用Postman向其發(fā)請求試試，如下圖，符合預期：

在這里插入圖片描述

  • 準備工作已完成，開始開發(fā)吧

修改請求body的套路

  1. 修改請求body是通過自定義filter實現(xiàn)的
  2. 配置路由及其filter的時候，有yml配置文件和代碼配置兩種方式可以配置路由，官方文檔給出的demo是代碼配置的，因此今天咱們也參考官方做法，通過代碼來配置路由和過濾器
  3. 在代碼配置路由的時候，調(diào)用filters方法，該方法的入?yún)⑹莻€lambda表達式
  4. 此lambda表達式固定調(diào)用modifyRequestBody方法，咱們只要定義好modifyRequestBody方法的三個入?yún)⒓纯?/li>
  5. modifyRequestBody方法的第一個入?yún)⑹禽斎腩愋?/li>
  6. 第二個入?yún)⑹欠祷仡愋?/li>
  7. 第三個是RewriteFunction接口的實現(xiàn)，這個代碼需要您自己寫，內(nèi)容是將輸入數(shù)據(jù)轉換為返回類型數(shù)據(jù)具體邏輯，咱們來看官方Demo，也就是上述套路了：
@Bean
public RouteLocator routes(RouteLocatorBuilder builder) {
    return builder.routes()
        .route("rewrite_request_obj", r -> r.host("*.rewriterequestobj.org")
            .filters(f -> f.prefixPath("/httpbin")
                .modifyRequestBody(String.class, Hello.class, MediaType.APPLICATION_JSON_VALUE,
                    (exchange, s) -> return Mono.just(new Hello(s.toUpperCase())))).uri(uri))
        .build();
}

修改響應body的套路

  • 用Spring Cloud Gateway修改響應body的套路和前面的請求body如出一轍
  • 通過代碼來配置路由和過濾器
  • 在代碼配置路由的時候，調(diào)用filters方法，該方法的入?yún)⑹莻€lambda表達式
  • 此lambda表達式固定調(diào)用modifyResponseBody方法，咱們只要定義好modifyResponseBody方法的三個入?yún)⒓纯?/li>
  • modifyRequestBody方法的第一個入?yún)⑹禽斎腩愋?/li>
  • 第二個入?yún)⑹欠祷仡愋?/li>
  • 第三個是RewriteFunction接口的實現(xiàn)，這個代碼要您自己寫，內(nèi)容是將輸入數(shù)據(jù)轉換為返回類型數(shù)據(jù)具體邏輯，咱們來看官方Demo，其實就是上述套路：
@Bean
public RouteLocator routes(RouteLocatorBuilder builder) {
    return builder.routes()
        .route("rewrite_response_upper", r -> r.host("*.rewriteresponseupper.org")
            .filters(f -> f.prefixPath("/httpbin")
                .modifyResponseBody(String.class, String.class,
                    (exchange, s) -> Mono.just(s.toUpperCase()))).uri(uri))
        .build();
}

套路總結出來了，接下來，咱們一起擼代碼？

按套路開發(fā)一個修改請求body的過濾器(filter)

  • 廢話不說，在父工程spring-cloud-tutorials下新建子工程gateway-change-body，pom.xml無任何特殊之處，注意依賴spring-cloud-starter-gateway即可
  • 啟動類毫無新意：
package com.bolingcavalry.changebody;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class ChangeBodyApplication {
    public static void main(String[] args) {
        SpringApplication.run(ChangeBodyApplication.class,args);
    }
}

配置文件千篇一律：

server:
  #服務端口
  port: 8081
spring:
  application:
    name: gateway-change-body

然后是核心邏輯：修改請求body的代碼，既RewriteFunction的實現(xiàn)類，代碼很簡單，將原始的請求body解析成Map對象，取出user-id字段，生成user-name字段放回map，apply方法返回的是個Mono：

package com.bolingcavalry.changebody.function;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.reactivestreams.Publisher;
import org.springframework.cloud.gateway.filter.factory.rewrite.RewriteFunction;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.Map;


@Slf4j
public class RequestBodyRewrite implements RewriteFunction<String, String> {

    private ObjectMapper objectMapper;

    public RequestBodyRewrite(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }

    /**
     * 根據(jù)用戶ID獲取用戶名稱的方法，可以按實際情況來內(nèi)部實現(xiàn)，例如查庫或緩存，或者遠程調(diào)用
     * @param userId
     * @return
     */
    private  String mockUserName(int userId) {
        return "user-" + userId;
    }

    @Override
    public Publisher<String> apply(ServerWebExchange exchange, String body) {
        try {
            Map<String, Object> map = objectMapper.readValue(body, Map.class);

            // 取得id
            int userId = (Integer)map.get("user-id");

            // 得到nanme后寫入map
            map.put("user-name", mockUserName(userId));

            // 添加一個key/value
            map.put("gateway-request-tag", userId + "-" + System.currentTimeMillis());

            return Mono.just(objectMapper.writeValueAsString(map));
        } catch (Exception ex) {
            log.error("1. json process fail", ex);
            // json操作出現(xiàn)異常時的處理
            return Mono.error(new Exception("1. json process fail", ex));
        }
    }
}

然后是按部就班的基于代碼實現(xiàn)路由配置，重點是lambda表達式執(zhí)行modifyRequestBody方法，并且將RequestBodyRewrite作為參數(shù)傳入：

package com.bolingcavalry.changebody.config;

import com.bolingcavalry.changebody.function.RequestBodyRewrite;
import com.bolingcavalry.changebody.function.ResponseBodyRewrite;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import reactor.core.publisher.Mono;

@Configuration
public class FilterConfig {
    @Bean
    public RouteLocator routes(RouteLocatorBuilder builder, ObjectMapper objectMapper) {
        return builder
                .routes()
                .route("path_route_change",
                        r -> r.path("/hello/change")
                                .filters(f -> f
                                        .modifyRequestBody(String.class,String.class,new RequestBodyRewrite(objectMapper))
                                        )
                        .uri("http://127.0.0.1:8082"))
                .build();
    }
}

代碼寫完了，運行工程gateway-change-body，在postman發(fā)起請求，得到響應如下圖，紅框中可見Gateway添加的內(nèi)容已成功：

在這里插入圖片描述

現(xiàn)在修改請求body已經(jīng)成功，接下來再來修改服務提供者響應的body

修改響應body

  • 接下來開發(fā)修改響應body的代碼
  • 新增RewriteFunction接口的實現(xiàn)類ResponseBodyRewrite.java
package com.bolingcavalry.changebody.function;

import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.extern.slf4j.Slf4j;
import org.reactivestreams.Publisher;
import org.springframework.cloud.gateway.filter.factory.rewrite.RewriteFunction;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.Map;

@Slf4j
public class ResponseBodyRewrite implements RewriteFunction<String, String> {

    private ObjectMapper objectMapper;

    public ResponseBodyRewrite(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }

    @Override
    public Publisher<String> apply(ServerWebExchange exchange, String body) {
        try {
            Map<String, Object> map = objectMapper.readValue(body, Map.class);

            // 取得id
            int userId = (Integer)map.get("user-id");

            // 添加一個key/value
            map.put("gateway-response-tag", userId + "-" + System.currentTimeMillis());

            return Mono.just(objectMapper.writeValueAsString(map));
        } catch (Exception ex) {
            log.error("2. json process fail", ex);
            return Mono.error(new Exception("2. json process fail", ex));
        }
    }
}

路由配置代碼中，lambda表達式里面，filters方法內(nèi)部調(diào)用modifyResponseBody，第三個入?yún)⑹荝esponseBodyRewrite：

package com.bolingcavalry.changebody.config;

import com.bolingcavalry.changebody.function.RequestBodyRewrite;
import com.bolingcavalry.changebody.function.ResponseBodyRewrite;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import reactor.core.publisher.Mono;

@Configuration
public class FilterConfig {

    @Bean
    public RouteLocator routes(RouteLocatorBuilder builder, ObjectMapper objectMapper) {
        return builder
                .routes()
                .route("path_route_change",
                        r -> r.path("/hello/change")
                                .filters(f -> f
                                        .modifyRequestBody(String.class,String.class,new RequestBodyRewrite(objectMapper))
                                        .modifyResponseBody(String.class, String.class, new ResponseBodyRewrite(objectMapper))
                                        )
                        .uri("http://127.0.0.1:8082"))
                .build();
    }
}

還記得咱們的第一個問題嗎？通過上面的代碼，您應該已經(jīng)看到了答案：用代碼配置路由時，多個過濾器的配置方法就是在filters方法中反復調(diào)用內(nèi)置的過濾器相關API，下圖紅框中的都可以：

在這里插入圖片描述

運行服務，用Postman驗證效果，如下圖紅框，Gateway在響應body中成功添加了一個key&value：

在這里插入圖片描述

代碼配置路由和yml配置是否可以混搭？

前面有兩個問題，接下來回答第二個，咱們在application.yml中增加一個路由配置：

server:
  #服務端口
  port: 8081
spring:
  application:
    name: gateway-change-body
  cloud:
    gateway:
      routes:
        - id: path_route_str
          uri: http://127.0.0.1:8082
          predicates:
            - Path=/hello/str

把gateway-change-body服務啟動起來，此時已經(jīng)有了兩個路由配置，一個在代碼中，一個在yml中，先試試yml中的這個，如下圖沒問題：

在這里插入圖片描述

再試試代碼配置的路由，如下圖，結論是代碼配置路由和yml配置可以混搭

在這里插入圖片描述

如何處理異常

  • 還有個問題必須要面對：修改請求或者響應body的過程中，如果發(fā)現(xiàn)問題需要提前返回錯誤（例如必要的字段不存在），代碼該怎么寫？
  • 咱們修改請求body的代碼集中在RequestBodyRewrite.java，增加下圖紅框內(nèi)容：

在這里插入圖片描述

  • 再來試試，這次請求參數(shù)中不包含user-id，收到Gateway返回的錯誤信息如下圖：

在這里插入圖片描述

看看控制臺，能看到代碼中拋出的異常信息：

在這里插入圖片描述

  • 此時，聰明的您應該發(fā)現(xiàn)問題所在了：咱們想告訴客戶端具體的錯誤，但實際上客戶端收到的是被Gateway框架處理后的內(nèi)容
  • 篇幅所限，上述問題從分析到解決的過程，就留給下一篇文章吧
  • 本篇的最后，請容許欣宸嘮叨兩句，聊聊為何要網(wǎng)關來修改請求和響應body的內(nèi)容，如果您沒興趣還請忽略

網(wǎng)關（Gateway）為什么要做這些？

看過開篇的兩個圖，聰明的您一定發(fā)現(xiàn)了問題：為什么要破壞原始數(shù)據(jù)，一旦系統(tǒng)出了問題如何定位是服務提供方還是網(wǎng)關？

  • 按照欣宸之前的經(jīng)驗，盡管網(wǎng)關會破壞原始數(shù)據(jù)，但只做一些簡單固定的處理，一般以添加數(shù)據(jù)為主，網(wǎng)關不了解業(yè)務，最常見的就是鑒權、添加身份或標簽等操作
  • 前面的圖中確實感受不到網(wǎng)關的作用，但如果網(wǎng)關后面有多個服務提供者，如下圖，這時候諸如鑒權、獲取賬號信息等操作由網(wǎng)關統(tǒng)一完成，比每個后臺分別實現(xiàn)一次更有效率，后臺可以更加專注于自身業(yè)務：

在這里插入圖片描述

  • 經(jīng)驗豐富的您可能會對我的狡辯不屑一顧：網(wǎng)關統(tǒng)一鑒權、獲取身份，一般會把身份信息放入請求的header中，也不會修改請求和響應的內(nèi)容啊，欣宸前面的一堆解釋還是沒說清楚為啥要在網(wǎng)關位置修改請求和響應的內(nèi)容！
  • 好吧，面對聰明的您，我攤牌了：本篇只是從技術上演示Spring Cloud Gateway如何修改請求和響應內(nèi)容，請不要將此技術與實際后臺業(yè)務耦合；

你不孤單，欣宸原創(chuàng)一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 數(shù)據(jù)庫+中間件系列
  6. DevOps系列

到此這篇關于Spring Cloud Gateway修改請求和響應body的內(nèi)容的文章就介紹到這了,更多相關Spring Cloud Gateway請求響應body內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

相關文章

  • Java+opencv3.2.0實現(xiàn)模板匹配

    Java+opencv3.2.0實現(xiàn)模板匹配

    這篇文章主要為大家詳細介紹了Java+opencv3.2.0實現(xiàn)模板匹配的相關資料，具有一定的參考價值，感興趣的小伙伴們可以參考一下
    2018-02-02
  • SpringMVC中的@RequestMapping注解解析

    SpringMVC中的@RequestMapping注解解析

    這篇文章主要介紹了SpringMVC中的@RequestMapping注解解析,SpringMVC使用@RequestMapping注解為控制器指定可以處理哪些?URL?請求,在控制器的類定義及方法定義處都可標注@RequestMapping,需要的朋友可以參考下
    2023-12-12
  • SpringBoot mybatis 實現(xiàn)多級樹形菜單的示例代碼

    SpringBoot mybatis 實現(xiàn)多級樹形菜單的示例代碼

    這篇文章主要介紹了SpringBoot mybatis 實現(xiàn)多級樹形菜單的示例代碼,代碼簡單易懂，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
    2021-05-05
  • Java 批量刪除Word中的空白段落示例代碼

    Java 批量刪除Word中的空白段落示例代碼

    這篇文章主要介紹了Java 批量刪除Word中的空白段落,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下
    2020-11-11
  • java input 調(diào)用手機相機和本地照片上傳圖片到服務器然后壓縮的方法

    java input 調(diào)用手機相機和本地照片上傳圖片到服務器然后壓縮的方法

    今天小編就為大家分享一篇java input 實現(xiàn)調(diào)用手機相機和本地照片上傳圖片到服務器然后壓縮的方法，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
    2018-08-08
  • spring中的FactoryBean代碼示例

    spring中的FactoryBean代碼示例

    這篇文章主要介紹了spring中的FactoryBean代碼示例，涉及FactoryBean的實現(xiàn)等相關內(nèi)容，具有一定參考價值，需要的朋友可以了解下。
    2017-10-10
  • 深入淺析 Spring Security 緩存請求問題

    深入淺析 Spring Security 緩存請求問題

    這篇文章主要介紹了 Spring Security 緩存請求問題，本文通過實例文字相結合的形式給大家介紹的非常詳細，具有一定的參考借鑒價值，需要的朋友參考下吧
    2019-04-04
  • 淺談java中的路徑表示

    淺談java中的路徑表示

    下面小編就為大家?guī)硪黄獪\談java中的路徑表示。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
    2017-04-04
  • Java設置String字符串編碼方法詳解

    Java設置String字符串編碼方法詳解

    因為String字符串很常用，所以我們在使用它的過程中，可能會面臨各種問題，比如”中文亂碼“問題等，那么為什么中文會亂碼？本文將給大家介紹一下Java如何設置String字符串編碼，來避免和解決這一常見問題,需要的朋友可以參考下
    2023-05-05
  • 學習在一臺新電腦上配置JAVA開發(fā)環(huán)境

    學習在一臺新電腦上配置JAVA開發(fā)環(huán)境

    本文主要介紹了如何在一臺新電腦上配置JAVA開發(fā)環(huán)境，每一個步驟都有對應的截圖和文字說明，需要的朋友可以參考下
    2015-07-07

最新評論