integrate Nacos as configuration center with NacosDynamicConfigManager

sofastack · Aug 4, 2024 · 70352c2 · 70352c2
1 parent 82b691e
commit 70352c2
Show file tree

Hide file tree

Showing 8 changed files with 304 additions and 0 deletions.
diff --git a/all/pom.xml b/all/pom.xml
@@ -315,6 +315,11 @@
             <artifactId>sofa-rpc-config-zk</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.alipay.sofa</groupId>
+            <artifactId>sofa-rpc-config-nacos</artifactId>
+            <version>${project.version}</version>
+        </dependency>
         <dependency>
             <groupId>com.alipay.sofa</groupId>
             <artifactId>bolt</artifactId>
@@ -571,6 +576,7 @@
                                     <include>com.alipay.sofa:sofa-rpc-tracer-opentracing-triple</include>
                                     <include>com.alipay.sofa:sofa-rpc-config-apollo</include>
                                     <include>com.alipay.sofa:sofa-rpc-config-zk</include>
+                                    <include>com.alipay.sofa:sofa-rpc-config-nacos</include>
                                     <include>com.alipay.sofa:sofa-rpc-doc-swagger</include>
                                     <!-- TODO -->
                                 </includes>

diff --git a/config/config-nacos/pom.xml b/config/config-nacos/pom.xml
@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.alipay.sofa</groupId>
+        <artifactId>sofa-rpc-config</artifactId>
+        <version>${revision}</version>
+    </parent>
+
+    <artifactId>sofa-rpc-config-nacos</artifactId>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.alipay.sofa</groupId>
+            <artifactId>sofa-rpc-log-common-tools</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.alipay.sofa</groupId>
+            <artifactId>sofa-rpc-log</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.alipay.sofa</groupId>
+            <artifactId>sofa-rpc-api</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>com.alibaba.nacos</groupId>
+            <artifactId>nacos-client</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-log4j12</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+    </dependencies>
+
+    <build>
+        <sourceDirectory>src/main/java</sourceDirectory>
+        <resources>
+            <resource>
+                <directory>src/main/resources</directory>
+                <filtering>false</filtering>
+                <includes>
+                    <include>**/**</include>
+                </includes>
+            </resource>
+        </resources>
+        <testSourceDirectory>src/test/java</testSourceDirectory>
+        <testResources>
+            <testResource>
+                <directory>src/test/resources</directory>
+                <filtering>false</filtering>
+                <includes>
+                    <include>**/**</include>
+                </includes>
+            </testResource>
+        </testResources>
+
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>${maven.compiler.source}</source>
+                    <target>${maven.compiler.source}</target>
+                    <encoding>${project.build.sourceEncoding}</encoding>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-install-plugin</artifactId>
+                <configuration>
+                    <skip>${module.install.skip}</skip>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-deploy-plugin</artifactId>
+                <configuration>
+                    <skip>${module.deploy.skip}</skip>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <configuration>
+                    <skipTests>${skipTests}</skipTests>
+                    <includes>
+                        <!-- 这里需要根据自己的需要指定要跑的单元测试 -->
+                        <include>**/*Test.java</include>
+                    </includes>
+                    <!-- 如无特殊需求，将forkMode设置为once -->
+                    <forkMode>once</forkMode>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/...nfig-nacos/src/main/java/com/alipay/sofa/rpc/dynamic/nacos/NaocsDynamicConfigManager.java b/...nfig-nacos/src/main/java/com/alipay/sofa/rpc/dynamic/nacos/NaocsDynamicConfigManager.java
@@ -0,0 +1,111 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.alipay.sofa.rpc.dynamic.nacos;
+
+import com.alibaba.nacos.api.PropertyKeyConst;
+import com.alipay.sofa.common.config.SofaConfigs;
+import com.alipay.sofa.rpc.auth.AuthRuleGroup;
+import com.alipay.sofa.rpc.common.config.RpcConfigKeys;
+import com.alipay.sofa.rpc.dynamic.DynamicConfigKeyHelper;
+import com.alipay.sofa.rpc.dynamic.DynamicConfigManager;
+import com.alipay.sofa.rpc.dynamic.DynamicHelper;
+import com.alipay.sofa.rpc.ext.Extension;
+import com.alibaba.nacos.api.config.ConfigService;
+import com.alibaba.nacos.api.exception.NacosException;
+import com.alibaba.nacos.api.config.ConfigFactory;
+
+import java.util.Properties;
+
+/**
+ * @author Narziss
+ * @version NaocsDynamicConfigManager.java, v 0.1 2024年07月26日 09:37 Narziss
+ */
+
+@Extension(value = "nacos", override = true)
+public class NaocsDynamicConfigManager extends DynamicConfigManager {
+
+    private static final String DEFAULT_NAMESPACE = "sofa-rpc";
+    private static final String ADDRESS           = SofaConfigs.getOrCustomDefault(RpcConfigKeys.NACOS_ADDRESS,
+                                                      "192.168.60.132:8848");
+    private static final String DEFAULT_GROUP     = "DEFAULT_GROUP";
+    private static final long   DEFAULT_TIMEOUT   = 5000;
+    private ConfigService       configService;
+    private Properties          nacosConfig       = new Properties();
+
+    protected NaocsDynamicConfigManager(String appName) {
+        super(appName);
+        try {
+            nacosConfig.put(PropertyKeyConst.SERVER_ADDR, ADDRESS);
+            nacosConfig.put(PropertyKeyConst.NAMESPACE, DEFAULT_NAMESPACE);
+            configService = ConfigFactory.createConfigService(nacosConfig);
+        } catch (NacosException e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void initServiceConfiguration(String service) {
+        //TODO not now
+
+    }
+
+    @Override
+    public String getProviderServiceProperty(String service, String key) {
+        try {
+            return configService.getConfig(DynamicConfigKeyHelper.buildProviderServiceProKey(service, key),
+                DEFAULT_GROUP, DEFAULT_TIMEOUT);
+        } catch (NacosException e) {
+            return DynamicHelper.DEFAULT_DYNAMIC_VALUE;
+        }
+    }
+
+    @Override
+    public String getConsumerServiceProperty(String service, String key) {
+        try {
+            return configService.getConfig(DynamicConfigKeyHelper.buildConsumerServiceProKey(service, key),
+                DEFAULT_GROUP, DEFAULT_TIMEOUT);
+        } catch (NacosException e) {
+            return DynamicHelper.DEFAULT_DYNAMIC_VALUE;
+        }
+    }
+
+    @Override
+    public String getProviderMethodProperty(String service, String method, String key) {
+        try {
+            return configService.getConfig(DynamicConfigKeyHelper.buildProviderMethodProKey(service, method, key),
+                DEFAULT_GROUP, DEFAULT_TIMEOUT);
+        } catch (NacosException e) {
+            return DynamicHelper.DEFAULT_DYNAMIC_VALUE;
+        }
+    }
+
+    @Override
+    public String getConsumerMethodProperty(String service, String method, String key) {
+        try {
+            return configService.getConfig(DynamicConfigKeyHelper.buildConsumerMethodProKey(service, method, key),
+                DEFAULT_GROUP, DEFAULT_TIMEOUT);
+        } catch (NacosException e) {
+            return DynamicHelper.DEFAULT_DYNAMIC_VALUE;
+        }
+    }
+
+    @Override
+    public AuthRuleGroup getServiceAuthRule(String service) {
+        //TODO 暂不支持
+        return null;
+    }
+}
diff --git a/...ain/resources/META-INF/services/sofa-rpc/com.alipay.sofa.rpc.dynamic.DynamicConfigManager b/...ain/resources/META-INF/services/sofa-rpc/com.alipay.sofa.rpc.dynamic.DynamicConfigManager
@@ -0,0 +1,2 @@
+nacos=com.alipay.sofa.rpc.dynamic.nacos.NaocsDynamicConfigManager
+
diff --git a/...-nacos/src/test/java/com/alipay/sofa/rpc/dynamic/nacos/NacosDynamicConfigManagerTest.java b/...-nacos/src/test/java/com/alipay/sofa/rpc/dynamic/nacos/NacosDynamicConfigManagerTest.java
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.alipay.sofa.rpc.dynamic.nacos;
+
+import com.alipay.sofa.rpc.dynamic.DynamicHelper;
+import com.alipay.sofa.rpc.log.Logger;
+import com.alipay.sofa.rpc.log.LoggerFactory;
+import org.junit.Assert;
+import org.junit.Test;
+
+public class NacosDynamicConfigManagerTest {
+
+    private final static Logger       logger                    = LoggerFactory
+                                                                    .getLogger(NacosDynamicConfigManagerTest.class);
+
+    private NaocsDynamicConfigManager nacosDynamicConfigManager = new NaocsDynamicConfigManager("test");
+
+    @Test
+    public void getProviderServiceProperty() {
+        String result = nacosDynamicConfigManager.getProviderServiceProperty("serviceName", "timeout");
+        Assert.assertEquals(DynamicHelper.DEFAULT_DYNAMIC_VALUE, result);
+    }
+
+    @Test
+    public void getConsumerServiceProperty() {
+    }
+
+    @Test
+    public void getProviderMethodProperty() {
+    }
+
+    @Test
+    public void getConsumerMethodProperty() {
+    }
+
+    @Test
+    public void getServiceAuthRule() {
+    }
+}
diff --git a/config/config-nacos/src/test/resources/log4j.xml b/config/config-nacos/src/test/resources/log4j.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
+<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/" debug="false">
+
+    <appender name="CONSOLE" class="org.apache.log4j.ConsoleAppender">
+        <layout class="org.apache.log4j.PatternLayout">
+            <param name="ConversionPattern" value="%d %t %5p [%c:%M:%L] - %m%n"/>
+        </layout>
+    </appender>
+
+    <root>
+        <level value="INFO"/>
+        <appender-ref ref="CONSOLE"/>
+    </root>
+
+</log4j:configuration>
diff --git a/config/pom.xml b/config/pom.xml
@@ -16,6 +16,7 @@
     <modules>
         <module>config-apollo</module>
         <module>config-zk</module>
+        <module>config-nacos</module>
     </modules>
 
     <dependencyManagement>

diff --git a/core/common/src/main/java/com/alipay/sofa/rpc/common/config/RpcConfigKeys.java b/core/common/src/main/java/com/alipay/sofa/rpc/common/config/RpcConfigKeys.java
@@ -149,4 +149,12 @@ public class RpcConfigKeys {
                                                                                         false,
                                                                                         "The address of Zookeeper configuration center.",
                                                                                         new String[] { "zookeeper_address" });
+
+    public static ConfigKey<String>         NACOS_ADDRESS                       = ConfigKey
+                                                                                    .build(
+                                                                                        "sofa.rpc.config.center.address",
+                                                                                        "127.0.0.1:8848",
+                                                                                        false,
+                                                                                        "The address of Nacos configuration center.",
+                                                                                        new String[] { "nacos_address" });
 }