Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix doc typo and format #857

Open
wants to merge 2 commits into
base: develop-astro-nacos
Choose a base branch
from
Open

fix doc typo and format #857

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f86390
fix doc typo and format
mawen12 Jan 8, 2025
274e707
fix doc typo
mawen12 Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions src/content/docs/latest/en/manual/user/java-sdk/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,11 @@ NacosClientProperties.PROTOTYPE.setProperty("global-key1","global-value1");

// properties1
NacosClientProperties properties1 = NacosClientProperties.PROTOTYPE.derive();
properties1.

setProperty("properties1-key1","properties1-value1");
properties1.setProperty("properties1-key1","properties1-value1");

// properties2
NacosClientProperties properties2 = properties1.derive();
properties2.

setProperty("properties2-key1","properties2-value1");
properties2.setProperty("properties2-key1","properties2-value1");
```

以上代码如下图所示:
Expand Down Expand Up @@ -143,7 +139,7 @@ String value = properties2.getProperty("global-key1");
| secretKey | SECRET_KEY | 使用阿里云RAM鉴权时需要使用的secretKey | 任意字符串 | 无 | |
| ramRoleName | RAM_ROLE_NAME | 使用阿里云RAM鉴权时需要使用的ramRoleName | 任意字符串 | 无 |
| signatureRegionId | SIGNATURE_REGION_ID | 使用阿里云RAM鉴权时，需要使用的signatureRegionId | 任意字符串 | 无 |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用户调试和问题排查。 | boolean | false |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用于调试和问题排查。 | boolean | false |
| ~~serverName~~ | ~~SERVER_NAME~~ | 该 JAVA SDK 的名称，目前仅在访问endpoint时使用，由于使用率低且命名不合理，将废弃 | 任意字符串 | 由serverAddr/endpoint自动拼接 |

### 2.2. 配置中心相关参数
Expand Down Expand Up @@ -181,7 +177,7 @@ String value = properties2.getProperty("global-key1");
### 2.4. 连接相关

Nacos Java SDK 连接Nacos Server时，可以设置一系列的参数，来提升针对网络抖动时的容错能力，这部分配置暂时**只能通过JVM参数(
-D)**进行设置，社区正在进行改造，支持其能够通过`NacosClientProperties`（即初始化Java SDK时传入的Properties）进行配置，尽请期待。
-D)** 进行设置，社区正在进行改造，支持其能够通过`NacosClientProperties`（即初始化Java SDK时传入的Properties）进行配置，尽请期待。

| 参数名 | 含义 | 可选值 | 默认值 |
|-----------------------------------------------------------------|------------------------------------------------------------------------------------|---------|---------------|
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/latest/en/manual/user/java-sdk/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ String serverAddr = "localhost:8848";
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(serverAddr);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(serverAddr);
```

Expand All @@ -78,7 +78,7 @@ properties.setProperty(PropertyKeyConst.NAMESPACE, "${namespaceId}");
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(properties);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(properties);
```

Expand Down Expand Up @@ -1042,7 +1042,7 @@ System.out.println(result.getData());

#### 描述

获取当前客户端所的所有服务列表
获取当前客户端所监听的所有服务列表

```java
List<ServiceInfo> getSubscribeServices() throws NacosException;
Expand All @@ -1063,6 +1063,6 @@ System.out.println(naming.getSubscribeServices());

## 5. Java SDK的生命周期

Nacos的Java SDK 生命周期从创建时开始，到调用`shutdown()`方法时结束，期间对应创建的线程池、连接等均会始终保留，及时连接断开，也会不断重试重新建立连接。
Nacos的Java SDK 生命周期从创建时开始，到调用`shutdown()`方法时结束，期间对应创建的线程池、连接等均会始终保留，即使连接断开，也会不断重试重新建立连接。

因此在使用时需要注意应用中创建的Nacos Java SDK的实例个数，避免造成线程池和连接的泄漏，在更换Nacos Java SDK实例时，切记调用`shutdown()`方法，同时在应用中应尽量复用同一个Nacos Java SDK实例，避免频繁的初始化实例。
10 changes: 3 additions & 7 deletions src/content/docs/latest/zh-cn/manual/user/java-sdk/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,11 @@ NacosClientProperties.PROTOTYPE.setProperty("global-key1","global-value1");

// properties1
NacosClientProperties properties1 = NacosClientProperties.PROTOTYPE.derive();
properties1.

setProperty("properties1-key1","properties1-value1");
properties1.setProperty("properties1-key1","properties1-value1");

// properties2
NacosClientProperties properties2 = properties1.derive();
properties2.

