SpringCloudGateway配置（跨域、限流、负载均衡、熔断）

简介

官方地址

Spring Cloud Gateway建立在Spring Boot 2.x，Spring WebFlux和Project Reactor之上，需要 Spring Boot 和 Spring Webflux 提供的 Netty 运行，它不能在传统的Servlet容器中工作，也不能在作为WAR构建时工作
网关里引入其它模块包含spring-boot-starter-web的需要排除

使用配置

# 访问信息
server:
  address: 0.0.0.0
  port: 8800
  servlet:
    contextPath: /
spring:
  # 服务名称
  application:
    name: springCloudGateway
  # SpringCloud配置
  cloud:
    # TODO 网关配置
    gateway:
      # 路由机制
      discovery:
        locator:
          # true 默认路由机制
          # 开启服务注册和发现功能，服务网关自动根据服务发现为每一个服务创建一个路由，这个路由将以(大写服务名)开头的请求路径转发到对应的服务中
          # 访问地址：127.0.0.1:8800/大写服务名/服务上下文/Controller/Method
          #
          # false 关闭默认路由机制，需要手动配置routes，默认通过路由名进行跳转的方式将失效，将请求路径上的服务名配置为小写
          # 访问地址：127.0.0.1:8800/小写写服务名/服务上下文/Controller/Method
          enabled: false
          lower-case-service-id: true
      # 路由地址
      routes:
        - id: BFF-AUTH-ROUTE # 自定义路由id,全局唯一（基于 【BFF-AUTH】 服务的路由）
		  uri: lb://bffAuth # 路由跳转到的服务名称，如果是多个服务则会进行负载均衡（默认随机策略，也可设置成权重策略）
		  predicates: # 断言，拦截请求规则设置
		    - Path=/springCloudGateway/auth
@Configuration
public class GlobalCorsConfig {
    
