微服务之服务网关

前言

在微服务架构中，1个系统会被拆分为了很多个微服务。
如果每1个微服务都直接对外暴露出来，让用户直接访问这些微服务；
那么如何对用户的身份和权限进行鉴定？如何对微服务中的访问流量进行限流？
此时我们需要1个统一的入口（网关服务）以上问题将迎刃而解；

 
 
一、服务网关(Gateway)简介

微服务的网关=路由转发+过滤器
如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。

以上架构，会存在着诸多的问题：

• 客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
  
• 认证复杂，每个服务都需要独立认证。
  
• 存在跨域请求，在一定场景下处理相对复杂。
  

上面的这些问题可以借助API网关来解决。所谓的API网关，就是指系统的统一入口。它封装了应用程序的内部结构，为客户端提供统一服务。
一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等等。
添加上API网关之后，系统的架构图变成了如下所示：

Spring Cloud Gateway旨在为微服务架构提供一种简单有效的统一的 API路由管理方式。
它不仅提供统一的路由方式，并且基于Filter链的方式提供了网关基本的功能，例如：安全，监控和限流。
 
微服务网关的作用

• 提供了统一访问入口，降低了服务受攻击面
  
• 提供了统一跨域解决方案
  
• 提供了统一日志记录操作，可以进行统一监控
  
• 提供了统一权限认证支持
  
• 提供了微服务限流功能，可以保护微服务，防止雪崩效应发生
  

 
二、Gateway搭建


1.创建1个api-gateway模块


 
2.pom依赖

我们使用的网关产品为spring-cloud框架提供的gateway；
服务网关需要调用服务注册中心(Nacos)获取服务提供者的调用地址；

1. <dependencies>
2.         
3.         <dependency>
4.             <groupId>org.springframework.cloud</groupId>
5.             <artifactId>spring-cloud-starter-gateway</artifactId>
6.         </dependency>
7.         
8.         
9.         <dependency>
10.             <groupId>com.alibaba.cloud</groupId>
11.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
12.         </dependency>
13.     </dependencies>

复制代码

2.创建启动类

1. package com.zhanggen.gateway;
3. import org.springframework.boot.SpringApplication;
4. import org.springframework.boot.autoconfigure.SpringBootApplication;
5. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
7. @SpringBootApplication
8. @EnableDiscoveryClient
9. public class GatewayApplication {
10.     public static void main(String[] args) {
11.         SpringApplication.run(GatewayApplication.class, args);
12.     }
13. }

复制代码

 
3.添加配置文件（application.yaml）

路由(Route) 是 gateway 中最基本的组件之一，表示一个具体的路由信息载体。主要定义了下面的几个信息:

• id，路由标识符，区别于其他 Route。
  
• uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。
  
• predicate，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。
  
• filter，过滤器用于修改请求和响应信息。
  