setProperty("properties2-key1","properties2-value1");
properties2.setProperty("properties2-key1","properties2-value1");
```

以上代码如下图所示:
Expand Down Expand Up @@ -143,7 +139,7 @@ String value = properties2.getProperty("global-key1");
| secretKey | SECRET_KEY | 使用阿里云RAM鉴权时需要使用的secretKey | 任意字符串 | 无 | |
| ramRoleName | RAM_ROLE_NAME | 使用阿里云RAM鉴权时需要使用的ramRoleName | 任意字符串 | 无 |
| signatureRegionId | SIGNATURE_REGION_ID | 使用阿里云RAM鉴权时，需要使用的signatureRegionId | 任意字符串 | 无 |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用户调试和问题排查。 | boolean | false |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用于调试和问题排查。 | boolean | false |
| ~~serverName~~ | ~~SERVER_NAME~~ | 该 JAVA SDK 的名称，目前仅在访问endpoint时使用，由于使用率低且命名不合理，将废弃 | 任意字符串 | 由serverAddr/endpoint自动拼接 |

### 2.2. 配置中心相关参数
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/latest/zh-cn/manual/user/java-sdk/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ String serverAddr = "localhost:8848";
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(serverAddr);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(serverAddr);
```

Expand All @@ -78,7 +78,7 @@ properties.setProperty(PropertyKeyConst.NAMESPACE, "${namespaceId}");
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(properties);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(properties);
```

Expand Down Expand Up @@ -1042,7 +1042,7 @@ System.out.println(result.getData());

#### 描述

获取当前客户端所的所有服务列表
获取当前客户端所监听的所有服务列表

```java
List<ServiceInfo> getSubscribeServices() throws NacosException;
Expand Down
10 changes: 3 additions & 7 deletions src/content/docs/next/en/manual/user/java-sdk/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,11 @@ NacosClientProperties.PROTOTYPE.setProperty("global-key1","global-value1");

// properties1
NacosClientProperties properties1 = NacosClientProperties.PROTOTYPE.derive();
properties1.

setProperty("properties1-key1","properties1-value1");
properties1.setProperty("properties1-key1","properties1-value1");

// properties2
NacosClientProperties properties2 = properties1.derive();
properties2.

setProperty("properties2-key1","properties2-value1");
properties2.setProperty("properties2-key1","properties2-value1");
```

以上代码如下图所示:
Expand Down Expand Up @@ -144,7 +140,7 @@ String value = properties2.getProperty("global-key1");
| secretKey | SECRET_KEY | 使用阿里云RAM鉴权时需要使用的secretKey | 任意字符串 | 无 | |
| ramRoleName | RAM_ROLE_NAME | 使用阿里云RAM鉴权时需要使用的ramRoleName | 任意字符串 | 无 |
| signatureRegionId | SIGNATURE_REGION_ID | 使用阿里云RAM鉴权时，需要使用的signatureRegionId | 任意字符串 | 无 |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用户调试和问题排查。 | boolean | false |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用于调试和问题排查。 | boolean | false |
| ~~clusterName~~ | ~~CLUSTER_NAME~~ | 由于和服务实例的ClusterName名称相同，容易造成混淆，该参数已废弃，请使用`endPointClusterName` | 任意URL支持的path | serverlist |
| ~~isAdaptClusterNameUsage~~ | ~~IS_ADAPT_CLUSTER_NAME_USAGE~~ | 是否兼容通过`clusterName`的方式设置`endPointClusterName`，让升级兼容性更好 | boolean | false |
| ~~serverName~~ | ~~SERVER_NAME~~ | 该 JAVA SDK 的名称，目前仅在访问endpoint时使用，由于使用率低且命名不合理，将废弃 | 任意字符串 | 由serverAddr/endpoint自动拼接 |
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/next/en/manual/user/java-sdk/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ String serverAddr = "localhost:8848";
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(serverAddr);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(serverAddr);
```

Expand All @@ -78,7 +78,7 @@ properties.setProperty(PropertyKeyConst.NAMESPACE, "${namespaceId}");
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(properties);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(properties);
```

Expand Down Expand Up @@ -1042,7 +1042,7 @@ System.out.println(result.getData());

#### 描述

获取当前客户端所的所有服务列表
获取当前客户端所监听的所有服务列表

```java
List<ServiceInfo> getSubscribeServices() throws NacosException;
Expand Down
10 changes: 3 additions & 7 deletions src/content/docs/next/zh-cn/manual/user/java-sdk/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,11 @@ NacosClientProperties.PROTOTYPE.setProperty("global-key1","global-value1");

// properties1
NacosClientProperties properties1 = NacosClientProperties.PROTOTYPE.derive();
properties1.

setProperty("properties1-key1","properties1-value1");
properties1.setProperty("properties1-key1","properties1-value1");