    private CorsConfiguration buildConfig() {
        CorsConfiguration corsConfiguration = new CorsConfiguration();
        // 预检请求的缓存时间（秒），即在这个时间段里，对于相同的跨域请求不会再预检了
        corsConfiguration.setMaxAge(18000L);
        // 允许cookies跨域
        corsConfiguration.setAllowCredentials(true);
        // 允许向该服务器提交请求的URI，*表示全部允许，在SpringMVC中，如果设成*，会自动转成当前请求头中的Origin
        corsConfiguration.addAllowedOrigin("*");
        // 允许访问的头信息,*表示全部
        corsConfiguration.addAllowedHeader("*");
        // 允许提交请求的方法类型，*表示全部允许
        corsConfiguration.addAllowedMethod("*");
        return corsConfiguration;
    }

    
    @Bean
    public CorsWebFilter corsFilter() {
        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());
        source.registerCorsConfiguration("
@Component
@Configuration
public class RequestRateLimiterForGatewaySentinelRouteConfig {
    
    @Bean
    public HostAddressKeyResolver hostAddressKeyResolver() {
        return new HostAddressKeyResolver();
    }

    
    @Bean
    public UserKeyResolver userKeyResolver() {
        return new UserKeyResolver();
    }

    
    @Bean
    @Primary
    public UrlKeyResolver urlKeyResolver() {
        return new UrlKeyResolver();
    }
}


class HostAddressKeyResolver implements KeyResolver {
    @Override
    public Mono resolve(ServerWebExchange exchange) {
        return Mono.just(Objects.requireNonNull(exchange.getRequest().getRemoteAddress()).getHostName());
    }
}


class UserKeyResolver implements KeyResolver {
    @Override
    public Mono resolve(ServerWebExchange exchange) {
        String token = exchange.getRequest().getHeaders().getFirst(SysKeyEnum.TOKEN.getKey());
        if (!StrUtil.isEffective(token)) {
            return Mono.just("default");
        }
        try {
            BaseLoginUserInfo baseLoginUserInfo = JwtUtil.verifyJwtForHs256(token);
            return Mono.just(baseLoginUserInfo.getAccount());
        } catch (Exception e) {
            return Mono.just("default");
        }
    }
}


class UrlKeyResolver implements KeyResolver {
    @Override
    public Mono resolve(ServerWebExchange exchange) {
        return Mono.just(exchange.getRequest().getPath().value());
    }
}

网关配置

spring:
  # TODO SpringCloud配置
  cloud:
    # TODO 网关配置
    gateway:
      # 路由机制
      discovery:
        locator:
          # true 默认路由机制
          #   开启服务注册和发现功能，服务网关自动根据服务发现为每一个服务创建一个路由，这个路由将以(大写服务名)开头的请求路径转发到对应的服务中
          #   默认网关访问 127.0.0.1:8763/大写服务名/服务上下文/Controller/Method
          # false 关闭默认路由机制，需要手动配置routes，默认通过路由名进行跳转的方式将失效
          enabled: false
          #  将请求路径上的服务名配置为小写
          #  默认网关访问 127.0.0.1:8763/小写写服务名/服务上下文/Controller/Method
          lower-case-service-id: true
      # 路由地址
      routes:
        # TODO 基于 【API-AUTH】 服务的路由配置
        # 直接访问 127.0.0.1:8768/apiAuth/auth/login
        # 网关访问 127.0.0.1:8763/springCloudGateway/gatewayAuth/auth/login
        - id: BFF-API-AUTH-ROUTE
          uri: lb://apiAuth
          predicates:
            - Path=/springCloudGateway/gatewayAuth
@Configuration
public class RequestRateLimiterForGatewaySentinelRouteConfig {
    private final List viewResolverList;
    private final ServerCodecConfigurer serverCodecConfigurer;

    public RequestRateLimiterForGatewaySentinelRouteConfig(ObjectProvider> viewResolverListProvider, ServerCodecConfigurer serverCodecConfigurer) {
        this.viewResolverList = viewResolverListProvider.getIfAvailable(Collections::emptyList);
        this.serverCodecConfigurer = serverCodecConfigurer;
    }

    // 初始化 SentinelGatewayFilter 过滤器
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public GlobalFilter sentinelGatewayFilter() {
        return new SentinelGatewayFilter();
    }

    // 初始化 SentinelGatewayBlockExceptionHandler 限流异常处理器
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
        return new SentinelGatewayBlockExceptionHandler(viewResolverList, serverCodecConfigurer);
    }

    // 自定义限流异常页面
    @PostConstruct
    public void initBlockHandlers() {
        BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
            @Override
            public Mono handleRequest(ServerWebExchange serverWebExchange, Throwable throwable) {
                return ServerResponse.status(HttpStatus.OK).
                        contentType(MediaType.APPLICATION_JSON).
                        body(BodyInserters.fromValue(new BaseResult().fail("触发流控")));
            }
        };
        GatewayCallbackManager.setBlockHandler(blockRequestHandler);
    }

    // 配置初始化限流参数
    @PostConstruct
    public void initGatewayRules() {
        Set gatewayFlowRuleSet = new HashSet<>();
        // 添加 BFF-API-AUTH-ROUTE路由 限流规则
        gatewayFlowRuleSet.add(
                new GatewayFlowRule("BFF-API-AUTH-ROUTE") // 路由ID
                        .setCount(1) // 限流阈值
                        .setIntervalSec(1)); // 统计时间窗口，默认单位秒
        // 添加 BFF-API-ADMIN-ROUTE路由 限流规则
        gatewayFlowRuleSet.add(
                new GatewayFlowRule("BFF-API-ADMIN-ROUTE") // 路由ID
                        .setCount(1) // 限流阈值
                        .setIntervalSec(1)); // 统计时间窗口，默认单位秒
        GatewayRuleManager.loadRules(gatewayFlowRuleSet);
    }
}

自定义API维度限流（对请求路径进行分组，再对分组进行限流，灵活性好，粒度细）

package com.springcloudalibaba.apiAuth.controller;

import com.springcloudalibaba.bclass.base.BaseResult;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
@RequestMapping("demo")
public class DemoController {
    @GetMapping("test1/fun1")
    public BaseResult test1Fun1() {
        return new BaseResult().success("test1Fun1");
    }

