作者：热黄油啤酒 \
链接：https://juejin.cn/post/700475...
前言
本文记录一下我是如何应用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>举荐一个开源收费的 Spring Boot 最全教程：
https://github.com/javastacks/spring-boot-best-practice
路由配置
网关作为申请对立入口，路由就相当于是每个业务零碎的入口，通过路由规定则能够匹配到对应微服务的入口，将申请命中到对应的业务零碎中
server: port: 8080spring: cloud: gateway: enabled: true routes: - id: demo-server uri: http://localhost:8081 predicates: - Path=/demo-server/** filters: - StripPrefix= 1routes
| 配置项 | 形容 |
|---|---|
| id | 路由惟一id，应用服务名称即可 |
| uri | 路由服务的拜访地址 |
| predicates | 路由断言 |
| filters | 过滤规定 |
解读配置
- 当初有一个服务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": "Path" }], "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":"Path" } ], "filters":[ { "args":{ "parts":1 }, "name":"StripPrefix" } ], "uri":"http://localhost:8081"}spring: 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代码实现
- 1.定义过滤器AuthFilter
- 2.获取申请对象 从申请头或参数或cookie中获取token(反对多种形式传token对于客户端更加敌对，比方局部web下载申请会新建一个页面，在申请头中传token解决起来比拟麻烦)
- 3.没有token,返回401
- 4.有token，查问redis是否无效
- 5.有效则返回401，无效则实现验证放行
- 6.重置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两个接口能够疾速实现一个过滤器，文中也具体的介绍了登录后的申请鉴权流程，如果有不分明中央能够评论区见咯。
近期热文举荐：
1.1,000+ 道 Java面试题及答案整顿(2022最新版)
2.劲爆！Java 协程要来了。。。
3.Spring Boot 2.x 教程，太全了！
4.别再写满屏的爆爆爆炸类了，试试装璜器模式，这才是优雅的形式！！
5.《Java开发手册（嵩山版）》最新公布，速速下载！
感觉不错，别忘了顺手点赞+转发哦！