优化路由缓存的读取，admin启动时加载所有路由到redis，gateway-web启动时读取redis中缓存的路由进行初使化

zhoutaoo · zhoutaoo · commit ed133ed5a9eb · 2019-10-11T00:15:24.000+08:00
diff --git a/gateway/gateway-admin/pom.xml b/gateway/gateway-admin/pom.xml
@@ -23,6 +23,12 @@
             <artifactId>jetcache-starter-redis</artifactId>
             <version>2.5.14</version>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.cloud</groupId>
+            <artifactId>spring-cloud-gateway-core</artifactId>
+            <version>2.1.0.RELEASE</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <build>
diff --git a/gateway/gateway-admin/src/main/java/com/springboot/cloud/gateway/admin/service/impl/GatewayRouteService.java b/gateway/gateway-admin/src/main/java/com/springboot/cloud/gateway/admin/service/impl/GatewayRouteService.java
@@ -1,21 +1,27 @@
 package com.springboot.cloud.gateway.admin.service.impl;
 
 import com.alicp.jetcache.Cache;
-import com.alicp.jetcache.anno.CacheInvalidate;
 import com.alicp.jetcache.anno.CacheType;
-import com.alicp.jetcache.anno.Cached;
 import com.alicp.jetcache.anno.CreateCache;
 import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
 import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import com.springboot.cloud.gateway.admin.dao.GatewayRouteMapper;
 import com.springboot.cloud.gateway.admin.entity.ov.GatewayRouteVo;
 import com.springboot.cloud.gateway.admin.entity.param.GatewayRouteQueryParam;
 import com.springboot.cloud.gateway.admin.entity.po.GatewayRoute;
 import com.springboot.cloud.gateway.admin.service.IGatewayRouteService;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang.StringUtils;
+import org.springframework.cloud.gateway.filter.FilterDefinition;
+import org.springframework.cloud.gateway.handler.predicate.PredicateDefinition;
+import org.springframework.cloud.gateway.route.RouteDefinition;
 import org.springframework.stereotype.Service;
 
+import javax.annotation.PostConstruct;
+import java.io.IOException;
+import java.net.URI;
 import java.util.List;
 import java.util.stream.Collectors;
 
@@ -25,34 +31,54 @@ public class GatewayRouteService extends ServiceImpl<GatewayRouteMapper, Gateway
 
     private static final String GATEWAY_ROUTES = "gateway_routes::";
 
-    @CreateCache(cacheType = CacheType.REMOTE)
-    private Cache<String, GatewayRouteVo> gatewayRouteCache;
+    @CreateCache(name = GATEWAY_ROUTES, cacheType = CacheType.REMOTE)
+    private Cache<String, RouteDefinition> gatewayRouteCache;
 
     @Override
     public boolean add(GatewayRoute gatewayRoute) {
         boolean isSuccess = this.save(gatewayRoute);
-        gatewayRouteCache.put(GATEWAY_ROUTES + gatewayRoute.getId(), new GatewayRouteVo(gatewayRoute));
+        gatewayRouteCache.put(gatewayRoute.getRouteId(), gatewayRouteToRouteDefinition(gatewayRoute));
         return isSuccess;
     }
 
     @Override
-    @CacheInvalidate(name = GATEWAY_ROUTES, key = "#id")
     public boolean delete(String id) {
-        boolean isSuccess = this.removeById(id);
-        gatewayRouteCache.remove(GATEWAY_ROUTES + id);
-        return isSuccess;
+        GatewayRoute gatewayRoute = this.getById(id);
+        gatewayRouteCache.remove(gatewayRoute.getRouteId());
+        return this.removeById(id);
     }
 
     @Override
-    @CacheInvalidate(name = GATEWAY_ROUTES, key = "#gatewayRoute.id")
     public boolean update(GatewayRoute gatewayRoute) {
         boolean isSuccess = this.updateById(gatewayRoute);
-        gatewayRouteCache.put(GATEWAY_ROUTES + gatewayRoute.getId(), new GatewayRouteVo(gatewayRoute));
+        gatewayRouteCache.put(gatewayRoute.getRouteId(), gatewayRouteToRouteDefinition(gatewayRoute));
         return isSuccess;
     }
 
