feat(apollo-client): add method interestedChangedKeys to ConfigChangeEvent

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/AbstractConfig.java

@@ -24,6 +24,7 @@
 import com.ctrip.framework.apollo.exceptions.ApolloConfigException;
 import com.ctrip.framework.apollo.model.ConfigChange;
 import com.ctrip.framework.apollo.model.ConfigChangeEvent;
+import com.ctrip.framework.apollo.model.InterestedConfigChangeEvent;
 import com.ctrip.framework.apollo.tracer.Tracer;
 import com.ctrip.framework.apollo.tracer.spi.Transaction;
 import com.ctrip.framework.apollo.util.ConfigUtil;
@@ -37,15 +38,12 @@
 import com.google.common.collect.Lists;
 import com.google.common.collect.Maps;
 import com.google.common.collect.Sets;
+
+import java.util.*;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import java.util.Date;
-import java.util.List;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Properties;
-import java.util.Set;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.atomic.AtomicLong;
@@ -454,32 +452,50 @@ protected void clearConfigCache() {
     }
   }
 
+  /**
+   * @param changes map's key is config property's key
+   */
+  protected void fireConfigChange(String namespace, Map<String, ConfigChange> changes) {
+    final Set<String> changedKeys = changes.keySet();
+    for (final ConfigChangeListener listener : this.m_listeners) {
+      Set<String> interestedChangedKeys = resolveInterestedChangedKeys(listener, changedKeys);
+      InterestedConfigChangeEvent interestedConfigChangeEvent = new InterestedConfigChangeEvent(
+          namespace, changes, interestedChangedKeys);
+      // reuse
+      this.fireConfigChange(interestedConfigChangeEvent);
+    }
+  }
+
   protected void fireConfigChange(final ConfigChangeEvent changeEvent) {
     for (final ConfigChangeListener listener : m_listeners) {
       // check whether the listener is interested in this change event
       if (!isConfigChangeListenerInterested(listener, changeEvent)) {
         continue;
       }
-      m_executorService.submit(new Runnable() {
-        @Override
-        public void run() {
-          String listenerName = listener.getClass().getName();
-          Transaction transaction = Tracer.newTransaction("Apollo.ConfigChangeListener", listenerName);
-          try {
-            listener.onChange(changeEvent);
-            transaction.setStatus(Transaction.SUCCESS);
-          } catch (Throwable ex) {
-            transaction.setStatus(ex);
-            Tracer.logError(ex);
-            logger.error("Failed to invoke config change listener {}", listenerName, ex);
-          } finally {
-            transaction.complete();
-          }
-        }
-      });
+      this.notifyAsync(listener, changeEvent);
     }
   }
 
