Spring Cloud Gateway整合Nacos实现服务路由及集群负载均衡

Posted 2023-04-28

参考技术A

我们都知道 Spring Cloud Gateway 是一个基于 Spring Boot 、 Spring WebFlux 、 Project Reactor 构建的高性能网关，旨在提供简单、高效的API路由。

Spring Cloud Gateway基于 Netty 运行，因此在传统Servlet容器中或者打成war包是不能正常运行的。

这里我们注册中心选型的是 Nacos ，如果还没有安装Nacos，请参考： Nacos快速安装部署 。

如果URI以==lb==开头，比如如上配置中的 lb://user-service ， Spring Cloud Gateway 会用 ReactiveLoadBalancerClientFilter 解析服务名为 user-service 的实例对应的实际host和端口，并做集群负载均衡。

这项功能通过全局过滤器 ReactiveLoadBalancerClientFilter 实现，官网描述如下：
[图片上传失败...(image-b13395-1655546589820)]

RouteRecordGlobalFilter 这个全局过滤器我们主要用来记录路由后的实际代理地址，以及调用耗时。

我们看下 RouteToRequestUrlFilter 的描述会发现实际路由地址会通过 ServerWebExchange 中名为 ServerWebExchangeUtils.GATEWAY_REQUEST_URL_ATTR 的属性保存。

[图片上传失败...(image-a33940-1655546589820)]

关于 RouteToRequestUrlFilter 的部分源码如下：

分别启动api-gateway、指定概要文件启动两个user-service服务实例、和两个message-service服务实例，查看Nacos控制台。
[图片上传失败...(image-34bdc6-1655546589820)]

可以看到，api-gateway启动了一个服务实例，user-service和message-service都启动了两个服务实例。

连续访问 http://localhost:9000/user/info ，可以看到user-service集群服务实例被轮询调用。

分别访问 http://localhost:9000/user/info 、 http://localhost:9000/message/info ，我们可以看到基于路径匹配的服务路由分发是成功的。

spring cloud gateway oauth 整合

https://gitee.com/owenwangwen/open-capacity-platform/tree/master/new-api-gateway

package com.open.capacity.client.filter;

import java.util.List;
import java.util.Map;

import javax.annotation.Resource;

import org.apache.commons.lang3.StringUtils;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.security.core.Authentication;
import org.springframework.stereotype.Component;
import org.springframework.util.AntPathMatcher;
import org.springframework.web.server.ServerWebExchange;

import reactor.core.publisher.Mono;

@Component
public class AccessFilter implements GlobalFilter ,Ordered{

    // url匹配器
    private AntPathMatcher pathMatcher = new AntPathMatcher();

    @Resource
    private RedisTemplate<String, Object> redisTemplate ;

    @Override
    public int getOrder() {
        // TODO Auto-generated method stub
        return -500;
    }

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // TODO Auto-generated method stub

        String accessToken = extractToken(exchange.getRequest());

        if(pathMatcher.match("/**/v2/api-docs/**",exchange.getRequest().getPath().value())){
            return chain.filter(exchange);
        }

        if(!pathMatcher.match("/api-auth/**",exchange.getRequest().getPath().value())){
            if (accessToken == null) {
                exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
                return exchange.getResponse().setComplete();
            }else{
                try {
                    Map<String, Object> params =  (Map<String, Object>) redisTemplate.opsForValue().get("token:" + accessToken) ;
                    if(params.isEmpty()){
                        exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
                        return exchange.getResponse().setComplete();
                    }
                } catch (Exception e) {
                    exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
                    return exchange.getResponse().setComplete();
                } 
            }
        }

        return chain.filter(exchange);
    }

    protected String extractToken(ServerHttpRequest request) {
        List<String> strings = request.getHeaders().get("Authorization");
        String authToken = null;
        if (strings != null) {
            authToken = strings.get(0).substring("Bearer".length()).trim();
        }

        if (StringUtils.isBlank(authToken)) {
            strings = request.getQueryParams().get("access_token");
            if (strings != null) {
                authToken = strings.get(0);
            }
        }

        return authToken;
    }

}