+    /**
+     * 将数据库中json对象转换为网关需要的RouteDefinition对象
+     *
+     * @param gatewayRoute
+     * @return RouteDefinition
+     */
+    private RouteDefinition gatewayRouteToRouteDefinition(GatewayRoute gatewayRoute) {
+        RouteDefinition routeDefinition = new RouteDefinition();
+        routeDefinition.setId(gatewayRoute.getRouteId());
+        routeDefinition.setOrder(gatewayRoute.getOrders());
+        routeDefinition.setUri(URI.create(gatewayRoute.getUri()));
+        ObjectMapper objectMapper = new ObjectMapper();
+        try {
+            routeDefinition.setFilters(objectMapper.readValue(gatewayRoute.getFilters(), new TypeReference<List<FilterDefinition>>() {
+            }));
+            routeDefinition.setPredicates(objectMapper.readValue(gatewayRoute.getPredicates(), new TypeReference<List<PredicateDefinition>>() {
+            }));
+        } catch (IOException e) {
+            log.error("网关路由对象转换失败", e);
+        }
+        return routeDefinition;
+    }
+
     @Override
-    @Cached(name = GATEWAY_ROUTES, key = "#id", cacheType = CacheType.REMOTE)
     public GatewayRoute get(String id) {
         return this.getById(id);
     }
@@ -65,10 +91,11 @@ public List<GatewayRouteVo> query(GatewayRouteQueryParam gatewayRouteQueryParam)
     }
 
     @Override
