SpringCloud Gateway服务网关的部署与使用的方法是什么

这篇文章主要介绍“SpringCloud Gateway服务网关的部署与使用的方法是什么”的相关知识，小编通过实际案例向大家展示操作过程，操作方法简单快捷，实用性强，希望这篇“SpringCloud Gateway服务网关的部署与使用的方法是什么”文章能帮助大家解决问题。

一、为什么需要服务网关：

1、什么是服务网关：

        传统的单体架构中只需要开放一个服务给客户端调用，但是微服务架构中是将一个系统拆分成多个微服务，如果没有网关，客户端只能在本地记录每个微服务的调用地址，当需要调用的微服务数量很多时，它需要了解每个服务的接口，这个工作量很大。那有了网关之后，能够起到怎样的改善呢？

        网关作为系统的唯一流量入口，封装内部系统的架构，所有请求都先经过网关，由网关将请求路由到合适的微服务，所以，使用网关的好处在于：

• （1）简化客户端的工作。网关将微服务封装起来后，客户端只需同网关交互，而不必调用各个不同服务；

• （2）降低函数间的耦合度。 一旦服务接口修改，只需修改网关的路由策略，不必修改每个调用该函数的客户端，从而减少了程序间的耦合性

• （3）解放开发人员把精力专注于业务逻辑的实现。由网关统一实现服务路由(灰度与ABTest)、负载均衡、访问控制、流控熔断降级等非业务相关功能，而不需要每个服务 API 实现时都去考虑

        但是 API 网关也存在不足之处，在微服务这种去中心化的架构中，网关又成了一个中心点或瓶颈点，它增加了一个我们必须开发、部署和维护的高可用组件。正是由于这个原因，在网关设计时必须考虑即使 API 网关宕机也不要影响到服务的调用和运行，所以需要对网关的响应结果有数据缓存能力，通过返回缓存数据或默认数据屏蔽后端服务的失败。

        在服务的调用方式上面，网关也有一定的要求，API 网关最好是支持 I/O 异步、同步非阻塞的，如果服务是同步阻塞调用，可以理解为微服务模块之间是没有彻底解耦的，即如果A依赖B提供的API，如果B提供的服务不可用将直接影响到A不可用，除非同步服务调用在API网关层或客户端做了相应的缓存。因此为了彻底解耦，在微服务调用上更建议选择异步方式进行。而对于 API 网关需要通过底层多个细粒度的 API 组合的场景，推荐采用响应式编程模型进行而不是传统的异步回调方法组合代码，其原因除了采用回调方式导致的代码混乱外，还有就是对于 API 组合本身可能存在并行或先后调用，对于采用回调方式往往很难控制。

2、服务网关的基本功能：

3、流量网关与服务网关的区别：

        流量网关和服务网关在系统整体架构中所处的位置如上图所示，流量网关（如Nignx）是指提供全局性的、与后端业务应用无关的策略，例如 HTTPS证书卸载、Web防火墙、全局流量监控等。而微服务网关（如Spring Cloud Gateway）是指与业务紧耦合的、提供单个业务域级别的策略，如服务治理、身份认证等。也就是说，流量网关负责南北向流量调度及安全防护，微服务网关负责东西向流量调度及服务治理。

二、服务网关的部署：

1、主流网关的对比与选型：

 （1）Kong 网关：Kong 的性能非常好，非常适合做流量网关，但是对于复杂系统不建议业务网关用 Kong，主要是工程性方面的考虑

（2）Zuul1.x 网关：Zuul 1.0 的落地经验丰富，但是性能差、基于同步阻塞IO，适合中小架构，不适合并发流量高的场景，因为容易产生线程耗尽，导致请求被拒绝的情况

（3）gateway 网关：功能强大丰富，性能好，官方基准测试 RPS (每秒请求数)是Zuul的1.6倍，能与 SpringCloud 生态很好兼容，单从流式编程+支持异步上也足以让开发者选择它了。

（4）Zuul 2.x：性能与 gateway 差不多，基于非阻塞的，支持长连接，但 SpringCloud 没有集成 zuul2 的计划，并且 Netflix 相关组件都宣布进入维护期，前景未知。

        综上，gateway 网关更加适合 SpringCloud 项目，而从发展趋势上看，gateway 替代 zuul 也是必然的。

2、Spring Cloud Gateway 网关的搭建：

（1）声明依赖版本号：

