feat(hbase-client): support custom config mode for dynamic reload (#422)

caojiajun · caojiajun · commit 344c187e61ff · 2025-06-19T10:18:52.000+08:00
diff --git a/camellia-hbase-client/camellia-hbase-spring-boot/src/main/java/com/netease/nim/camellia/hbase/springboot/CamelliaHBaseConfiguration.java b/camellia-hbase-client/camellia-hbase-spring-boot/src/main/java/com/netease/nim/camellia/hbase/springboot/CamelliaHBaseConfiguration.java
@@ -12,10 +12,14 @@
 import com.netease.nim.camellia.hbase.CamelliaHBaseTemplate;
 import com.netease.nim.camellia.hbase.conf.CamelliaHBaseConf;
 import com.netease.nim.camellia.hbase.connection.CamelliaHBaseConnectionFactory;
+import com.netease.nim.camellia.hbase.exception.CamelliaHBaseException;
 import com.netease.nim.camellia.hbase.resource.HBaseResource;
+import com.netease.nim.camellia.hbase.resource.HBaseTemplateResourceTableUpdater;
 import com.netease.nim.camellia.hbase.util.CamelliaHBaseInitUtil;
 import com.netease.nim.camellia.hbase.util.HBaseResourceUtil;
 import com.netease.nim.camellia.tools.utils.FileUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
@@ -31,6 +35,8 @@
 @EnableConfigurationProperties({CamelliaHBaseProperties.class})
 public class CamelliaHBaseConfiguration {
 
+    private static final Logger logger = LoggerFactory.getLogger(CamelliaHBaseConfiguration.class);
+
     @Bean
     @ConditionalOnMissingBean(value = {ProxyEnv.class})
     public ProxyEnv proxyEnv() {
@@ -122,8 +128,38 @@ public CamelliaHBaseTemplate hBaseTemplate(CamelliaHBaseProperties properties) {
                 throw new IllegalArgumentException("only support xml/yml");
             }
             return new CamelliaHBaseTemplate(env, camelliaApi, remote.getBid(), remote.getBgroup(), remote.isMonitor(), remote.getCheckIntervalMillis());
+        } else if (type == CamelliaHBaseProperties.Type.CUSTOM) {
+            CamelliaHBaseProperties.Custom custom = properties.getCustom();
+            String className = custom.getResourceTableUpdaterClassName();
+            if (className == null) {
+                throw new IllegalArgumentException("resourceTableUpdaterClassName missing");
+            }
+            HBaseTemplateResourceTableUpdater updater;
+            try {
+                Class<?> clazz;
+                try {
+                    clazz = Class.forName(className);
+                } catch (ClassNotFoundException e) {
+                    clazz = Thread.currentThread().getContextClassLoader().loadClass(className);
+                }
+                updater = (HBaseTemplateResourceTableUpdater) clazz.getConstructor().newInstance();
+                logger.info("HBaseTemplateResourceTableUpdater init success, class = {}", className);
+            } catch (Exception e) {
+                logger.error("HBaseTemplateResourceTableUpdater init error, class = {}", className, e);
+                throw new CamelliaHBaseException(e);
+            }
+            Map<String, String> conf = custom.getConf();
+            CamelliaHBaseConf camelliaHBaseConf = new CamelliaHBaseConf();
+            for (Map.Entry<String, String> entry : conf.entrySet()) {
+                camelliaHBaseConf.addConf(entry.getKey(), entry.getValue());
+            }
+            CamelliaHBaseEnv env = new CamelliaHBaseEnv.Builder()
+                    .connectionFactory(new CamelliaHBaseConnectionFactory.DefaultHBaseConnectionFactory(camelliaHBaseConf))
+                    .proxyEnv(proxyEnv())
+                    .build();
+            return new CamelliaHBaseTemplate(env, updater);
         } else {
-            throw new IllegalArgumentException("only support local/remote");
+            throw new IllegalArgumentException("only support local/remote/custom");
         }
     }
 }
