首页 > 软件编程 > Java > 从0到1学SpringCloud之SpringCloud gateway网关路由配置示例详解

从0到1学SpringCloud之SpringCloud gateway网关路由配置示例详解

福牛 4月 04, 2023 28 0

一、前言

微服务中经常用到gateway作为网关，它有什么作用，怎么使用？

Spring Cloud Gateway的目标提供统一的路由方式且基于Filter 链的方式提供了网关基本的功能， 例如：安全、监控、指标和限流 。

Spring Cloud Gateway的通信框架使用的是Netty。

特点：

1、动态路由：能够匹配任何请求属性

2、可以对路由指定Predicate(断言)和Filter(过滤器) ：

predicate，可以理解为匹配条件；filter，可以理解为拦截器。

3、集成Hystrix的断路器功能

4、集成SpringCloud服务发现功能

5、请求限流功能

6、支持路径重写

二、代码演示

1、配置文件

为了更好的理解，我们先配置几个请求路径

yml格式配置如下：

  1. server:
  2.      port: 9999
  3. #服务名称
  4. spring:
  5.      application:
  6.      name: zhufeng–gateway–config
  7.      cloud:
  8.      nacos:
  9.          config:
  10.          server–addr: ${spring.cloud.nacos.discovery.server–addr}
  11.          discovery:
  12.              server–addr: 127.0.0.1:8848
  13.      gateway:
  14.          routes:
  15.          – id: zhufeng–web–user # 请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务
  16.              uri: lb://zhufeng-web-user #在服务注册中心找服务名为 zhufeng-web-user 的服务
  17.              predicates:
  18.              – Path=/user/info # 设置路由断言,当请求 /user/info 时进行转发
  19.          – id: zhufeng–web–msg # 请求 http://localhost:9999/route/msg/info 会转发到 zhufeng-web-msg 服务
  20.              uri: lb://zhufeng-web-msg
  21.              predicates:
  22.              – Path=/route/msg/info # 设置路由断言,当请求 /msg/info 时进行转发
  23.              filters:
  24.              – StripPrefix=1 # 前缀， 在当前路径匹配中表示去掉第一个前缀 /route

配置说明：

1、定义gateway的端口为9999

2、注册中心使用nacos

3、配置路由规则：

请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务

请求 http://localhost:9999/route/msg/info 会转发到 zhufeng-web-msg 服务

如果使用的是properties配置文件，则需要对数组的配置进行转换：

  1. #服务端口
  2. server.port=9999
  3. #服务名称
  4. spring.application.name=zhufeng–gateway–config
  5. # 请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务
  6. spring.cloud.gateway.routes[0].id=zhufeng–web–user
  7. # 在服务注册中心找服务名为 zhufeng-web-user 的服务
  8. spring.cloud.gateway.routes[0].uri=lb://zhufeng-web-user
  9. # 设置路由断言,当请求 /user/info 时进行转发
  10. spring.cloud.gateway.routes[0].predicates[0]=Path=/user/info
  11. # 请求 http://localhost:9999/msg/info 会转发到 zhufeng-web-msg 服务
  12. spring.cloud.gateway.routes[1].id=zhufeng–web–msg
  13. # 在服务注册中心找服务名为 zhufeng-web-msg 的服务 #lb://zhufeng-web-msg
  14. spring.cloud.gateway.routes[1].uri=lb://zhufeng-web-msg
  15. # 设置路由断言,当请求 /msg/info 时进行转发
  16. spring.cloud.gateway.routes[1].predicates[0]=Path=/route/msg/info
  17. # 前缀， 在当前路径匹配中表示去掉第一个前缀 /route
  18. spring.cloud.gateway.routes[1].filters[0]=StripPrefix=1

2、pom依赖

使用的微服务的版本信息如下：

 <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
<spring-cloud.version>Hoxton.SR12</spring-cloud.version>
<spring-cloud-alibaba.version>2.2.7.RELEASE</spring-cloud-alibaba.version>

  1. <dependencies>
  2.      <!–gateway 网关依赖,内置webflux 依赖 –>
  3.      <dependency>
  4.          <groupId>org.springframework.cloud</groupId>
  5.          <artifactId>spring-cloud-starter-gateway</artifactId>
  6.      </dependency>
  8.      <!–断路器依赖 –>
  9.      <dependency>
  10.          <groupId>com.alibaba.cloud</groupId>
  11.          <artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
  12.      </dependency>
  13.      <dependency>
  14.          <groupId>org.springframework.cloud</groupId>
  15.          <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
  16.      </dependency>
  17.      <dependency>
  18.          <groupId>com.alibaba.csp</groupId>
  19.          <artifactId>sentinel-datasource-extension</artifactId>
  20.      </dependency>
  22.      <dependency>
  23.          <groupId>org.springframework.cloud</groupId>
  24.          <artifactId>spring-cloud-starter-sleuth</artifactId>
  25.      </dependency>
  26. </dependencies>

