eureka-client 部分属性中文注释

tanyunpeng · Sep 29, 2017 · 671d7fc · 671d7fc
1 parent 103e087
commit 671d7fc
Show file tree

Hide file tree

Showing 18 changed files with 287 additions and 97 deletions.
diff --git a/...nt-archaius2/src/main/java/com/netflix/appinfo/providers/Archaius2VipAddressResolver.java b/...nt-archaius2/src/main/java/com/netflix/appinfo/providers/Archaius2VipAddressResolver.java
@@ -34,7 +34,7 @@ public String resolveDeploymentContextBasedVipAddresses(String vipAddressMacro)
         Matcher matcher = VIP_ATTRIBUTES_PATTERN.matcher(result);
         while (matcher.find()) {
             String key = matcher.group(1);
-            String value = config.getString(key, "");
+            String value = config.getString(key, ""); // TODO 疑问：疑问，config 和 DynamicPropertyFactory.getInstance().
 
             logger.debug("att:" + matcher.group());
             logger.debug(", att key:" + key);

diff --git a/eureka-client/src/main/java/com/netflix/appinfo/AbstractEurekaIdentity.java b/eureka-client/src/main/java/com/netflix/appinfo/AbstractEurekaIdentity.java
@@ -1,18 +1,36 @@
 package com.netflix.appinfo;
 
+import com.netflix.yunai.Done;
+
 import javax.annotation.Nullable;
 
+/**
+ * Eureka 对象标识符抽象类
+ */
 public abstract class AbstractEurekaIdentity {
+
     public static final String PREFIX = "DiscoveryIdentity-";
 
     public static final String AUTH_NAME_HEADER_KEY = PREFIX + "Name";
     public static final String AUTH_VERSION_HEADER_KEY = PREFIX + "Version";
     public static final String AUTH_ID_HEADER_KEY = PREFIX + "Id";
 
+    /**
+     * @return 对象名
+     */
+    @Done(progress = 100)
     public abstract String getName();
 
+    /**
+     * @return 对象版本号
+     */
+    @Done(progress = 100)
     public abstract String getVersion();
 
+    /**
+     * @return 对象编号
+     */
     @Nullable
+    @Done(progress = 100)
     public abstract String getId();
 }
diff --git a/eureka-client/src/main/java/com/netflix/appinfo/AbstractInstanceConfig.java b/eureka-client/src/main/java/com/netflix/appinfo/AbstractInstanceConfig.java
@@ -15,41 +15,71 @@
  */
 package com.netflix.appinfo;
 
-import java.net.InetAddress;
-import java.net.UnknownHostException;
-import java.util.Map;
-
 import com.netflix.discovery.CommonConstants;
 import com.netflix.discovery.shared.Pair;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.net.InetAddress;
+import java.net.UnknownHostException;
+import java.util.Map;
+
 /**
  * An abstract instance info configuration with some defaults to get the users
  * started quickly.The users have to override only a few methods to register
  * their instance with eureka server.
  *
- * @author Karthik Ranganathan
+ * Eureka 应用对象配置抽象基类
  *
+ * @author Karthik Ranganathan
  */
 public abstract class AbstractInstanceConfig implements EurekaInstanceConfig {
+
     private static final Logger logger = LoggerFactory.getLogger(AbstractInstanceConfig.class);
 
     /**
      * @deprecated 2016-08-29 use {@link CommonConstants#DEFAULT_CONFIG_NAMESPACE}
      */
     @Deprecated
     public static final String DEFAULT_NAMESPACE = CommonConstants.DEFAULT_CONFIG_NAMESPACE;
-
+
+    /**
+     * 契约过期时间，单位：秒
+     */
     private static final int LEASE_EXPIRATION_DURATION_SECONDS = 90;
+    /**
+     * 租约续约频率，单位：秒。
+     */
     private static final int LEASE_RENEWAL_INTERVAL_SECONDS = 30;
+    /**
+     * 应用 https 端口关闭
+     */
     private static final boolean SECURE_PORT_ENABLED = false;
+    /**
+     * 应用 http 端口开启
+     */
     private static final boolean NON_SECURE_PORT_ENABLED = true;
+    /**
+     * 应用 http 端口
+     */
     private static final int NON_SECURE_PORT = 80;
+    /**
+     * 应用 https 端口
+     */
     private static final int SECURE_PORT = 443;
+    /**
+     * 应用初始化后开启
+     */
     private static final boolean INSTANCE_ENABLED_ON_INIT = false;
+    /**
+     * 主机信息
+     * key：主机 IP 地址
+     * value：主机名
+     */
     private static final Pair<String, String> hostInfo = getHostInfo();
+    /**
+     * 数据中心信息
+     */
     private DataCenterInfo info = new DataCenterInfo() {
         @Override
         public Name getName() {

diff --git a/eureka-client/src/main/java/com/netflix/appinfo/AmazonInfo.java b/eureka-client/src/main/java/com/netflix/appinfo/AmazonInfo.java
@@ -16,6 +16,16 @@
 
 package com.netflix.appinfo;
 
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.netflix.discovery.converters.jackson.builder.StringInterningAmazonInfoBuilder;
+import com.netflix.discovery.internal.util.AmazonInfoUtils;
+import com.thoughtworks.xstream.annotations.XStreamOmitField;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
@@ -27,16 +37,6 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-import com.fasterxml.jackson.annotation.JsonCreator;
-import com.fasterxml.jackson.annotation.JsonIgnore;
-import com.fasterxml.jackson.annotation.JsonProperty;
-import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
-import com.netflix.discovery.converters.jackson.builder.StringInterningAmazonInfoBuilder;
-import com.netflix.discovery.internal.util.AmazonInfoUtils;
-import com.thoughtworks.xstream.annotations.XStreamOmitField;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 /**
  * An AWS specific {@link DataCenterInfo} implementation.
  *
@@ -143,7 +143,6 @@ public String toString() {
         }
     }
 
-
     public static final class Builder {
         private static final Logger logger = LoggerFactory.getLogger(Builder.class);
         private static final int SLEEP_TIME_MS = 100;

diff --git a/eureka-client/src/main/java/com/netflix/appinfo/AmazonInfoConfig.java b/eureka-client/src/main/java/com/netflix/appinfo/AmazonInfoConfig.java
@@ -1,10 +1,13 @@
 package com.netflix.appinfo;
 
+import com.netflix.yunai.Done;
+
 /**
  * Config related to loading of amazon metadata from the EC2 metadata url.
  *
  * @author David Liu
  */
+@Done
 public interface AmazonInfoConfig {
 
     /**

diff --git a/eureka-client/src/main/java/com/netflix/appinfo/ApplicationInfoManager.java b/eureka-client/src/main/java/com/netflix/appinfo/ApplicationInfoManager.java
@@ -16,17 +16,18 @@
 
 package com.netflix.appinfo;
 
-import javax.inject.Inject;
-import javax.inject.Singleton;
-import java.util.Map;
-import java.util.concurrent.ConcurrentHashMap;
-
 import com.netflix.appinfo.InstanceInfo.InstanceStatus;
 import com.netflix.appinfo.providers.EurekaConfigBasedInstanceInfoProvider;
 import com.netflix.discovery.StatusChangeEvent;
+import com.netflix.yunai.Done;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.inject.Inject;
+import javax.inject.Singleton;
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
 /**
  * The class that initializes information required for registration with
  * <tt>Eureka Server</tt> and to be discovered by other components.
@@ -45,6 +46,7 @@
  *
  */
 @Singleton
+@Done
 public class ApplicationInfoManager {
     private static final Logger logger = LoggerFactory.getLogger(ApplicationInfoManager.class);
 

diff --git a/eureka-client/src/main/java/com/netflix/appinfo/DataCenterInfo.java b/eureka-client/src/main/java/com/netflix/appinfo/DataCenterInfo.java
@@ -24,7 +24,8 @@
 
 /**
  * A simple interface for indicating which <em>datacenter</em> a particular instance belongs.
- *
+ * <p>
+ * 数据中心信息接口，标记所属数据中心名
  *
  * @author Karthik Ranganathan
  */
@@ -33,7 +34,17 @@
 @JsonTypeIdResolver(DataCenterTypeInfoResolver.class)
 public interface DataCenterInfo {
 
-    enum Name {Netflix, Amazon, MyOwn}
+    /**
+     * 数据中心名枚举
+     */
+    enum Name {
+        Netflix,
+        Amazon,
+        MyOwn
+    }
 
+    /**
+     * @return 归属的数据中心名
+     */
     Name getName();
-}
+}
diff --git a/eureka-client/src/main/java/com/netflix/appinfo/EurekaClientIdentity.java b/eureka-client/src/main/java/com/netflix/appinfo/EurekaClientIdentity.java
@@ -1,9 +1,14 @@
 package com.netflix.appinfo;
 
+import com.netflix.yunai.Done;
+
 /**
  * This class holds metadata information related to eureka client auth with the eureka server
+ *
+ * Eureka 客户端标识符
  */
 public class EurekaClientIdentity extends AbstractEurekaIdentity {
+
     public static final String DEFAULT_CLIENT_NAME = "DefaultClient";
 
     private final String clientVersion = "1.4";
@@ -20,17 +25,21 @@ public EurekaClientIdentity(String id, String clientName) {
     }
 
     @Override
+    @Done(progress = 100)
     public String getName() {
         return clientName;
     }
 
     @Override
+    @Done(progress = 100)
     public String getVersion() {
         return clientVersion;
     }
 
     @Override
+    @Done(progress = 100)
     public String getId() {
         return id;
     }
+
 }