优化代码

实现定时清除过期的灰度服务实例

Author: saleson

spring-cloud-gray-samples/spring-cloud-gray-server-sample/src/main/resources/config/application.yml

@@ -54,4 +54,7 @@ eureka:
 
 gray:
   server:
-    evictionIntervalTimerInMs: 30000
+    evictionIntervalTimerInMs: 30000
+    instance:
+      eviction:
+        enabled: true

spring-cloud-gray-samples/spring-cloud-gray-server-sample/src/test/java/cn/springcloud/gray/service/test/GrayInstanceRecordEvictionTest.java

@@ -0,0 +1,47 @@
+package cn.springcloud.gray.service.test;
+
+import cn.springcloud.gray.server.app.GrayServerApplication;
+import cn.springcloud.gray.server.configuration.properties.GrayServerProperties;
+import cn.springcloud.gray.server.module.GrayInstanceRecordEvictor;
+import cn.springcloud.gray.server.module.domain.GrayInstance;
+import cn.springcloud.gray.server.service.GrayInstanceService;
+import lombok.extern.slf4j.Slf4j;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.context.junit4.SpringRunner;
+
+import java.util.List;
+
+@ActiveProfiles({"dev"})
+@RunWith(SpringRunner.class)
+@SpringBootTest(classes = GrayServerApplication.class)
+@Slf4j
+public class GrayInstanceRecordEvictionTest {
+
+    @Autowired
+    private GrayServerProperties grayServerProperties;
+    @Autowired
+    private GrayInstanceRecordEvictor grayInstanceRecordEvictor;
+    @Autowired
+    private GrayInstanceService grayInstanceService;
+
+    @Test
+    public void testEvictGrayInstance() {
+        GrayServerProperties.InstanceRecordEvictProperties evictProperties =
+                grayServerProperties.getInstance().getEviction();
+        List<GrayInstance> befores = grayInstanceService.findAllByEvictableRecords(
+                evictProperties.getLastUpdateDateExpireDays(), evictProperties.getEvictionInstanceStatus());
+
+        if (befores.size() > 0) {
+            grayInstanceRecordEvictor.evict();
+            List<GrayInstance> afters = grayInstanceService.findAllByEvictableRecords(
+                    evictProperties.getLastUpdateDateExpireDays(), evictProperties.getEvictionInstanceStatus());
+            log.info("before:{}, after:{}", befores.size(), afters.size());
+            Assert.assertTrue("清理失败的灰度服务实例失败", afters.size() == 0);
+        }
+    }
+}

spring-cloud-gray-samples/spring-cloud-gray-server-sample/src/test/java/cn/springcloud/gray/service/test/GrayInstanceServiceTest.java

@@ -2,6 +2,7 @@
 
 
 import cn.springcloud.gray.model.GrayStatus;
+import cn.springcloud.gray.model.InstanceStatus;
 import cn.springcloud.gray.server.app.GrayServerApplication;
 import cn.springcloud.gray.server.configuration.properties.GrayServerProperties;
 import cn.springcloud.gray.server.module.domain.GrayInstance;
@@ -16,6 +17,7 @@
 import org.springframework.test.context.ActiveProfiles;
 import org.springframework.test.context.junit4.SpringRunner;
 
+import java.util.Arrays;
 import java.util.List;
 
 @ActiveProfiles({"dev"})
@@ -36,8 +38,17 @@ public class GrayInstanceServiceTest {
     @Test
     public void test() throws JsonProcessingException {
         List<GrayInstance> grayInstances = grayInstanceService.findAllByStatus(
-                GrayStatus.OPEN, grayServerProperties.getNormalInstanceStatus());
+                GrayStatus.OPEN, grayServerProperties.getInstance().getNormalInstanceStatus());
         log.info("{}", objectMapper.writeValueAsString(grayInstances));
 
     }
+
+
+    @Test
+    public void testFindAllByEvictableRecords() throws JsonProcessingException {
+        List<GrayInstance> grayInstances = grayInstanceService.findAllByEvictableRecords(1,
+                Arrays.asList(InstanceStatus.DOWN, InstanceStatus.UNKNOWN));
+        System.out.println(objectMapper.writeValueAsString(grayInstances));
+    }
+
 }

spring-cloud-gray-server/pom.xml

@@ -13,6 +13,10 @@
 
 
     <dependencies>
+        <dependency>
+            <groupId>cn.springcloud.gray</groupId>
+            <artifactId>spring-cloud-gray-utils</artifactId>
+        </dependency>
         <dependency>
             <groupId>cn.springcloud.gray</groupId>
             <artifactId>spring-cloud-gray-core</artifactId>

spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/GrayServerInitializingDestroyBean.java

@@ -1,30 +1,82 @@
 package cn.springcloud.gray.server;
 
+import cn.springcloud.gray.concurrent.DefaultThreadFactory;
+import cn.springcloud.gray.server.configuration.properties.GrayServerProperties;
 import cn.springcloud.gray.server.manager.GrayServiceManager;