+    @PostConstruct
     public boolean overload() {
         List<GatewayRoute> gatewayRoutes = this.list(new QueryWrapper<>());
         gatewayRoutes.forEach(gatewayRoute ->
-                gatewayRouteCache.put(GATEWAY_ROUTES + gatewayRoute.getId(), new GatewayRouteVo(gatewayRoute))
+                gatewayRouteCache.put(gatewayRoute.getRouteId(), gatewayRouteToRouteDefinition(gatewayRoute))
         );
         log.info("全局初使化网关路由成功!");
         return true;
diff --git a/gateway/gateway-admin/src/main/resources/application.yml b/gateway/gateway-admin/src/main/resources/application.yml
@@ -37,51 +37,10 @@ jetcache:
     default:
       type: caffeine
       keyConvertor: fastjson
-      expireAfterWriteInMillis: 3600000
-      expireAfterAccessInMillis: 1800000
-    # 長時本地緩存，主要用于要求时效一般
-    longTime:
-      type: caffeine
-      keyConvertor: fastjson
-      expireAfterWriteInMillis: 300000
-      expireAfterAccessInMillis: 180000
-    # 短時本地緩存，主要用于要求时效较高的配置
-    shortTime:
-      type: caffeine
-      keyConvertor: fastjson
-      expireAfterWriteInMillis: 60000
-      expireAfterAccessInMillis: 40000
   remote:
     # 默认2小时的远程缓存
     default:
       type: redis
-      expireAfterWriteInMillis: 43200000
-      keyConvertor: fastjson
-      valueEncoder: kryo
-      valueDecoder: kryo
-      poolConfig:
-        minIdle: 5
-        maxIdle: 20
-        maxTotal: 50
-      host: ${REDIS_HOST:localhost}
-      port: ${REDIS_PORT:6379}
-    # 长时远程緩存，主要用于要求时效要求一般的集中式缓存
-    longTime:
-      type: redis
-      expireAfterWriteInMillis: 7200000
-      keyConvertor: fastjson
-      valueEncoder: kryo
-      valueDecoder: kryo
-      poolConfig:
-        minIdle: 5
-        maxIdle: 20
-        maxTotal: 50
-      host: ${REDIS_HOST:localhost}
-      port: ${REDIS_PORT:6379}
-    # 短時远程緩存，主要用于要求时效较高的集中式缓存
-    shortTime:
-      type: redis
-      expireAfterWriteInMillis: 300000
       keyConvertor: fastjson
       valueEncoder: kryo
       valueDecoder: kryo
diff --git a/gateway/gateway-web/pom.xml b/gateway/gateway-web/pom.xml
@@ -18,6 +18,12 @@
     </parent>
 
     <dependencies>
+        <!--core基础类库-->
+        <dependency>
+            <groupId>com.springboot.cloud</groupId>
+            <artifactId>core</artifactId>
+            <version>0.0.1-SNAPSHOT</version>
+        </dependency>
         <!--api网关-->
         <dependency>
             <groupId>org.springframework.cloud</groupId>
@@ -39,16 +45,6 @@
             <artifactId>springfox-swagger2</artifactId>
             <version>2.9.2</version>
         </dependency>
-        <dependency>
-            <groupId>com.springboot.cloud</groupId>
-            <artifactId>core</artifactId>
-            <version>0.0.1-SNAPSHOT</version>
-        </dependency>
-        <dependency>
-            <groupId>org.apache.commons</groupId>
-            <artifactId>commons-pool2</artifactId>
-            <version>2.6.0</version>
-        </dependency>
         <!--网关签权客户端-->
         <dependency>
             <groupId>com.springboot.cloud</groupId>
diff --git a/gateway/gateway-web/src/main/java/com/springboot/cloud/gateway/GatewayApplication.java b/gateway/gateway-web/src/main/java/com/springboot/cloud/gateway/GatewayApplication.java
@@ -1,5 +1,7 @@
 package com.springboot.cloud.gateway;
 
+import com.alicp.jetcache.anno.config.EnableCreateCacheAnnotation;
+import com.alicp.jetcache.anno.config.EnableMethodCache;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.client.circuitbreaker.EnableCircuitBreaker;
@@ -10,6 +12,8 @@
 @EnableDiscoveryClient
 @EnableFeignClients(basePackages = "com.springboot.cloud.auth.client")
 @EnableCircuitBreaker
+@EnableMethodCache(basePackages = "com.springboot.cloud")
+@EnableCreateCacheAnnotation
 public class GatewayApplication {
     public static void main(String[] args) {
         SpringApplication.run(GatewayApplication.class, args);
diff --git a/gateway/gateway-web/src/main/java/com/springboot/cloud/gateway/service/impl/RouteService.java b/gateway/gateway-web/src/main/java/com/springboot/cloud/gateway/service/impl/RouteService.java
@@ -1,18 +1,24 @@
 package com.springboot.cloud.gateway.service.impl;
 
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.google.common.collect.Lists;
+import com.alicp.jetcache.Cache;
+import com.alicp.jetcache.anno.CacheType;
+import com.alicp.jetcache.anno.CreateCache;
 import com.springboot.cloud.gateway.service.IRouteService;
 import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.lang3.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.cloud.gateway.route.RouteDefinition;
 import org.springframework.data.redis.core.StringRedisTemplate;
 import org.springframework.stereotype.Service;
 import org.springframework.util.CollectionUtils;
 import reactor.core.publisher.Mono;
 
-import java.io.IOException;
-import java.util.*;
+import javax.annotation.PostConstruct;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 @Service
 @Slf4j
@@ -23,36 +29,41 @@ public class RouteService implements IRouteService {
     @Autowired
     private StringRedisTemplate stringRedisTemplate;
 
+    @CreateCache(name = GATEWAY_ROUTES, cacheType = CacheType.REMOTE)
+    private Cache<String, RouteDefinition> gatewayRouteCache;
+
     private Map<String, RouteDefinition> routeDefinitionMaps = new HashMap<>();
 
+    @PostConstruct
     private void loadRouteDefinition() {
+        log.info("loadRouteDefinition, 开始初使化路由");
         Set<String> gatewayKeys = stringRedisTemplate.keys(GATEWAY_ROUTES + "*");
-
         if (CollectionUtils.isEmpty(gatewayKeys)) {
             return;
         }
-
-        List<String> gatewayRoutes = Optional.ofNullable(stringRedisTemplate.opsForValue().multiGet(gatewayKeys)).orElse(Lists.newArrayList());
-        gatewayRoutes.forEach(value -> {
-            try {
-                RouteDefinition routeDefinition = new ObjectMapper().readValue(value, RouteDefinition.class);
-                routeDefinitionMaps.put(routeDefinition.getId(), routeDefinition);
-            } catch (IOException e) {
-                log.error(e.getMessage());
-            }
-        });
+        log.info("预计初使化路由, gatewayKeys：{}", gatewayKeys);
+        // 去掉key的前缀
+        Set<String> gatewayKeyIds = gatewayKeys.stream().map(key -> {
+            return key.replace(GATEWAY_ROUTES, StringUtils.EMPTY);
+        }).collect(Collectors.toSet());
+        Map<String, RouteDefinition> allRoutes = gatewayRouteCache.getAll(gatewayKeyIds);
+        log.info("gatewayKeys：{}", allRoutes);
+        routeDefinitionMaps.putAll(allRoutes);
+        log.info("共初使化路由信息：{}", routeDefinitionMaps.size());
     }
 
     @Override
     public Collection<RouteDefinition> getRouteDefinitions() {
-        loadRouteDefinition();
         return routeDefinitionMaps.values();
     }
 
     @Override
     public Mono<Void> save(Mono<RouteDefinition> routeDefinitionMono) {
         return routeDefinitionMono.flatMap(routeDefinition -> {
             routeDefinitionMaps.put(routeDefinition.getId(), routeDefinition);
+            gatewayRouteCache.put(routeDefinition.getId(), routeDefinition);
+            log.info("新增路由1条：{}", routeDefinition);
+            log.info("目前路由共{}条：", routeDefinitionMaps.size());
             return Mono.empty();
         });
     }
@@ -61,6 +72,9 @@ public Mono<Void> save(Mono<RouteDefinition> routeDefinitionMono) {
     public Mono<Void> delete(Mono<String> routeId) {
         return routeId.flatMap(id -> {
             routeDefinitionMaps.remove(id);
+            gatewayRouteCache.remove(id);
+            log.info("删除路由1条：{}", routeId);
+            log.info("目前路由共{}条：", routeDefinitionMaps.size());
             return Mono.empty();
         });
     }
diff --git a/gateway/gateway-web/src/main/resources/application.yml b/gateway/gateway-web/src/main/resources/application.yml
@@ -11,6 +11,12 @@ spring:
     lettuce:
       pool:
         max-active: 300
+  datasource:
+    driver-class-name: com.mysql.jdbc.Driver
+    url: jdbc:${DATASOURCE_DBTYPE:mysql}://${DATASOURCE_HOST:localhost}:${DATASOURCE_PORT:3306}/sc_gateway?characterEncoding=UTF-8&useUnicode=true&useSSL=false
+    username: ${DATASOURCE_USERNAME:root}
+    password: ${DATASOURCE_PASSWORD:root123}
+
   zipkin:
     enabled: true
     sender:
@@ -40,6 +46,29 @@ spring:
           rate-limiter: "#{@defaultRedisRateLimiter}"  #SPEL表达式去的对应的bean
           key-resolver: "#{@apiKeyResolver}" #SPEL表达式去的对应的bean
 
+jetcache:
+  statIntervalMinutes: 15
+  areaInCacheName: false
+  hidePackages: com.springboot.cloud
+  local:
+    # 默认2小时本地缓存
+    default:
+      type: caffeine
+      keyConvertor: fastjson
+  remote:
+    # 默认2小时的远程缓存
+    default:
+      type: redis
+      keyConvertor: fastjson
+      valueEncoder: kryo
+      valueDecoder: kryo
+      poolConfig:
+        minIdle: 5
+        maxIdle: 20
+        maxTotal: 50
+      host: ${REDIS_HOST:localhost}
+      port: ${REDIS_PORT:6379}
+
 #网关白名单，无需要签权url
 gate:
   ignore:
diff --git a/gateway/pom.xml b/gateway/pom.xml
@@ -27,5 +27,15 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-openfeign</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.alicp.jetcache</groupId>
+            <artifactId>jetcache-starter-redis</artifactId>
+            <version>2.5.14</version>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-pool2</artifactId>
+            <version>2.6.0</version>
+        </dependency>
     </dependencies>
 </project>