+  private void notifyAsync(final ConfigChangeListener listener, final ConfigChangeEvent changeEvent) {
+    m_executorService.submit(new Runnable() {
+      @Override
+      public void run() {
+        String listenerName = listener.getClass().getName();
+        Transaction transaction = Tracer.newTransaction("Apollo.ConfigChangeListener", listenerName);
+        try {
+          listener.onChange(changeEvent);
+          transaction.setStatus(Transaction.SUCCESS);
+        } catch (Throwable ex) {
+          transaction.setStatus(ex);
+          Tracer.logError(ex);
+          logger.error("Failed to invoke config change listener {}", listenerName, ex);
+        } finally {
+          transaction.complete();
+        }
+      }
+    });
+  }
+
   private boolean isConfigChangeListenerInterested(ConfigChangeListener configChangeListener, ConfigChangeEvent configChangeEvent) {
     Set<String> interestedKeys = m_interestedKeys.get(configChangeListener);
     Set<String> interestedKeyPrefixes = m_interestedKeyPrefixes.get(configChangeListener);
@@ -510,6 +526,32 @@ private boolean isConfigChangeListenerInterested(ConfigChangeListener configChan
     return false;
   }
 
+  private Set<String> resolveInterestedChangedKeys(ConfigChangeListener configChangeListener, Set<String> changedKeys) {
+    Set<String> interestedChangedKeys = new HashSet<>();
+
+    if (this.m_interestedKeys.containsKey(configChangeListener)) {
+      Set<String> interestedKeys = this.m_interestedKeys.get(configChangeListener);
+      for (String interestedKey : interestedKeys) {
+        if (changedKeys.contains(interestedKey)) {
+          interestedChangedKeys.add(interestedKey);
+        }
+      }
+    }
+
+    if (this.m_interestedKeyPrefixes.containsKey(configChangeListener)) {
+      Set<String> interestedKeyPrefixes = this.m_interestedKeyPrefixes.get(configChangeListener);
+      for (String interestedKeyPrefix : interestedKeyPrefixes) {
+        for (String changedKey : changedKeys) {
+          if (changedKey.startsWith(interestedKeyPrefix)) {
+            interestedChangedKeys.add(changedKey);
+          }
+        }
+      }
+    }
+
+    return Collections.unmodifiableSet(interestedChangedKeys);
+  }
+
   List<ConfigChange> calcPropertyChanges(String namespace, Properties previous,
                                          Properties current) {
     if (previous == null) {

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultConfig.java

@@ -34,7 +34,6 @@
 import com.ctrip.framework.apollo.core.utils.ClassLoaderUtil;
 import com.ctrip.framework.apollo.enums.PropertyChangeType;
 import com.ctrip.framework.apollo.model.ConfigChange;
-import com.ctrip.framework.apollo.model.ConfigChangeEvent;
 import com.ctrip.framework.apollo.tracer.Tracer;
 import com.ctrip.framework.apollo.util.ExceptionUtil;
 import com.google.common.collect.ImmutableMap;
@@ -163,7 +162,7 @@ public synchronized void onRepositoryChange(String namespace, Properties newProp
       return;
     }
 
-    this.fireConfigChange(new ConfigChangeEvent(m_namespace, actualChanges));
+    this.fireConfigChange(m_namespace, actualChanges);
 
     Tracer.logEvent("Apollo.Client.ConfigChanges", m_namespace);
   }

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/SimpleConfig.java

@@ -27,7 +27,6 @@
 import org.slf4j.LoggerFactory;
 
 import com.ctrip.framework.apollo.model.ConfigChange;
-import com.ctrip.framework.apollo.model.ConfigChangeEvent;
 import com.ctrip.framework.apollo.tracer.Tracer;
 import com.ctrip.framework.apollo.util.ExceptionUtil;
 import com.google.common.base.Function;
@@ -112,7 +111,7 @@ public String apply(ConfigChange input) {
     updateConfig(newConfigProperties, m_configRepository.getSourceType());
     clearConfigCache();
 
-    this.fireConfigChange(new ConfigChangeEvent(m_namespace, changeMap));
+    this.fireConfigChange(m_namespace, changeMap);
 
     Tracer.logEvent("Apollo.Client.ConfigChanges", m_namespace);
   }

apollo-client/src/main/java/com/ctrip/framework/apollo/model/ConfigChangeEvent.java

@@ -16,6 +16,7 @@
  */
 package com.ctrip.framework.apollo.model;
 
+import java.util.Collections;
 import java.util.Map;
 import java.util.Set;
 
@@ -26,16 +27,15 @@
 public class ConfigChangeEvent {
   private final String m_namespace;
   private final Map<String, ConfigChange> m_changes;
-
   /**
    * Constructor.
    * @param namespace the namespace of this change
    * @param changes the actual changes
    */
   public ConfigChangeEvent(String namespace,
                            Map<String, ConfigChange> changes) {
-    m_namespace = namespace;
-    m_changes = changes;
+    this.m_namespace = namespace;
+    this.m_changes = changes;
   }
 
   /**
@@ -46,6 +46,14 @@ public Set<String> changedKeys() {
     return m_changes.keySet();
   }
 
+  /**
+   * @return interested and changed keys
+   * @see InterestedConfigChangeEvent#interestedChangedKeys()
+   */
+  public Set<String> interestedChangedKeys() {
+    return Collections.emptySet();
+  }
+
   /**
    * Get a specific change instance for the key specified.
    * @param key the changed key

apollo-client/src/main/java/com/ctrip/framework/apollo/model/InterestedConfigChangeEvent.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2021 Apollo Authors
+ *
+ * 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 the License.
+ *
+ */
+package com.ctrip.framework.apollo.model;
+
+import com.ctrip.framework.apollo.Config;
+import com.ctrip.framework.apollo.ConfigChangeListener;
+import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
+import java.util.Collections;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * In {@link ApolloConfigChangeListener} you set some interested key's rule, you can get those keys
+ * by this class's instance.
+ *
+ * @author wxq
+ */
+public class InterestedConfigChangeEvent extends ConfigChangeEvent {
+
+  /**
+   * @see Config#addChangeListener(ConfigChangeListener, Set)
+   * @see Config#addChangeListener(ConfigChangeListener, Set, Set)
+   * @see ApolloConfigChangeListener#interestedKeys()
+   * @see ApolloConfigChangeListener#interestedKeyPrefixes()
+   */
+  private final Set<String> m_interestedChangedKeys;
+
+  public InterestedConfigChangeEvent(String namespace,
+      Map<String, ConfigChange> changes, Set<String> interestedChangedKeys) {
+    super(namespace, changes);
+    this.m_interestedChangedKeys = interestedChangedKeys;
+  }
+
+  /**
+   * @return interested and changed keys
+   */
+  @Override
+  public Set<String> interestedChangedKeys() {
+    return Collections.unmodifiableSet(this.m_interestedChangedKeys);
+  }
+}

apollo-client/src/test/java/com/ctrip/framework/apollo/internals/DefaultConfigTest.java

@@ -751,7 +751,18 @@ public void onChange(ConfigChangeEvent changeEvent) {
     ConfigChangeEvent changeEvent = interestedInAllKeysFuture.get(500, TimeUnit.MILLISECONDS);
 
     assertEquals(someChangeEvent, changeEvent);
-    assertEquals(someChangeEvent, interestedInSomeKeyFuture.get(500, TimeUnit.MILLISECONDS));
+
+    {
+      // hidden variables in scope
+      ConfigChangeEvent actualConfigChangeEvent = interestedInSomeKeyFuture.get(500, TimeUnit.MILLISECONDS);
+      assertEquals(someChangeEvent.changedKeys(), actualConfigChangeEvent.changedKeys());
+      for (String changedKey : someChangeEvent.changedKeys()) {
+        ConfigChange expectConfigChange = someChangeEvent.getChange(changedKey);
+        ConfigChange actualConfigChange = actualConfigChangeEvent.getChange(changedKey);
+        assertEquals(expectConfigChange, actualConfigChange);
+      }
+    }
+
     assertFalse(interestedInSomeKeyNotChangedFuture.isDone());
   }
 

apollo-client/src/test/java/com/ctrip/framework/apollo/model/InterestedConfigChangeEventTest.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2021 Apollo Authors
+ *
+ * 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 the License.
+ *
+ */
+package com.ctrip.framework.apollo.model;
+
+import static org.junit.Assert.*;
+
+import com.ctrip.framework.apollo.ConfigChangeListener;
+import com.ctrip.framework.apollo.enums.ConfigSourceType;
+import com.ctrip.framework.apollo.enums.PropertyChangeType;
+import com.ctrip.framework.apollo.internals.AbstractConfig;
+import com.google.common.util.concurrent.SettableFuture;
+import java.util.Collections;
+import java.util.Map;
+import java.util.Set;
+import java.util.UUID;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+import org.junit.Test;
+import org.mockito.Matchers;
+
+import static org.mockito.Mockito.*;
+
+/**
+ * @author wxq
+ */
+public class InterestedConfigChangeEventTest {
+
+  @Test
+  public void TestInterestedChangedKeys()
+      throws ExecutionException, InterruptedException, TimeoutException {
+
+    final String namespace = "app";
+    final String keyPrefix = "key-abc.";
+    final String key = keyPrefix + UUID.randomUUID().toString();
+
+    final SettableFuture<ConfigChangeEvent> onChangeFuture = SettableFuture.create();
+    ConfigChangeListener configChangeListener = spy(new ConfigChangeListener() {
+      @Override
+      public void onChange(ConfigChangeEvent changeEvent) {
+        assertEquals(namespace, changeEvent.getNamespace());
+        assertEquals(1, changeEvent.interestedChangedKeys().size());
+        assertTrue(changeEvent.interestedChangedKeys().contains(key));
+        onChangeFuture.set(changeEvent);
+      }
+    });
+
+    UnsupportedOperationConfig config = new UnsupportedOperationConfig();
+    config.addChangeListener(configChangeListener, Collections.singleton("key-nothing"), Collections.singleton(keyPrefix));
+    config.fireConfigChange(namespace, Collections.singletonMap(key,
+        new ConfigChange(namespace, key, "123", "456", PropertyChangeType.MODIFIED)));
+
+    onChangeFuture.get(500, TimeUnit.MILLISECONDS);
+
+    verify(configChangeListener, atLeastOnce()).onChange(Matchers.<ConfigChangeEvent>any());
+  }
+
+  /**
+   * @author wxq
+   */
+  private static class UnsupportedOperationConfig extends AbstractConfig {
+
+    @Override
+    public String getProperty(String key, String defaultValue) {
+      throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public Set<String> getPropertyNames() {
+      throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public ConfigSourceType getSourceType() {
+      throw new UnsupportedOperationException();
+    }
+
+    @Override
+    public void fireConfigChange(String namespace, Map<String, ConfigChange> changes) {
+      super.fireConfigChange(namespace, changes);
+    }
+  }
+}