diff --git a/camellia-hbase-client/camellia-hbase-spring-boot/src/main/java/com/netease/nim/camellia/hbase/springboot/CamelliaHBaseProperties.java b/camellia-hbase-client/camellia-hbase-spring-boot/src/main/java/com/netease/nim/camellia/hbase/springboot/CamelliaHBaseProperties.java
@@ -14,6 +14,7 @@ public class CamelliaHBaseProperties {
     private Type type = Type.LOCAL;
     private Local local = new Local();
     private Remote remote;
+    private Custom custom;
 
     public Type getType() {
         return type;
@@ -39,6 +40,14 @@ public void setRemote(Remote remote) {
         this.remote = remote;
     }
 
+    public Custom getCustom() {
+        return custom;
+    }
+
+    public void setCustom(Custom custom) {
+        this.custom = custom;
+    }
+
     public static class Local {
         private ConfType confType = ConfType.XML;
         private XML xml = new XML();
@@ -294,10 +303,32 @@ public static enum ConfType {
         }
     }
 
+    public static class Custom {
+        private String resourceTableUpdaterClassName;
+        private Map<String, String> conf = new HashMap<>();
+
+        public String getResourceTableUpdaterClassName() {
+            return resourceTableUpdaterClassName;
+        }
+
+        public void setResourceTableUpdaterClassName(String resourceTableUpdaterClassName) {
+            this.resourceTableUpdaterClassName = resourceTableUpdaterClassName;
+        }
+
+        public Map<String, String> getConf() {
+            return conf;
+        }
+
+        public void setConf(Map<String, String> conf) {
+            this.conf = conf;
+        }
+    }
+
 
     public static enum Type {
         LOCAL,
         REMOTE,
+        CUSTOM,
         ;
     }
 }
diff --git a/camellia-hbase-client/camellia-hbase/src/main/java/com/netease/nim/camellia/hbase/CamelliaHBaseTemplate.java b/camellia-hbase-client/camellia-hbase/src/main/java/com/netease/nim/camellia/hbase/CamelliaHBaseTemplate.java
@@ -7,7 +7,9 @@
 import com.netease.nim.camellia.core.util.ResourceTransferUtil;
 import com.netease.nim.camellia.hbase.resource.HBaseResource;
 import com.netease.nim.camellia.hbase.resource.HBaseResourceWrapper;
+import com.netease.nim.camellia.hbase.resource.HBaseTemplateResourceTableUpdater;
 import com.netease.nim.camellia.hbase.util.CamelliaHBaseInitUtil;
+import com.netease.nim.camellia.hbase.util.HBaseResourceUtil;
 import org.apache.hadoop.hbase.client.*;
 import org.apache.hadoop.hbase.filter.CompareFilter;
 
@@ -25,9 +27,11 @@ public class CamelliaHBaseTemplate implements ICamelliaHBaseTemplate {
     private static final boolean defaultMonitorEnable = false;
 
     private final ReloadableProxyFactory<CamelliaHBaseClientImpl> factory;
+    private final CamelliaApi service;
 
     public CamelliaHBaseTemplate(CamelliaHBaseEnv env, CamelliaApi service, long bid, String bgroup,
                                  boolean monitorEnable, long checkIntervalMillis) {
+        this.service = service;
         this.factory = new ReloadableProxyFactory.Builder<CamelliaHBaseClientImpl>()
                 .service(new ApiServiceWrapper(service, env))
                 .clazz(CamelliaHBaseClientImpl.class)
@@ -39,6 +43,28 @@ public CamelliaHBaseTemplate(CamelliaHBaseEnv env, CamelliaApi service, long bid
                 .build();
     }
 
+    public CamelliaHBaseTemplate(CamelliaHBaseEnv env, HBaseTemplateResourceTableUpdater updater) {
+        this(env, new LocalDynamicCamelliaApi(updater.getResourceTable(), HBaseResourceUtil.HBaseResourceTableChecker),
+                defaultBid, defaultBgroup, defaultMonitorEnable, defaultCheckIntervalMillis);
+        updater.addCallback(new ResourceTableUpdateCallback() {
+            @Override
+            public void callback(ResourceTable resourceTable) {
+                if (service instanceof LocalDynamicCamelliaApi) {
+                    ((LocalDynamicCamelliaApi) service).updateResourceTable(resourceTable);
+                }
+                reloadResourceTable();
+            }
+        });
+    }
+
+    public final void reloadResourceTable() {
+        factory.reload(false);
+    }
+
+    public CamelliaHBaseTemplate(HBaseTemplateResourceTableUpdater updater) {
+        this(CamelliaHBaseEnv.defaultHBaseEnv(), updater);
+    }
+
     public CamelliaHBaseTemplate(CamelliaHBaseEnv env, String url, long bid, String bgroup,
                                  boolean monitorEnable, long checkIntervalMillis,
                                  int connectTimeoutMillis, int readTimeoutMillis) {
diff --git a/camellia-hbase-client/camellia-hbase/src/main/java/com/netease/nim/camellia/hbase/resource/HBaseTemplateResourceTableUpdater.java b/camellia-hbase-client/camellia-hbase/src/main/java/com/netease/nim/camellia/hbase/resource/HBaseTemplateResourceTableUpdater.java
@@ -0,0 +1,16 @@
+package com.netease.nim.camellia.hbase.resource;
+
+import com.netease.nim.camellia.core.api.ResourceTableUpdater;
+import com.netease.nim.camellia.core.model.ResourceTable;
+import com.netease.nim.camellia.hbase.util.HBaseResourceUtil;
+
+
+public abstract class HBaseTemplateResourceTableUpdater extends ResourceTableUpdater {
+
+    @Override
+    public void checkResourceTable(ResourceTable resourceTable) {
+        super.checkResourceTable(resourceTable);
+        HBaseResourceUtil.checkResourceTable(resourceTable);
+    }
+
+}
diff --git a/camellia-redis-client/camellia-redis-spring-boot-starters/camellia-redis-spring-boot/src/main/java/com/netease/nim/camellia/redis/springboot/CamelliaRedisConfiguration.java b/camellia-redis-client/camellia-redis-spring-boot-starters/camellia-redis-spring-boot/src/main/java/com/netease/nim/camellia/redis/springboot/CamelliaRedisConfiguration.java
@@ -119,7 +119,7 @@ public CamelliaRedisTemplate camelliaRedisTemplate(CamelliaRedisProperties prope
             CamelliaRedisProperties.Custom custom = properties.getCustom();
             String className = custom.getResourceTableUpdaterClassName();
             if (className == null) {
-                throw new IllegalArgumentException("proxyRouteConfUpdaterClassName missing");
+                throw new IllegalArgumentException("resourceTableUpdaterClassName missing");
             }
             RedisTemplateResourceTableUpdater updater;
             try {

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ public CamelliaRedisTemplate camelliaRedisTemplate(CamelliaRedisProperties prope`
`119`	`119`	`CamelliaRedisProperties.Custom custom = properties.getCustom();`
`120`	`120`	`String className = custom.getResourceTableUpdaterClassName();`
`121`	`121`	`if (className == null) {`
`122`		`- throw new IllegalArgumentException("proxyRouteConfUpdaterClassName missing");`
	`122`	`+ throw new IllegalArgumentException("resourceTableUpdaterClassName missing");`
`123`	`123`	`}`
`124`	`124`	`RedisTemplateResourceTableUpdater updater;`
`125`	`125`	`try {`