    @GetMapping("test1/fun2")
    public BaseResult test1Fun2() {
        return new BaseResult().success("test1Fun2");
    }

    @GetMapping("test2/fun1")
    public BaseResult test2Fun1() {
        return new BaseResult().success("test2Fun1");
    }

    @GetMapping("test2/fun2")
    public BaseResult test2Fun2() {
        return new BaseResult().success("test2Fun2");
    }
}

// 添加配置类代码
package com.springcloudalibaba.gateway.configurer;

import com.alibaba.csp.sentinel.adapter.gateway.common.SentinelGatewayConstants;
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiDefinition;
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPathPredicateItem;
import com.alibaba.csp.sentinel.adapter.gateway.common.api.ApiPredicateItem;
import com.alibaba.csp.sentinel.adapter.gateway.common.api.GatewayApiDefinitionManager;
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayFlowRule;
import com.alibaba.csp.sentinel.adapter.gateway.common.rule.GatewayRuleManager;
import com.alibaba.csp.sentinel.adapter.gateway.sc.SentinelGatewayFilter;
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.BlockRequestHandler;
import com.alibaba.csp.sentinel.adapter.gateway.sc.callback.GatewayCallbackManager;
import com.alibaba.csp.sentinel.adapter.gateway.sc.exception.SentinelGatewayBlockExceptionHandler;
import com.springcloudalibaba.bclass.base.BaseResult;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.codec.ServerCodecConfigurer;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.server.ServerResponse;
import org.springframework.web.reactive.result.view.ViewResolver;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import javax.annotation.PostConstruct;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;


@Configuration
public class RequestRateLimiterForGatewaySentinelApiConfig {
    private final List viewResolverList;
    private final ServerCodecConfigurer serverCodecConfigurer;

    public RequestRateLimiterForGatewaySentinelApiConfig(ObjectProvider> viewResolverListProvider, ServerCodecConfigurer serverCodecConfigurer) {
        this.viewResolverList = viewResolverListProvider.getIfAvailable(Collections::emptyList);
        this.serverCodecConfigurer = serverCodecConfigurer;
    }

    // 初始化 SentinelGatewayFilter 过滤器
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public GlobalFilter sentinelGatewayFilter() {
        return new SentinelGatewayFilter();
    }

    // 初始化 SentinelGatewayBlockExceptionHandler 限流异常处理器
    @Bean
    @Order(Ordered.HIGHEST_PRECEDENCE)
    public SentinelGatewayBlockExceptionHandler sentinelGatewayBlockExceptionHandler() {
        return new SentinelGatewayBlockExceptionHandler(viewResolverList, serverCodecConfigurer);
    }

    // 自定义限流异常页面
    @PostConstruct
    public void initBlockHandlers() {
        BlockRequestHandler blockRequestHandler = new BlockRequestHandler() {
            @Override
            public Mono handleRequest(ServerWebExchange serverWebExchange, Throwable throwable) {
                return ServerResponse.status(HttpStatus.OK).
                        contentType(MediaType.APPLICATION_JSON).
                        body(BodyInserters.fromValue(new BaseResult().fail("触发流控")));
            }
        };
        GatewayCallbackManager.setBlockHandler(blockRequestHandler);
    }

    // 自定义API分组
    @PostConstruct
    public void initCustomizedApis() {
        Set apiDefinitionSet = new HashSet<>();
        // 自定义 apiAuth_test1 分组 /springCloudGateway/gatewayAuth/
        ApiDefinition apiAuth_test1 = new ApiDefinition("apiAuth_test1").setPredicateItems(new HashSet(){
            {
                // 添加断言，该值的内容为：配置文件spring.cloud.gateway.routes.predicates的值 + 自定义规则
                add(new ApiPathPredicateItem().setPattern("/springCloudGateway/gatewayAuth/demo/test1/**").setMatchStrategy(SentinelGatewayConstants.URL_MATCH_STRATEGY_PREFIX));
            }
        });

        // 自定义 apiAuth_test1 分组 /springCloudGateway/gatewayAuth/
        ApiDefinition apiAuth_test2 = new ApiDefinition("apiAuth_test2").setPredicateItems(new HashSet(){
            {
                // 添加断言，该值的内容为：配置文件spring.cloud.gateway.routes.predicates的值 + 自定义规则
                add(new ApiPathPredicateItem().setPattern("/springCloudGateway/gatewayAuth/demo/test2/fun1"));
                add(new ApiPathPredicateItem().setPattern("/springCloudGateway/gatewayAuth/demo/test2/fun2"));
            }
        });
        //
        apiDefinitionSet.add(apiAuth_test1);
        apiDefinitionSet.add(apiAuth_test2);
        GatewayApiDefinitionManager.loadApiDefinitions(apiDefinitionSet);
    }