注意：

如果nacos使用的不是2.x版本，需要从spring-cloud-starter-alibaba-nacos-discovery中移除默认nacos-client版本，替换方式如下：

  1. <!–注册中心客户端 –>
  2. <dependency>
  3.      <groupId>com.alibaba.cloud</groupId>
  4.      <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  5.      <exclusions>
  6.          <!–移除默认版本，默认为2.x版本–>
  7.          <exclusion>
  8.              <groupId>com.alibaba.nacos</groupId>
  9.              <artifactId>nacos-client</artifactId>
  10.          </exclusion>
  11.      </exclusions>
  12. </dependency>
  14. <dependency>
  15.      <groupId>com.alibaba.nacos</groupId>
  16.      <artifactId>nacos-client</artifactId>
  17.      <version>1.4.3</version>
  18. </dependency>

启动类：

  1. package com.zhufeng.gateway.config;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.cloud.client.SpringCloudApplication;
  6. /**
  7.      * @ClassName: GatewayConfigApplication
  8.      * @Description 网关启动类
  9.      * @author 月夜烛峰
  10.      * @date 2022/7/22 20:11
  11.      */
  12. @SpringCloudApplication
  13. public class GatewayConfigApplication {
  15.      public static void main(String[] args) throws Exception {
  16.          SpringApplication.run(GatewayConfigApplication.class, args);
  17.      }
  19. }

 3、创建微服务

创建两个微服务 zhufeng-web-user 、 zhufeng-web-msg

-1

在zhufeng-web-user创建Controller:

  1. package com.zhufeng.web.controller;
  2.  
  3. import com.alibaba.fastjson.JSONObject;
  4. import org.springframework.web.bind.annotation.RequestMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  6. /**
  7.      * @ClassName: UserController
  8.      * @Description User路由测试
  9.      * @author 月夜烛峰
  10.      * @date 2022/7/22 20:01
  11.      */
  12. @RestController
  13. @RequestMapping(“user”)
  14. public class UserController {
  16.      @RequestMapping(“info”)
  17.      public String userInfo(){
  18.          JSONObject userJson = new JSONObject();
  19.          userJson.put(“id”,“user1001”);
  20.          userJson.put(“name”,“月夜烛峰”);
  21.          return userJson.toJSONString();
  22.      }
  23. }

配置文件：

#服务端口
server.port=8081
#服务名称
spring.application.name=zhufeng-web-user

在 zhufeng-web-msg 创建对应Controller

  1. package com.zhufeng.web.controller;
  3. import org.springframework.web.bind.annotation.RequestMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  7. /**
  8.      * @ClassName: MsgController
  9.      * @Description 消息路由测试
  10.      * @author 月夜烛峰
  11.      * @date 2022/7/22 20:33
  12.      */
  13. @RequestMapping(“msg”)
  14. @RestController
  15. public class MsgController {
  17.      @RequestMapping(“info”)
  18.      public String showInfo() {
  19.          return “good luck~”;
  20.      }
  21. }

配置文件：

#服务端口
server.port=8080
#服务名称
spring.application.name=zhufeng-web-msg

分别启动网关微服务、zhufeng-web-user、zhufeng-web-msg

-2

进入nacos控制台，可以看到已经注册成功。

三、请求测试

1、微服务请求转发

zhufeng-gateway-config微服务只有一个启动类，没有其它代码，所有的请求会根据路由规则进行转发。

请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务

-3

请求 http://localhost:9999/route/msg/info 会转发到 zhufeng-web-msg 服务

-4

转发到 zhufeng-web-user 的路由规则 比较好理解，就是根据请求路径进行转发，但是在zhufeng-web-msg微服务中，我们并没有配置  route  的请求前缀，但依然可以转发到 MsgController ， 这是因为gateway通过过滤器 filters 属性 StripPrefix=1 去掉了第一个uri前缀。

如果设置 StripPrefix=2 ，则会去掉前面两个前缀

原uri /route/msg/info  转换为  /info

2、第三方请求转发

网关中配置的都是我们自己的微服务，如果请求的服务并没有注册到我们nacos中，或者请求的服务为第三方，该如何处理？

在gateway中新增配置项，properties格式如下：

  1. spring.cloud.gateway.routes[2].id=zhufeng–route–zhufeng
  2. #请求 http://localhost:9999/route/yyzhufeng 会转发到 https://www.csdn.net/
  3. spring.cloud.gateway.routes[2].uri=https://www.csdn.net/
  4. spring.cloud.gateway.routes[2].predicates[0]=Path=/route/yyzhufeng
  5. # 前缀， 在当前路径匹配中表示去掉前两个前缀 /route/yyzhufeng
  6. spring.cloud.gateway.routes[2].filters[0]=StripPrefix=2

请求 http://localhost:9999/route/yyzhufeng 会转发到 https://www.csdn.net/

-5

标签

相关推荐

发表评论