文章目录

  • 简介
    • 什么是 Spring Cloud Gateway
    • 功能介绍
    • 工作流程
  • 开始搭建
    • 创建项目
    • 修改POM文件
    • 添加启动类
    • 添加配置文件
    • 启动项目测试
  • 网关全局过滤
    • 创建全局过滤器
    • 测试
  • 结尾

简介

接下来对服务消费者添加路由网关来实现统一访问接口，本操作先要完成之前的步骤，详情请参照【Spring Cloud Alibaba】Spring Cloud Alibaba 搭建教程

什么是 Spring Cloud Gateway

Spring Cloud Gateway 是 Spring 官方基于 Spring 5.0，Spring Boot 2.0 和 Project Reactor 等技术开发的网关，该项目提供了一个库，用于在Spring WebFlux之上构建API网关。Spring Cloud Gateway旨在提供一种简单而有效的方式来路由到API，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，如：安全性，监控/指标和弹性等。

功能介绍

  • 基于Spring Framework 5、Project Reactor和Spring Boot 2.0构建
  • 能够在任何请求属性上匹配路由。
  • Predicates（断言） 和 Filters（过滤器） 作用于特定路由
  • 集成Hystrix断路器。
  • 集成Spring Cloud DiscoveryClient（服务发现客户端）
  • 易于编写断言和过滤器
  • 限流
  • 路径重写

工作流程


Spring Cloud Gateway 工作流程说明如下：

  1. 客户端将请求发送到 Spring Cloud Gateway 上。
  2. Spring Cloud Gateway 通过 Gateway Handler Mapping 找到与请求相匹配的路由，将其发送给 Gateway Web Handler。
  3. Gateway Web Handler 通过指定的过滤器链（Filter Chain），将请求转发到实际的服务节点中，执行业务逻辑返回响应结果。
  4. 过滤器之间用虚线分开是因为过滤器可能会在转发请求之前（pre）或之后（post）执行业务逻辑。
  5. 过滤器（Filter）可以在请求被转发到服务端前，对请求进行拦截和修改，例如参数校验、权限校验、流量监控、日志输出以及协议转换等。
  6. 过滤器可以在响应返回客户端之前，对响应进行拦截和再处理，例如修改响应内容或响应头、日志输出、流量监控等。
  7. 响应原路返回给客户端。

总而言之，客户端发送到 Spring Cloud Gateway 的请求需要通过一定的匹配条件，才能定位到真正的服务节点。在将请求转发到服务进行处理的过程前后（pre 和 post），我们还可以对请求和响应进行一些精细化控制。

Predicate 就是路由的匹配条件，而 Filter 就是对请求和响应进行精细化控制的工具。有了这两个元素，再加上目标 URI，就可以实现一个具体的路由了。

开始搭建

创建项目

在我们之前搭建好的父项目中右击新建->新模块

为我们的子模块取名字、组ID和工件ID

创建后目录结构如下

修改POM文件

pom.xml

<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>spring-cloud-alibaba</artifactId><groupId>com.moonce</groupId><version>1.0-SNAPSHOT</version></parent><modelVersion>4.0.0</modelVersion><artifactId>moonce-gateway</artifactId><packaging>jar</packaging><properties><java.version>1.8</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-actuator</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></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-starter-openfeign</artifactId></dependency><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-sentinel</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-gateway</artifactId></dependency><!----><!--com.alibaba.cloud--><!--spring-cloud-starter-alibaba-nacos-config--><!----></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId><configuration><mainClass>com.moonce.gateway.GatewayApplication</mainClass></configuration></plugin></plugins></build></project>

与项目moonce-consumer-feign相比，主要增加了 org.springframework.cloud:spring-cloud-starter-gateway 依赖,去除了org.springframework.boot:spring-boot-starter-web。

注意：在 gateway 网关服务中不能引入 spring-boot-starter-web 的依赖，否则会报错

添加启动类

创建com.moonce.gateway包和GatewayApplication.java启动类

GatewayApplication.java

package com.moonce.gateway;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.cloud.client.discovery.EnableDiscoveryClient;import org.springframework.cloud.openfeign.EnableFeignClients;@SpringBootApplication@EnableDiscoveryClient@EnableFeignClientspublic class GatewayApplication {public static void main(String[] args) {SpringApplication.run(GatewayApplication.class, args);}}

