插: 前些天发现了一个巨牛的人工智能学习网站,普通易懂,风趣幽默,不由得分享一下给各人。点击跳转到网站。
坚韧不拔,越积极越荣幸,各人一起学习鸭~~~
媒介
本文纪录一下我是怎样利用Gateway搭建网关服务及实现动态路由的,资助各人学习怎样快速搭建一个网关服务,相识路由干系设置,鉴权的流程及业务处理处罚,有爱好的肯定看到末了,非常恰当没接触过网关服务的同砚当作入门教程。
搭建服务
框架
SpringBoot 2.1
<parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.0.RELEASE</version></parent>Spring-cloud-gateway-core
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-gateway-core</artifactId></dependency>common-lang3
<dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId></dependency>路由设置
网关作为哀求同一入口,路由就相当于是每个业务体系的入口,通过路由规则可以匹配到对应微服务的入口,将哀求掷中到对应的业务体系中
server: port: 8080spring: cloud: gateway: enabled: true routes: - id: demo-server uri: http://localhost:8081 predicates: - Path=/demo-server/** filters: - StripPrefix= 1routes
解读设置
- 如今有一个服务demo-server摆设在本机,所在和端口为127.0.0.1:8081,以是路由设置uri为http://localhost:8081
- 利用网关服务路由到此服务,predicates -Path=/demo-server/**,网关服务的端口为8080,启动网关服务,访问localhost:8080/demo-server,路由断言就会将哀求路由到demo-server
- 直接访问demo-server的接口localhost:8081/api/test,通过网关的访问所在则为localhost:8080/demo-server/api/test,predicates设置将哀求断言到此路由,filters-StripPrefix=1代表将所在中/后的第一个截取,以是demo-server就截取掉了
利用gateway通过设置文件即可完成路由的设置,非常方便,我们只要充实的相识设置项的寄义及规则就可以了;但是这些设置假如要修改则必要重启服务,重启网关服务会导致整个体系不可用,这一点是无法担当的,下面先容怎样通过Nacos实现动态路由
动态路由
利用nacos连合gateway-server实现动态路由,我们必要先摆设一个nacos服务,可以利用docker摆设或下载源码在本地启动,具体操纵可以参考官方文档即可
Nacos设置
groupId: 利用网关服务名称即可
dataId: routes
设置格式:json
[{ "id": "xxx-server", "order": 1, #优先级 "predicates": [{ #路由断言 "args": { "pattern": "/xxx-server/**" }, "name": " ath" }], "filters": [{ #过滤规则 "args": { "parts": 0 #k8s服务内部访问容器为http://xxx-server/xxx-server的话,设置0即可 }, "name": "StripPrefix" #截取的开始索引 }], "uri": "http://localhost:8080/xxx-server" #目的所在}]json格式设置项与yaml中对应,必要相识设置在json中的写法
比对一下json设置与yaml设置
{ "id":"demo-server", "predicates":[ { "args":{ "pattern":"/demo-server/**" }, "name":" ath" } ], "filters":[ { "args":{ "parts":1 }, "name":"StripPrefix" } ], "uri":"http://localhost:8081"}server: port: 8080spring: cloud: gateway: enabled: true routes: - id: demo-server uri: http://localhost:8081 predicates: - Path=/demo-server/** filters: - StripPrefix= 1代码实现
Nacos实现动态路由的方式焦点就是通过Nacos设置监听,设置发生改变后实行网关干系api创建路由
@Componentpublic class NacosDynamicRouteService implements ApplicationEventPublisherAware { private static final Logger LOGGER = LoggerFactory.getLogger(NacosDynamicRouteService.class); @Autowired private RouteDefinitionWriter routeDefinitionWriter; private ApplicationEventPublisher applicationEventPublisher; /** 路由id */ private static List<String> routeIds = Lists.newArrayList(); /** * 监听nacos路由设置,动态改变路由 * @param configInfo */ @NacosConfigListener(dataId = "routes", groupId = "gateway-server") public void routeConfigListener(String configInfo) { clearRoute(); try { List<RouteDefinition> gatewayRouteDefinitions = JSON.parseArray(configInfo, RouteDefinition.class); for (RouteDefinition routeDefinition : gatewayRouteDefinitions) { addRoute(routeDefinition); } publish(); LOGGER.info("Dynamic Routing Publish Success"); } catch (Exception e) { LOGGER.error(e.getMessage(), e); } } /** * 清空路由 */ private void clearRoute() { for (String id : routeIds) { routeDefinitionWriter.delete(Mono.just(id)).subscribe(); } routeIds.clear(); } @Override public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) { this.applicationEventPublisher = applicationEventPublisher; } /** * 添加路由 * * @param definition */ private void addRoute(RouteDefinition definition) { try { routeDefinitionWriter.save(Mono.just(definition)).subscribe(); routeIds.add(definition.getId()); } catch (Exception e) { LOGGER.error(e.getMessage(), e); } } /** * 发布路由、使路由收效 */ private void publish() { this.applicationEventPublisher.publishEvent(new RefreshRoutesEvent(this.routeDefinitionWriter)); }}过滤器
gateway提供GlobalFilter及Ordered两个接口用来界说过滤器,我们自界说过滤器只必要实现这个两个接口即可
- GlobalFilter filter() 实现过滤器业务
- Ordered getOrder() 界说过滤器实行序次
通常一个网关服务的过滤重要包罗 鉴权(是否登录、是否黑名单、是否免登录接口...) 限流(ip限流等等)功能,我们今天简单先容鉴权过滤器的流程实现
鉴权过滤器
必要实现鉴权过滤器,我们先得相识登录及鉴权流程,如下图所示
由图可知,我们鉴权过滤焦点就是验证token是否有效,以是我们网关服务必要与业务体系在同一个redis库,先给网关添加redis依靠及设置
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis-reactive</artifactId></dependency>spring: redis: host: redis-server port: 6379 password: database: 0代码实现
- 界说过滤器AuthFilter
- 获取哀求对象 从哀求头或参数或cookie中获取token(支持多种方式传token对于客户端更加友好,好比部分web下载哀求会新建一个页面,在哀求头中传token处理处罚起来比力贫苦)
- 没有token,返回401
- 有token,查询redis是否有效
- 无效则返回401,有效则完成验证放行
- 重置token逾期时间、添加内部哀求头信息方便业务体系权限处理处罚
@Componentpublic class AuthFilter implements GlobalFilter, Ordered { @Autowired private RedisTemplate<String, String> redisTemplate; private static final String TOKEN_HEADER_KEY = "auth_token"; @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 1.获取哀求对象 ServerHttpRequest request = exchange.getRequest(); // 2.获取token String token = getToken(request); ServerHttpResponse response = exchange.getResponse(); if (StringUtils.isBlank(token)) { // 3.token为空 返回401 response.setStatusCode(HttpStatus.UNAUTHORIZED); return response.setComplete(); } // 4.验证token是否有效 String userId = getUserIdByToken(token); if (StringUtils.isBlank(userId)) { // 5.token无效 返回401 response.setStatusCode(HttpStatus.UNAUTHORIZED); return response.setComplete(); } // token有效,后续业务处理处罚 // 从写哀求头,方便业务体系从哀求头获取用户id举行权限干系处理处罚 ServerHttpRequest.Builder builder = exchange.getRequest().mutate(); request = builder.header("user_id", userId).build(); // 延伸缓存逾期时间-token缓存用户假如不绝在操纵就会不绝重置逾期 // 如许克制用户操纵过程中突然逾期影响业务操纵及体验,只有效户操纵隔断时间大于缓存逾期时间才会逾期 resetTokenExpirationTime(token, userId); // 完成验证 return chain.filter(exchange); } @Override public int getOrder() { // 优先级 越小越优先 return 0; } /** * 从redis中获取用户id * 在登录操纵时间 登岸乐成会天生一个token, redis得key为auth_token:token 值为用户id * * @param token * @return */ private String getUserIdByToken(String token) { String redisKey = String.join(":", "auth_token", token); return redisTemplate.opsForValue().get(redisKey); } /** * 重置token逾期时间 * * @param token * @param userId */ private void resetTokenExpirationTime(String token, String userId) { String redisKey = String.join(":", "auth_token", token); redisTemplate.opsForValue().set(redisKey, userId, 2, TimeUnit.HOURS); } /** * 获取token * * @param request * @return */ private static String getToken(ServerHttpRequest request) { HttpHeaders headers = request.getHeaders(); // 从哀求头获取token String token = headers.getFirst(TOKEN_HEADER_KEY); if (StringUtils.isBlank(token)) { // 哀求头无token则从url获取token token = request.getQueryParams().getFirst(TOKEN_HEADER_KEY); } if (StringUtils.isBlank(token)) { // 哀求头和url都没有token则从cookies获取 HttpCookie cookie = request.getCookies().getFirst(TOKEN_HEADER_KEY); if (cookie != null) { token = cookie.getValue(); } } return token; }}总结
Gateway通过设置项可以实现路由功能,整合Nacos及设置监听可以实现动态路由,实现GlobalFilter, Ordered两个接口可以快速实现一个过滤器,文中也具体的先容了登录后的哀求鉴权流程,假如有不清晰地方可以品评区见咯。 |