微服务之服务网关介绍及(Spring Cloud Gateway搭建)
off999 2025-02-03 14:31 22 浏览 0 评论
0、前言
在微服务架构中,1个系统会被拆分为了很多个微服务。
如果每1个微服务都直接对外暴露出来,让用户直接访问这些微服务;
那么如何对用户的身份和权限进行鉴定?如何对微服务中的访问流量进行限流?
此时我们需要1个统一的入口(网关服务)以上问题将迎刃而解;
一、服务网关(Gateway)简介
微服务的网关=路由转发+过滤器
如果没有网关的存在,我们只能在客户端记录每个微服务的地址,然后分别去调用。
以上架构,会存在着诸多的问题:
客户端多次请求不同的微服务,增加客户端代码或配置编写的复杂性
认证复杂,每个服务都需要独立认证。
存在跨域请求,在一定场景下处理相对复杂。
上面的这些问题可以借助API网关来解决。所谓的API网关,就是指系统的统一入口。它封装了应用程序的内部结构,为客户端提供统一服务。
一些与业务本身功能无关的公共逻辑可以在这里实现,诸如认证、鉴权、监控、路由转发等等。
添加上API网关之后,系统的架构图变成了如下所示:
Spring Cloud Gateway旨在为微服务架构提供一种简单有效的统一的 API路由管理方式。
它不仅提供统一的路由方式,并且基于Filter链的方式提供了网关基本的功能,例如:安全,监控和限流。
微服务网关的作用
提供了统一访问入口,降低了服务受攻击面 提供了统一跨域解决方案 提供了统一日志记录操作,可以进行统一监控 提供了统一权限认证支持 提供了微服务限流功能,可以保护微服务,防止雪崩效应发生
二、Gateway搭建
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>
3.创建启动类
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);
}
}
4.添加配置文件(application.yaml)
路由(Route) 是 gateway 中最基本的组件之一,表示一个具体的路由信息载体。主要定义了下面的几个信息:
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
5.测试网关路由转发功能
启动项目,并通过网关去访问用户微服务,现请求流程如下
用户的请求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;
6.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; #记录代理信息
}
}
}
nginx.conf
三、断言(理解)
断言就是1刀切,只有当前这1个条件判断成功才能进行路由转发,只有断言都返回真,才会真正的执行路由。
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个执行时机:
PRE: 这种过滤器在请求被路由之前调用,可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等
POST:这种过滤器在路由到微服务以后执行,可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等
2.过滤器类型
Gateway的Filter从作用范围可分为2种
GatewayFilter:应用到单个路由或者一个分组的路由上
GlobalFilter:应用到所有的路由上
3.内置局部过滤器
局部过滤器是针对单个路由的过滤器。在SpringCloud Gateway中内置了很多不同类型的网关路由过滤器。具体如下:
过滤器工厂 | 作用 | 参数 |
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 # 修改返回状态
5.内置全局过滤器
全局过滤器作用于所有路由无需配置。通过全局过滤器可以实现对权限的统一校验,安全性验证等功能。
SpringCloud Gateway内部也是通过一系列的内置全局过滤器对整个路由转发进行处理如下:
6.自定义全局过滤器(重点)
内置的过滤器已经可以完成大部分的功能,但是对于企业开发的一些业务功能处理,还是需要我们自己编写过滤器来实现的。
下面,我们一起通过代码的形式自定义一个过滤器,去完成统一的权限校验。
开发中的鉴权逻辑:
当客户端第一次请求服务时,服务端对用户进行信息认证(登录)
认证通过,将用户信息进行加密形成token,返回给客户端,作为登录凭证
以后每次请求,客户端都携带认证的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;
}
}
com.zhanggen.gateway.auth.AuthGlobalFilter
相关推荐
- python列表(List)必会的13个核心技巧(附实用方法)
-
列表(List)是Python入门的关键步骤,因为它是编程中最常用的数据结构之一。以下是高效掌握列表的核心技巧和实用方法:一、理解列表的本质可变有序集合:可随时修改内容,保持元素顺序混合类型:一个列表...
- Python列表(List)一文全掌握:核心知识点+20实战练习题
-
Python列表(List)知识点教程一、列表的定义与特性定义:列表是可变的有序集合,用方括号[]定义,元素用逗号分隔。list1=[1,"apple",3.14]lis...
- python编程中列表常见的9大问题,你知道吗?
-
Python列表常见错误及解决方案列表(list)是Python中最常用的数据结构之一,但在使用过程中经常会遇到各种问题。以下是Python列表使用中的常见错误及其解决方法:一、索引越界错误1.访问...
- python之列表操作(python列表操作函数大全)
-
常用函数函数名功能说明append将一个元素添加到列表中names=['tom']用法:names.append('tommy')注意事项:被添加的元素只会被添加到...
- 7 种在 Python 中反转列表的智能方法
-
1.使用reverse()方法(原地)my_list=[10,12,6,34,23]my_list.reverse()print(my_list)#output:[23,34,6,12,...
- Python教程-列表复制(python中列表copy的用法)
-
作为软件开发者,我们总是努力编写干净、简洁、高效的代码。Python列表是一种多功能的数据结构,它允许你存储一个项目的集合。在Python中,列表是可变的,这意味着你可以在创建一个列表后改变它的...
- 「Python程序设计」基本数据类型:列表(数组)
-
列表是python程序设计中的一个基本的,也是重要的数据结构。我们可以把列表数据结构,理解为其它编程语言中的数组。定义和创建列表列表中的数据元素的索引,和数组基本一致,第一个元素的索引,或者是下标为0...
- Python中获取列表最后一个元素的方法
-
技术背景在Python编程中,经常会遇到需要获取列表最后一个元素的场景。Python提供了多种方法来实现这一需求,不同的方法适用于不同的场景。实现步骤1.使用负索引-1这是最简单和最Pythoni...
- Python学不会来打我(11)列表list详解:用法、场景与类型转换
-
在Python编程中,列表(list)是最常用且功能最强大的数据结构之一。它是一个有序、可变、支持重复元素的集合,可以存储任意类型的对象,包括整数、字符串、布尔值、甚至其他列表。本文将从基础语法开始...
- 零起点Python机器学习快速入门-4-4-列表操作
-
Python列表的基本操作展开。首先,定义了两个列表zlst和vlst并将它们的内容打印出来。接着,使用切片操作从这两个列表中提取部分元素,分别得到s2、s3和s4三个新的列表,并打...
- python入门 到脱坑 基本数据类型—列表
-
以下是Python列表(List)的入门详解,包含基础操作、常用方法和实用技巧,适合初学者系统掌握:一、列表基础1.定义列表#空列表empty_list=[]#包含不同类型元素的列表...
- Python 列表(List)完全指南:数据操作的利器
-
在Python中,列表(list)是一种可变序列(mutablesequence),它允许我们存储和操作一组有序数据(ordereddata)。本教程将从基础定义(basicdefiniti...
- 如何快速掌握 Python中列表的使用
-
学习python知识,好掌握Python列表的使用。从概念上来讲,Python中的列表list是一种有序、可变的容器,可以存储任意类型的数据(包括其他列表)。以下是列表的常用的操作和知识:1....
- Python中的列表详解及示例(python中列表的用法)
-
艾瑞巴蒂干货来了,数据列表,骚话没有直接来吧列表(List)是Python中最基本、最常用的数据结构之一,它是一个有序的可变集合,可以包含任意类型的元素。列表的基本特性有序集合:元素按插入顺序存储可变...
- python数据类型之列表、字典、元组、集合及操作
-
Python数据类型进阶:列表、字典与集合在Python中,数据类型是编程的基础,熟练掌握常用数据结构是成为高级开发者的关键。上一篇文章我们学习到了Python的数据类型:字符串(string)、数...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python自定义函数 (53)
- python进度条 (67)
- python吧 (67)
- python字典遍历 (54)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python串口编程 (60)
- python读取文件夹下所有文件 (59)
- java调用python脚本 (56)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python人脸识别 (54)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)