<properties><spring-boot.version>2.3.2.RELEASE</spring-boot.version><spring-cloud.version>Hoxton.SR9</spring-cloud.version><spring-cloud-alibaba.version>2.2.6.RELEASE</spring-cloud-alibaba.version></properties> <!-- 只声明依赖，不引入依赖 --><dependencyManagement><dependencies><!-- 声明springBoot版本 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-dependencies</artifactId><version>${spring-boot.version}</version><type>pom</type><scope>import</scope></dependency><!-- 声明springCloud版本 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency><!-- 声明 springCloud Alibaba 版本 --><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-alibaba-dependencies</artifactId><version>${spring-cloud-alibaba.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>

（2）添加依赖：

<!-- 引入gateway网关 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId><exclusions>        <exclusion><groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-starter-web</artifactId>        </exclusion>    </exclusions></dependency>

注意：一定要排除掉 spring-boot-starter-web 依赖，否则启动报错

（3）配置项目名与端口：

server:  port: 9023  servlet:    context-path: /${spring.application.name}spring:  application:    name: gateway

好了，网关项目搭建完成，其实就添加这么一个依赖，关于详细的配置以及作用下文介绍。

3、Spring Cloud Gateway 配置项的说明：

        在介绍 Spring Cloud Gateway 的配置项之前，我们先了解几个 Spring Cloud Gateway 的核心术语：

• 断言（Predicate）：参照 Java8 的新特性Predicate，允许开发人员匹配 HTTP 请求中的任何内容，比如请求头或请求参数，最后根据匹配结果返回一个布尔值。

• 路由（route）：由ID、目标URI、断言集合和过滤器集合组成。如果聚合断言结果为真，则转发到该路由。

• 过滤器（filter）：可以在返回请求之前或之后修改请求和响应的内容。

3.1、路由 Route：

        Route 主要由 路由id、目标uri、断言集合和过滤器集合组成，那我们简单看看这些属性到底有什么作用。

（1）id：路由标识，要求唯一，名称任意（默认值 uuid，一般不用，需要自定义）

（2）uri：请求最终被转发到的目标地址

（3）order： 路由优先级，数字越小，优先级越高

（4）predicates：断言数组，即判断条件，如果返回值是boolean，则转发请求到 uri 属性指定的服务中

（5）filters：过滤器数组，在请求传递过程中，对请求做一些修改

3.2、断言 Predicate：

        Predicate 来自于 Java8 的接口。Predicate 接受一个输入参数，返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑（比如：与，或，非）。

        Predicate 可以用于接口请求参数校验、判断新老数据是否有变化需要进行更新操作。Spring Cloud Gateway 内置了许多 Predict，这些 Predict 的源码在 org.springframework.cloud.gateway.handler.predicate 包中，有兴趣可以阅读一下。内置的一些断言如下图：

以上11种断言这里就不再介绍如何配置了，官方文档写的很清楚：https://docs.spring.io/spring-cloud-gateway/docs/2.2.9.RELEASE/reference/html/

下面就以最后一种权重断言为例介绍一下如何配置。配置如下：

spring:  cloud:    gateway:      # 路由数组：指当请求满足什么样的断言时，转发到哪个服务上      routes:        # 路由标识，要求唯一，名称任意        - id: gateway-provider_1  # 请求最终被转发到的目标地址          uri: http://localhost:9024          # 设置断言          predicates:            # Path Route Predicate Factory 断言，满足 /gateway/provider@Component@Slf4jpublic class AuthorizeGatewayFilterFactory extends AbstractGatewayFilterFactory<AuthorizeGatewayFilterFactory.Config> {     private static final String AUTHORIZE_TOKEN = "token";     //构造函数，加载Config    public AuthorizeGatewayFilterFactory() {        //固定写法        super(AuthorizeGatewayFilterFactory.Config.class);        log.info("Loaded GatewayFilterFactory [Authorize]");    }     //读取配置文件中的参数 赋值到 配置类中    @Override    public List<String> shortcutFieldOrder() {        //Config.enabled        return Arrays.asList("enabled");    }     @Override    public GatewayFilter apply(AuthorizeGatewayFilterFactory.Config config) {        return (exchange, chain) -> {            //判断是否开启授权验证            if (!config.isEnabled()) {                return chain.filter(exchange);            }             ServerHttpRequest request = exchange.getRequest();            HttpHeaders headers = request.getHeaders();            //从请求头中获取token            String token = headers.getFirst(AUTHORIZE_TOKEN);            if (token == null) {                //从请求头参数中获取token                token = request.getQueryParams().getFirst(AUTHORIZE_TOKEN);            }             ServerHttpResponse response = exchange.getResponse();            //如果token为空，直接返回401，未授权            if (StringUtils.isEmpty(token)) {                response.setStatusCode(HttpStatus.UNAUTHORIZED);                //处理完成，直接拦截，不再进行下去                return response.setComplete();            }                        //授权正常，继续下一个过滤器链的调用            return chain.filter(exchange);        };    }     @Data    @AllArgsConstructor    @NoArgsConstructor    public static class Config {        // 控制是否开启认证        private boolean enabled;    }}

局部过滤器需要在路由中配置才能生效，配置如下：

spring:  cloud:    gateway:      routes:        - id: gateway-provider_1          uri: http://localhost:9024          predicates:            - Path=/gateway/provider    @Bean    @Order (-1)    public WebFilter apiPrefixFilter()    {        return (exchange, chain) ->        {            ServerHttpRequest request = exchange.getRequest();            String path = request.getURI().getRawPath();             path = path.startsWith(prefix) ? path.replaceFirst(prefix, "") : path;            ServerHttpRequest newRequest = request.mutate().path(path).build();             return chain.filter(exchange.mutate().request(newRequest).build());        };    }}

        至此，我们就开启了 spring cloud gateway 的自动路由功能，网关自动根据注册中心的服务名为每个服务创建一个router，将以服务名开头的请求路径转发到对应的服务。假设我们的服务提供者在 nacos 注册中心的服务名为 “gateway-provider”，这时我们只需要访问 “http://localhost:9023/gateway/gateway-provider/test”，就可以将请求成功转发过去了

5、Gateway 整合 Apollo 实现动态路由配置：

        上述例子都是将网关的一系列配置写到项目的配置文件中，一旦路由策略发生改变必须要重启项目，这样维护成本很高，特别是服务网关作为系统的中心点，一旦重启出现问题，影响面将是十分巨大的，因此，我们将网关的配置存放到配置中心中，这样由配置中心统一管理，一旦路由发生改变，只需要在配置中心修改即可，降低风险且实时失效。本部分就以 Apollo 配置中心为例介绍下如下实现动态路由配置：

（1）添加 apollo 配置中心依赖：

<!-- Apollo 统一配置中心 --><dependency>    <groupId>com.ctrip.framework.apollo</groupId>    <artifactId>apollo-client</artifactId>    <version>1.7.0</version></dependency>

（2）添加 Apollo 路由更改监听刷新类：

import com.ctrip.framework.apollo.enums.PropertyChangeType;import com.ctrip.framework.apollo.model.ConfigChange;import com.ctrip.framework.apollo.model.ConfigChangeEvent;import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;import org.slf4j.Logger;import org.slf4j.LoggerFactory;import org.springframework.beans.BeansException;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.cloud.context.environment.EnvironmentChangeEvent;import org.springframework.cloud.gateway.config.GatewayProperties;import org.springframework.cloud.gateway.event.RefreshRoutesEvent;import org.springframework.cloud.gateway.route.RouteDefinitionWriter;import org.springframework.context.ApplicationContext;import org.springframework.context.ApplicationContextAware;import org.springframework.context.ApplicationEventPublisher;import org.springframework.context.ApplicationEventPublisherAware;import org.springframework.context.annotation.Configuration; import java.util.ArrayList; @Configurationpublic class GatewayPropertRefresher implements ApplicationContextAware, ApplicationEventPublisherAware{    private static final Logger logger = LoggerFactory.getLogger(GatewayPropertRefresher.class);     private static final String ID_PATTERN = "spring\\.cloud\\.gateway\\.routes\\[\\d+\\]\\.id";     private static final String DEFAULT_FILTER_PATTERN = "spring\\.cloud\\.gateway\\.default-filters\\[\\d+\\]\\.name";      private ApplicationContext applicationContext;     private ApplicationEventPublisher publisher;     @Autowired    private  GatewayProperties gatewayProperties;     @Autowired    private RouteDefinitionWriter routeDefinitionWriter;      @Override    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {        this.applicationContext = applicationContext;    }     @Override    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {        this.publisher = applicationEventPublisher;    }          @ApolloConfigChangeListener(interestedKeyPrefixes = "spring.cloud.gateway.")    public void onChange(ConfigChangeEvent changeEvent)    {        refreshGatewayProperties(changeEvent);    }         private void refreshGatewayProperties(ConfigChangeEvent changeEvent)    {        logger.info("gateway网关配置 刷新开始！");         preDestroyGatewayProperties(changeEvent);        //更新配置        this.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));        //更新路由        refreshGatewayRouteDefinition();         logger.info("gateway网关配置 刷新完成！");    }         private synchronized void preDestroyGatewayProperties(ConfigChangeEvent changeEvent)    {        logger.info("Pre Destroy GatewayProperties 操作开始!");         final boolean needClearRoutes = this.checkNeedClear(changeEvent, ID_PATTERN, this.gatewayProperties.getRoutes().size());        if (needClearRoutes)        {            this.gatewayProperties.setRoutes(new ArrayList());        }         final boolean needClearDefaultFilters = this.checkNeedClear(changeEvent, DEFAULT_FILTER_PATTERN, this.gatewayProperties.getDefaultFilters().size());        if (needClearDefaultFilters)        {            this.gatewayProperties.setRoutes(new ArrayList());        }         logger.info("Pre Destroy GatewayProperties 操作完成!");    }      private void refreshGatewayRouteDefinition()    {        logger.info("Refreshing Gateway RouteDefinition 操作开始!");         this.publisher.publishEvent(new RefreshRoutesEvent(this));         logger.info("Gateway RouteDefinition refreshed 操作完成!");    }         private boolean checkNeedClear(ConfigChangeEvent changeEvent, String pattern, int existSize) {         return changeEvent.changedKeys().stream().filter(key -> key.matches(pattern)).filter(key ->        {            ConfigChange change = changeEvent.getChange(key);            return PropertyChangeType.DELETED.equals(change.getChangeType());        }).count() == existSize;    }}

（3）暴露endpoint端点：

# 暴露endpoint端点，暴露路由信息，有获取所有路由、刷新路由、查看单个路由、删除路由等方法
management.endpoints.web.exposure.include = *
management.endpoint.health.show-details = always

        至此，我们就完成了 Gateway 网关整合 Apollo 配置中心实现动态路由配置，一旦路由发生改变，只需要在配置中心修改即可被监听到并实时失效

6、自定义全局异常处理器：

        通过前面的测试可以看到一个现象：一旦路由的微服务下线或者失联了，Spring Cloud Gateway直接返回了一个错误页面，如下图：

        显然这种异常信息不友好，前后端分离架构中必须定制返回的异常信息。传统的Spring Boot 服务中都是使用 @ControllerAdvice 来包装全局异常处理的，但是由于服务下线，请求并没有到达。因此必须在网关中也要定制一层全局异常处理，这样才能更加友好的和客户端交互。

        Spring Cloud Gateway提供了多种全局处理的方式，今天只介绍其中一种方式，实现还算比较优雅：

        直接创建一个类 GlobalErrorExceptionHandler，实现 ErrorWebExceptionHandler，重写其中的 handle 方法，代码如下：

@Slf4j@Order(-1)@Component@RequiredArgsConstructorpublic class GlobalErrorExceptionHandler implements ErrorWebExceptionHandler {  private final ObjectMapper objectMapper;  @SuppressWarnings({"rawtypes", "unchecked", "NullableProblems"}) @Override public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {  ServerHttpResponse response = exchange.getResponse();  if (response.isCommitted()) {   return Mono.error(ex);  }   // JOSN格式返回  response.getHeaders().setContentType(MediaType.APPLICATION_JSON);  if (ex instanceof ResponseStatusException) {   response.setStatusCode(((ResponseStatusException) ex).getStatus());  }   return response.writeWith(Mono.fromSupplier(() -> {   DataBufferFactory bufferFactory = response.bufferFactory();   try {    //todo 返回响应结果，根据业务需求，自己定制    CommonResponse resultMsg = new CommonResponse("500",ex.getMessage(),null);    return bufferFactory.wrap(objectMapper.writeValueAsBytes(resultMsg));   }   catch (JsonProcessingException e) {    log.error("Error writing response", ex);    return bufferFactory.wrap(new byte[0]);   }  })); }}

        好了，全局异常处理已经定制完成了，在测试一下，此时正常返回JSON数据了（JSON的样式根据架构需要自己定制），如下图：

关于“SpringCloud Gateway服务网关的部署与使用的方法是什么”的内容就介绍到这里了，感谢大家的阅读。如果想了解更多行业相关的知识，可以关注编程网行业资讯频道，小编每天都会为大家更新不同的知识点。