support additional group from env

weibocom · Aug 2, 2022 · 180da70 · 180da70
1 parent d4ecb66
commit 180da70
Show file tree

Hide file tree

Showing 10 changed files with 230 additions and 111 deletions.
diff --git a/motan-core/src/main/java/com/weibo/api/motan/common/MotanConstants.java b/motan-core/src/main/java/com/weibo/api/motan/common/MotanConstants.java
@@ -161,6 +161,11 @@ public class MotanConstants {
     // ------------------ attachment constants -----------------
     public static final String ATT_PRINT_TRACE_LOG = "print_trace_log"; // 针对单请求是否打印（access）日志
 
+    // ------------------ common env name -----------------
+    public static final String ENV_ADDITIONAL_GROUP = "MOTAN_SERVICE_ADDITIONAL_GROUP"; //motan service 追加导出分组。例如可以自动追加云平台上的分组
+    public static final String ENV_MESH_PROXY = "MOTAN_MESH_PROXY"; //使用mesh代理motan请求的环境变量名
+    public static final String ENV_MOTAN_IP_PREFIX = "MOTAN_IP_PREFIX";
+
     private MotanConstants() {
     }
 

diff --git a/motan-core/src/main/java/com/weibo/api/motan/config/ServiceConfig.java b/motan-core/src/main/java/com/weibo/api/motan/config/ServiceConfig.java
@@ -30,6 +30,7 @@
 import com.weibo.api.motan.util.ConcurrentHashSet;
 import com.weibo.api.motan.util.LoggerUtil;
 import com.weibo.api.motan.util.NetUtils;
+import com.weibo.api.motan.util.StringTools;
 import org.apache.commons.lang3.StringUtils;
 
 import java.util.*;
@@ -43,15 +44,15 @@
 public class ServiceConfig<T> extends AbstractServiceConfig {
 
     private static final long serialVersionUID = -3342374271064293224L;
-    private static ConcurrentHashSet<String> existingServices = new ConcurrentHashSet<String>();
+    private static ConcurrentHashSet<String> existingServices = new ConcurrentHashSet<>();
     // 具体到方法的配置
     protected List<MethodConfig> methods;
 
     // 接口实现类引用
     private T ref;
 
     // service 对应的exporters，用于管理service服务的生命周期
-    private List<Exporter<T>> exporters = new CopyOnWriteArrayList<Exporter<T>>();
+    private List<Exporter<T>> exporters = new CopyOnWriteArrayList<>();
     private Class<T> interfaceClass;
     private BasicServiceInterfaceConfig basicService;
     private AtomicBoolean exported = new AtomicBoolean(false);
@@ -120,7 +121,7 @@ public synchronized void export() {
         for (ProtocolConfig protocolConfig : protocols) {
             Integer port = protocolPorts.get(protocolConfig.getId());
             if (port == null) {
-                throw new MotanServiceException(String.format("Unknow port in service:%s, protocol:%s", interfaceClass.getName(),
+                throw new MotanServiceException(String.format("Unknown port in service:%s, protocol:%s", interfaceClass.getName(),
                         protocolConfig.getId()));
             }
             doExport(protocolConfig, port);
@@ -142,7 +143,6 @@ public synchronized void unexport() {
         }
     }
 
-    @SuppressWarnings("unchecked")
     private void doExport(ProtocolConfig protocolConfig, int port) {
         String protocolName = protocolConfig.getName();
         if (protocolName == null || protocolName.length() == 0) {
@@ -157,7 +157,7 @@ private void doExport(ProtocolConfig protocolConfig, int port) {
             hostAddress = getLocalHostAddress();
         }
 
-        Map<String, String> map = new HashMap<String, String>();
+        Map<String, String> map = new HashMap<>();
 
         map.put(URLParamType.nodeType.getName(), MotanConstants.NODE_TYPE_SERVICE);
         map.put(URLParamType.refreshTimestamp.getName(), String.valueOf(System.currentTimeMillis()));
@@ -167,31 +167,33 @@ private void doExport(ProtocolConfig protocolConfig, int port) {
 
         URL serviceUrl = new URL(protocolName, hostAddress, port, interfaceClass.getName(), map);
 
+        String groupString = serviceUrl.getParameter(URLParamType.group.getName(), ""); // do not with default group value
+        String additionalGroup = System.getenv(MotanConstants.ENV_ADDITIONAL_GROUP);
+        if (StringUtils.isNotBlank(additionalGroup)) { // check additional groups
+            groupString = StringUtils.isBlank(groupString) ? additionalGroup : groupString + "," + additionalGroup;
+            serviceUrl.addParameter(URLParamType.group.getName(), groupString);
+        }
         // check multi group.
-        String groupString = serviceUrl.getGroup();
-        if (groupString.contains(MotanConstants.COMMA_SEPARATOR)){
-            String[] groups = groupString.split(MotanConstants.COMMA_SEPARATOR);
-            for (String group : groups){
-                if (StringUtils.isNotBlank(group)){ // create new service for each group
-                    URL newGroupServiceUrl = serviceUrl.createCopy();
-                    newGroupServiceUrl.addParameter(URLParamType.group.getName(), group.trim());
-                    exportService(hostAddress, protocolName, newGroupServiceUrl);
-                }
+        if (groupString.contains(MotanConstants.COMMA_SEPARATOR)) {
+            for (String group : StringTools.splitSet(groupString, MotanConstants.COMMA_SEPARATOR)) {
+                URL newGroupServiceUrl = serviceUrl.createCopy();
+                newGroupServiceUrl.addParameter(URLParamType.group.getName(), group);
+                exportService(hostAddress, protocolName, newGroupServiceUrl);
             }
-        }else {
+        } else {
             exportService(hostAddress, protocolName, serviceUrl);
         }
     }
 
-    private void exportService(String hostAddress, String protocol, URL serviceUrl){
+    private void exportService(String hostAddress, String protocol, URL serviceUrl) {
         if (serviceExists(serviceUrl)) {
             LoggerUtil.warn(String.format("%s configService is malformed, for same service (%s) already exists ", interfaceClass.getName(),
                     serviceUrl.getIdentity()));
             throw new MotanFrameworkException(String.format("%s configService is malformed, for same service (%s) already exists ",
                     interfaceClass.getName(), serviceUrl.getIdentity()), MotanErrorMsgConstant.FRAMEWORK_INIT_ERROR);
         }
         LoggerUtil.info("export for service url :" + serviceUrl.toFullStr());
-        List<URL> urls = new ArrayList<URL>();
+        List<URL> urls = new ArrayList<>();
 
         // injvm 协议只支持注册到本地，其他协议可以注册到local、remote
         if (MotanConstants.PROTOCOL_INJVM.equals(protocol)) {

diff --git a/motan-core/src/main/java/com/weibo/api/motan/protocol/support/ProtocolFilterDecorator.java b/motan-core/src/main/java/com/weibo/api/motan/protocol/support/ProtocolFilterDecorator.java
@@ -1,11 +1,11 @@
 /*
  * Copyright 2009-2016 Weibo, Inc.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
  * in compliance with the License. You may obtain a copy of the License at
- * 
+ *
  * http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software distributed under the License
  * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
  * or implied. See the License for the specific language governing permissions and limitations under
@@ -26,13 +26,11 @@
 import com.weibo.api.motan.filter.InitializableFilter;
 import com.weibo.api.motan.rpc.*;
 import com.weibo.api.motan.util.LoggerUtil;
+import com.weibo.api.motan.util.StringTools;
 import org.apache.commons.lang3.StringUtils;
 
 import java.lang.reflect.Method;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
+import java.util.*;
 
 import static com.weibo.api.motan.common.MotanConstants.DISABLE_FILTER_PREFIX;
 
@@ -210,7 +208,7 @@ public T getImpl() {
      */
     protected List<Filter> getFilters(URL url, String key) {
         // load default filters
-        List<Filter> filters = new ArrayList<Filter>();
+        List<Filter> filters = new ArrayList<>();
         List<Filter> defaultFilters = ExtensionLoader.getExtensionLoader(Filter.class).getExtensions(key);
         if (defaultFilters != null && defaultFilters.size() > 0) {
             filters.addAll(defaultFilters);
@@ -220,25 +218,26 @@ protected List<Filter> getFilters(URL url, String key) {
         String filterStr = url.getParameter(URLParamType.filter.getName());
         if (StringUtils.isNotBlank(filterStr)) {
             HashSet<String> removedFilters = new HashSet<>();
-            String[] filterNames = MotanConstants.COMMA_SPLIT_PATTERN.split(filterStr);
+            Set<String> filterNames = StringTools.splitSet(filterStr, MotanConstants.COMMA_SEPARATOR);
             for (String fn : filterNames) {
-                if (StringUtils.isBlank(fn)) {
-                    continue;
-                }
-                fn = fn.trim();
-                if (fn.startsWith(DISABLE_FILTER_PREFIX)){ // disable filter
-                    if (fn.length() > DISABLE_FILTER_PREFIX.length()){
+                if (fn.startsWith(DISABLE_FILTER_PREFIX)) { // disable filter
+                    if (fn.length() > DISABLE_FILTER_PREFIX.length()) {
                         removedFilters.add(fn.substring(DISABLE_FILTER_PREFIX.length()).trim());
                     }
-                }else {
-                    addIfAbsent(filters, fn);
+                } else {
+                    Filter extFilter = ExtensionLoader.getExtensionLoader(Filter.class).getExtension(fn, false);
+                    if (extFilter == null) {
+                        LoggerUtil.warn("filter extension not found. filer name: " + fn);
+                        continue;
+                    }
+                    filters.add(extFilter);
                 }
             }
 
             // remove disabled filters
-            if (!removedFilters.isEmpty()){
+            if (!removedFilters.isEmpty()) {
                 for (String removedName : removedFilters) {
-                    filters.removeIf((filter)-> removedName.equals(filter.getClass().getAnnotation(SpiMeta.class).name()));
+                    filters.removeIf((filter) -> removedName.equals(filter.getClass().getAnnotation(SpiMeta.class).name()));
                 }
             }
         }
@@ -248,24 +247,4 @@ protected List<Filter> getFilters(URL url, String key) {
         Collections.reverse(filters);
         return filters;
     }
-
-    private void addIfAbsent(List<Filter> filters, String extensionName) {
-        Filter extFilter = ExtensionLoader.getExtensionLoader(Filter.class).getExtension(extensionName, false);
-        if (extFilter == null) {
-            LoggerUtil.warn("filter extension not found. filer name: " + extensionName);
-            return;
-        }
-
-        boolean exists = false;
-        for (Filter f : filters) {
-            if (f.getClass() == extFilter.getClass()) {
-                exists = true;
-                break;
-            }
-        }
-        if (!exists) {
-            filters.add(extFilter);
-        }
-
-    }
 }
diff --git a/motan-core/src/main/java/com/weibo/api/motan/util/MeshProxyUtil.java b/motan-core/src/main/java/com/weibo/api/motan/util/MeshProxyUtil.java
@@ -18,6 +18,7 @@
 
 package com.weibo.api.motan.util;
 
+import com.weibo.api.motan.common.MotanConstants;
 import com.weibo.api.motan.common.URLParamType;
 import com.weibo.api.motan.core.extension.ExtensionLoader;
 import com.weibo.api.motan.registry.RegistryFactory;
@@ -32,8 +33,6 @@
  * @date 2022/7/14.
  */
 public class MeshProxyUtil {
-    public static final String MESH_PROXY_ENV_NAME = "MOTAN_MESH_PROXY"; //使用mesh代理motan请求的环境变量名
-
     // config keys
     private static final String MODE_KEY = "mode"; // proxy type key
     private static final String PORT_KEY = "port"; // mesh transport port for client end
@@ -155,7 +154,7 @@ private static String getValue(Map<String, String> configs, String key, String d
     // 检查是否支持mesh proxy
     private static void initCheck() {
         // check env set
-        String meshProxyString = System.getenv(MESH_PROXY_ENV_NAME);
+        String meshProxyString = System.getenv(MotanConstants.ENV_MESH_PROXY);
         if (StringUtils.isNotBlank(meshProxyString)) {
             LoggerUtil.info("find MOTAN_MESH_PROXY env, value:" + meshProxyString);
             proxyConfig = parseProxyConfig(meshProxyString);

diff --git a/motan-core/src/main/java/com/weibo/api/motan/util/NetUtils.java b/motan-core/src/main/java/com/weibo/api/motan/util/NetUtils.java
@@ -16,6 +16,7 @@
 
 package com.weibo.api.motan.util;
 
+import com.weibo.api.motan.common.MotanConstants;
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -40,8 +41,6 @@ public class NetUtils {
 
     public static final String ANYHOST = "0.0.0.0";
 
-    public static final String MOTAN_IP_PREFIX = "MOTAN_IP_PREFIX";
-
     private static volatile InetAddress LOCAL_ADDRESS = null;
 
     private static final Pattern LOCAL_IP_PATTERN = Pattern.compile("127(\\.\\d{1,3}){3}$");
@@ -73,14 +72,14 @@ public static InetAddress getLocalAddress() {
      * 查找策略：首先看是否已经查到ip --> 环境变量中指定的ip --> hostname对应的ip --> 根据连接目标端口得到的本地ip --> 轮询网卡
      * </pre>
      *
-     * @return loca ip
+     * @return local ip
      */
     public static InetAddress getLocalAddress(Map<String, Integer> destHostPorts) {
         if (LOCAL_ADDRESS != null) {
             return LOCAL_ADDRESS;
         }
         InetAddress localAddress = null;
-        String ipPrefix = System.getenv(MOTAN_IP_PREFIX);
+        String ipPrefix = System.getenv(MotanConstants.ENV_MOTAN_IP_PREFIX);
         if (StringUtils.isNotBlank(ipPrefix)) { // 环境变量中如果指定了motan使用的ip前缀，则使用与该前缀匹配的网卡ip作为本机ip。
             localAddress = getLocalAddressByNetworkInterface(ipPrefix);
             LoggerUtil.info("get local address by ip prefix: " + ipPrefix + ", address:" + localAddress);
@@ -115,7 +114,7 @@ private static InetAddress getLocalAddressByHostname() {
                 return localAddress;
             }
         } catch (Throwable e) {
-            logger.warn("Failed to retriving local address by hostname:" + e);
+            logger.warn("Failed to retrieving local address by hostname:" + e);
         }
         return null;
     }
@@ -129,20 +128,14 @@ private static InetAddress getLocalAddressBySocket(Map<String, Integer> destHost
             String host = entry.getKey();
             int port = entry.getValue();
             try {
-                Socket socket = new Socket();
-                try {
+                try (Socket socket = new Socket()) {
                     SocketAddress addr = new InetSocketAddress(host, port);
                     socket.connect(addr, 1000);
                     LoggerUtil.info("get local address from socket. remote host:" + host + ", port:" + port);
                     return socket.getLocalAddress();
-                } finally {
-                    try {
-                        socket.close();
-                    } catch (Throwable e) {
-                    }
                 }
             } catch (Exception e) {
-                LoggerUtil.warn(String.format("Failed to retriving local address by connecting to dest host:port(%s:%s) false, e=%s", host,
+                LoggerUtil.warn(String.format("Failed to retrieving local address by connecting to dest host:port(%s:%s) false, e=%s", host,
                         port, e));
             }
         }
@@ -169,16 +162,16 @@ private static InetAddress getLocalAddressByNetworkInterface(String prefix) {
                                     }
                                 }
                             } catch (Throwable e) {
-                                logger.warn("Failed to retriving ip address, " + e.getMessage(), e);
+                                logger.warn("Failed to retrieving ip address, " + e.getMessage(), e);
                             }
                         }
                     } catch (Throwable e) {
-                        logger.warn("Failed to retriving ip address, " + e.getMessage(), e);
+                        logger.warn("Failed to retrieving ip address, " + e.getMessage(), e);
                     }
                 }
             }
         } catch (Throwable e) {
-            logger.warn("Failed to retriving ip address, " + e.getMessage(), e);
+            logger.warn("Failed to retrieving ip address, " + e.getMessage(), e);
         }
         return null;
     }

diff --git a/motan-core/src/main/java/com/weibo/api/motan/util/StringTools.java b/motan-core/src/main/java/com/weibo/api/motan/util/StringTools.java
@@ -19,15 +19,13 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
 import java.net.URLEncoder;
-import java.util.Map;
-import java.util.TreeMap;
+import java.util.*;
 
 import org.apache.commons.lang3.StringUtils;
 
 import com.weibo.api.motan.common.MotanConstants;
 
 /**
- * 
  * String utils
  *
  * @author fishermen
@@ -72,7 +70,7 @@ public static String urlDecode(String value) {
     public static String toQueryString(Map<String, String> ps) {
         StringBuilder buf = new StringBuilder();
         if (ps != null && ps.size() > 0) {
-            for (Map.Entry<String, String> entry : new TreeMap<String, String>(ps).entrySet()) {
+            for (Map.Entry<String, String> entry : new TreeMap<>(ps).entrySet()) {
                 String key = entry.getKey();
                 String value = entry.getValue();
                 if (key != null && key.length() > 0 && value != null && value.length() > 0) {
@@ -87,4 +85,18 @@ public static String toQueryString(Map<String, String> ps) {
         }
         return buf.toString();
     }
+
+    // 切分string，去重去空
+    public static Set<String> splitSet(String str, String regex) {
+        Set<String> result = new HashSet<>();
+        if (str != null) {
+            String[] strings = str.split(regex);
+            for (String s : strings) {
+                if (StringUtils.isNotBlank(s)) {
+                    result.add(s.trim());
+                }
+            }
+        }
+        return result;
+    }
 }