Merge pull request #3625 from yuluo-yx/0215-yuluo/feat-update-code

feat: optimize sidecar-example and readme docs

Author: yuluo-yx

.licenscheckconfig.yaml

@@ -68,6 +68,8 @@ header:
     - 'distribution/NOTICE-BIN'
     - 'test/src/test/resources/**'
     - '**/src/test/resources/statelang/**'
+    - '**/*.mod'
+    - '**/*.sum'
 
   comment: on-failure
 dependency:

spring-cloud-alibaba-examples/spring-cloud-alibaba-sidecar-examples/readme-zh.md

@@ -2,43 +2,41 @@
 
 ## 项目说明
 
-本项目演示如何使用 Nacos + Spring Cloud Alibaba Sidecar 完成 异构语言微服务的接入。
-
-[Spring Cloud Alibaba Sidecar](https://spring-cloud-alibaba-group.github.io/github-pages/hoxton/zh-cn/index.html#_spring_cloud_alibaba_sidecar)  是一个用来快速完美整合 Spring Cloud 与 异构语言微服务 的框架
-
+本项目演示如何使用 Nacos + Spring Cloud Alibaba Sidecar 完成异构微服务的接入。
 
+[Spring Cloud Alibaba Sidecar](https://sca.aliyun.com/zh-cn/docs/2022.0.0.0/user-guide/sidecar/overview)  是一个用来快速完美整合 Spring Cloud 应用与异构微服务的框架。
 
 ## 准备工作
 
 ### 下载并启动 Nacos
 
-**在接入 Sidecar 之前，首先需要启动 Nacos服务器。**
+**在接入 Sidecar 之前，首先需要启动 Nacos Server。**
 
-1. 下载[Nacos二进制文件](https://github.com/alibaba/nacos/releases/download/2.1.0/nacos-server-2.1.0.zip) 并解压
+1. 下载 [Nacos Server](https://github.com/alibaba/nacos/releases/) 并解压
 
 2. 启动 Nacos Server
 
-   下载解压后 我们需要进入到 bin 目录启动 nacos 服务， 一定不要双击启动，双击默认会以集群方式启动，我们以单机方式启动。
-```bash
-startup.cmd -m standalone
-```
+   下载解压，需要进入到 bin 目录启动 nacos server， 一定不要双击启动，双击默认会以集群方式启动。这里以单机方式启动：
+   
+   ```bash
+   startup.cmd -m standalone
+   ```
 
 3. 登录 Nacos
 
-   我们来到浏览器 输入localhost:8848/nacos 可以看到Nacos的运行的界面
-   用户名和密码都是 `nacos`
-
+   浏览器输入 localhost:8848/nacos 可以看到 Nacos 的 控制台界面，输入用户名和密码以登录 Nacos（用户名和密码都是 `nacos`）；
 
 ## 简单示例
-本文以Nacos作为注册中心为例，Sidecar接入一个非Java语言的服务。
 
+本文以 Nacos 作为注册中心为例，Sidecar 接入一个非 Java 语言的服务。
+
+> 默认以 golang 语言服务为示例，可以在 `application.yml` 中启动 `node` 异构服务。
 
 ### Step1: 引入依赖
 
 修改 `pom.xml` 文件，引入 Spring Cloud Alibaba Sidecar Starter。
 
 ```xml
-
 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-gateway</artifactId>
@@ -53,78 +51,82 @@ startup.cmd -m standalone
     <groupId>com.alibaba.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
 </dependency>
-
 ```
 
 ### Step2: 配置 Sidecar 相关信息
-然后在项目的application.yml 文件中指定以下配置
+
+然后在项目的 `application.yml` 配置文件中指定以下配置：
+
 ```yaml
 server:
    port: 8070
+
 spring:
+   profiles:
+      active: node
+
    cloud:
       nacos:
-         username: nacos
-         password: nacos
          discovery:
+            username: 'nacos'
+            password: 'nacos'
             server-addr: 127.0.0.1:8848
-            group: test
       gateway:
          discovery:
             locator:
                enabled: true
 
    application:
-      name: node-service
-# sidecar 相关的配置
+      name: sidecar-service
+
 sidecar:
-   # 异构微服务的IP
+   # heterogeneous microservices IP
    ip: 127.0.0.1
-   # 异构微服务的端口
-   port: 8060
+   # heterogeneous microservices Port
+   port: 8050
+
+   # heterogeneous microservices health url
+   # health-check-url: http://localhost:8050/api/v1/health-check
 
-   # 异构微服务的健康检查URL(这里不配置的话，默认会认为是UP)
-   health-check-url: http://localhost:8060/health.json
-# springboot actuator监控相关
 management:
    endpoint:
       health:
          show-details: always
 ```
-注意：这里的 localhost:8060，是我本机起了一个nginx 代理了这个health.json的请求。在实际使用过程中可以是任意的REST服务，只需要返回正确的JSON格式的健康检测数据即可。
-```json
 
+注意：这里的 localhost:8050，是异构服务地址。在实际使用过程中可以是任意的 REST 服务，只需要返回正确的 JSON 格式的健康检测数据即可。
+
+```json
 {
-  "status": "DOWN"
+  "status": "UP"
 }
 ```
 
 ### Step3: 启动应用
+
 之后分别启动 Sidecar 服务、本地异构服务。
 
 IDE 直接启动：找到主类 `com.alibaba.cloud.sidecar.DemoApplication`，执行 main 方法启动应用。
 
-注意：本文是以 `spring-cloud-alibaba-sidecar-nacos-example`项目为例，所以启动的是它下面的`DemoApplication`启动类。
+注意：本文是以 `spring-cloud-alibaba-sidecar-nacos-example` 项目为例，所以启动的是它下面的 `DemoApplication` 启动类。
+
 ![idea.png](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662550869316-98d574af-d1ba-4c00-a0af-5e33e13075fd.png)
 
 ### Step4: 查看服务注册情况
 
 ![nacos.png](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662548324337-566cc824-4d08-4041-ac83-1968c7347a9e.png)
 
+### Step4: 访问异构服务
 
+完成上面4步，我们发现对应的服务 `sidecar-service` 已经成功注册到了注册中心。此时，这个服务已经成功的融入到了 Spring Cloud 微服务的怀抱。对于 Spring Cloud 微服务而言，访问它跟访问其它的 Java 微服务没有任何区别。
+而这，也正是 Spring Cloud Alibaba Sidecar 的魅力所在。接下来，将继续演示怎样访问这个服务。
 
+浏览器访问：`http://127.0.0.1:8070/sidecar-service/test`
 
-### Step4: 访问异构服务
-完成上面4步，我们发现对应的服务`node-service`已经成功注册到了注册中心。此时，这个服务已经成功的融入到了Spring Cloud 微服务的怀抱。对于Spring Cloud 微服务而言，访问它跟访问其它的Java微服务没有任何的区别。
-而这，也正是 Spring Cloud Alibaba Sidecar的魅力所在。接下来，我们将继续演示怎样访问这个服务。
-
-浏览器访问
-http://127.0.0.1:8070/node-service/health.json
 能调通则说明整合成功。
 
-![](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662549893322-1b7a761a-ecd7-44ae-88b6-872eca43a866.png)
+![img](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662549893322-1b7a761a-ecd7-44ae-88b6-872eca43a866.png)
 
 ## More
 
-如果您对 spring cloud starter alibaba sidecar 有任何建议或想法，欢迎在 issue 中或者通过其他社区渠道向我们提出。
-
+如果您对 spring cloud starter alibaba sidecar 有任何建议或想法，欢迎在 Issue 中或者通过其他社区渠道向我们提出。

spring-cloud-alibaba-examples/spring-cloud-alibaba-sidecar-examples/readme.md

@@ -1,39 +1,40 @@
-# Spring Cloud Alibaba Sidecar Example
+## Spring Cloud Alibaba Sidecar Example
 
-## Project Instruction
+## Project Description
 
-This project demonstrates how to use `Nacos + Spring Cloud Alibaba Sidecar` to access heterogeneous language microservices.
+This project demonstrates how to use Nacos + Spring Cloud Alibaba Sidecar to accomplish heterogeneous microservice access.
 
-[Spring Cloud Alibaba Sidecar](https://spring-cloud-alibaba-group.github.io/github-pages/hoxton/zh-cn/index.html#_spring_cloud_alibaba_sidecar)  is a framework for fast and seamless integration of Spring Cloud with heterogeneous language microservices.
+[Spring Cloud Alibaba Sidecar](https://sca.aliyun.com/zh-cn/docs/2022.0.0.0/user-guide/sidecar/overview) is a framework for quickly and seamlessly integrating Spring Cloud applications with heterogeneous microservices. services.
 
+## Preparation
 
+### Download and start Nacos
 
-## Preparation
+**Before you can access Sidecar, you need to start Nacos Server.**
 
-### Download and Startup Nacos
+1. Download [Nacos Server](https://github.com/alibaba/nacos/releases/download/2.1.0/nacos-server-2.1.0.zip) and unzip it. 2.
 
-**You should startup Nacos Server before using Sidecar**
+2. Start Nacos Server
 
-1. Download [Nacos](https://archive.apache.org/dist/rocketmq/4.3.2/rocketmq-all-4.3.2-bin-release.zip) and unzip it.
+   After downloading and unpacking, you need to go to the bin directory to start the nacos server, make sure you don't double-click to start it, double-clicking will start it as a cluster by default. Here, we will start it as a standalone server:
 
-2. Startup Name Server
+   ```bash
+   startup.cmd -m standalone
+   ```
 
-```bash
-startup.cmd -m standalone
-```
+3. Log in to Nacos
+
+   Type localhost:8848/nacos in your browser to see the Nacos console, and enter your username and password to log in to Nacos (username and password both are `nacos`);
 
-3. Sign in Nacos
-   
-   Open you browser then input `localhost:8848/nacos` ,you can see the Nacos dashboard ui .
-   The default username and password are `nacos`
+## Simple Example
 
+In this article, we use Nacos as a registry as an example, and Sidecar to access a non-Java language service.
 
-## Simple example
-In this paper, Sidecar accesses a non-Java language service using Nacos as a registry as an example.
+> By default, we use the golang language service as an example, and we can start the `node` heterogeneous service in `application.yml`.
 
+### Step1: Introducing dependencies
 
-### Step1: Declare dependency
-Add dependency spring-cloud-starter-alibaba-sidecar to the `pom.xml` file in your Sidecar project.
+Modify the `pom.xml` file to introduce Spring Cloud Alibaba Sidecar Starter.
 
 ```xml
 <dependency>
@@ -52,68 +53,80 @@ Add dependency spring-cloud-starter-alibaba-sidecar to the `pom.xml` file in you
 </dependency>
 ```
 
-### Step2: Configure sidecar
-Then add necessary configurations to file `/src/main/resources/application.yml`.
+### Step2: Configure Sidecar related information
+
+Then specify the following configuration in the project's `application.yml` configuration file:
+
 ```yaml
 server:
    port: 8070
+
 spring:
+   profiles:
+      active: node
+
    cloud:
       nacos:
-         username: nacos
-         password: nacos
          discovery:
+            username: 'nacos'
+            password: 'nacos'
             server-addr: 127.0.0.1:8848
-            group: test
       gateway:
          discovery:
             locator:
                enabled: true
 
    application:
-      name: node-service
-sidecar:
-  # heterogeneous service‘s ip
-  ip: 127.0.0.1
-  # heterogeneous service's port
-  port: 8060
+      name: sidecar-service
 
-  # heterogeneous service's health check URL
-  health-check-url: http://localhost:8060/health.json
+sidecar:
+   # heterogeneous microservices IP
+   ip: 127.0.0.1
+   # heterogeneous microservices Port
+   port: 8050
+
+   # heterogeneous microservices health url
+   # health-check-url: http://localhost:8050/api/v1/health-check
+
+management:
+   endpoint:
+      health:
+         show-details: always
 ```
-Note: `localhost:8060` here, is my local machine started a nginx proxy for this `health.json` request. In actual use it can be any REST service, just need to return the correct JSON format health detection data.
-```json
 
+Note: localhost:8050 is the address of the heterogeneous service. In practice it can be any REST service, it just needs to return the correct JSON formatted health test data.
+
+```json
 {
-  "status": "DOWN"
+  "status": "UP"
 }
 ```
 
-### Step3: Start Application
-After that, start the `Sidecar` service and the local heterogeneous service respectively.
+### Step3: Starting the application
+
+After that, start the Sidecar service and local heterogeneous service respectively.
 
-Start in IDE: Find main class  `com.alibaba.cloud.sidecar.DemoApplication`, and execute the main method.
+IDE direct start: find the main class `com.alibaba.cloud.sidecar.DemoApplication` and execute the main method to start the application.
+
+Note: In this article, we take the `spring-cloud-alibaba-sidecar-nacos-example` project as an example, so we start the `DemoApplication` startup class under it.
 
-Note: This article takes the `spring-cloud-alibaba-sidecar-nacos-example` project as an example, so it starts the `DemoApplication` startup class under it.
 ![idea.png](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662550869316-98d574af-d1ba-4c00-a0af-5e33e13075fd.png)
 
-### Step4: View service registration
-![nacos.png](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662605412601-06780784-915c-40f6-b6b2-67176f6c5419.png)
+### Step4: Check the service registrations.
 
+![nacos.png](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662548324337-566cc824-4d08-4041-ac83-1968c7347a9e.png)
 
+### Step4: Accessing Heterogeneous Services
 
+After completing the above 4 steps, we find that the corresponding service `sidecar-service` has been successfully registered to the registry. At this point, this service has been successfully integrated into Spring Cloud microservices. For Spring Cloud microservices, accessing it is no different from accessing other Java microservices.
+This is the beauty of Spring Cloud Alibaba Sidecar. Next, we will continue to demonstrate how to access this service.
 
-### Step4: Accessing services
-After completing the above 4 steps, we find that the corresponding service `node-service` has been successfully registered to the registry. At this point, the service has been successfully integrated into the Spring Cloud microservice. For Spring Cloud microservices, accessing it is no different than accessing any other Java microservice.
-This is where the beauty of Spring Cloud Alibaba Sidecar comes in. Next, we will continue to demonstrate how to access this service.
+Browser Access: `http://127.0.0.1:8070/sidecar-service/test`
 
-Browser Access below address:
-http://127.0.0.1:8070/node-service/health.json
-If you see the following message, the access was successful.
+The integration is successful if it works.
 
-![](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662549893322-1b7a761a-ecd7-44ae-88b6-872eca43a866.png)
+![img](https://cdn.nlark.com/yuque/0/2022/png/1752280/1662549893322-1b7a761a-ecd7-44ae-88b6-872eca43a866.png)
 
 ## More
 
-If you have any ideas or suggestions for `Spring Cloud Alibaba Sidecar`, please don't hesitate to tell us by submitting github issues.
-
+If you have any suggestions or ideas about spring cloud starter alibaba sidecar, please feel free to submit them to us in an Issue or through other community channels.

spring-cloud-alibaba-examples/spring-cloud-alibaba-sidecar-examples/spring-cloud-alibaba-sidecar-example/golang-service-sidecar/cmd/main.go

@@ -0,0 +1,36 @@
+//
+// Copyright 2013-2023 the original author or authors.
+//
+// Licensed 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
+//
+//      https://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 main
+
+import (
+	"log"
+
+	"golang-sidecar/pkg/constant"
+	route "golang-sidecar/pkg/route"
+
+	"github.com/gin-gonic/gin"
+)
+
+func main() {
+
+	if err := route.SettingRouter(gin.Default()).Run(constant.ServicePort); err != nil {
+		log.Fatal("Golang sidecar service start failed.")
+	}
+
+	log.Println("Golang sidecar service listener in localhost:8060 ...")
+
+}