[Java知识库]构建SpringCloud网关服务

搭建网关

导入maven包：

    <!--网关依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>

    <!--服务发现依赖-->
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    </dependency>

他们的版本由父项目中的管理依赖提供：

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>Hoxton.SR10</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>

    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>
        <version>2.2.8.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>

配置文件：

spring:
  application:
    name: gateway-api
  cloud:
    nacos:
      server-addr: localhost:8848   # 配置nacos
    gateway:
      routes:
        - id: user-service                # 路由的id，需要唯一
#          uri: http://127.0.0.1:8080     # 可直接指定服务地址，不会负载均衡
          uri: lb://userservice           # 使用服务名称进行负载均衡
          predicates:                     # 断言，制定路由规则
            - Path=/user/**               # 按照路径进行匹配，需要以 /user/开头
server:
  port: 9000

路由断言工厂 Route Predict Factory

路由过滤器 GatewayFilter

有31中不同的路由过滤器工厂（GatewayFilterFactory）。 Spring Cloud 提供了多种网关过滤器工厂（GatewayFilterFactory）：网关过滤器工厂。 常见的过滤器工厂如下：

spring:
  cloud:
    gateway:
      routes:
      - id: add_request_header_route
        uri: https://example.org
        filters:
        - AddRequestHeader=X-Request-red, blue      # 将在header中添加 X-Request-red=blue

默认过滤器

对所有路由生效，需要写到 default-filters 中。

spring:
  application:
    name: gateway-api
  cloud:
    nacos:
      server-addr: localhost:8848   # 配置nacos
    gateway:
      routes:
        - id: user-service                # 路由的id，需要唯一
#          uri: http://127.0.0.1:8080     # 可直接指定服务地址，不会负载均衡
          uri: lb://userservice           # 使用服务名称进行负载均衡
          predicates:                     # 断言，制定路由规则
            - Path=/user/**               # 按照路径进行匹配，需要以 /user/开头
          filters:
            - AddRequestParameter=name, tom     # 只对user-service生效
        - id: order-service
          uri: lb://orderservice
          predicates:
            - Path=/order/**
    
      # 默认配置对上面的所有routes生效
      default-filters:
        - AddRequestParameter=age,20

全局过滤器

GlobalFilter 的逻辑需要自己写代码实现，需要实现 GlobalFilter 接口。 使用 @Order 或者 Ordered 接口制定过滤器的优先级。（Order越小，优先级越高，越先执行）

• 路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增
• 当过滤器的order值一样时，会按照 defaultFilter > 路由过滤器 > GlobalFilter 的顺序执行

//@Order(-1)
@Component
public class GatewayGlobalFilter implements GlobalFilter, Ordered {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        
        MultiValueMap<String, String> queryParams = request.getQueryParams();
        String username = queryParams.getFirst("username");
        if("admin".equals(username)){
            // 放行
            return chain.filter(exchange);
        }

        // 添加 401 错误
        response.setStatusCode(HttpStatus.UNAUTHORIZED);
        return response.setComplete();
    }

    @Override
    public int getOrder() {
        return -1;
    }
}

跨域问题处理

域名不同、端口不同时会发生跨域问题。需要是浏览器发起的请求，如果是各个服务之间的互相转发并不会涉及到跨域问题。

添加以下配置开放针对某些网站的跨域请求：

spring:
  application:
    name: gateway-api
  cloud:
    nacos:
      server-addr: localhost:8848   # 配置nacos
    gateway:
      # 跨域处理
      globalcors:
        add-to-simple-url-handler-mapping: true     # 不拦截options请求
        cors-configurations:
          '[/**]':
            allowed-origins:                        # 允许跨域的网站
              - "http://localhost:8090"
            allowed-methods:
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowed-headers: "*"                    # 允许请求头中携带的头信息
            allow-credentials : true                # 允许携带cookie
            maxAge: 360000                          # 本次跨域检测的有效期

服务发现

可以通过spring.cloud.gateway.discovery.locator.enabled=true将网关上已经注册的服务添加到路由中。默认的路由是： http://localhost:port/service_name/path。

例如：http://localhost:9000/user/1 -> http://localhost:9000/userservice/user/1

spring:
  application:
    name: gateway-api
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true                             # 自动配置路由
          lower-case-service-id: true               # 默认为大写

总结

• 使用 @LoadBalanced 注解访问服务时，nacos 和 eureka 可以通用。
• 使用 Feign 的方式访问服务时，nacos 和 eureka 可以通用。
• nacos 的自动配置并不是针对所有包都生效，有时需要手动重新定义bean。
• 网关的配置针对 eureka 和 nacos 采用同一套代码，只需要将服务注册到 eureka 或者 nacos 上即可（所有服务、网关都要注册）
• 使用网关后，可以不在使用 feign-api ，因为网关已经有了负载均衡的功能。