实际工作中我们会有很多个项目,这些项目共同使用同一个网关gateway来实现路由,各个项目之间调用以及前端调用都可以直接通过服务名称来调用,不用管ip,后续项目迁移到其它服务器也不受影响。
首先搭建springboot微服务,添加jar包
<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.1.0.RELEASE</version>
</parent><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-gateway-core</artifactId>
</dependency><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId>
</dependency>
修改配置文件,网关作为请求统一入口,路由就相当于是每个业务系统的入口,通过路由规则则可以匹配到对应微服务的入口,将请求命中到对应的业务系统中
server:port: 8080spring:cloud:gateway:enabled: trueroutes:- id: demo-serveruri: http://localhost:8081predicates:- Path=/demo-server/**filters:- StripPrefix= 1
routes
配置项 | 描述 |
---|---|
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
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: trueroutes:- id: demo-serveruri: http://localhost:8081predicates:- Path=/demo-server/**filters:- StripPrefix= 1
代码实现
Nacos实现动态路由的方式核心就是通过Nacos配置监听,配置发生改变后执行网关相关api创建路由
@Component
public class NacosDynamicRouteService implements ApplicationEventPublisherAware {private static final Logger LOGGER = LoggerFactory.getLogger(NacosDynamicRouteService.class);@Autowiredprivate 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();}@Overridepublic 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-serverport: 6379password:database: 0
代码实现
1.定义过滤器AuthFilter
2.获取请求对象 从请求头或参数或cookie中获取token(支持多种方式传token对于客户端更加友好,比如部分web下载请求会新建一个页面,在请求头中传token处理起来比较麻烦)
3.没有token,返回401
4.有token,查询redis是否有效
5.无效则返回401,有效则完成验证放行
6.重置token过期时间、添加内部请求头信息方便业务系统权限处理
@Component
public class AuthFilter implements GlobalFilter, Ordered {@Autowiredprivate RedisTemplate<String, String> redisTemplate;private static final String TOKEN_HEADER_KEY = "auth_token";@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {// 1.获取请求对象ServerHttpRequest request = exchange.getRequest();// 2.获取tokenString token = getToken(request);ServerHttpResponse response = exchange.getResponse();if (StringUtils.isBlank(token)) {// 3.token为空 返回401response.setStatusCode(HttpStatus.UNAUTHORIZED);return response.setComplete();}// 4.验证token是否有效String userId = getUserIdByToken(token);if (StringUtils.isBlank(userId)) {// 5.token无效 返回401response.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);}@Overridepublic 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();// 从请求头获取tokenString token = headers.getFirst(TOKEN_HEADER_KEY);if (StringUtils.isBlank(token)) {// 请求头无token则从url获取tokentoken = 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两个接口可以快速实现一个过滤器,文中也详细的介绍了登录后的请求鉴权流程。