// properties2
NacosClientProperties properties2 = properties1.derive();
properties2.

setProperty("properties2-key1","properties2-value1");
properties2.setProperty("properties2-key1","properties2-value1");
```

以上代码如下图所示:
Expand Down Expand Up @@ -144,7 +140,7 @@ String value = properties2.getProperty("global-key1");
| secretKey | SECRET_KEY | 使用阿里云RAM鉴权时需要使用的secretKey | 任意字符串 | 无 | |
| ramRoleName | RAM_ROLE_NAME | 使用阿里云RAM鉴权时需要使用的ramRoleName | 任意字符串 | 无 |
| signatureRegionId | SIGNATURE_REGION_ID | 使用阿里云RAM鉴权时，需要使用的signatureRegionId | 任意字符串 | 无 |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用户调试和问题排查。 | boolean | false |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用于调试和问题排查。 | boolean | false |
| ~~clusterName~~ | ~~CLUSTER_NAME~~ | 由于和服务实例的ClusterName名称相同，容易造成混淆，该参数已废弃，请使用`endPointClusterName` | 任意URL支持的path | serverlist |
| ~~isAdaptClusterNameUsage~~ | ~~IS_ADAPT_CLUSTER_NAME_USAGE~~ | 是否兼容通过`clusterName`的方式设置`endPointClusterName`，让升级兼容性更好 | boolean | false |
| ~~serverName~~ | ~~SERVER_NAME~~ | 该 JAVA SDK 的名称，目前仅在访问endpoint时使用，由于使用率低且命名不合理，将废弃 | 任意字符串 | 由serverAddr/endpoint自动拼接 |
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/next/zh-cn/manual/user/java-sdk/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ String serverAddr = "localhost:8848";
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(serverAddr);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(serverAddr);
```

Expand All @@ -78,7 +78,7 @@ properties.setProperty(PropertyKeyConst.NAMESPACE, "${namespaceId}");
# 初始化配置中心的Nacos Java SDK
ConfigService configService = NacosFactory.createConfigService(properties);

# 初始化配置中心的Nacos Java SDK
# 初始化注册中心的Nacos Java SDK
NamingService namingService = NacosFactory.createNamingService(properties);
```

Expand Down Expand Up @@ -1042,7 +1042,7 @@ System.out.println(result.getData());

#### 描述

获取当前客户端所的所有服务列表
获取当前客户端所监听的所有服务列表

```java
List<ServiceInfo> getSubscribeServices() throws NacosException;
Expand Down
10 changes: 3 additions & 7 deletions src/content/docs/v3.0/en/manual/user/java-sdk/properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,15 +78,11 @@ NacosClientProperties.PROTOTYPE.setProperty("global-key1","global-value1");

// properties1
NacosClientProperties properties1 = NacosClientProperties.PROTOTYPE.derive();
properties1.

setProperty("properties1-key1","properties1-value1");
properties1.setProperty("properties1-key1","properties1-value1");

// properties2
NacosClientProperties properties2 = properties1.derive();
properties2.

setProperty("properties2-key1","properties2-value1");
properties2.setProperty("properties2-key1","properties2-value1");
```

以上代码如下图所示:
Expand Down Expand Up @@ -144,7 +140,7 @@ String value = properties2.getProperty("global-key1");
| secretKey | SECRET_KEY | 使用阿里云RAM鉴权时需要使用的secretKey | 任意字符串 | 无 | |
| ramRoleName | RAM_ROLE_NAME | 使用阿里云RAM鉴权时需要使用的ramRoleName | 任意字符串 | 无 |
| signatureRegionId | SIGNATURE_REGION_ID | 使用阿里云RAM鉴权时，需要使用的signatureRegionId | 任意字符串 | 无 |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用户调试和问题排查。 | boolean | false |
| logAllProperties | LOG_ALL_PROPERTIES | 启动Java SDK时，是否打印全量参数，包含自定义properties、JVM和环境变量，主要用于调试和问题排查。 | boolean | false |
| ~~clusterName~~ | ~~CLUSTER_NAME~~ | 由于和服务实例的ClusterName名称相同，容易造成混淆，该参数已废弃，请使用`endPointClusterName` | 任意URL支持的path | serverlist |
| ~~isAdaptClusterNameUsage~~ | ~~IS_ADAPT_CLUSTER_NAME_USAGE~~ | 是否兼容通过`clusterName`的方式设置`endPointClusterName`，让升级兼容性更好 | boolean | false |
| ~~serverName~~ | ~~SERVER_NAME~~ | 该 JAVA SDK 的名称，目前仅在访问endpoint时使用，由于使用率低且命名不合理，将废弃 | 任意字符串 | 由serverAddr/endpoint自动拼接 |
Expand Down
Loading