添加配置文件

application.yml

spring:application:# 应用名称name: moonce-gatewaycloud:# 使用 Nacos 作为服务注册发现nacos:discovery:server-addr: 127.0.0.1:8848# 使用 Sentinel 作为熔断器sentinel:transport:port: 8721dashboard: localhost:8080# 路由网关配置gateway:# 设置与服务注册发现组件结合，这样可以采用服务名的路由策略discovery:locator:enabled: true# 配置路由规则routes:# 采用自定义路由 ID（有固定用法，不同的 id 有不同的功能，详见：https://cloud.spring.io/spring-cloud-gateway/2.0.x/single/spring-cloud-gateway.html#gateway-route-filters）- id: MOONCE-CONSUMER# 采用 LoadBalanceClient 方式请求，以 lb:// 开头，后面的是注册在 Nacos 上的服务名uri: lb://moonce-consumer# Predicate 翻译过来是“谓词”的意思，必须，主要作用是匹配用户的请求，有很多种用法predicates:# Method 方法谓词，这里是匹配 GET 和 POST 请求- Method=GET,POST- id: MOONCE-CONSUMER-FEIGNuri: lb://moonce-consumer-feignpredicates:- Method=GET,POSTserver:port: 9000# 开启熔断机制feign:sentinel:enabled: true# 暴露所以端点management:endpoints:web:exposure:include: "*"# 配置日志级别，方便调试logging:level:org.springframework.cloud.gateway: debug

启动项目测试

依次运行 Nacos 服务：ProviderApplication、ConsumerApplication、ConsumerFeignApplication、GatewayApplication

打开浏览器访问：http://localhost:9000/moonce-consumer/test/app/name ，浏览器显示如下

打开浏览器访问：http://localhost:9000/moonce-consumer-feign/test/hi 浏览器显示如下

注意：请求方式是 http://路由网关IP:路由网关Port/服务名/

至此说明 Spring Cloud Gateway 的路由功能配置成功！！！

网关全局过滤

全局过滤器作用于所有的路由，不需要单独配置，我们可以用它来实现很多统一化处理的业务需求，比如权限认证，IP 访问限制等等。

创建全局过滤器

创建com.moonce.gateway.filters包和AuthFilter.java类，实现 GlobalFilter, Ordered 接口并在类上增加 @Component 注解。

package com.moonce.gateway.filters;import com.fasterxml.jackson.core.JsonProcessingException;import com.fasterxml.jackson.databind.ObjectMapper;import com.google.common.collect.Maps;import org.springframework.cloud.gateway.filter.GatewayFilterChain;import org.springframework.cloud.gateway.filter.GlobalFilter;import org.springframework.core.Ordered;import org.springframework.core.io.buffer.DataBuffer;import org.springframework.http.HttpStatus;import org.springframework.http.server.reactive.ServerHttpResponse;import org.springframework.stereotype.Component;import org.springframework.web.server.ServerWebExchange;import reactor.core.publisher.Mono;import java.util.Map;/** * 鉴权过滤器 */@Componentpublic class AuthFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {String token = exchange.getRequest().getQueryParams().getFirst("token");if (token == null || token.isEmpty()) {ServerHttpResponse response = exchange.getResponse();// 封装错误信息Map<String, Object> responseData = Maps.newHashMap();responseData.put("code", 401);responseData.put("message", "非法请求，Token不存在！");try {// 将信息转换为 JSONObjectMapper objectMapper = new ObjectMapper();byte[] data = objectMapper.writeValueAsBytes(responseData);// 输出错误信息到页面DataBuffer buffer = response.bufferFactory().wrap(data);response.setStatusCode(HttpStatus.UNAUTHORIZED);response.getHeaders().add("Content-Type", "application/json;charset=UTF-8");return response.writeWith(Mono.just(buffer));} catch (JsonProcessingException e) {e.printStackTrace();}}return chain.filter(exchange);}/** * 设置过滤器的执行顺序 * * @return */@Overridepublic int getOrder() {return Ordered.LOWEST_PRECEDENCE;}}

测试

重启GatewayApplication，浏览器访问http://localhost:9000/moonce-consumer/test/app/name 网页显示如下

浏览器访问：http://localhost:9000/moonce-consumer/test/app/name" />

结尾

本文只做简单搭建介绍详情使用请见官网文档