做网站的公司重庆,深圳中小企业网站建设,台州网站建设方案托管,大型网站开发人员一、初识网关#xff1f;
1、网关介绍
在微服务架构中#xff0c;一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢#xff1f;如果没有网关的存在#xff0c;我们只能在客户端记录每个微服务的地址#xff0c;然后分别去调用。这样的话…一、初识网关
1、网关介绍
在微服务架构中一个系统会被拆分为很多个微服务。那么作为客户端要如何去调用这么多的微服务呢如果没有网关的存在我们只能在客户端记录每个微服务的地址然后分别去调用。这样的话会产生很多问题例如
客户端多次请求不同的微服务增加客户端代码或配置编写的复杂性认证复杂每个微服务都有独立认证存在跨域请求在一定场景下处理相对复杂
为解决上面的问题所以引入了网关的概念所谓的API网关就是指系统的统一入口提供内部服务的路由中转为客户端提供统一服务一些与业务本身功能无关的公共逻辑可以在这里实现诸如认证、鉴权、监控、路由转发等。 2、网关对比 Zuul 1.x Netflix开源的网关基于Servlet框架构建功能丰富使用JAVA开发易于二次开发 问题即一个线程处理一次连接请求这种方式在内部延迟严重、设备故障较多情况下会引起存活的连接增多和线程增加的情况发生。 Zuul 2.x Zuul2 采用了Netty实现异步非阻塞编程模型每个 CPU 核一个线程处理所有的请求和响应请求和响应的生命周期是通过事件和回调来处理的这种方式减少了线程数量因此开销较小。 GateWay Spring公司为了替换Zuul而开发的网关服务底层为Netty将在下面具体介绍。 Nginxlua 使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本问题在于无法融入到微服务架构中 Kong 基于NginxLua开发性能高稳定有多个可用的插件(限流、鉴权等等)可以开箱即用。 问题只支持Http协议二次开发自由扩展困难提供管理API缺乏更易用的管控、配置方式。
3.Gateway介绍
Spring Cloud Gateway 基于Spring Boot 2.x、Spring WebFlux和Project Reactor它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代Netflix Zuul其不仅提供统一的路由方式并且基于 Filter 链的方式提供了网关基本的功能例如安全监控和限流。
特点
性能强劲是Zuul的1.6倍功能强大内置了很多实用的功能例如转发、监控、限流等设计优雅容易扩展
3.1 基本概念
路由(Route) 是 gateway 中最基本的组件之一表示一个具体的路由信息载体。主要定义了下面的几个信息:
id路由标识、区别于其他routeuri路由指向的目的地uri即客户端请求最终被转发到的微服务order用于多个route之间的排序数值越小排序越靠前匹配优先级越高predicate断言的作用是进行条件判断只有断言都返回真才会真正的执行路由filter过滤器用于修改请求和响应信息
3.2 执行流程
Gateway Client向Gateway Server发送请求请求首先会被HttpWebHandlerAdapter进行提取组装成网关上下文然后网关的上下文会传递到DispatcherHandler它负责将请求分发给RoutePredicateHandlerMappingRoutePredicateHandlerMapping负责路由查找并根据路由断言判断路由是否可用如果过断言成功由FilteringWebHandler创建过滤器链并调用请求会一次经过PreFilter–微服务–PostFilter的方法最终返回响应
4. 核心流程简单介绍
在开始Gateway的使用之前我们先简单的来提下Gateway的核心流程。了解即可 说明
客户端向 Spring Cloud Gateway 发出请求。如果Gateway Handler Mapping确定请求与路由匹配则将其发送到Gateway Web Handler 处理程序。此处理程序通过特定于请求的Fliter链运行请求。Fliter被虚线分隔的原因是Fliter可以在发送代理请求之前pre和之后post运行逻辑。执行所有pre过滤器逻辑。然后进行代理请求。发出代理请求后将运行“post”过滤器逻辑。
过滤器的作用
Filter在pre类型的过滤器可以做参数效验、权限效验、流量监控、日志输出、协议转换等。Filter在post类型的过滤器可以做响应内容、响应头的修改、日志输出、流量监控等这两种类型的过滤器有着非常重要的作用
需要了解的几个核心概念 Route路由 路由是构建网关的基础模块它由ID目标URI包括一些列的断言和过滤器组成如果断言为true则匹配该路由 Predicate断言 参考的是Java8的java.util.function.Predicate开发人员可以匹配HTTP请求中的所有内容例如请求头或请求参数请求与断言匹配则进行路由 Filter过滤 指的是Spring框架中GateWayFilter的实例使用过滤器可以在请求被路由前或者之后对请求进行修改。 三个核心点连起来 当用户发出请求到达GateWayGateWay会通过一些匹配条件定位到真正的服务节点并在这个转发过程前后进行一些及细化控制。其中Predicate就是我们匹配的条件而Filter可以理解为一个拦截器有了这两个点再加上目标URI就可以实现一个具体的路由了。
二、网关应用
这里随便创建一个简单项目为了方便测试网关
1、入门案例
我们可以在前面的Nacos的案例基础上再创建一个SpringBoot项目。 然后在项目中添加网关的依赖
dependencygroupIdorg.springframework.cloud/groupIdartifactIdspring-cloud-starter-gateway/artifactId
/dependency 同时我们还需要添加下Nacos的依赖。这块也需要Nacos作为注册中心存在
dependencygroupIdcom.alibaba.cloud/groupIdartifactIdspring-cloud-starter-alibaba-nacos-discovery/artifactId
/dependency然后在配置文件中添加Nacos和网关的相关配置
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:8848gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/user/** # 断言路径相匹配进行路由management:endpoint:web:exposure:include:*这里通过断言处理。针对访问网关的请求中。如果是 /nacos-provider 开头的请求就路由到http://192.168.1.111:9001/nacos-provider这个服务中
因为配置nacos在启动类中同时添加相关的组件
EnableDiscoveryClient
SpringBootApplication
public class Gateway9999Application {public static void main(String[] args) {ConfigurableApplicationContext app SpringApplication.run(Gateway9999Application.class, args);}}然后启动服务。提交请求到网关http://localhost:9999/user/hello 可以看到请求路由到了 9999 服务中了。说明网关起作用了!!!同时在Nacos中也可以看到注册的服务了 2、负载均衡
前面的例子我们都是在网关中直接写好要路由到的地址。在实际在开发中我们的服务更多的都是注册在注册中心中。而且都有做集群的多节点的部署。这时我们需要通过负载均衡的方式来处理在Gateway中提供了两种负载均衡的方式
2.1 自动负载均衡
首先要实现负载均衡我们需要开启相关的配置
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能 我们可以启动两个需要路由的服务 然后我们就可以直接访问网关服务。http://localhost:9999/nacos-provider/hello会根据提供的nacos-provider去注册中心中动态的找到相关的服务。然后路由到具体的服务中 但是在访问后出现这个错误 原因是负载均衡我们需要添加相关的loadbalancer依赖
dependencygroupIdorg.springframework.cloud/groupIdartifactIdspring-cloud-starter-loadbalancer/artifactId
/dependency再访问就好了 轮询的可以看到两个服务信息。说明负载均衡生效了。
2.2 手动负载均衡
在以上的配置中其实是有问题的问题在于当前的服务名称暴露并且太过于灵活那么如果想解决的话其实我们可以进行手动配置。
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: false #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由filters:- StripPrefix1
management:endpoint:web:exposure:include:*测试即可成功
三、Predicate
每一个Predicate的使用可以理解为当满足条件后才会进行转发如果十多个那就是满足所有条件才会转发。
1.断言的种类
After匹配在指定日期时间之后发生的请求。Before匹配在指定日期之前发生的请求。Between需要指定两个日期参数设定一个时间区间匹配此时间区间内的请求。Cookie需要指定两个参数分别为name和regexp正则表达式也可以理解Key和Value匹配具有给定名称且其值与正则表达式匹配的Cookie。Header需要两个参数header和regexp正则表达式也可以理解为Key和Value匹配请求携带信息。Host匹配当前请求是否来自于设置的主机。Method可以设置一个或多个参数匹配HTTP请求比如GET、POSTPath匹配指定路径下的请求可以是多个用逗号分隔Query需要指定一个或者多个参数一个必须参数和一个可选的正则表达式匹配请求中是否包含第一个参数如果有两个参数则匹配请求中第一个参数的值是否符合正则表达式。RemoteAddr匹配指定IP或IP段符合条件转发。Weight需要两个参数group和weightint实现了路由权重功能按照路由权重选择同一个分组中的路由
2. 案例讲解
咱们选择其中几个给大家做下演示讲解
2.1 After
匹配在指定时间之后发生的请求可以对应提前上线业务
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- After2023-12-20T21:40:10.52908:00[Asia/Shanghai]filters:- StripPrefix1
management:endpoint:web:exposure:include:*设置的时间是在当前时间之前。可以正常访问。但是如果我们把时间设置到了现在时间之后。在访问就404了
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- After2023-12-20T23:40:10.52908:00[Asia/Shanghai]filters:- StripPrefix1
management:endpoint:web:exposure:include:* 当这个After理解了以后剩下的关于日期时间的设置Before、Between道理都是一样的只不过是限定不同的日期时间区间
2.2 Cookie
需要指定两个参数分别为name和regexp正则表达式也可以理解Key和Value匹配具有给定名称且其值与正则表达式匹配的Cookie。
简单理解就是路由规则会通过获取Cookie name值和正则表达式去匹配如果匹配上就会执行路由如果匹配不上则不执行。
我们可以分为两种情况演示Cookie匹配Cookie不匹配
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- Cookieusername,[a-z] # 匹配Cookie的key和value正则表达式filters:- StripPrefix1
management:endpoint:web:exposure:include:*那么我们通过postman来进行测试
当Cookie匹配时
能正常的访问 当Cookie不匹配时 响应的就有错误的信息了 2.3 Header
需要两个参数header和regexp正则表达式也可以理解为Key和Value匹配请求携带信息。
实际上就是请求头携带的信息官网给出的案例是X-Request-Id那我们就用这个做实验
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- HeaderX-Request-Id,\d #表示数字filters:- StripPrefix1
management:endpoint:web:exposure:include:*测试即可看到效果 2.4 Host
匹配当前请求是否来自于设置的主机。
这个比较比较简单我们直接来试验
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- Host**.jowell.com #匹配当前的主机地址发出的请求filters:- StripPrefix1
management:endpoint:web:exposure:include:*测试即可 2.5 Method
可以设置一个或多个参数匹配HTTP请求比如GET、POST
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- MethodGET,POST # 匹配GET请求或者POST请求filters:- StripPrefix1
management:endpoint:web:exposure:include:*2.6 Query
需要指定一个或者多个参数一个必须参数和一个可选的正则表达式匹配请求中是否包含第一个参数如果有两个参数则匹配请求中第一个参数的值是否符合正则表达式。
server:port: 9999
spring:application:name: gateway-servicecloud:nacos:discovery:server-addr: 192.168.1.111:80gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/boge/** # 断言路径相匹配进行路由- Queryid,. # 匹配请求参数这里如果需要匹配多个参数可以写多个Queryfilters:- StripPrefix1
management:endpoint:web:exposure:include:*测试 2.7 Weight
需要两个参数group和weightint实现了路由权重功能按照路由权重选择同一个分组中的路由
官网提供的演示yml
spring:cloud:gateway:routes:- id: weight_highuri: https://weighthigh.orgpredicates:- Weightgroup1, 8- id: weight_lowuri: https://weightlow.orgpredicates:- Weightgroup1, 2该路由会将约 80% 的流量转发到weighthigh.org将约 20% 的流量转发到weightlow.org
小结
Predicate就是为了实现一组匹配规则让请求过来找到对应的Route进行处理。
3. Filter
路由过滤器允许以某种方式修改传入的 HTTP 请求或传出的 HTTP 响应。路由过滤器的范围是特定的路由。Spring Cloud Gateway 包含许多内置的 GatewayFilter 工厂。 GateWay内置的Filter生命周期为两种pre业务逻辑之前、post业务逻辑之后 GateWay本身自带的Filter分为两种 GateWayFilter单一、GlobalFilter全局 单一的有32种全局的有9种 官方网址https://docs.spring.io/spring-cloud-gateway/docs/current/reference/html/#global-filters
这个数量实在是太惊人了而且用法都比较简单所以这里大家可以自行根据官网给出的演示进行练习在这里给大家举一个例子
3.1、配置
spring:application:name: gateway-servicecloud:nacos:discovery:username: nacospassword: nacosserver-addr: gateway:discovery:locator:enabled: true #开启注册中心路由功能routes: # 路由- id: nacos-provider #路由ID没有固定要求但是要保证唯一建议配合服务名uri: lb://nacos-provider # 匹配提供服务的路由地址predicates: # 断言- Path/cloud/** # 断言路径相匹配进行路由filters:- StripPrefix1- name: Tokenargs:enable: true3.2、JWT工具 !-- Token生成与解析--dependencygroupIdcom.auth0/groupIdartifactIdjava-jwt/artifactIdversion3.18.3/version/dependencypackage org.jowell.config;import com.auth0.jwt.JWT;
import com.auth0.jwt.JWTCreator;
import com.auth0.jwt.algorithms.Algorithm;
import com.google.common.collect.Maps;import java.util.Calendar;
import java.util.HashMap;/*** Author: Mr.zhongjiawei* Date: 2023-05-04 17:47* Description: 生成Token工具类*/
public class JwtUtils {private JwtUtils() {}/*** 盐*/private static final String SIGN CAS#%O3OAD!6-;/*** token Key*/private static final String JWT_KEY_PHONE phone;/*** 用于每次生成Token不唯一*/private static final String JWT_TOKEN_TIME tokenTime;/*** 生成token** param passengerPhone 手机号* return Token*/public static String generatorToken(String passengerPhone) {HashMapString, String map Maps.newHashMap();map.put(JWT_KEY_PHONE, passengerPhone);map.put(JWT_TOKEN_TIME, Calendar.getInstance().getTime().toString());JWTCreator.Builder jwt JWT.create();//整合mapmap.forEach(jwt::withClaim);//生成Tokenreturn jwt.sign(Algorithm.HMAC256(SIGN));}/*** 检验token是否正确*/public static boolean verify(String token) {try {JWT.require(Algorithm.HMAC256(SIGN)).build().verify(token);return true;} catch (Exception e) {e.printStackTrace();return false;}}}
3.3、用JWT工具生成Token 3.4、创建过滤器类
TokenGatewayFilterFactory
package org.jowell.filter;import com.alibaba.nacos.common.utils.StringUtils;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import org.jowell.config.FilterConfig;
import org.springframework.cloud.gateway.filter.GatewayFilter;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.factory.AbstractGatewayFilterFactory;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpHeaders;
import org.springframework.http.server.reactive.ServerHttpRequest;
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.Arrays;
import java.util.List;
import java.util.Optional;/*** token过滤权限拦截*/
Component
public class TokenGatewayFilterFactory extends AbstractGatewayFilterFactoryFilterConfig {public static final String ENABLE_KEY enable;public static final String EXCLUDE_KEY exclude;/*** 放行路径*/public static final String MATCH_STR /captchaImage,/image,/login,/getInfo, /logout,/getRouters,/test,/websocket,/common/download/resource,/patfile, /wms/pdf,/wms/report/listDeliveryToday,/wms/report,/cs/help_doc/getDocById,/lab/re_info/listAll,/drmes,/loginByCardNo,/lab/areas/list,/wxmp;/*** 匿名标识针对不同模块统一开放的匿名请求提高MATCH_STR变量可读性*/public static final String ANONY_INDEX /anony/;public TokenGatewayFilterFactory() {super(FilterConfig.class);}Overridepublic ListString shortcutFieldOrder() {return Arrays.asList(ENABLE_KEY, EXCLUDE_KEY);}Overridepublic GatewayFilter apply(FilterConfig config) {return (exchange, chain) - {if (!config.isEnable()) {return chain.filter(exchange);}return getVoidMono(exchange, chain);};}public MonoVoid getVoidMono(ServerWebExchange exchange, GatewayFilterChain chain) {ServerHttpRequest request exchange.getRequest();ServerHttpResponse response exchange.getResponse();String[] arr MATCH_STR.split(,);String requestUrl request.getPath().toString();//匿名标识过滤一遍boolean flag requestUrl.contains(ANONY_INDEX);if (!flag) {flag Arrays.stream(arr).anyMatch(requestUrl::contains);}if (flag) {return chain.filter(exchange);}/** 根据token信息获取用户权限进行权限校验操作*/String token Optional.ofNullable(request.getHeaders().getFirst(token)).orElse();if (StringUtils.isBlank(token)) {DataBuffer data setErrorInfo(response, 未登录,请重新登录!!!, 401);return response.writeWith(Mono.just(data));}Claims claims parseToken(token);if (claims null) {DataBuffer data setErrorInfo(response, 未登录或登录过期哦,请重新登录!!!, 401);return response.writeWith(Mono.just(data));}return chain.filter(exchange);}private DataBuffer setErrorInfo(ServerHttpResponse response, String msg, int code) {//设置headersHttpHeaders httpHeaders response.getHeaders();httpHeaders.add(Content-Type, application/json; charsetUTF-8);httpHeaders.add(Cache-Control, no-store, no-cache, must-revalidate, max-age0);//设置bodyString body {\code\: code , \message\: \ msg \};return response.bufferFactory().wrap(body.getBytes());}/*** 从令牌中获取数据声明** param token 令牌* return 数据声明*/public static Claims parseToken(String token) {return Jwts.parser().setSigningKey(abcdefghijklmnopqrstuvwxyz).parseClaimsJws(token).getBody();}
}
3.5、测试
不token带参数 带token: 完毕