+import cn.springcloud.gray.server.module.GrayInstanceRecordEvictor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.InitializingBean;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationContextAware;
 
 import javax.annotation.PreDestroy;
+import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.ScheduledThreadPoolExecutor;
+import java.util.concurrent.TimeUnit;
 
-public class GrayServerInitializingDestroyBean implements InitializingBean {
+@Slf4j
+public class GrayServerInitializingDestroyBean
+        implements InitializingBean, ApplicationContextAware {
     private GrayServiceManager grayServiceManager;
+    private GrayServerProperties grayServerProperties;
+    private ScheduledExecutorService scheduledExecutorService =
+            new ScheduledThreadPoolExecutor(1, new DefaultThreadFactory("initDestory"));
+    private ApplicationContext appCxt;
 
-    public GrayServerInitializingDestroyBean(GrayServiceManager grayServiceManager) {
+    public GrayServerInitializingDestroyBean(
+            GrayServiceManager grayServiceManager, GrayServerProperties grayServerProperties) {
         this.grayServiceManager = grayServiceManager;
+        this.grayServerProperties = grayServerProperties;
     }
 
     @Override
     public void afterPropertiesSet() {
         initToWork();
     }
 
-
     private void initToWork() {
         grayServiceManager.openForWork();
-    }
 
+        // 初始化灰度实例的回收任务
+        initGrayInstanceRecordEvictionTask();
+    }
 
     @PreDestroy
     public void shutdown() {
         grayServiceManager.shutdown();
+        scheduledExecutorService.shutdown();
+    }
+
+    @Override
+    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
+        appCxt = applicationContext;
+    }
+
+    private void initGrayInstanceRecordEvictionTask() {
+        GrayServerProperties.InstanceRecordEvictProperties evictProperties =
+                grayServerProperties.getInstance().getEviction();
+        if (!evictProperties.isEnabled()) {
+            return;
+        }
+        String beanName = "grayInstanceRecordEvictor";
+        GrayInstanceRecordEvictor instanceRecordEvictor =
+                getBean(beanName, GrayInstanceRecordEvictor.class);
+        if (instanceRecordEvictor == null) {
+            log.error("没有找到名为{}的GrayInstanceRecordEvictor类型或者为GrayInstanceRecordEvictor类型的实例", beanName);
+            throw new NullPointerException("没有找到GrayInstanceRecordEvictor类型的实例");
+        }
+        scheduledExecutorService.schedule(
+                () -> instanceRecordEvictor.evict(),
+                evictProperties.getEvictionIntervalTimerInMs(),
+                TimeUnit.MILLISECONDS);
+    }
+
+    private <T> T getBean(String beanName, Class<T> cls) {
+        T t = appCxt.getBean(beanName, cls);
+        if (t == null) {
+            t = appCxt.getBean(cls);
+        }
+        return t;
     }
 }

spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/configuration/DBStorageConfiguration.java

@@ -2,13 +2,17 @@
 
 import cn.springcloud.gray.event.GrayEventPublisher;
 import cn.springcloud.gray.server.configuration.properties.GrayServerProperties;
+import cn.springcloud.gray.server.module.GrayInstanceRecordEvictor;
 import cn.springcloud.gray.server.module.GrayServerModule;
 import cn.springcloud.gray.server.module.GrayServerTrackModule;
-import cn.springcloud.gray.server.module.SimpleGrayServerModule;
-import cn.springcloud.gray.server.module.SimpleGrayServerTrackModule;
+import cn.springcloud.gray.server.module.jpa.JPAGrayInstanceRecordEvictor;
+import cn.springcloud.gray.server.module.jpa.JPAGrayServerModule;
+import cn.springcloud.gray.server.module.jpa.JPAGrayServerTrackModule;
 import cn.springcloud.gray.server.service.*;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.domain.EntityScan;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
@@ -39,19 +43,38 @@ public GrayServerModule grayServerModule(
                 GrayEventPublisher grayEventPublisher,
                 GrayServiceService grayServiceService, GrayInstanceService grayInstanceService,
                 GrayDecisionService grayDecisionService, GrayPolicyService grayPolicyService) {
-            return new SimpleGrayServerModule(
+            return new JPAGrayServerModule(
                     grayServerProperties, grayEventPublisher, grayServiceService, grayInstanceService,
                     grayDecisionService, grayPolicyService);
         }
 
 
         @Bean
         public GrayServerTrackModule grayServerTrackModule(GrayEventPublisher grayEventPublisher, GrayTrackService grayTrackService) {
-            return new SimpleGrayServerTrackModule(grayEventPublisher, grayTrackService);
+            return new JPAGrayServerTrackModule(grayEventPublisher, grayTrackService);
         }
 
     }
 
