update integrated-example docker-compose deploy document (#3337)

2 years ago · 79197a11d9
parent 1add62660e
commit 79197a11d9
1 changed files with 26 additions and 37 deletions
--- a/spring-cloud-alibaba-examples/integrated-example/docs/zh/docker-compose-deploy-zh.md
+++ b/spring-cloud-alibaba-examples/integrated-example/docs/zh/docker-compose-deploy-zh.md
@ -1,10 +1,10 @@
-# Spring Cloud Alibaba容器化部署最佳实践 | Docker-Compose 版本
+# Spring Cloud Alibaba 容器化部署最佳实践 | Docker-Compose 版本

 ## 准备工作

-> Note: 使用Docker-Compose方式体验Demo时，请确保本地机器内存资源 >= 24G！
+> Note: 使用 Docker-Compose 方式体验 Demo 时，请确保本地机器内存资源 >= 24G！

-如果您还没有安装Docker和Docker-Compose，请按照官方文档来构建运行环境：
+如果您还没有安装 Docker 和 Docker-Compose，请按照官方文档来构建运行环境：

 - Docker：https://docs.docker.com/desktop/install/linux-install/
 - Docker-Compose：https://docs.docker.com/compose/install/
@ -23,68 +23,59 @@
 127.0.0.1 integrated-frontend
 ```

-### 准备jar包
+### 准备 jar 包

-进入`spring-cloud-alibaba-examples`目录下，执行`mvn package`命令编译项目生成jar包，为后续Docker构建服务镜像做准备。
+进入 `spring-cloud-alibaba-examples` 目录下，执行 `mvn package` 命令编译项目生成 jar 包，为后续 Docker 构建服务镜像做准备。

 ## 快速启动

 ### 组件启动

-进入`spring-cloud-alibaba-examples/integrated-example`目录下，在终端中执行以下命令`docker-compose -f ./docker-compose/docker-compose-env.yml up -d`来快速部署运行example所需组件。
+进入 `spring-cloud-alibaba-examples/integrated-example` 目录下，在终端中执行以下命令 `docker-compose -f ./docker-compose/docker-compose-env.yml up -d` 来快速部署运行 example 所需组件。

 ### 添加配置

-docker-compose-env.yml文件运行成功之后，添加Nacos配置：
+docker-compose-env.yml 文件运行成功之后，添加 Nacos 配置：

-1. 进入`spring-cloud-alibaba-examples/integrated-example`目录下；
-2. 在终端中执行`config-init/scripts/nacos-config-quick.sh`脚本文件。
+1. 进入 `spring-cloud-alibaba-examples/integrated-example` 目录下；
+2. 在终端中执行 `config-init/scripts/nacos-config-quick.sh` 脚本文件。

 完成所有微服务配置的一键导入。

-> 注意：windows操作系统可以通过`git bash`执行shell脚本文件完成配置导入。
+> 注意：windows 操作系统可以通过 `git bash` 执行 shell 脚本文件完成配置导入。

 ### 服务启动

-进入`spring-cloud-alibaba-examples/integrated-example`目录下，在终端中执行以下命令`docker-compose -f ./docker-compose/docker-compose-service.yml up -d`来快速部署运行example所需服务。
+进入 `spring-cloud-alibaba-examples/integrated-example` 目录下，在终端中执行以下命令 `docker-compose -f ./docker-compose/docker-compose-service.yml up -d` 来快速部署运行 example 所需服务。

 ## 停止所有容器

 ### 停止服务容器

-进入`spring-cloud-alibaba-examples/integrated-example`目录下，在终端中执行以下命令`docker-compose -f ./docker-compose/docker-compose-service.yml down`来停止正在运行的example服务容器。
+进入 `spring-cloud-alibaba-examples/integrated-example` 目录下，在终端中执行以下命令 `docker-compose -f ./docker-compose/docker-compose-service.yml down` 来停止正在运行的 example 服务容器。


 ### 停止组件容器

-进入`spring-cloud-alibaba-examples/integrated-example`目录下，在终端中执行以下命令`docker-compose -f ./docker-compose/docker-compose-env.yml down`来停止正在运行的example组件容器。
+进入 `spring-cloud-alibaba-examples/integrated-example` 目录下，在终端中执行以下命令 `docker-compose -f ./docker-compose/docker-compose-env.yml down` 来停止正在运行的 example 组件容器。

-> 在容器启动时，可以通过`docker-compose -f docker-compose-*.yml up`观察容器的启动过程！
+> 在容器启动时，可以通过 `docker-compose -f docker-compose-*.yml up` 观察容器的启动过程！

-## 体验Demo
-
-准备工作完成后可以运行 demo 示例，主要根据不同的使用场景，可以分别体验用户下单(分布式事务能力)以及模拟高流量点赞(熔断限流以及削峰填谷的能力)。
-
-首先需要分别启动`integrated-frontend`以及`integrated-gateway`微服务应用。
-
- `integrated-gateway` 模块是整个最佳实践示例的网关。
- `integrated-frontend` 为最佳实践示例的简易前端页面。
+## 体验 Demo

 ### 分布式事务能力

 #### 场景说明

-针对分布式事务能力，SCA社区提供了**用户下单购买货物的场景**，下单后：
+针对分布式事务能力，SCA 社区提供了**用户下单购买货物的场景**，下单后：

 - 先请求库存模块，扣减库存
 - 扣减账户余额
 - 生成订单信息返回响应

-##### 启动测试
-
-分别启动`integrated-storage`,`integrated-account`,`integrated-order`三个微服务应用。
+#### 启动测试

-访问`http://integrated-frontend:8080/order` 来体验对应场景。
+访问 `http://integrated-frontend:8080/order` 来体验对应场景。

 直接点击下单按钮提交表单，应用模拟客户端向网关发送了一个创建订单的请求。

@ -96,13 +87,13 @@ docker-compose-env.yml文件运行成功之后，添加Nacos配置：

 在本 demo 示例中，为了便于演示，每件商品的单价都为2。

-而在前面的准备工作中，**初始化业务数据库表**的时候应用新建了一个用户，用户userId 为 admin，余额为 3 元；同时新建了一个编号为 1 号的商品，库存为 100 件。
+而在前面的准备工作中，**初始化业务数据库表**的时候应用新建了一个用户，用户 userId 为 admin，余额为 3 元；同时新建了一个编号为 1 号的商品，库存为 100 件。

-因此通过上述的操作，应用会创建一个订单，扣减对应商品编号为 1 号的库存个数(100-1=99)，扣减 admin 用户的余额(3-2=1)。
+因此通过上述的操作，应用会创建一个订单，扣减对应商品编号为 1 号的库存个数（100-1=99），扣减 admin 用户的余额（3-2=1）。

 ![](https://my-img-1.oss-cn-hangzhou.aliyuncs.com/image-20221016155429801.png)

-如果再次请求相同的接口，同样是先扣减库存(99-1=98)，但是会因为 admin 用户余额不足而抛出异常，并被 Seata 捕获，执行分布式事务二阶段提交，回滚事务。
+如果再次请求相同的接口，同样是先扣减库存（99-1=98），但是会因为 admin 用户余额不足而抛出异常，并被 Seata 捕获，执行分布式事务二阶段提交，回滚事务。

 ![](https://my-img-1.oss-cn-hangzhou.aliyuncs.com/image-20221016155436112.png)

@ -112,32 +103,30 @@ docker-compose-env.yml文件运行成功之后，添加Nacos配置：

 #### 场景说明

-针对大流量背景下的服务熔断限流，削峰填谷，SCA社区提供了**用户为商品进行点赞的场景**。在此场景下，SCA社区提供了两种应对大流量的处理方式。
+针对大流量背景下的服务熔断限流，削峰填谷，SCA 社区提供了**用户为商品进行点赞的场景**。在此场景下，SCA 社区提供了两种应对大流量的处理方式。

 - Sentinel 在网关侧绑定指定网关路由进行服务的熔断降级。
 - RocketMQ 进行流量削峰填谷，在大流量请求下，生产者向 RocketMQ 发送消息，而消费者则通过可配置的消费速率进行拉取消费，减少大流量直接请求数据库增加点赞请求的压力。

 #### 启动测试

-分别启动`integrated-praise-provider`以及`integrated-praise-consumer`模块。
-
 - Sentinel 服务熔断降级

-访问`http://integrated-frontend:8080/sentinel` 体验对应场景。
+访问 `http://integrated-frontend:8080/sentinel` 体验对应场景。

 ![](https://my-img-1.oss-cn-hangzhou.aliyuncs.com/image-20221016155501290.png)

 网关路由点赞服务的限流规则为 5，而在前端通过异步处理模拟了 10 次并发请求。

-因此可以看到 Sentinel 在 Gateway 侧针对多出的流量进行了服务熔断返回 fallback 给客户端，同时数据库的点赞数进行了更新(+5)。
+因此可以看到 Sentinel 在 Gateway 侧针对多出的流量进行了服务熔断返回 fallback 给客户端，同时数据库的点赞数进行了更新（+5）。

 ![](https://my-img-1.oss-cn-hangzhou.aliyuncs.com/image-20220914155755103.png)

 - RocketMQ 进行流量削峰填谷

-访问`http://integrated-frontend:8080/rocketmq` 体验对应场景。
+访问 `http://integrated-frontend:8080/rocketmq` 体验对应场景。

-由于之前在 Nacos 中配置了`integrated-praise-consumer`消费者模块的消费速率以及间隔，在点击按钮时应用模拟 1000 个点赞请求，针对 1000 个点赞请求，`integrated-praise-provider`
+由于之前在 Nacos 中配置了 `integrated-praise-consumer` 消费者模块的消费速率以及间隔，在点击按钮时应用模拟 1000 个点赞请求，针对 1000 个点赞请求，`integrated-praise-provider`
 会将 1000 次请求都向 Broker 投递消息，而在消费者模块中会根据配置的消费速率进行消费，向数据库更新点赞的商品数据，模拟大流量下 RocketMQ 削峰填谷的特性。

 可以看到数据库中点赞的个数正在动态更新。