OCP開源項目：Spring Cloud Gateway模塊中動態路由的實現

時間  2019-11-22
標籤 ocp 開源 項目 spring cloud gateway 模塊 動態 路由 實現 欄目 Spring 简体版
原文   原文鏈接

OCP開源項目：Spring Cloud Gateway模塊中動態路由的實現

1.前言

本章將介紹OCP開源項目：Spring Cloud Gateway模塊中動態路由的實現。html

2. Spring Cloud Gateway

Spring Cloud Gateway旨在提供一種簡單而有效的方式來路由到API，併爲他們提供橫切關注點，例如：安全性，監控/指標和彈性。java

2.1 Spring Cloud Gateway特徵

  • 基於Spring Framework 5，Project Reactor和Spring Boot 2.0構建
  • 可以匹配任何請求屬性上的路由。
  • 謂詞和過濾器特定於路線。
  • Hystrix斷路器集成。
  • Spring Cloud DiscoveryClient集成
  • 易於編寫謂詞和過濾器
  • 請求率限制
  • 路徑重寫

2.2 項目實戰

接下來，開始咱們的 Spring Cloud Gateway 限流之旅吧！mysql

2.2.1 Spring Cloud Gateway 限流

new-api-gateway

2.2.2 OCP子項目new-api-gateway

pom.xmlreact

​
<!--基於 reactive stream 的redis -->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>
​
<!--spring cloud gateway 相關依賴-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
​
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
​
<dependency>
  <groupId>org.springframework.cloud</groupId>
  <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
​
複製代碼

2.2.3 配置HostName的規則限流

目前只對user-center用戶中心進行限流git

spring:
 cloud:
 gateway:
 discovery:
 locator:
 lowerCaseServiceId: true
 enabled: true
 routes:
        # =====================================
 - id: api-eureka
 uri: lb://eureka-server
 order: 8000
 predicates:
 - Path=/api-eureka/**
 filters:
 - StripPrefix=1   
 - name: Hystrix
 args:
              name : default
 fallbackUri: 'forward:/defaultfallback'
 - id: api-user
 uri: lb://user-center
 order: 8001
 predicates:
 - Path=/api-user/**   
 filters:
 - GwSwaggerHeaderFilter
 - StripPrefix=1 
 - name: Hystrix
 args:
              name : default
 fallbackUri: 'forward:/defaultfallback'
 - name: RequestRateLimiter                #對應 RequestRateLimiterGatewayFilterFactory
 args:
              redis-rate-limiter.replenishRate: 1  # 令牌桶的容積 放入令牌桶的容積每次一個
              redis-rate-limiter.burstCapacity: 3  # 流速 每秒 
 key-resolver: "#{@ipAddressKeyResolver}" # SPEL表達式去的對應的bean
​
​
複製代碼

2.2.4 新增配置類RequestRateLimiterConfig

配置類新建在com.open.capacity.client.config路徑下web

package com.open.capacity.client.config;
​
import org.springframework.cloud.gateway.filter.ratelimit.KeyResolver;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import reactor.core.publisher.Mono;
​
/** * 定義spring cloud gateway中的 key-resolver: "#{@ipAddressKeyResolver}" #SPEL表達式去的對應的bean * ipAddressKeyResolver 要取bean的名字 * */
@Configuration
public class RequestRateLimiterConfig {
​
    /** * 根據 HostName 進行限流 * @return */
    @Bean("ipAddressKeyResolver")
    public KeyResolver ipAddressKeyResolver() {
        return exchange -> Mono.just(exchange.getRequest().getRemoteAddress().getHostName());
    }
​
    /** * 根據api接口來限流 * @return */
    @Bean(name="apiKeyResolver")
    public KeyResolver apiKeyResolver() {
        return exchange ->  Mono.just(exchange.getRequest().getPath().value());
    }
​
    /** * 用戶限流 * 使用這種方式限流，請求路徑中必須攜帶userId參數。 * 提供第三種方式 * @return */
    @Bean("userKeyResolver")
    KeyResolver userKeyResolver() {
        return exchange -> Mono.just(exchange.getRequest().getQueryParams().getFirst("userId"));
    }
}
​
複製代碼

