Spring Cloud Gateway提供的簡易網關實現方式，你使用過嗎？

作者：Springboot實戰案例錦集 2023-09-15 08:18:49

對于“敏感”標頭（默認情況下為cookie和authorization）和“代理”（x-forward-*）頭，提供了非常好的支持，這些頭不會向下游傳遞。如：當我們的請求中有Authorization 請求Header信息時，默認將不會向下游傳遞，這是默認行為還有cookie。我們可以通過修改配置文件覆蓋。

環境：SpringBoot2.5.13

Spring Cloud Gateway提供了一個名為ProxyExchange的實用程序對象。你可以在常規Spring web處理程序中使用它作為方法參數。它通過鏡像HTTP動詞的方法支持基本的下游HTTP交換。在MVC中，它還支持通過forward()方法轉發到本地處理程序。要使用ProxyExchange，需要在classpath中包含正確的模塊(spring-cloud-gateway-mvc(3.1.5)或spring-cloud-gateway-webflux)。

下面的MVC示例將請求代理到/test下游到遠程服務器:

@RestController
@SpringBootApplication
public class GatewaySampleApplication {


  @Value("${remote.home}")
  private URI home;


  @GetMapping("/test")
  public ResponseEntity<?> proxy(ProxyExchange<byte[]> proxy) throws Exception {
    return proxy.uri(home.toString() + "/image/png").get();
  }


}

下面的例子對Webflux做了相同的事情:

@RestController
@SpringBootApplication
public class GatewaySampleApplication {


  @Value("${remote.home}")
  private URI home;


  @GetMapping("/test")
  public Mono<ResponseEntity<?>> proxy(ProxyExchange<byte[]> proxy) throws Exception {
    return proxy.uri(home.toString() + "/image/png").get();
  }


}

ProxyExchange上的便利方法使處理程序方法能夠發現并增強傳入請求的URI路徑。例如，你可能想提取路徑末尾的元素并將其傳遞到下游:

@GetMapping("/proxy/path/**")
public ResponseEntity<?> proxyPath(ProxyExchange<byte[]> proxy) throws Exception {
  // 如這里請求的/proxy/path/666，那么這里path = 666
  String path = proxy.path("/proxy/path/");
  return proxy.uri(home.toString() + "/foos/" + path).get();
}

目標服務接口

@RestController
@RequestMapping("/business")
public class BusinessController {


  @PostMapping("/index")
  public Object index(@RequestBody Map<String ,Object> body) {
    System.out.println("業務接口接收到的內容：" + body) ;
    Map<String, Object> result = new HashMap<>() ;
    result.put("code", 0) ;
    result.put("data", "業務處理成功 - " + LocalDateTime.now().getNano()) ;
    result.put("message", "success") ;
    return result ;
  }
  
}

網關服務接口

@RestController
@RequestMapping("/proxy/api")
public class GatewayController {


  @GetMapping("")
  public Object order(@RequestHeader("token") String token, 
      Integer id, ProxyExchange<Map<String, Object>> exchange) {
    System.out.println("token = " + token + ", id = " + id) ;
    Map<String, Object> body = new HashMap<>() ;
    body.put("id", id) ;
    body.put("token", token) ;
    return exchange.uri("http://localhost:9000/business/index").body(body).post() ;
  }
  
}

調用結果

圖片

Postman請求

控制臺輸出

你還可以使用ProxyExchange的header()方法向下游響應添加header。

exchange.uri("http://localhost:9000/business/index").header("key", "123123").body(body).post() ;

你還可以通過在get()方法(以及其他方法)中添加一個mapper來操作響應頭(以及響應中的其他任何內容)。mapper是一個Function，接收傳入的ResponseEntity并將其轉換為傳出的ResponseEntity，如下：

exchange.uri("http://localhost:9000/business/index").header("key", "123123").body(body).post(result -> {
  System.out.println("Resposne Header: " + result.getHeaders()) ;
  return ResponseEntity.ok("success") ;
}) ;

對于“敏感”標頭（默認情況下為cookie和authorization）和“代理”（x-forward-*）頭，提供了非常好的支持，這些頭不會向下游傳遞。如：

當我們的請求中有Authorization 請求Header信息時，默認將不會向下游傳遞，這是默認行為還有cookie。我們可以通過修改配置文件覆蓋。

spring:
  cloud:
    gateway:
      proxy:
        sensitive:
        - ''

完畢！！！

責任編輯：武曉燕來源： Spring全家桶實戰案例源碼

cookie 網關代理