[type:fix] Fix the nacos data sync model missing the contextPath conf…

…iguration (#5721) (#5722) * add nacosConfig contextPath param * config shenyu.sync.nacos.context-path default value: nacos --------- Co-authored-by: aias00 <rokkki@163.com> Co-authored-by: xiaoyu <xiaoyu@apache.org> Co-authored-by: moremind <hefengen@apache.org>
apache · Oct 31, 2024 · 134b48d · 134b48d
1 parent a2bcca7
commit 134b48d
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 2 deletions.
diff --git a/...n-listener-nacos/src/main/java/org/apache/shenyu/admin/config/NacosSyncConfiguration.java b/...n-listener-nacos/src/main/java/org/apache/shenyu/admin/config/NacosSyncConfiguration.java
@@ -72,6 +72,9 @@ public ConfigService nacosConfigService(final NacosProperties nacosProp) throws
             if (StringUtils.isNotBlank(nacosProp.getPassword())) {
                 properties.put(PropertyKeyConst.PASSWORD, nacosProp.getPassword());
             }
+            if (StringUtils.isNotBlank(nacosProp.getContextPath())) {
+                properties.put(PropertyKeyConst.CONTEXT_PATH, nacosProp.getContextPath());
+            }
         }
         return NacosFactory.createConfigService(properties);
     }

diff --git a/...stener-nacos/src/main/java/org/apache/shenyu/admin/config/properties/NacosProperties.java b/...stener-nacos/src/main/java/org/apache/shenyu/admin/config/properties/NacosProperties.java
@@ -33,6 +33,8 @@ public class NacosProperties {
 
     private String password;
 
+    private String contextPath;
+
     private NacosACMProperties acm;
 
     /**
@@ -107,6 +109,24 @@ public void setPassword(final String password) {
         this.password = password;
     }
 
+    /**
+     * Gets the value of contextPath.
+     *
+     * @return the value of contextPath
+     */
+    public String getContextPath() {
+        return contextPath;
+    }
+
+    /**
+     * Sets the contextPath.
+     *
+     * @param contextPath contextPath
+     */
+    public void setContextPath(final String contextPath) {
+        this.contextPath = contextPath;
+    }
+
     /**
      * Gets the value of acm.
      *

diff --git a/shenyu-admin/src/main/resources/application.yml b/shenyu-admin/src/main/resources/application.yml
@@ -90,6 +90,7 @@ shenyu:
 #      namespace: 1c10d748-af86-43b9-8265-75f487d20c6c
 #      username:
 #      password:
+#      context-path: nacos
 #      acm:
 #        enabled: false
 #        endpoint: acm.aliyun.com

diff --git a/shenyu-bootstrap/src/main/resources/application.yml b/shenyu-bootstrap/src/main/resources/application.yml
@@ -253,6 +253,7 @@ shenyu:
 #      namespace: 1c10d748-af86-43b9-8265-75f487d20c6c
 #      username:
 #      password:
+#      context-path: nacos
 #      acm:
 #        enabled: false
 #        endpoint: acm.aliyun.com

diff --git a/...java/org/apache/shenyu/springboot/starter/sync/data/nacos/NacosSyncDataConfiguration.java b/...java/org/apache/shenyu/springboot/starter/sync/data/nacos/NacosSyncDataConfiguration.java
@@ -103,6 +103,9 @@ public ConfigService nacosConfigService(final NacosConfig nacosConfig) throws Ex
             if (nacosConfig.getPassword() != null) {
                 properties.put(PropertyKeyConst.PASSWORD, nacosConfig.getPassword());
             }
+            if (StringUtils.isNotBlank(nacosConfig.getContextPath())) {
+                properties.put(PropertyKeyConst.CONTEXT_PATH, nacosConfig.getContextPath());
+            }
         }
         return NacosFactory.createConfigService(properties);
     }

diff --git a/...u-sync-data-nacos/src/main/java/org/apache/shenyu/sync/data/nacos/config/NacosConfig.java b/...u-sync-data-nacos/src/main/java/org/apache/shenyu/sync/data/nacos/config/NacosConfig.java
@@ -29,6 +29,8 @@ public class NacosConfig {
 
     private String password;
 
+    private String contextPath;
+
     private NacosACMConfig acm;
 
     /**
@@ -103,6 +105,24 @@ public void setPassword(final String password) {
         this.password = password;
     }
 
+    /**
+     * Gets the value of contextPath.
+     *
+     * @return the value of contextPath
+     */
+    public String getContextPath() {
+        return contextPath;
+    }
+
+    /**
+     * Sets the contextPath.
+     *
+     * @param contextPath contextPath
+     */
+    public void setContextPath(final String contextPath) {
+        this.contextPath = contextPath;
+    }
+
     /**
      * get acm.
      *
@@ -134,12 +154,13 @@ public boolean equals(final Object o) {
                 && Objects.equals(namespace, that.namespace)
                 && Objects.equals(username, that.username)
                 && Objects.equals(password, that.password)
+                && Objects.equals(contextPath, that.contextPath)
                 && Objects.equals(acm, that.acm);
     }
 
     @Override
     public int hashCode() {
-        return Objects.hash(url, namespace, username, password, acm);
+        return Objects.hash(url, namespace, username, password, contextPath, acm);
     }
 
     @Override
@@ -157,6 +178,9 @@ public String toString() {
                 + ", password='"
                 + password
                 + '\''
+                + ", contextPath='"
+                + contextPath
+                + '\''
                 + ", acm="
                 + acm
                 + '}';

diff --git a/...nc-data-nacos/src/test/java/org/apache/shenyu/sync/data/nacos/config/NacosConfigTest.java b/...nc-data-nacos/src/test/java/org/apache/shenyu/sync/data/nacos/config/NacosConfigTest.java
@@ -38,6 +38,8 @@ public final class NacosConfigTest {
 
     private static final String USERNAME = "username";
 
+    private static final String CONTEXT_PATH = "nacos";
+
     private static final NacosACMConfig ACM = new NacosACMConfig();
 
     private NacosConfig nacosConfig;
@@ -51,12 +53,14 @@ public void setUp() {
         nacosConfig.setNamespace(NAMESPACE);
         nacosConfig.setPassword(PASSWORD);
         nacosConfig.setUsername(USERNAME);
+        nacosConfig.setContextPath(CONTEXT_PATH);
         nacosConfig.setAcm(ACM);
         that = new NacosConfig();
         that.setUrl(URL);
         that.setNamespace(NAMESPACE);
         that.setPassword(PASSWORD);
         that.setUsername(USERNAME);
+        that.setContextPath(CONTEXT_PATH);
         that.setAcm(ACM);
     }
 
@@ -66,6 +70,7 @@ public void testGetterSetter() {
         assertEquals(NAMESPACE, nacosConfig.getNamespace());
         assertEquals(PASSWORD, nacosConfig.getPassword());
         assertEquals(USERNAME, nacosConfig.getUsername());
+        assertEquals(CONTEXT_PATH, nacosConfig.getContextPath());
         assertEquals(ACM, nacosConfig.getAcm());
     }
 
@@ -80,7 +85,7 @@ public void testEquals() {
     @Test
     public void testHashCode() {
         assertEquals(Objects.hash(nacosConfig.getUrl(), nacosConfig.getNamespace(),
-                        nacosConfig.getUsername(), nacosConfig.getPassword(), nacosConfig.getAcm()),
+                        nacosConfig.getUsername(), nacosConfig.getPassword(), nacosConfig.getContextPath(), nacosConfig.getAcm()),
                 nacosConfig.hashCode());
     }
 }