2.2.5 壓力測試

接下來配置東西弄完以後 咱們開始進行壓力測試，壓力測試以前，因爲new-api-gateway有全局攔截器 AccessFilter 的存在，若是不想進行登陸就進行測試的。先把 "/api-auth/**" 的判斷中的註釋掉。接下來咱們開用postman進行測試面試

@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
	// TODO Auto-generated method stub
	
	String accessToken = extractToken(exchange.getRequest());
	
	
	if(pathMatcher.match("/**/v2/api-docs/**",exchange.getRequest().getPath().value())){
		return chain.filter(exchange);
	}
	
	if(!pathMatcher.match("/api-auth/**",exchange.getRequest().getPath().value())){
// if (accessToken == null) {
// exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
// return exchange.getResponse().setComplete();
// }else{
// try {
// Map<String, Object> params = (Map<String, Object>) redisTemplate.opsForValue().get("token:" + accessToken) ;
// if(params.isEmpty()){
// exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
// return exchange.getResponse().setComplete();
// }
// } catch (Exception e) {
// exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED);
// return exchange.getResponse().setComplete();
// }
// }
	}
	return chain.filter(exchange);
}
​
​
複製代碼
  • 1.打開postman 選擇Collections 點擊新建按鈕

新建
輸入名稱與描述

  • 2.點擊新建的Collection 新建一個request redis

    添加request
    添加request2

    1. 輸入地址：127.0.0.1:9200/api-user/users-anon/login?username=admin

填入URL

  • 4.切換成Tests的tab下，選擇右邊Status code is 200選項，這裏能夠選擇其餘的方法，根據本身的api定義。

選擇Status code is 200

  • 5.這裏須要注意：操做完剛剛的數據，必須點擊save進行保存，不然沒法生效；
    保存
    請求配置

請求配置

    1. 點擊 Run，就能夠查看結果，有五次成功，五次失敗；限流成功返回429

運行結果
運行結果

在前一章，咱們已經作了簡單spring cloud gateway 介紹 和 限流，接下來，spring cloud gateway最重要的，也是最爲關鍵的 動態路由，首先，API網關負責服務請求路由、組合及協議轉換，客戶端的全部請求都首先通過API網關，而後由它將匹配的請求路由到合適的微服務，是系統流量的入口，在實際生產環境中爲了保證高可靠和高可用，儘可能避免重啓，若是有新的服務要上線時，能夠經過動態路由配置功能上線。spring

3. Spring Cloud Gateway動態路由實現

首先，springcloudgateway配置路由有2種方式：sql

  • yml配置文件
  • 面向對象配置（代碼方式配置）

3.1 yml配置

yml配置

3.2 代碼方式配置

代碼方式配置

3.3 路由初始化

srping cloud gateway網關啓動時，路由信息默認會加載內存中，路由信息被封裝到RouteDefinition對象中，

org.springframework.cloud.gateway.route.RouteDefinition
複製代碼

RouteDefinition

該類有的屬性爲 :

@NotEmpty
private String id = UUID.randomUUID().toString();
​
//路由斷言定義
@NotEmpty
@Valid
private List<PredicateDefinition> predicates = new ArrayList<>();
​
//路由過濾定義
@Valid
private List<FilterDefinition> filters = new ArrayList<>();
​
//對應的URI
@NotNull
private URI uri;
​
private int order = 0;
複製代碼

一個RouteDefinition有個惟一的ID，若是不指定，就默認是UUID，多個RouteDefinition組成了gateway的路由系統，全部路由信息在系統啓動時就被加載裝配好了，並存到了內存裏。

3.4 網關的自動配置

