前言
在微服务架构中，1个系统会被拆分为了很多个微服务。
如果每1个微服务都直接对外暴露出来，让用户直接访问这些微服务，会出现以下问题；
- 客户端会多次请求不同的微服务，需要在客户端实现负载均衡，增加了客户端的复杂性。
- 跨域请求复杂，客户端需要兼容不同微服务后端跨域方案。
- 客户端身份认证复杂，每个微服务都需要独立认证。
- 微服务难以扩展、重构，项目迭代可能导致微服务重新划分。
- 如果某些微服务使用了防火墙、浏览器不友好的协议，直接访问会有一定困难。
此时我们需要1个统一的入口（网关服务）以上问题将迎刃而解；
-
客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
-
认证复杂，每个服务都需要独立认证。
-
存在跨域请求，在一定场景下处理相对复杂。
上面的这些问题可以借助API网关来解决。所谓的API网关，就是指系统的统一入口。它封装了应用程序的内部结构，为客户端提供统一服务。
一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控、路由转发等等。
微服务网关的作用
- 提供了统一访问入口，降低了服务受攻击面
- 提供了统一跨域解决方案
- 提供了统一日志记录操作，可以进行统一监控
- 提供了统一权限认证支持
- 提供了微服务限流功能，可以保护微服务，防止雪崩效应发生
1.创建1个api-gateway模块
2.pom依赖
我们使用的网关产品为spring-cloud框架提供的gateway；
服务网关需要调用服务注册中心(Nacos)获取服务提供者的调用地址；
<dependencies> <!--引入gateway网关--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <!--Nacos服务发现依赖--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency> </dependencies>
2.创建启动类
package com.zhanggen.gateway; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.client.discovery.EnableDiscoveryClient; @SpringBootApplication @EnableDiscoveryClient public class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class, args); } }
3.添加配置文件（application.yaml）
-
id，路由标识符，区别于其他 Route。
-
uri，路由指向的目的地 uri，即客户端请求最终被转发到的微服务。
-
predicate，断言的作用是进行条件判断，只有断言都返回真，才会真正的执行路由。
-
filter
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
- id: user-service-route # 当前路由的标识, 要求唯一
uri: lb://user-service # 请求要转发到的地址
predicates: # 断言(就是路由转发要满足的条件)
- Path=/user/** # 当请求路径满足Path指定的规则时,才进行路由转发
跨域配置
spring:
cloud:
gateway:
globalcors:
add-to-simple-url-handler-mapping: true
corsConfigurations:
'[/**]':
allowedHeaders: "*"
allowedOrigins: "*"
allowedMethods:
- GET
- POST
- DELETE
- PUT
- OPTION
routes:
# 平台管理
- id: admin
uri: lb://leadnews-admin
predicates:
- Path=/admin/**
filters:
- StripPrefix= 1
- id: wemedia
uri: lb://leadnews-wemedia
predicates:
- Path=/wemedia/**
filters:
- StripPrefix= 1
4.测试网关路由转发功能
启动项目，并通过网关去访问用户微服务，现请求流程如下
- 匹配成功之后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
5.Nginx转发
使用Nginx转发用户请求到Gateway
worker_processes 1; events { worker_connections 1024; } http { include mime.types; default_type application/octet-stream; sendfile on; keepalive_timeout 65; gzip on; upstream heima-app-gateway{ server localhost:51601; } server { listen 8801; location / { root html/app/; index index.html; } location ~/app/(.*) { proxy_pass http://heima-app-gateway/$1; proxy_set_header HOST $host; # 不改变源请求头的值 proxy_pass_request_body on; #开启获取请求体 proxy_pass_request_headers on; #开启获取请求头 proxy_set_header X-Real-IP $remote_addr; # 记录真实发出请求的客户端IP proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; #记录代理信息 } } upstream heima-wemedia-gateway{ server localhost:51602; } server { listen 8802; location / { root html/wemedia-web/; index index.html; } location ~/wemedia/MEDIA/(.*) { proxy_pass http://heima-wemedia-gateway/$1; proxy_set_header HOST $host; # 不改变源请求头的值 proxy_pass_request_body on; #开启获取请求体 proxy_pass_request_headers on; #开启获取请求头 proxy_set_header X-Real-IP $remote_addr; # 记录真实发出请求的客户端IP proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; #记录代理信息 } } upstream heima-admin-gateway{ server localhost:51603; } server { listen 8803; location / { root html/admin-web/; index index.html; } location ~/service_6001/(.*) { proxy_pass http://heima-admin-gateway/$1; proxy_set_header HOST $host; # 不改变源请求头的值 proxy_pass_request_body on; #开启获取请求体 proxy_pass_request_headers on; #开启获取请求头 proxy_set_header X-Real-IP $remote_addr; # 记录真实发出请求的客户端IP proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; #记录代理信息 } } }
1.基于Datetime类型的断言
# AfterRoutePredicateFactory： 接收一个日期参数，判断请求日期是否晚于指定日期
# BeforeRoutePredicateFactory： 接收一个日期参数，判断请求日期是否早于指定日期
# BetweenRoutePredicateFactory： 接收两个日期参数，判断请求日期是否在指定时间段内
- After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]
2.基于远程地址的断言
# RemoteAddrRoutePredicateFactory：接收一个IP地址段，判断请求主机地址是否在地址段中
- RemoteAddr=192.168.1.1/24
3.基于Cookie的断言
# CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。 判断请求cookie是否具有给定名称且值与正则表达式匹配。
- Cookie=chocolate, ch.
4.基于Header的断言
# HeaderRoutePredicateFactory：接收两个参数，标题名称和正则表达式。 判断请求Header是否具有给定名称且值与正则表达式匹配。
- Header=X-Request-Id, \d+
5.基于Host的断言
# HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。
- Host=**.testhost.org
6.基于Path请求路径的断言
# PathRoutePredicateFactory：接收一个参数，判断请求的URI部分是否满足路径规则。
- Path=/foo/{segment}
7.基于Query请求参数的断言
# QueryRoutePredicateFactory ：接收两个参数，请求param和正则表达式， 判断请求参数是否具有给定名称且值与正则表达式匹配。
- Query=baz, ba.
8.使用
接下来我们验证几个内置断言的使用：
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
- id: user-service-route # 当前路由的标识, 要求唯一
uri: lb://user-service # 请求要转发到的地址
predicates: # 断言(就是路由转发要满足的条件)
- Path=/user/** # 当请求路径满足Path指定的规则时,才进行路由转发
- Before=2019-11-28T00:00:00.000+08:00 # 限制请求时间在2019-11-28之前
- Method=POST # 限制请求方式为POST
Gateway也包含过滤器功能，网关服务的过滤器会对请求或响应进行拦截，完成一些通用操作。
1.过滤器执行时机
Gateway的过滤器中有2个执行时机：
2.过滤器类型
-
GatewayFilter：应用到单个路由或者一个分组的路由上
-
3.
| 作用 | 参数 | |
|---|---|---|
| AddRequestHeader | 为原始请求添加Header | Header的名称及值 |
| AddRequestParameter | 为原始请求添加请求参数 | 参数名称及值 |
| AddResponseHeader | 为原始响应添加Header | Header的名称及值 |
| DedupeResponseHeader | 剔除响应头中重复的值 | 需要去重的Header名称及去重策略 |
| Hystrix | 为路由引入Hystrix的断路器保护 | HystrixCommand的名称 |
| FallbackHeaders | 为fallbackUri的请求头中添加具体的异常信息 | Header的名称 |
| PrefixPath | 为原始请求路径添加前缀 | 前缀路径 |
| PreserveHostHeader | 为请求添加一个preserveHostHeader=true的属性，路由过滤器会检查该属性以决定是否要发送原始的Host | 无 |
| RequestRateLimiter | 用于对请求限流，限流算法为令牌桶 | keyResolver、rateLimiter、statusCode、denyEmptyKey、emptyKeyStatus |
| RedirectTo | 将原始请求重定向到指定的URL | http状态码及重定向的url |
| RemoveHopByHopHeadersFilter | 为原始请求删除IETF组织规定的一系列Header | 默认就会启用，可以通过配置指定仅删除哪些Header |
| RemoveRequestHeader | 为原始请求删除某个Header | Header名称 |
| RemoveResponseHeader | 为原始响应删除某个Header | Header名称 |
| RewritePath | 重写原始的请求路径 | 原始路径正则表达式以及重写后路径的正则表达式 |
| RewriteResponseHeader | 重写原始响应中的某个Header | Header名称，值的正则表达式，重写后的值 |
| SaveSession | 在转发请求之前，强制执行WebSession::save操作 |
无 |
| secureHeaders | 为原始响应添加一系列起安全作用的响应头 | 无，支持修改这些安全响应头的值 |
| SetPath | 修改原始的请求路径 | 修改后的路径 |
| SetResponseHeader | 修改原始响应中某个Header的值 | Header名称，修改后的值 |
| SetStatus | 修改原始响应的状态码 | HTTP 状态码，可以是数字，也可以是字符串 |
| StripPrefix | 用于截断原始请求的路径 | 使用数字表示要截断的路径的数量 |
| Retry | 针对不同的响应进行重试 | retries、statuses、methods、series |
| RequestSize | 设置允许接收最大请求包的大小。如果请求包大小超过设置的值，则返回 413 Payload Too Large |
请求包大小，单位为字节，默认值为5M |
| ModifyRequestBody | 在转发请求之前修改原始请求体内容 | 修改后的请求体内容 |
| ModifyResponseBody | 修改原始响应体的内容 |
4.内置局部过滤器的使用
我们只需要把过滤器配置在微服务的配置文件中即可生效；
server:
port: 7000
spring:
application:
name: api-gateway
cloud:
nacos:
discovery:
server-addr: localhost:8848 # nacos地址
gateway:
routes: # 路由数组[路由 就是指定当请求满足什么条件的时候转到哪个微服务]
- id: user-service-route # 当前路由的标识, 要求唯一
uri: lb://user-service # 请求要转发到的地址
predicates: # 断言(就是路由转发要满足的条件)
- Path=/user/** # 当请求路径满足Path指定的规则时,才进行路由转发
filters:
- SetStatus=2000 # 修改返回状态
6.
下面，我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。
开发中的鉴权逻辑：
-
当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
-
认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证
-
以后每次请求，客户端都携带认证的token
-
下面的我们自定义一个GlobalFilter，去校验所有请求的请求参数中是否包含“token”，如何不包含请求参数“token”则不转发路由，否则执行正常的逻辑。
package com.zhanggen.gateway.auth; import org.apache.commons.lang.StringUtils; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.Ordered; import org.springframework.http.HttpStatus; import org.springframework.stereotype.Component; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; //全局认证过滤器 @Component public class AuthGlobalFilter implements GlobalFilter, Ordered { //认证逻辑 @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { //请求参数数,获取一个叫token的参数的值 String token = request.getParamter("token") String token = exchange.getRequest().getQueryParams().getFirst("token"); //判断是否请求参数中携带了token if (StringUtils.isBlank(token)) { System.out.println("鉴权失败"); exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);//设置响应码 resp.setStatus(401) return exchange.getResponse().setComplete();//返回响应 } //调用chain.filter继续向下游执行 return chain.filter(exchange); } //决定当前过滤器的执行级别, 数组越小,优先级越高 @Override public int getOrder() { return 0; } }
当过滤器的order值一样时，局部过滤器 优先级高于 全局过滤器;