    // 配置初始化限流参数
    @PostConstruct
    public void initGatewayRules() {
        Set gatewayFlowRuleSet = new HashSet<>();
        // 添加 apiAuth_test1分组 限流规则
        gatewayFlowRuleSet.add(new GatewayFlowRule(("apiAuth_test1")).setCount(1).setIntervalSec(1));
        // 添加 apiAuth_test2分组 限流规则
        gatewayFlowRuleSet.add(new GatewayFlowRule(("apiAuth_test2")).setCount(1).setIntervalSec(1));
        //
        GatewayRuleManager.loadRules(gatewayFlowRuleSet);
    }
}

负载均衡

根据负载均衡发生位置的不同，可以分为"服务端负载均衡"和"客户端负载均衡"
1、客户端负载均衡是指：在发生请求之前就已经选举出了即将请求的服务实例，在微服务调用关系中一般会选择该方式

pom依赖




	org.springframework.cloud
	spring-cloud-starter-loadbalancer

yml配置

spring:
  # 服务名称
  application:
    name: springCloudGateway
  # SpringCloud配置
  cloud:
    # TODO nacos配置中心、注册中心
    nacos:
      server-addr: 192.168.213.148:8848 # nacos访问地址
      username: nacos # nacos登陆账号
      password: nacos # nacos登陆密码
      config:
        # nacos中配置文件的读取方式：${spring.application.name}-${spring.profile.active}.${spring.cloud.nacos.config.file-extension}
        # 默认Nacos的配置文件会覆盖本地的配置文件
        context-path: /nacos # 访问地址
        namespace: b2d90f05-6fb6-4735-a1c7-c4ed2e4587d2 # 命名空间（对应开发环境）
        group: springcloudalibaba # 所属分组（对应开发项目的别名）
        file-extension: yaml # 配置文件后缀
      discovery:
        namespace: b2d90f05-6fb6-4735-a1c7-c4ed2e4587d2 # 命名空间（对应开发环境）
        group: springcloudalibaba # 所属分组（对应开发项目的别名）
    # TODO loadbalancer负载均衡
    loadbalancer:
      enabled: true # 默认打开loadbalancer负载均衡策略
      nacos:
        enabled: false # 默认关闭nacos负载均衡策略
    # TODO 网关配置
    gateway:
      # 路由机制
      discovery:
        locator:
          # true 默认路由机制
          # 开启服务注册和发现功能，服务网关自动根据服务发现为每一个服务创建一个路由，这个路由将以(大写服务名)开头的请求路径转发到对应的服务中
          # 访问地址：127.0.0.1:8800/大写服务名/服务上下文/Controller/Method
          #
          # false 关闭默认路由机制，需要手动配置routes，默认通过路由名进行跳转的方式将失效，将请求路径上的服务名配置为小写
          # 访问地址：127.0.0.1:8800/小写写服务名/服务上下文/Controller/Method
          enabled: false
          lower-case-service-id: true
      # 路由地址
      routes:
        # TODO 基于 【BFF-AUTH】 服务的路由配置
        - id: BFF-AUTH-ROUTE
          uri: lb://bffAuth
          predicates:
            - Path=/springCloudGateway/auth/**
          filters:
            - StripPrefix=1
            - RewritePath=/auth/(?.*),/bffAuth/${segment}

测试（默认采用的是随机策略）

SpringCloudGateway配置（跨域、限流、负载均衡、熔断）

Java相关栏目本月热门文章