org.springframework.cloud.gateway.config.GatewayAutoConfiguration
複製代碼

4 

//RouteLocatorBuilder 採用代碼的方式注入路由
@Bean
public RouteLocatorBuilder routeLocatorBuilder(ConfigurableApplicationContext context) {
  return new RouteLocatorBuilder(context);
}
​
//PropertiesRouteDefinitionLocator 配置文件路由定義
@Bean
@ConditionalOnMissingBean
public PropertiesRouteDefinitionLocator propertiesRouteDefinitionLocator(GatewayProperties properties) {
  return new PropertiesRouteDefinitionLocator(properties);
}
​
//InMemoryRouteDefinitionRepository 內存路由定義
@Bean
@ConditionalOnMissingBean(RouteDefinitionRepository.class)
public InMemoryRouteDefinitionRepository inMemoryRouteDefinitionRepository() {
  return new InMemoryRouteDefinitionRepository();
}
​
//CompositeRouteDefinitionLocator 組合多種模式，爲RouteDefinition統一入口
@Bean
@Primary
public RouteDefinitionLocator routeDefinitionLocator(List<RouteDefinitionLocator> routeDefinitionLocators) {
  return new CompositeRouteDefinitionLocator(Flux.fromIterable(routeDefinitionLocators));
}
​
​
@Bean
public RouteLocator routeDefinitionRouteLocator(GatewayProperties properties, List<GatewayFilterFactory> GatewayFilters, List<RoutePredicateFactory> predicates, RouteDefinitionLocator routeDefinitionLocator) {
  return new RouteDefinitionRouteLocator(routeDefinitionLocator, predicates, GatewayFilters, properties);
}
​
//CachingRouteLocator 爲RouteDefinition提供緩存功能
@Bean
@Primary
//TODO: property to disable composite?
public RouteLocator cachedCompositeRouteLocator(List<RouteLocator> routeLocators) {
  return new CachingRouteLocator(new CompositeRouteLocator(Flux.fromIterable(routeLocators)));
}
​
複製代碼

裝配yml文件的，它返回的是PropertiesRouteDefinitionLocator，該類繼承了RouteDefinitionLocator，RouteDefinitionLocator就是路由的裝載器，裏面只有一個方法，就是獲取路由信息的。

org.springframework.cloud.gateway.route.RouteDefinitionLocator
複製代碼

5

RouteDefinitionLocator 類圖以下：

RouteDefinitionLocator 類圖

