SpringCloud Gateway网关集成与配置

📝 学技术、更要掌握学习的方法，一起学习，让进步发生
👩🏻 作者：一只IT攻城狮 ，关注我，不迷路 。
💐学习建议：1、养成习惯，学习java的任何一个技术，都可以先去官网先看看，更准确、更专业。
💐学习建议：2、然后记住每个技术最关键的特性（通常一句话或者几个字），从主线入手，由浅入深学习。
❤️ 《SpringCloud入门实战系列》解锁SpringCloud主流组件入门应用及关键特性。带你了解SpringCloud主流组件,是如何一战解决微服务诸多难题的。

SpringCloud Gateway原理介绍传送门： SpringCloud入门实战（八）-Gateway服务网关集成

一、Gateway的项目集成与配置

1、服务提供者添加spring-cloud-starter-gateway依赖

第一步，首先改造一下服务提供者，也就是我们的payment工程，添加spring-cloud-starter-gateway依赖

 <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

自测一下，看是否成功启动并注册进注册中心。

当启动报错如下：Please set spring.main.web-application-type=reactive or remove spring-boot-starter-web dependency.

原因：gateway组件中的 spring-boot-starter-webflux 和 springboot作为web项目启动必不可少的 spring-boot-starter-web 出现冲突。
解决办法：按照提示，删除web依赖即可，如果还是不行，查看是否引入的公共包里通过依赖传递引入了，如果是排除掉即可。

如果报错：Caused by: java.lang.NoClassDefFoundError: javax/servlet/http/HttpServlet

原因:自带容器中的jar包与maven引入的tomcat依赖中的jar包有冲突,tomcat找不到servlet，即缺少了servlet-api.jar包
解决办法：添加如下依赖

<dependency>
  <groupId>javax.servlet</groupId>
   <artifactId>javax.servlet-api</artifactId>
</dependency>

2、新建网关新项目

第二步，在原项目基础上，新建module作为网关的新项目eg:cloud-gateway,简单的网关项目只需要启动类、pom、配置文件即可。

3、网关项目pom中引入spring-cloud-starter-gateway依赖

（由于网关项目作为新项目也要注册进注册中心，所以注册中心依赖也要有）

cloud-gateway的pom.xml

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

  <parent>
    <artifactId>springcloud-hystrix</artifactId>
    <groupId>org.test</groupId>
    <version>1.0-SNAPSHOT</version>
  </parent>
  <modelVersion>4.0.0</modelVersion>

  <artifactId>cloud-gateway</artifactId>

  <dependencies>
    <dependency>
      <groupId>org.test</groupId>
      <artifactId>cloud-common</artifactId>
      <version>1.0-SNAPSHOT</version>
    </dependency>
    <!--gateway-->
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>
    <!--lombok-->
    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
    </dependency>
    <!--junit-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
    </dependency>
    <!-- log4j -->
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
    </dependency>
    <!-- devtools热部署 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <scope>runtime</scope>
      <optional>true</optional>
    </dependency>
  </dependencies>

</project>

4、配置application.yml文件

cloud-gateway的application.yml文件
将服务提供者提供的接口，暴露给网关，通过调用网关转发到真正的服务。进行如下配置：

server:
  port: 9527

spring:
  application:
    name: cloud-gateway #微服务应用的名字
  cloud:
    gateway:
      routes:
        - id: payment_routh #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001      #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/timeout/**        # 断言，路径相匹配的进行路由

        - id: payment_routh2 #payment_route    #路由的ID，没有固定规则但要求唯一，建议配合服务名
          uri: http://localhost:8001          #匹配后提供服务的路由地址
          predicates:
            - Path=/payment/ok/**         # 断言，路径相匹配的进行路由
eureka:
  client:
    register-with-eureka: true #向注册中心注册自己
    fetch-registry: true #从EurekaServer抓取已有的注册信息，集群必须设置成true，才能配合ribbon负载均衡
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka
  instance:
    instance-id: gateway9527 #主机名称修改
    prefer-ip-address: true #访问路径可以显示ip
    hostname: cloud-gateway-service

对照payment工程服务提供者提供的接口，配置我们的网关工程的配置文件。

5、测试

启动注册中心（7001）->启动服务提供者（8001）->启动网关（9527）
原始payment访问地址：http://localhost:8001/payment/hystrix/ok/1
通过gateway访问地址：http://localhost:9527/payment/hystrix/ok/1

---

如果加入网关之后，eureka注册成功，直接访问gateway接口出现500或者404：

[cb64c1a3-3] There was an unexpected error (type=Not Found, status=404).
org.springframework.web.server.ResponseStatusException: 404 NOT_FOUND
	at org.springframework.web.reactive.resource.ResourceWebHandler.lambda$handle$1(ResourceWebHandler.java:408)
	Suppressed: The stacktrace has been enhanced by Reactor, refer to additional information below: 
Error has been observed at the following site(s):
	*__checkpoint ⇢ org.springframework.cloud.gateway.filter.WeightCalculatorWebFilter [DefaultWebFilterChain]
	*__checkpoint ⇢ HTTP GET "/payment/timeout/1" [ExceptionHandlingWebHandler]

可以通过以下方式排查，不是必须都配置，根据自己项目情况处理：
① 配置 filters: - StripPrefix=1，与路由id同级，去除前缀
② 网关中如果有 spring-boot-starter-actuator 依赖，删除
③启动类没有直接写在主包下面，而是写在了子包下面，需要在启动类加上@ComponentScan(“xxx”)，xxx一定是你的主包名
④检查配置文件中gateway相关的层级还有空格情况

二、Gateway网关路由的两种配置方式

1、在配置文件yml中配置

上面已经介绍过

2、代码中注入路由定位的（RouteLocator）的Bean

新建个配置类（功能同yml配置一样），

@Configuration
public class GateWayConfig {
    /**
     * 配置了一个id为test_routh的路由规则，
     * 当访问地址 http://localhost:9527/baidu时会自动转发到地址：https://www.baidu.com/
     * @param builder
     * @return
     */
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder)
    {
        RouteLocatorBuilder.Builder routes = builder.routes();
        routes.route("test_routh", r -> r.path("/baidu").uri("http://www.baidu.com")).build();
        return routes.build();

    }
  }