diff --git a/CHANGELOG.md b/CHANGELOG.md index 605d677b..59f42e40 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,3 +5,4 @@ - [Optimize: remove discovery module useless code](https://github.com/Tencent/spring-cloud-tencent/pull/595) - [Optimize: remove useless code for rest template router](https://github.com/Tencent/spring-cloud-tencent/pull/601) - [Optimize: optimize configuration conditional & optimize config data tips](https://github.com/Tencent/spring-cloud-tencent/pull/603) +- [Optimize: Maybe remove Chinese characters](https://github.com/Tencent/spring-cloud-tencent/pull/607) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c5b1e573..86f23b37 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing --- -If you have good comments or suggestions, welcome to create [Issues](https://github.com/Tencent/spring-cloud-tencent/issues) or [Pull Requests](https://github.com/Tencent/spring-cloud-tencent/pulls),contribute to the Spring Cloud Tencent open source community. Spring Cloud Tencent continues to recruit contributors, even if it is answering questions in the issue, or doing some simple bugfixes, it will be of great help to Spring Cloud Tencent. +If you have good comments or suggestions, welcome to create [Issues](https://github.com/Tencent/spring-cloud-tencent/issues) or [Pull Requests](https://github.com/Tencent/spring-cloud-tencent/pulls), contribute to the Spring Cloud Tencent open source community. Spring Cloud Tencent continues to recruit contributors, even if it is answering questions in the issue, or doing some simple bugfixes, it will be of great help to Spring Cloud Tencent. [Tencent Open Source Incentive Program](https://opensource.tencent.com/contribution) Encourage developers to participate and contribute, and look forward to your joining. diff --git a/README-zh.md b/README-zh.md index 2eed3f1f..8eb30678 100644 --- a/README-zh.md +++ b/README-zh.md @@ -113,7 +113,7 @@ You can build this project with command: - [Actuator Endpoint Extension](https://github.com/Tencent/spring-cloud-tencent/wiki/Actuator-Endpoint-%E6%89%A9%E5%B1%95) - 最佳实践 - - [Multi-feature environment](https://github.com/Tencent/spring-cloud-tencent/wiki/多特性环境) + - [Multi-feature environment](https://github.com/Tencent/spring-cloud-tencent/wiki/%E5%A4%9A%E7%89%B9%E6%80%A7%E7%8E%AF%E5%A2%83) - [Multi-registration and multi-discovery](https://github.com/Tencent/spring-cloud-tencent/wiki/Multi-registration-and-multi-discovery) - 开发文档 diff --git a/README.md b/README.md index 1d8024c1..d3a350a8 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ You can build this project with command: - [Actuator Endpoint Extension](https://github.com/Tencent/spring-cloud-tencent/wiki/Actuator-Endpoint-%E6%89%A9%E5%B1%95) - Best Practices - - [Multi-feature environment](https://github.com/Tencent/spring-cloud-tencent/wiki/多特性环境) + - [Multi-feature environment](https://github.com/Tencent/spring-cloud-tencent/wiki/%E5%A4%9A%E7%89%B9%E6%80%A7%E7%8E%AF%E5%A2%83) - [Multi-registration and multi-discovery](https://github.com/Tencent/spring-cloud-tencent/wiki/Multi-registration-and-multi-discovery) - Development documentation diff --git a/changes/changes-1.7.0.md b/changes/changes-1.7.0.md index 4089d1fd..18542007 100644 --- a/changes/changes-1.7.0.md +++ b/changes/changes-1.7.0.md @@ -22,7 +22,7 @@ - [Optimize router label resolver spi](https://github.com/Tencent/spring-cloud-tencent/pull/524) - [Code optimization for rpc-enhancement module](https://github.com/Tencent/spring-cloud-tencent/pull/526) - [Feature: Optimized configuration update](https://github.com/Tencent/spring-cloud-tencent/pull/528) -- [Feature:support pushGateway push metrics](https://github.com/Tencent/spring-cloud-tencent/pull/529) +- [Feature: support pushGateway push metrics](https://github.com/Tencent/spring-cloud-tencent/pull/529) - [Feature: remove location metadata](https://github.com/Tencent/spring-cloud-tencent/pull/536) - [Feature: remove location metadata](https://github.com/Tencent/spring-cloud-tencent/pull/542) - [add feature-env plugin & add spring cloud gateway staining plugin](https://github.com/Tencent/spring-cloud-tencent/pull/533) diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigAnnotationProcessor.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigAnnotationProcessor.java index 04e3ea49..b137c490 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigAnnotationProcessor.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigAnnotationProcessor.java @@ -40,7 +40,7 @@ import static com.tencent.cloud.polaris.config.listener.PolarisConfigListenerCon /** * {@link PolarisConfigAnnotationProcessor} implementation for spring . - *

This source file was reference from: + *

This source file was reference from: * * ApolloAnnotationProcessor * @author Palmer Xu 2022-06-07 diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigKVFileChangeListener.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigKVFileChangeListener.java index d5e29199..eba43e81 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigKVFileChangeListener.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/annotation/PolarisConfigKVFileChangeListener.java @@ -26,7 +26,7 @@ import java.lang.annotation.Target; /** * Configuring the change listener annotation. - *

This source file was reference from: + *

This source file was reference from: * * ApolloAnnotationProcessor * @author Palmer Xu 2022-05-31 diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java index 2e6473df..300ea1bb 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java @@ -52,7 +52,7 @@ import static org.springframework.boot.context.config.ConfigData.Option.PROFILE_ * Load {@link ConfigData} via {@link PolarisConfigDataLoader} * * @author wlx - * @date 2022/7/5 11:14 下午 + * @date 2022/7/5 11:14 PM */ public class PolarisConfigDataLoader implements ConfigDataLoader { diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java index 04b81a48..c0a33566 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java @@ -30,7 +30,7 @@ import org.springframework.boot.context.config.Profiles; * A polaris configData resource from which {@link ConfigData} can be loaded. * * @author wlx - * @date 2022/7/5 11:13 下午 + * @date 2022/7/5 11:13 PM */ public class PolarisConfigDataResource extends ConfigDataResource { diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisImportExceptionFailureAnalyzer.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisImportExceptionFailureAnalyzer.java index 2f29d923..245dc700 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisImportExceptionFailureAnalyzer.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisImportExceptionFailureAnalyzer.java @@ -7,7 +7,7 @@ import org.springframework.cloud.commons.ConfigDataMissingEnvironmentPostProcess /** * Class for most {@code FailureAnalyzer} implementations, to analyze ImportException when * miss Polaris configData config. - *

Refer to the Nacos project implementation: + *

Refer to the Nacos project implementation: * * ImportExceptionFailureAnalyzer * diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/listener/PolarisConfigListenerContext.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/listener/PolarisConfigListenerContext.java index 01aebbb4..07edc90e 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/listener/PolarisConfigListenerContext.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/listener/PolarisConfigListenerContext.java @@ -49,7 +49,7 @@ import static com.tencent.polaris.configuration.api.core.ChangeType.MODIFIED; /** * Polaris Config Listener Context Defined . - *

This source file was reference from: + *

This source file was reference from: * * AbstractConfig * @author Palmer Xu 2022-06-06 diff --git a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/util/OkHttpUtil.java b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/util/OkHttpUtil.java index df9db0be..77dd62f4 100644 --- a/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/util/OkHttpUtil.java +++ b/spring-cloud-starter-tencent-polaris-discovery/src/main/java/com/tencent/cloud/polaris/util/OkHttpUtil.java @@ -62,12 +62,12 @@ public final class OkHttpUtil { if (response.isSuccessful() && Objects.nonNull(response.body())) { String result = response.body().string(); - LOGGER.debug("exec get request, url: {} success,response data: {}", url, result); + LOGGER.debug("exec get request, url: {} success, response data: {}", url, result); return true; } } catch (Exception e) { - LOGGER.error("exec get request,url: {} failed!", url, e); + LOGGER.error("exec get request, url: {} failed!", url, e); } return false; } diff --git a/spring-cloud-tencent-examples/metadata-transfer-example/README.md b/spring-cloud-tencent-examples/metadata-transfer-example/README.md index 5fd736ba..d2d524bf 100644 --- a/spring-cloud-tencent-examples/metadata-transfer-example/README.md +++ b/spring-cloud-tencent-examples/metadata-transfer-example/README.md @@ -5,7 +5,7 @@ This example shows how to use ```spring-cloud-starter-tencent-metadata-transfer``` in Spring Cloud project for its features. -This example contains ```metadata-frontend```、```metadata-middle```、```metadata-backend```. +This example contains ```metadata-frontend```, ```metadata-middle```, ```metadata-backend```. ## Instruction @@ -55,7 +55,7 @@ Execute under ```spring-cloud-tencent-examples/metadata-transfer-example``` mvn clean package ``` -Then find the jars under ```metadata-frontend```、```metadata-middle```、```metadata-backend```, and run it: +Then find the jars under ```metadata-frontend```, ```metadata-middle```, ```metadata-backend```, and run it: ``` java -jar ${app.jar} diff --git a/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java b/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java index 8c4e3876..78eec0f1 100644 --- a/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java +++ b/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java @@ -5,7 +5,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; /** * @author wlx - * @date 2022/7/6 9:15 下午 + * @date 2022/7/6 9:15 PM */ @SpringBootApplication public class PolarisConfigDataExampleApplication { diff --git a/spring-cloud-tencent-examples/polaris-router-featureenv-example/README.md b/spring-cloud-tencent-examples/polaris-router-featureenv-example/README.md index e0853aef..8cf15c31 100644 --- a/spring-cloud-tencent-examples/polaris-router-featureenv-example/README.md +++ b/spring-cloud-tencent-examples/polaris-router-featureenv-example/README.md @@ -32,7 +32,7 @@ By default, the applications point to the official Polaris experience environmen registration data at the experience site after a successful launch. - Console address: http://14.116.241.63:8080/ - - Account:polaris + - Account: polaris - Password: polaris ## III. Testing @@ -89,7 +89,7 @@ Simulate a real-world scenario, assuming that the client request has a uid reque **Configure coloring rules** -Polaris Configuration Address:http://14.116.241.63:8080/#/filegroup-detail?group=featureenv-gateway&namespace=default +Polaris Configuration Address: http://14.116.241.63:8080/#/filegroup-detail?group=featureenv-gateway&namespace=default Modify the `rule/staining.json` configuration file and fill in the following rule: diff --git a/spring-cloud-tencent-examples/polaris-router-grayrelease-example/README.md b/spring-cloud-tencent-examples/polaris-router-grayrelease-example/README.md index 8ad68bbe..4359bfcd 100644 --- a/spring-cloud-tencent-examples/polaris-router-grayrelease-example/README.md +++ b/spring-cloud-tencent-examples/polaris-router-grayrelease-example/README.md @@ -10,10 +10,10 @@ This project shows how to use Spring Cloud Tencent route and transitive feature ![](https://qcloudimg.tencent-cloud.cn/raw/488182fd3001b3e77d9450e2c8798ff3.png) -Incoming requests dispatched from Gateway service to 3 environments: +Incoming requests dispatched from Gateway service to 3 environments: - gray1(match uid=1), env=green(green environment) - gray2(match uid=2), env=purple(purple environment) -- baseline(stable environment, match all other requests), env=blue(blue environment) +- baseline(stable environment, match all other requests), env=blue(blue environment) ## How to access @@ -26,8 +26,8 @@ Incoming requests dispatched from Gateway service to 3 environments: 2. start router-grayrelease-gateway application - - Launch by IDE:Start the main class `GrayReleaseGatewayApplication`. - - Launch by Jar:Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-gateway-${verion}.jar` to launch application. + - Launch by IDE: Start the main class `GrayReleaseGatewayApplication`. + - Launch by Jar: Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-gateway-${verion}.jar` to launch application. 3. add the route rule @@ -136,13 +136,13 @@ Incoming requests dispatched from Gateway service to 3 environments: - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=blue - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=blue + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-frontend application - - Launch by IDE:Start the main class `GrayReleaseFrontApplication`. - - Launch by Jar:Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-frontend-${verion}.jar` to launch application. + - Launch by IDE: Start the main class `GrayReleaseFrontApplication`. + - Launch by Jar: Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-frontend-${verion}.jar` to launch application. #### Start gray1 environment (green) @@ -150,8 +150,8 @@ Incoming requests dispatched from Gateway service to 3 environments: - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=green - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=green + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-frontend application (same as previous instruction) @@ -163,8 +163,8 @@ Incoming requests dispatched from Gateway service to 3 environments: - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=purple - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=purple + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-frontend application (same as previous instruction) @@ -182,13 +182,13 @@ You can find the instances with different tags in polaris console. - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=blue - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=blue + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-middle application - - Launch by IDE:Start the main class `GrayReleaseMiddleApplication`. - - Launch by Jar:Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-middle-${verion}.jar` to launch application. + - Launch by IDE: Start the main class `GrayReleaseMiddleApplication`. + - Launch by Jar: Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-middle-${verion}.jar` to launch application. #### Start gray2 environment (purple) @@ -196,8 +196,8 @@ You can find the instances with different tags in polaris console. - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=purple - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=purple + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-middle application (same as previous instruction) @@ -209,13 +209,13 @@ You can find the instances with different tags in polaris console. - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=blue - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=blue + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-backend application - - Launch by IDE:Start the main class `GrayReleaseBackendApplication`. - - Launch by Jar:Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-backend-${verion}.jar` to launch application. + - Launch by IDE: Start the main class `GrayReleaseBackendApplication`. + - Launch by Jar: Execute `mvn clean package` to compile with jar package, then use `java -jar router-grayrelease-backend-${verion}.jar` to launch application. #### Start gray1 environment (green) @@ -223,8 +223,8 @@ You can find the instances with different tags in polaris console. - polaris server address: polaris_address=grpc://127.0.0.1:8091 - pushgateway address: prometheus_address=127.0.0.1:9091 - - env tag:SCT_METADATA_CONTENT_env=green - - transitive tag:SCT_METADATA_CONTENT_TRANSITIVE=env + - env tag: SCT_METADATA_CONTENT_env=green + - transitive tag: SCT_METADATA_CONTENT_TRANSITIVE=env 2. start router-grayrelease-backend application (same as previous instruction)