子類功能描述：

  • CachingRouteDefinitionLocator：RouteDefinitionLocator包裝類， 緩存目標RouteDefinitionLocator 爲routeDefinitions提供緩存功能
  • CompositeRouteDefinitionLocator -RouteDefinitionLocator包裝類，組合多種 RouteDefinitionLocator 的實現，爲 routeDefinitions提供統一入口
  • PropertiesRouteDefinitionLocator-從配置文件(GatewayProperties 例如，YML / Properties 等 ) 讀取RouteDefinition
  • RouteDefinitionRepository-從存儲器( 例如，內存 / Redis / MySQL 等 )讀取RouteDefinition
  • DiscoveryClientRouteDefinitionLocator-從註冊中心( 例如，Eureka / Consul / Zookeeper / Etcd 等

推薦參考文章：www.jianshu.com/p/b02c7495e…

3.5 編寫動態路由

新建數據腳本，在 sql目錄下 02.oauth-center.sql

​
#
# Structure for table "sys_gateway_routes"
#
​
DROP TABLE IF EXISTS sys_gateway_routes;
CREATE TABLE sys_gateway_routes
(
  `id`            char(32) NOT NULL COMMENT 'id',
  `uri`           VARCHAR(100) NOT NULL COMMENT 'uri路徑',
  `predicates`    VARCHAR(1000) COMMENT '斷定器',
  `filters`       VARCHAR(1000) COMMENT '過濾器',
  `order`         INT COMMENT '排序',
  `description`   VARCHAR(500) COMMENT '描述',
  `delFlag`       int(11) DEFAULT '0' COMMENT '刪除標誌 0 不刪除 1 刪除',
  `createTime`    datetime NOT NULL,
  `updateTime`    datetime NOT NULL,
   PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=38 DEFAULT CHARSET=utf8mb4 COMMENT '服務網關路由表';
​

複製代碼
/** * 路由實體類 */
public class GatewayRoutes {
    private String id;
    private String uri;
    private String predicates;
    private String filters;
    private Integer order;
    private String description;
    private Integer delFlag;
    private Date createTime;
    private Date updateTime;   
    //省略getter，setter
}
複製代碼
/** * 路由的Service類 */
@Service
public class DynamicRouteServiceImpl implements ApplicationEventPublisherAware, IDynamicRouteService {
  
  /** * 新增路由 * * @param gatewayRouteDefinition * @return */
  @Override
  public String add(GatewayRouteDefinition gatewayRouteDefinition) {
    GatewayRoutes gatewayRoutes = transformToGatewayRoutes(gatewayRouteDefinition);
    gatewayRoutes.setDelFlag(0);
    gatewayRoutes.setCreateTime(new Date());
    gatewayRoutes.setUpdateTime(new Date());
    gatewayRoutesMapper.insertSelective(gatewayRoutes);
​
    gatewayRouteDefinition.setId(gatewayRoutes.getId());
    redisTemplate.opsForValue().set(GATEWAY_ROUTES_PREFIX + gatewayRouteDefinition.getId(), JSONObject.toJSONString(gatewayRouteDefinition));
    return gatewayRoutes.getId();
  }
​
  /** * 修改路由 * * @param gatewayRouteDefinition * @return */
  @Override
  public String update(GatewayRouteDefinition gatewayRouteDefinition) {
    GatewayRoutes gatewayRoutes = transformToGatewayRoutes(gatewayRouteDefinition);
    gatewayRoutes.setCreateTime(new Date());
    gatewayRoutes.setUpdateTime(new Date());
    gatewayRoutesMapper.updateByPrimaryKeySelective(gatewayRoutes);
​
    redisTemplate.delete(GATEWAY_ROUTES_PREFIX + gatewayRouteDefinition.getId());
    redisTemplate.opsForValue().set(GATEWAY_ROUTES_PREFIX + gatewayRouteDefinition.getId(), JSONObject.toJSONString(gatewayRouteDefinition));
    return gatewayRouteDefinition.getId();
  }
​
​
  /** * 刪除路由 * @param id * @return */
  @Override
  public String delete(String id) {
    gatewayRoutesMapper.deleteByPrimaryKey(id);
    redisTemplate.delete(GATEWAY_ROUTES_PREFIX + id);
    return "success";
  }
  
  
}
​
複製代碼
/**
 *  核心類
 *      getRouteDefinitions() 經過該方法獲取到所有路由，每次有request過來請求的時候，都會往該方法過。
 *
 */
@Component
public class RedisRouteDefinitionRepository implements RouteDefinitionRepository {
​
    public static final String GATEWAY_ROUTES_PREFIX = "geteway_routes_";
​
    @Autowired
    private StringRedisTemplate redisTemplate;
​
    private Set<RouteDefinition> routeDefinitions = new HashSet<>();
​
    /**
     * 獲取所有路由
     * @return
     */
    @Override
    public Flux<RouteDefinition> getRouteDefinitions() {
        /**
         * 從redis 中 獲取 所有路由,由於保存在redis ,mysql 中 頻繁讀取mysql 有可能會帶來沒必要要的問題
         */
        Set<String> gatewayKeys = redisTemplate.keys(GATEWAY_ROUTES_PREFIX + "*");
        if (!CollectionUtils.isEmpty(gatewayKeys)) {
            List<String> gatewayRoutes = Optional.ofNullable(redisTemplate.opsForValue().multiGet(gatewayKeys)).orElse(Lists.newArrayList());
            gatewayRoutes
                    .forEach(routeDefinition -> routeDefinitions.add(JSON.parseObject(routeDefinition, RouteDefinition.class)));
        }
        return Flux.fromIterable(routeDefinitions);
    }
​
    /**
     * 添加路由方法
     * @param route
     * @return
     */
    @Override
    public Mono<Void> save(Mono<RouteDefinition> route) {
        return route.flatMap(routeDefinition -> {
            routeDefinitions.add( routeDefinition );
            return Mono.empty();
        });
    }
​
    /**
     * 刪除路由
     * @param routeId
     * @return
     */
    @Override
    public Mono<Void> delete(Mono<String> routeId) {
        return routeId.flatMap(id -> {
            List<RouteDefinition> collect = routeDefinitions.stream().filter(
                    routeDefinition -> StringUtils.equals(routeDefinition.getId(), id)
            ).collect(Collectors.toList());
            routeDefinitions.removeAll(collect);
            return Mono.empty();
        });
    }
}
​
​
複製代碼
​
​
/** * 編寫Rest接口 */
@RestController
@RequestMapping("/route")
public class RouteController {
​
    @Autowired
    private IDynamicRouteService dynamicRouteService;
​
    //增長路由
    @PostMapping("/add")
    public Result add(@RequestBody GatewayRouteDefinition gatewayRouteDefinition) {
        return Result.succeed(dynamicRouteService.add(gatewayRouteDefinition));
    }
​
    //更新路由
    @PostMapping("/update")
    public Result update(@RequestBody GatewayRouteDefinition gatewayRouteDefinition) {
        return Result.succeed(dynamicRouteService.update(gatewayRouteDefinition));
    }
​
    //刪除路由
    @DeleteMapping("/{id}")
    public Result delete(@PathVariable String id) {
        return Result.succeed(dynamicRouteService.delete(id));
    }
​
}
​
複製代碼

3.6 測試編寫的動態路由

GET localhost:9200/actuator/gateway/routes
複製代碼

1.使用該接口，查看gateway下的所有路由，測試路由 /jd/** 並無找到

7 

POST 127.0.0.1:9200/route/add
複製代碼

參數由json格式構建 對應 com.open.capacity.client.dto.GatewayRouteDefinition 類

{
  "id": "",
  "uri": "lb://user-center",
  "order": 1111,
  "filters": [
    {
      "name": "StripPrefix",
      "args": {
        "_genkey_0": "1"
      }
    }
  ],
  "predicates": [
    {
      "name": "Path",
      "args": {
        "_genkey_0": "/jd/**"
      }
    }
  ],
  "description": "測試路由新增"
}
​
複製代碼

添加成功，返回對應id，查看mysql，redis 都已經保存成功

8

9

在這裏插入圖片描述

在訪問剛剛 獲取所有路由的接口，發現咱們的**/jd/****已經註冊到咱們的網關上

10 

GET localhost:9200/jd/users-anon/login?username=admin
複製代碼

這個時候，咱們沒有重啓項目，依然能夠訪問咱們自定義的路由，到此，咱們已經完成了添加操做，後續的刪除，更新，就是簡單調用下API就完成！

11

劃重點

以上來自開源項目OCP: gitee.com/owenwangwen…

項目演示地址 http://59.110.164.254:8066/login.html 用戶名/密碼：admin/admin

項目監控 http://106.13.3.200:3000 用戶名/密碼：admin/1q2w3e4r

項目代碼地址 gitee.com/owenwangwen…

羣號:483725710（備註：Coder編程）歡迎你們加入~

文末

歡迎關注我的微信公衆號：Coder編程 獲取最新原創技術文章和免費學習資料，更有大量精品思惟導圖、面試資料、PMP備考資料等你來領，方便你隨時隨地學習技術知識！

歡迎關注並star~

微信公衆號
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程