前面分别对 Spring Cloud Zuul 与 Spring Cloud Gateway 进行了简单的说明它门是API网关API网关负责服务请求路由、组合及协议转换客户端的所有请求都首先经过API网关然后由它将匹配的请求路由到合适的微服务是系统流量的入口在实际生产环境中为了保证高可靠和高可用尽量避免重启如果有新的服务要上线时可以通过动态路由配置功能上线。本篇拿 Spring Cloud Gateway 为例对网关的动态路由进行简单分析下一篇将分享动态路由的进阶实现1.gateway配置路由主要有两种方式1.用yml配置文件2.写在代码里。而无论是 yml还是代码配置启动网关后将无法修改路由配置如有新服务要上线则需要先把网关下线修改 yml 配置后再重启网关yml配置方式代码配置方式2.gateway网关启动时路由信息默认会加载内存中路由信息被封装到 RouteDefinition 对象中配置多个RouteDefinition组成gateway的路由系统仔细的同学可能看到RouteDefinition中的字段与上面代码配置方式比较对应RouteDefinition对象在 org.springframework.cloud.gateway.route包下其定义如下RouteDefinitionLocator是个接口在org.springframework.cloud.gateway.route包下如果想查看网关中所有的路由信息调用此接口方法是一个办法需要从先注入到容器后面还有另外一种查看方式是Spring Cloud Gateway 的Endpoint端点提供的方法3.Spring Cloud Gateway 提供了 Endpoint 端点暴露路由信息有获取所有路由、刷新路由、查看单个路由、删除路由等方法源码在 org.springframework.cloud.gateway.actuate.GatewayControllerEndpoint 中想访问端点中的方法需要添加 spring-boot-starter-actuator 注解并在配置文件中暴露所有端点# 暴露端点 management: endpoints: web: exposure: include: * endpoint: health: show-details: always4.动态路由代码实现前提需要启动 3个服务eureka、gateway、consumer-service1.eureka使用前面博客中的代码2.consumer-service是个web项目提供一个hello方法需注册到eureka上3.新建gateway添加引用org.springframework.cloud spring-cloud-starter-gateway org.springframework.cloud spring-cloud-starter-netflix-eureka-client org.springframework.boot spring-boot-starter-actuator4.添加基本配置和注册到eureka不要配置路由信息映射到consumer-service由后面的动态路由功能路由过去5.根据Spring Cloud Gateway的路由模型定义数据传输模型分别是路由模型、过滤器模型、断言模型//1.创建路由模型public class GatewayRouteDefinition {//路由的Idprivate String id;//路由断言集合配置private List predicates new ArrayList();//路由过滤器集合配置private List filters new ArrayList();//路由规则转发的目标uriprivate String uri;//路由执行的顺序private int order 0;//此处省略get和set方法}//2.创建过滤器模型public class GatewayFilterDefinition {//Filter Nameprivate String name;//对应的路由规则private MapString, String args new LinkedHashMap();//此处省略Get和Set方法}//3.路由断言模型public class GatewayPredicateDefinition {//断言对应的Nameprivate String name;//配置的断言规则private MapString, String args new LinkedHashMap();//此处省略Get和Set方法}6.编写动态路由实现类需实现ApplicationEventPublisherAware接口/**动态路由服务*/Servicepublic class DynamicRouteServiceImpl implements ApplicationEventPublisherAware{Autowiredprivate RouteDefinitionWriter routeDefinitionWriter;private ApplicationEventPublisher publisher;Overridepublic void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {this.publisher applicationEventPublisher;}//增加路由public String add(RouteDefinition definition) {routeDefinitionWriter.save(Mono.just(definition)).subscribe();this.publisher.publishEvent(new RefreshRoutesEvent(this));return “success”;}//更新路由public String update(RouteDefinition definition) {try {delete(definition.getId());} catch (Exception e) {return update fail,not find route routeId: definition.getId();}try {routeDefinitionWriter.save(Mono.just(definition)).subscribe();this.publisher.publishEvent(new RefreshRoutesEvent(this));return “success”;} catch (Exception e) {return “update route fail”;}}//删除路由public MonoResponseEntity delete(String id) {return this.routeDefinitionWriter.delete(Mono.just(id)).then(Mono.defer(() - {return Mono.just(ResponseEntity.ok().build());})).onErrorResume((t) - {return t instanceof NotFoundException;}, (t) - {return Mono.just(ResponseEntity.notFound().build());});}}7.编写 Rest接口通过这些接口实现动态路由功能注意SpringCloudGateway使用的是WebFlux不要引用WebMvcRestControllerRequestMapping(“/route”)public class RouteController {Autowired private DynamicRouteServiceImpl dynamicRouteService; //增加路由 PostMapping(/add) public String add(RequestBody GatewayRouteDefinition gwdefinition) { String flag fail; try { RouteDefinition definition assembleRouteDefinition(gwdefinition); flag this.dynamicRouteService.add(definition); } catch (Exception e) { e.printStackTrace(); } return flag; } //删除路由 DeleteMapping(/routes/{id}) public MonoResponseEntityObject delete(PathVariable String id) { try { return this.dynamicRouteService.delete(id); }catch (Exception e){ e.printStackTrace(); } return null; } //更新路由 PostMapping(/update) public String update(RequestBody GatewayRouteDefinition gwdefinition) { RouteDefinition definition assembleRouteDefinition(gwdefinition); return this.dynamicRouteService.update(definition); } //把传递进来的参数转换成路由对象 private RouteDefinition assembleRouteDefinition(GatewayRouteDefinition gwdefinition) { RouteDefinition definition new RouteDefinition(); definition.setId(gwdefinition.getId()); definition.setOrder(gwdefinition.getOrder()); //设置断言 ListPredicateDefinition pdListnew ArrayList(); ListGatewayPredicateDefinition gatewayPredicateDefinitionListgwdefinition.getPredicates(); for (GatewayPredicateDefinition gpDefinition: gatewayPredicateDefinitionList) { PredicateDefinition predicate new PredicateDefinition(); predicate.setArgs(gpDefinition.getArgs()); predicate.setName(gpDefinition.getName()); pdList.add(predicate); } definition.setPredicates(pdList); //设置过滤器 ListFilterDefinition filters new ArrayList(); ListGatewayFilterDefinition gatewayFilters gwdefinition.getFilters(); for(GatewayFilterDefinition filterDefinition : gatewayFilters){ FilterDefinition filter new FilterDefinition(); filter.setName(filterDefinition.getName()); filter.setArgs(filterDefinition.getArgs()); filters.add(filter); } definition.setFilters(filters); URI uri null; if(gwdefinition.getUri().startsWith(http)){ uri UriComponentsBuilder.fromHttpUrl(gwdefinition.getUri()).build().toUri(); }else{ // uri为 lb://consumer-service 时使用下面的方法 uri URI.create(gwdefinition.getUri()); } definition.setUri(uri); return definition; }}8.启动项目查看网关路由信息访问 localhost:9999/actuator/gateway/routes因没有配置路由信息因此返回结果为空数组9.通过Postman发一个 post 请求新增路由接口地址http://localhost:9999/route/update路由到 consumer-service 上然后通过网关访问查看是否转发请求了这里直接调用的update有就会覆盖没有则新增10.再访问 localhost:9999/actuator/gateway/routes 可以看到新的路由信息已经配置进去了这就是动态路由配置还可以调用删除、修改接口操作动态操作路由信息11.配置路由信息后访问consumer-service服务正常返回说明路由已经生效请求转发到consumer-service服务好了动态路由的简单实现了一般在生产环境不使用此方式因为网关都是多实例部署还可能随时增加实例需要已调用接口的方式一一调用网关所有的实例本篇博客参考了许进的文章地址http://springcloud.cn/view/407 还有他写的 《重新定义SpringCloud》比较不错代码已上传至码云源码项目使用的版本信息如下- SpringBoot 2.0.6.RELEASE - SpringCloud Finchley.SR2下篇将介绍动态路由的进阶实现实现方式创建一个路由信息维护的项目实现增删改查路由信息到mysql然后发布发布后将路由信息与版本信息保存到redis中对外提供 rest 接口网关开启定时任务定时拉取 rest 接口中最新版本的路由信息这样网关发布多个实例后都会单独的去拉取维护的路由信息参考了https://blog.csdn.net/tianyaleixiaowu/article/details/83412301