+
+    @Configuration
+    @ConditionalOnProperty("gray.server.instance.eviction.enabled")
+    public static class JPAGrayInstanceRecordEvictionConfiguration {
+
+        @Bean
+        @ConditionalOnMissingBean
+        public GrayInstanceRecordEvictor grayInstanceRecordEvictor(
+                GrayInstanceService grayInstanceService, GrayServerProperties grayServerProperties) {
+            GrayServerProperties.InstanceRecordEvictProperties evictProperties =
+                    grayServerProperties.getInstance().getEviction();
+            return new JPAGrayInstanceRecordEvictor(grayInstanceService,
+                    evictProperties.getEvictionInstanceStatus(),
+                    evictProperties.getLastUpdateDateExpireDays());
+        }
+
+
+    }
+
     @Bean
     public PlatformTransactionManager transactionManager(DataSource dataSource) {
         return new DataSourceTransactionManager(dataSource);

spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/configuration/GrayServerAutoConfiguration.java

@@ -33,8 +33,6 @@ public class GrayServerAutoConfiguration {
     @Autowired
     private GrayServerProperties grayServerConfig;
 
-    @Autowired
-    private GrayServerModule grayServerModule;
 
     @Bean
     @ConditionalOnMissingBean
@@ -44,14 +42,15 @@ public RestTemplate restTemplate() {
 
     @Bean
     @ConditionalOnMissingBean
-    public DefaultGrayServiceManager defaultGrayServiceManager(GrayServerEvictor grayServerEvictor) {
+    public DefaultGrayServiceManager defaultGrayServiceManager(
+            GrayServerEvictor grayServerEvictor, GrayServerModule grayServerModule) {
         return new DefaultGrayServiceManager(grayServerConfig, grayServerModule, grayServerEvictor);
     }
 
 
     @Bean
     public GrayServerInitializingDestroyBean grayServerInitializingBean(GrayServiceManager grayServiceManager) {
-        return new GrayServerInitializingDestroyBean(grayServiceManager);
+        return new GrayServerInitializingDestroyBean(grayServiceManager, grayServerConfig);
     }
 
 

spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/configuration/properties/GrayServerProperties.java

@@ -8,16 +8,56 @@
 import java.util.Arrays;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.concurrent.TimeUnit;
 
 @Setter
 @Getter
 @ConfigurationProperties(prefix = "gray.server")
 public class GrayServerProperties {
 
-    private int evictionIntervalTimerInMs = 60000;
+    private long evictionIntervalTimerInMs = TimeUnit.SECONDS.toMillis(60);
 
-    private Set<InstanceStatus> normalInstanceStatus =
-            new HashSet<>(Arrays.asList(InstanceStatus.STARTING, InstanceStatus.UP));
+    private InstanceProperties instance = new InstanceProperties();
 
+    @Setter
+    @Getter
+    public static class InstanceProperties {
 
+        private Set<InstanceStatus> normalInstanceStatus =
+                new HashSet<>(Arrays.asList(InstanceStatus.STARTING, InstanceStatus.UP));
+
+
+        private InstanceRecordEvictProperties eviction = new InstanceRecordEvictProperties();
+
+
+    }
+
+
+    /**
+     * 灰度实例的清理配置参数
+     */
+    @Setter
+    @Getter
+    public static class InstanceRecordEvictProperties {
+
+        private boolean enabled;
+
+        /**
+         * 定时执行的时间周期
+         */
+        private long evictionIntervalTimerInMs = TimeUnit.DAYS.toMillis(1l);
+
+
+        /**
+         * 将被清理的状态
+         */
+        private Set<InstanceStatus> evictionInstanceStatus =
+                new HashSet<>(Arrays.asList(InstanceStatus.DOWN, InstanceStatus.UNKNOWN));
+
+
+        /**
+         * 最后更新时间过期天数
+         */
+        private int lastUpdateDateExpireDays = 1;
+    }
 }

spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/dao/model/GrayInstanceDO.java

@@ -3,6 +3,7 @@
 import lombok.*;
 
 import javax.persistence.*;
+import java.util.Date;
 
 @Setter
 @Getter
@@ -21,6 +22,8 @@ public class GrayInstanceDO {
     private String host;
     @Column(length = 5)
     private Integer port;
+    @Column
+    private Date lastUpdateDate;
 
     /**
      * 实例状态

spring-cloud-gray-server/src/main/java/cn/springcloud/gray/server/dao/repository/GrayInstanceRepository.java

@@ -6,6 +6,7 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
+import java.util.Date;
 import java.util.List;
 
 @Repository
@@ -21,4 +22,7 @@ public interface GrayInstanceRepository extends JpaRepository<GrayInstanceDO, St
     List<GrayInstanceDO> findAllByServiceIdAndInstanceStatusIn(String serviceId, String[] instanceStatus);
 
     List<GrayInstanceDO> findAllByGrayStatusAndInstanceStatusIn(String grayStatus, String[] instanceStatus);
+
+
+    List<GrayInstanceDO> findAllByLastUpdateDateBeforeAndInstanceStatusIn(Date lastUpdateDate, String[] instanceStatus);
 }