Merge pull request #496 from tentativafc/master

Change metadata from gRPC.port to gRPC_port

Author: yidongnan

docs/en/client/configuration.md

@@ -65,7 +65,7 @@ There are a number of supported schemes, that you can use to determine the targe
   one and also supports `SVC` lookups. See also [Kubernetes Setup](../kubernetes.md).
 - `discovery` (Prio 6): \
   (Optional) Uses spring-cloud's `DiscoveryClient` to lookup appropriate targets. The connections will be refreshed
-  automatically during `HeartbeatEvent`s. Uses the `gRPC.port` metadata to determine the port, otherwise uses the
+  automatically during `HeartbeatEvent`s. Uses the `gRPC_port` metadata to determine the port, otherwise uses the
   service port. \
   Example: `discovery:///service-name`
 - `self` (Prio 0): \

docs/zh-CN/client/configuration.md

@@ -44,7 +44,7 @@ grpc.client.__name__.address=static://localhost:9090
 
 - `static`（优先级 4）: 一个简单的IP静态列表 （v4 和 v6）, 可用于连接到服务端 （支持 `localhost`）。 例如：`static://192.168.1:8080,10.0.0.1:1337`
 - [`dns`](https://github.com/grpc/grpc-java/blob/master/core/src/main/java/io/grpc/internal/DnsNameResolver.java#L66)（优先级 5）：解析并绑定到给定 DNS 名称的所有地址。 地址将被缓存，只有当现有连接被关闭 / 失败时才会刷新。 更多选项，例如 `SVC` 查找（对 kubernetes 有用），可以通过系统属性启用。 例如：`dns:///example.my.company`
-- `discovery` (优先级 6)：(可选) 使用 Spring Cloud 的`DiscoveryClient` 去查找合适的目标。 在 `HeartbeatEvent` 的时候，连接将自动刷新。 使用 `gRPC.port` 元数据来确定端口，否则使用服务端口。 示例： `discovery:///service-name`
+- `discovery` (优先级 6)：(可选) 使用 Spring Cloud 的`DiscoveryClient` 去查找合适的目标。 在 `HeartbeatEvent` 的时候，连接将自动刷新。 使用 `gRPC_port` 元数据来确定端口，否则使用服务端口。 示例： `discovery:///service-name`
 - `self`（优先级 0）：如果您使用 `grpc-server-spring-boot-starter` 并且不想指定自己的地址 / 端口，则可以使用 self 关键词作为 scheme 或者 address 。 这对于需要使用随机服务器端口以避免冲突的测试特别有用。 例如：`self`或`self:self`
 - `in-process`：这是一个特殊的方案，将使用 `InProcessChannelFactory` 来替代原有正常的 ChannelFactory。 并使用它连接到 [`InProcessServer`](../server/configuration.md#enabling-the-inprocessserver)。 例如：`in-process:foobar`
 - *custom*: 您可以通过 Java 的 `ServiceLoader` 或从 Spring 的应用上下文中选择要自定义的 [`NameResolverProvider`](https://javadoc.io/page/io.grpc/grpc-all/latest/io/grpc/NameResolverProvider.html) ，并将其注册到 `NameResolverRegistry` 上.

grpc-client-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/client/nameresolver/DiscoveryClientNameResolver.java

@@ -44,14 +44,16 @@
 
 /**
  * The DiscoveryClientNameResolver resolves the service hosts and their associated gRPC port using the channel's name
- * and spring's cloud {@link DiscoveryClient}. The ports are extracted from the {@code gRPC.port} metadata.
+ * and spring's cloud {@link DiscoveryClient}. The ports are extracted from the {@code gRPC_port} metadata.
  *
  * @author Michael ([email protected])
  * @author Daniel Theuke ([email protected])
  */
 @Slf4j
 public class DiscoveryClientNameResolver extends NameResolver {
 
+    @Deprecated
+    private static final String LEGACY_CLOUD_DISCOVERY_METADATA_PORT = "gRPC.port";
     private static final List<ServiceInstance> KEEP_PREVIOUS = null;
 
     private final String name;
@@ -243,9 +245,16 @@ private int getGRPCPort(final ServiceInstance instance) {
             if (metadata == null) {
                 return instance.getPort();
             }
-            final String portString = metadata.get(GrpcUtils.CLOUD_DISCOVERY_METADATA_PORT);
+            String portString = metadata.get(GrpcUtils.CLOUD_DISCOVERY_METADATA_PORT);
             if (portString == null) {
-                return instance.getPort();
+                portString = metadata.get(LEGACY_CLOUD_DISCOVERY_METADATA_PORT);
+                if (portString == null) {
+                    return instance.getPort();
+                } else {
+                    log.warn("Found legacy grpc port metadata '{}' for client '{}' use '{}' instead",
+                            LEGACY_CLOUD_DISCOVERY_METADATA_PORT, DiscoveryClientNameResolver.this.name,
+                            GrpcUtils.CLOUD_DISCOVERY_METADATA_PORT);
+                }
             }
             try {
                 return Integer.parseInt(portString);

grpc-common-spring-boot/src/main/java/net/devh/boot/grpc/common/util/GrpcUtils.java

@@ -29,7 +29,7 @@ public final class GrpcUtils {
     /**
      * The cloud discovery metadata key used to identify the grpc port.
      */
-    public static final String CLOUD_DISCOVERY_METADATA_PORT = "gRPC.port";
+    public static final String CLOUD_DISCOVERY_METADATA_PORT = "gRPC_port";
 
     /**
      * The constant for the grpc server port, -1 represents don't start an inter process server.

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/autoconfigure/GrpcMetadataConsulConfiguration.java

@@ -17,8 +17,8 @@
 
 package net.devh.boot.grpc.server.autoconfigure;
 
-import java.util.ArrayList;
-import java.util.List;
+import java.util.HashMap;
+import java.util.Map;
 
 import javax.annotation.PostConstruct;
 
@@ -52,11 +52,13 @@ public class GrpcMetadataConsulConfiguration {
     public void init() {
         if (consulRegistration != null) {
             final int port = grpcProperties.getPort();
-            List<String> tags = consulRegistration.getService().getTags();
-            tags = tags == null ? new ArrayList<>() : tags;
+            Map<String, String> meta = consulRegistration.getService().getMeta();
+            if (meta == null) {
+                meta = new HashMap<>();
+            }
             if (GrpcUtils.INTER_PROCESS_DISABLE != port) {
-                tags.add(GrpcUtils.CLOUD_DISCOVERY_METADATA_PORT + "=" + port);
-                consulRegistration.getService().setTags(tags);
+                meta.put(GrpcUtils.CLOUD_DISCOVERY_METADATA_PORT, Integer.toString(port));
+                consulRegistration.getService().setMeta(meta);
             }
         }
     }