1. server:
2.   port: 7000
3. spring:
4.   application:
5.     name: api-gateway
6.   cloud:
7.     nacos:
8.       discovery:
9.         server-addr: localhost:8848 # nacos地址
10.     gateway:
11.       routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
12.         - id: user-service-route # 当前路由的标识, 要求唯一
13.           uri: lb://user-service # 请求要转发到的地址
14.           predicates: # 断言(就是路由转发要满足的条件)
15.             - Path=/user/** # 当请求路径满足Path指定的规则时,才进行路由转发

复制代码

 
4.测试网关路由转发功能


启动项目，并通过网关去访问用户微服务，现请求流程如下

• 用户的请求http://127.0.0.1:7000/user/1到达GatWay
  
• GatWay摘取URL中的/user/1路径进行路由匹配
  
• 匹配成功之后URL变成http://user-service/user/1
  
• GatWay调用客户端负载均衡器(Ribin)去服务注册中心(Nacos)拉取http://user-service/user/1对应的服务，进行负载均衡选择
  
• 选择出1个微服务之后http://user-service/user/1转换成http://127.0.0.1:8081/user/1
  
• GatWay把用户请求转发到http://127.0.0.1:8081/user/1；
  

 
 
三、断言(理解)

断言就是1刀切，只有当前这1个条件判断成功才能进行路由转发，只有断言都返回真，才会真正的执行路由。
1.基于Datetime类型的断言

1. # AfterRoutePredicateFactory：   接收一个日期参数，判断请求日期是否晚于指定日期
2. # BeforeRoutePredicateFactory：  接收一个日期参数，判断请求日期是否早于指定日期
3. # BetweenRoutePredicateFactory： 接收两个日期参数，判断请求日期是否在指定时间段内
4. - After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]

复制代码

2.基于远程地址的断言

1. # RemoteAddrRoutePredicateFactory：接收一个IP地址段，判断请求主机地址是否在地址段中
2. - RemoteAddr=192.168.1.1/24

复制代码

3.基于Cookie的断言

1. # CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。 判断请求cookie是否具有给定名称且值与正则表达式匹配。
2. - Cookie=chocolate, ch.

复制代码

4.基于Header的断言

1. # HeaderRoutePredicateFactory：接收两个参数，标题名称和正则表达式。 判断请求Header是否具有给定名称且值与正则表达式匹配。
2. - Header=X-Request-Id, \d+

复制代码

5.基于Host的断言

1. # HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。
2. - Host=**.testhost.org

复制代码

6.基于Path请求路径的断言

1. # PathRoutePredicateFactory：接收一个参数，判断请求的URI部分是否满足路径规则。
2. - Path=/foo/{segment}

复制代码

7.基于Query请求参数的断言

1. # QueryRoutePredicateFactory ：接收两个参数，请求param和正则表达式， 判断请求参数是否具有给定名称且值与正则表达式匹配。
2. - Query=baz, ba.

复制代码

8.使用

接下来我们验证几个内置断言的使用：

1. server:
2.   port: 7000
3. spring:
4.   application:
5.     name: api-gateway
6.   cloud:
7.     nacos:
8.       discovery:
9.         server-addr: localhost:8848 # nacos地址
10.     gateway:
11.       routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
12.         - id: user-service-route # 当前路由的标识, 要求唯一
13.           uri: lb://user-service # 请求要转发到的地址
14.           predicates: # 断言(就是路由转发要满足的条件)
15.             - Path=/user/** # 当请求路径满足Path指定的规则时,才进行路由转发            - Before=2019-11-28T00:00:00.000+08:00 # 限制请求时间在2019-11-28之前            - Method=POST # 限制请求方式为POST

复制代码

 
四、过滤器

Gateway也包含过滤器功能，网关服务的过滤器会对请求或响应进行拦截，完成一些通用操作。
1.过滤器执行时机

Gateway的过滤器中有2个执行时机：

• PRE： 这种过滤器在请求被路由之前调用，可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等
  
• POST：这种过滤器在路由到微服务以后执行，可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等
  

 

2.过滤器类型

Gateway的Filter从作用范围可分为2种

• GatewayFilter：应用到单个路由或者一个分组的路由上
  
• GlobalFilter：应用到所有的路由上
  

 

3.内置局部过滤器

局部过滤器是针对单个路由的过滤器。在SpringCloud Gateway中内置了很多不同类型的网关路由过滤器。具体如下：
过滤器工厂作用参数AddRequestHeader为原始请求添加HeaderHeader的名称及值AddRequestParameter为原始请求添加请求参数参数名称及值AddResponseHeader为原始响应添加HeaderHeader的名称及值DedupeResponseHeader剔除响应头中重复的值需要去重的Header名称及去重策略Hystrix为路由引入Hystrix的断路器保护HystrixCommand的名称FallbackHeaders为fallbackUri的请求头中添加具体的异常信息Header的名称PrefixPath为原始请求路径添加前缀前缀路径PreserveHostHeader为请求添加一个preserveHostHeader=true的属性，路由过滤器会检查该属性以决定是否要发送原始的Host无RequestRateLimiter用于对请求限流，限流算法为令牌桶keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatusRedirectTo将原始请求重定向到指定的URLhttp状态码及重定向的urlRemoveHopByHopHeadersFilter为原始请求删除IETF组织规定的一系列Header默认就会启用，可以通过配置指定仅删除哪些HeaderRemoveRequestHeader为原始请求删除某个HeaderHeader名称RemoveResponseHeader为原始响应删除某个HeaderHeader名称RewritePath重写原始的请求路径原始路径正则表达式以及重写后路径的正则表达式RewriteResponseHeader重写原始响应中的某个HeaderHeader名称，值的正则表达式，重写后的值SaveSession在转发请求之前，强制执行WebSession::save操作无secureHeaders为原始响应添加一系列起安全作用的响应头无，支持修改这些安全响应头的值SetPath修改原始的请求路径修改后的路径SetResponseHeader修改原始响应中某个Header的值Header名称，修改后的值SetStatus修改原始响应的状态码HTTP 状态码，可以是数字，也可以是字符串StripPrefix用于截断原始请求的路径使用数字表示要截断的路径的数量Retry针对不同的响应进行重试retries、statuses、methods、seriesRequestSize设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回 413 Payload Too Large请求包大小，单位为字节，默认值为5MModifyRequestBody在转发请求之前修改原始请求体内容修改后的请求体内容ModifyResponseBody修改原始响应体的内容修改后的响应体内容 
4.内置局部过滤器的使用

我们只需要把过滤器配置在微服务的配置文件中即可生效；

1. server:
2.   port: 7000
3. spring:
4.   application:
5.     name: api-gateway
6.   cloud:
7.     nacos:
8.       discovery:
9.         server-addr: localhost:8848 # nacos地址
10.     gateway:
11.       routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
12.         - id: user-service-route # 当前路由的标识, 要求唯一
13.           uri: lb://user-service # 请求要转发到的地址
14.           predicates: # 断言(就是路由转发要满足的条件)
15.             - Path=/user/** # 当请求路径满足Path指定的规则时,才进行路由转发          filters:            - SetStatus=2000 # 修改返回状态

复制代码

 

5.内置全局过滤器

全局过滤器作用于所有路由无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。
SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下：

 
6.自定义全局过滤器(重点)

内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的。
下面，我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。
开发中的鉴权逻辑：

• 当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
  
• 认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证
  
• 以后每次请求，客户端都携带认证的token
  
• 服务端对token进行解密，判断是否有效。
  

 下面的我们自定义一个GlobalFilter，去校验所有请求的请求参数中是否包含“token”，如何不包含请求参数“token”则不转发路由，否则执行正常的逻辑。

1. package com.zhanggen.gateway.auth;
3. import org.apache.commons.lang.StringUtils;
4. import org.springframework.cloud.gateway.filter.GatewayFilterChain;
5. import org.springframework.cloud.gateway.filter.GlobalFilter;
6. import org.springframework.core.Ordered;
7. import org.springframework.http.HttpStatus;
8. import org.springframework.stereotype.Component;
9. import org.springframework.web.server.ServerWebExchange;
10. import reactor.core.publisher.Mono;
12. //全局认证过滤器
13. @Component
14. public class AuthGlobalFilter implements GlobalFilter, Ordered {
16.     //认证逻辑
17.     @Override
18.     public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
20.         //请求参数数,获取一个叫token的参数的值  String token =  request.getParamter("token")
21.         String token = exchange.getRequest().getQueryParams().getFirst("token");
23.         //判断是否请求参数中携带了token
24.         if (StringUtils.isBlank(token)) {
25.             System.out.println("鉴权失败");
26.             exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);//设置响应码 resp.setStatus(401)
27.             return exchange.getResponse().setComplete();//返回响应
28.         }
30.         //调用chain.filter继续向下游执行
31.         return chain.filter(exchange);
32.     }
34.     //决定当前过滤器的执行级别, 数组越小,优先级越高
35.     @Override
36.     public int getOrder() {
37.         return 0;
38.     }
39. }

复制代码

com.zhanggen.gateway.auth.AuthGlobalFilter 当过滤器的order值一样时，局部过滤器 优先级高于 全局过滤器;
 
参考

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！