# 部署方式

Apache RocketMQ 5.0 版本完成基本消息收发，包括 NameServer、Broker、Proxy 组件。 在 5.0 版本中 Proxy 和 Broker 根据实际诉求可以分为 Local 模式和 Cluster 模式，一般情况下如果没有特殊需求，或者遵循从早期版本平滑升级的思路，可以选用Local模式。

- 在 Local 模式下，Broker 和 Proxy 是同进程部署，只是在原有 Broker 的配置基础上新增 Proxy 的简易配置就可以运行。
- 在 Cluster 模式下，Broker 和 Proxy 分别部署，即在原有的集群基础上，额外再部署 Proxy 即可。

## 一、Local模式部署

由于 Local 模式下 Proxy 和 Broker 是同进程部署，Proxy本身无状态，因此主要的集群配置仍然以 Broker 为基础进行即可。

### 1、启动 NameServer
NameServer需要先于Broker启动，且如果在生产环境使用，为了保证高可用，建议一般规模的集群启动3个NameServer，各节点的启动命令相同，如下：

```bash
### 首先启动Name Server
$ nohup sh mqnamesrv &
 
### 验证Name Server 是否启动成功
$ tail -f ~/logs/rocketmqlogs/namesrv.log
The Name Server boot success...
```




### 2、启动Broker+Proxy

#### 2.1 单组节点单副本模式

:::warning{title="注意"}
这种方式风险较大，因为 Broker 只有一个节点，一旦Broker重启或者宕机时，会导致整个服务不可用。不建议线上环境使用, 可以用于本地测试。
:::

启动 Broker+Proxy

```bash
$ nohup sh bin/mqbroker -n localhost:9876 --enable-proxy &

### 验证Broker 是否启动成功，例如Broker的IP为：192.168.1.2，且名称为broker-a
$ tail -f ~/logs/rocketmqlogs/broker_default.log 
The broker[xxx, 192.169.1.2:10911] boot success...
```


:::tip{title="内存调整"}
此步骤可能会遇到以下报错：
`/home/ctm/evn/rocketmq-all-5.2.0-bin-release/bin/runbroker.sh: line 123: 7444 Killed "$JAVA" ${JAVA_OPT} $@`

这是因为启动脚本中这个参数默认配置是8G，需要根据实际情况修改
:::


 <img src="https://data.golovin.cn/img/21dc649f2418b24bfd41f7dcf9526fab.image.png?imagevanblog" width="95%">



 <img src="https://data.golovin.cn/img/a90f65e7b1c27a450778f3bad34a671a.image.png?imagevanblog" width="70%">



 <img src="https://data.golovin.cn/img/db8cbee1f5da5dc0821340bbb80b75e4.image.png?imagevanblog" width="90%">



#### 2.2 多组节点（集群）单副本模式

一个集群内全部部署 Master 角色，不部署Slave 副本，例如2个Master或者3个Master，这种模式的优缺点如下：

- 优点：配置简单，单个Master宕机或重启维护对应用无影响，在磁盘配置为RAID10时，即使机器宕机不可恢复情况下，由于RAID10磁盘非常可靠，消息也不会丢（异步刷盘丢失少量消息，同步刷盘一条不丢），性能最高；

- 缺点：单台机器宕机期间，这台机器上未被消费的消息在机器恢复之前不可订阅，消息实时性会受到影响。


启动Broker+Proxy集群

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-noslave/broker-a.properties --enable-proxy &
 
### 在机器B，启动第二个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-noslave/broker-b.properties --enable-proxy &
```

:::note

如上启动命令是在单个NameServer情况下使用的。对于多个NameServer的集群，Broker启动命令中`-n`后面的地址列表用分号隔开即可，例如 `192.168.1.1:9876;192.161.2:9876`。

:::

#### 2.3 多节点（集群）多副本模式-异步复制

每个Master配置一个Slave，有多组 Master-Slave，HA采用异步复制方式，主备有短暂消息延迟（毫秒级），这种模式的优缺点如下：

- 优点：即使磁盘损坏，消息丢失的非常少，且消息实时性不会受影响，同时Master宕机后，消费者仍然可以从Slave消费，而且此过程对应用透明，不需要人工干预，性能同多Master模式几乎一样；

- 缺点：Master宕机，磁盘损坏情况下会丢失少量消息。


启动Broker+Proxy集群

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-a.properties --enable-proxy &
 
### 在机器B，启动第二个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-b.properties --enable-proxy &
 
### 在机器C，启动第一个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-a-s.properties --enable-proxy &
 
### 在机器D，启动第二个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-b-s.properties --enable-proxy &
```

#### 2.4 多节点（集群）多副本模式-同步双写

每个Master配置一个Slave，有多对 Master-Slave，HA采用同步双写方式，即只有主备都写成功，才向应用返回成功，这种模式的优缺点如下：

- 优点：数据与服务都无单点故障，Master宕机情况下，消息无延迟，服务可用性与数据可用性都非常高；

- 缺点：性能比异步复制模式略低（大约低10%左右），发送单个消息的RT会略高，且目前版本在主节点宕机后，备机不能自动切换为主机。

启动 Broker+Proxy 集群

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-a.properties --enable-proxy &
 
### 在机器B，启动第二个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-b.properties --enable-proxy &
 
### 在机器C，启动第一个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-a-s.properties --enable-proxy &
 
### 在机器D，启动第二个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-b-s.properties --enable-proxy &
```
:::tip
以上 Broker 与 Slave 配对是通过指定相同的 BrokerName 参数来配对，Master 的 BrokerId 必须是 0，Slave 的 BrokerId 必须是大于 0 的数。另外一个 Master 下面可以挂载多个 Slave，同一 Master 下的多个 Slave 通过指定不同的 BrokerId 来区分。$ROCKETMQ_HOME指的RocketMQ安装目录，需要用户自己设置此环境变量。
:::
#### 2.5 在5.0版本 HA新模式
提供更具灵活性的HA机制，让用户更好的平衡成本、服务可用性、数据可靠性，同时支持业务消息和流存储的场景。[详见](https://rocketmq.apache.org/zh/docs/deploymentOperations/03autofailover)

## 二、Cluster模式部署

在 Cluster 模式下，Broker 与 Proxy分别部署，我可以在 NameServer和 Broker都启动完成之后再部署 Proxy。

在 Cluster模式下，一个 Proxy集群和 Broker集群为一一对应的关系，可以在 Proxy的配置文件 `rmq-proxy.json` 中使用 `rocketMQClusterName` 进行配置

### 1、启动 NameServer

```bash
### 首先启动Name Server
$ nohup sh mqnamesrv &
 
### 验证Name Server 是否启动成功
$ tail -f ~/logs/rocketmqlogs/namesrv.log
The Name Server boot success...
```

### 2、启动 Broker

#### 2.1 单组节点单副本模式

:::caution
这种方式风险较大，因为 Broker 只有一个节点，一旦Broker重启或者宕机时，会导致整个服务不可用。不建议线上环境使用, 可以用于本地测试。
:::

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 &
```

#### 2.2 多组节点（集群）单副本模式

一个集群内全部部署 Master 角色，不部署Slave 副本，例如2个Master或者3个Master，这种模式的优缺点如下：

- 优点：配置简单，单个Master宕机或重启维护对应用无影响，在磁盘配置为RAID10时，即使机器宕机不可恢复情况下，由于RAID10磁盘非常可靠，消息也不会丢（异步刷盘丢失少量消息，同步刷盘一条不丢），性能最高；

- 缺点：单台机器宕机期间，这台机器上未被消费的消息在机器恢复之前不可订阅，消息实时性会受到影响。

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-noslave/broker-a.properties &
 
### 在机器B，启动第二个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-noslave/broker-b.properties &
```

:::note

如上启动命令是在单个NameServer情况下使用的。对于多个NameServer的集群，Broker启动命令中`-n`后面的地址列表用分号隔开即可，例如 `192.168.1.1:9876;192.161.2:9876`。

:::

#### 2.3 多节点（集群）多副本模式-异步复制

每个Master配置一个Slave，有多组 Master-Slave，HA采用异步复制方式，主备有短暂消息延迟（毫秒级），这种模式的优缺点如下：

- 优点：即使磁盘损坏，消息丢失的非常少，且消息实时性不会受影响，同时Master宕机后，消费者仍然可以从Slave消费，而且此过程对应用透明，不需要人工干预，性能同多Master模式几乎一样；

- 缺点：Master宕机，磁盘损坏情况下会丢失少量消息。

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-a.properties &
 
### 在机器B，启动第二个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-b.properties &
 
### 在机器C，启动第一个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-a-s.properties &
 
### 在机器D，启动第二个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-async/broker-b-s.properties &
```

#### 2.4 多节点（集群）多副本模式-同步双写

每个Master配置一个Slave，有多对 Master-Slave，HA采用同步双写方式，即只有主备都写成功，才向应用返回成功，这种模式的优缺点如下：

- 优点：数据与服务都无单点故障，Master宕机情况下，消息无延迟，服务可用性与数据可用性都非常高；

- 缺点：性能比异步复制模式略低（大约低10%左右），发送单个消息的RT会略高，且目前版本在主节点宕机后，备机不能自动切换为主机。

```bash
### 在机器A，启动第一个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-a.properties &
 
### 在机器B，启动第二个Master，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-b.properties &
 
### 在机器C，启动第一个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-a-s.properties &
 
### 在机器D，启动第二个Slave，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqbroker -n 192.168.1.1:9876 -c $ROCKETMQ_HOME/conf/2m-2s-sync/broker-b-s.properties &
```
:::tip
以上 Broker 与 Slave 配对是通过指定相同的 BrokerName 参数来配对，Master 的 BrokerId 必须是 0，Slave 的 BrokerId 必须是大于 0 的数。另外一个 Master 下面可以挂载多个 Slave，同一 Master 下的多个 Slave 通过指定不同的 BrokerId 来区分。$ROCKETMQ_HOME指的RocketMQ安装目录，需要用户自己设置此环境变量。
:::

#### 2.5 在5.0版本 HA新模式
提供更具灵活性的HA机制，让用户更好的平衡成本、服务可用性、数据可靠性，同时支持业务消息和流存储的场景。[详见](https://rocketmq.apache.org/zh/docs/deploymentOperations/03autofailover)

### 3、启动 Proxy

可以在多台机器启动多个Proxy

```shell
### 在机器A，启动第一个Proxy，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqproxy -n 192.168.1.1:9876 &

### 在机器B，启动第二个Proxy，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqproxy -n 192.168.1.1:9876 &

### 在机器C，启动第三个Proxy，例如NameServer的IP为：192.168.1.1
$ nohup sh bin/mqproxy -n 192.168.1.1:9876 &
```

若需要指定配置文件，可以使用 `-pc`或者 `--proxyConfigPath` 进行指定

```shell
### 自定义配置文件
$ nohup sh bin/mqproxy -n 192.168.1.1:9876 -pc /path/to/proxyConfig.json &
```

RocketMQ-5.2.0安装部署手册

# 思考和整理自己日常工作中架构相关事项，以班为单位，提交信息汇总



## 1、自己工作中的哪些任务是跟架构相关的?

1. 近一年工作中，有涉及过一次dubbo项目重构为sofa框架的项目改造，在这个期间主要的内容分为几个部分：
* 项目module结构改造和maven依赖的梳理与替换；
* 业务代码启动类等相关注解、import依赖的替换；
* 以及部分组件的更换适配sofa，



 * 如定时任务由原本的xxljob更换为sofa金融云提供的定时任务平台，定时任务改为由平台配置，相关代码根据手册和原有定时任务的性质重构为其划分的简单定时任务、分片/分库定时任务、拓扑定时任务
 * 缓存由原本的redis更换为tair（基于redis，也兼容redis）
 * 动态配置由原本的基于nacos的实现方案更换为sofa金融云实例上的动态配置，通讯rpc方式也是发生了变化，系统与外部系统通讯也更换为通过在云平台上注册Api网关的形式暴露出去

2. 另外还有一次是负责系统的ERP模块的设计实现工作，在这个任务期间，对输入输出的公共报文体的思考和定义；数据的解析校验，公共处理部分，业务处理模块的划分；与原系统的的对接整合与解耦合；ERP接口文档的编写和外部系统的对接，有了更进一步的思考和探索与学习

* 总体用一句话来描述我对我设计的erp系统的定位：类似于网关模块的一个概念，但也不完全相同：它既做与外部系统与主系统的桥接关系，也对主系统仅做服务接口引用达到数据获取的目的，此外所有复杂的数据处理逻辑均在erp系统中各自erp接口模块中自行实现；达到既连通，又相对独立的目的。

## 2、能否大概描述自己负责的/做过的业务系统的业务需求和大概流程?

* 我主要负责主系统中交易模块的需求开发与日常维护，今年开始基本以维护为主。需求大概就是实现企业创建付款单据然后提交审批复核，最终生成指令做实际交易，以及交易后期的相关业务；
* 流程相对复杂，总体来讲大部分逻辑体现在前端的付款制单的业务流程、校验流程、和整个流程面临的各类分流分支处理上，当然提交到后端后仍然会进行统一套但略微有区别（主要是顺序性和关联性和流程性没有前端那样强，但该有的校验均需要后端再控制一遍，不满足则报错，这是处于安全性与实时性的考虑）。期间涉及各大中台与关联系统的对接与维护工作，实现系统校验的正确性和时效性，这也简便了整个付款逻辑的复杂度，但同时也带来了维护成本的大幅增加（沟通成本、也带来了一定的强关联性，比如中台服务挂掉了，系统支付业务就无法继续进行，但这也是合理的，因为实际交易也是交易中心与核心及统一支付系统处理，中台宕机理应无法交易）


## 3、能否讲清楚自己目前负责的系统使用的各类技术，框架，以及组件，模块等

1. 大概能理清楚主系统涉及和使用到的技术和组件有哪些、如何使用的，应用场景是哪些，划分模块的根据和理由是什么。自我评价，对系统的熟练和认知程度表面而言应该是在80%的样子，对具体组件的深刻理解上还远远不够，大概在40%的程度，后续应该考虑两个问题：

* 横向：如果我要用xxx替换当前使用的xxx，会有什么不同，两者优劣在哪？对系统带来的影响和改动有哪些？
* 纵向：当前使用的这个组件和技术还具备哪些能力，能否应用到系统中？当前系统面临的某些瓶颈是否可以通过部分组件的合力应用达到优化的目的？这个组件和技术的实现原理是什么，为什么会是这样？

Week 01 

:::info{title="Copilot远程授权工具"}
支持系统：Windows10以上，MacOS，Linux
支持IDE：VSCode正式最新版（预览版不支持），Jetbrains全家桶，AndroidStudio，VS 2022以上（暂时只支持Windows的VS）。
:::


# 激活步骤


:::warning{title="注意"}
注意：下载的激活器请保证文件完整性，请不要把其中的copilot_activator可执行文件移动到其他文件夹下使用。
:::

1. 你要用什么插件先安装好插件，如果你之前已经安装过，请确保自己已经升级到最新版本。





:::note{title="Copilot系列的三个插件"}
Github Copilot（支持VScode、Jetbrains、AndroidStudio、VS）
Github Copilot Labs（只支持VScode）
Github Copilot Chat（只支持VScode，需购买Chat版授权码）
:::

2. 根据你的操作系统下载相对应最新版本的授权器。下载前关闭电脑的杀毒软件，解压后把目录加入白名单，因为授权器会进行修改插件文件的操作，所以杀毒软件会报毒，但软件绝无任何木马病毒，可以放心使用。

:::note{title="下载链接"}
下载链接：https://wwa.lanzoub.com/b04wcnlqj
提取密码：dxke

这里对于使用mac电脑的，要看你的vscode和jetbrains是intel版本还是apple版本去下载对应的，而不是看你电脑实际的芯片去下对应的。
:::


 <img src="https://data.golovin.cn/img/02f7d118df3962353216373af6f52f8d.image.png?imagevanblog" width="80%">


3. Copilot如果登录着其他github账号，退出掉，VSCode点击左下角人头像退出，JetBrains点击右下角Copilot图标退出。彻底关闭VSCode，Jetbrains等软件（如果关了还是报错，可能有残留进程，请重启电脑），打开软件的情况下运行授权器可能导致授权失败！
 
4. 将下载的压缩包解压，双击运行其中的copilot activator。如果你的电脑是Linux，终端运行./copilot_activator命令，另外注意Linux不支持ARM架构, 需要Glibc大于2.28(ldd --version查看glibc版本号)
 

 <img src="https://data.golovin.cn/img/aa571a070eb0f05e2c92dfb6fe664d90.image.png?imagevanblog" width="80%">


5. 输入你的授权码授权并按回车。（授权码中的横线不要删除，前后不要有空格）


 <img src="https://data.golovin.cn/img/c223781d28fa3f68d9de300260679a1e.image.png?imagevanblogg" width="80%">


6. 选择你要授权的软件，输入数字按回车即可：


 <img src="https://data.golovin.cn/img/d5d1066301f6543cdea109a99a966d95.image.png?imagevanblog" width="50%">


7. 这时候回到软件查看是否激活成功。如果还是不好用，请先找到你的copilot插件目录，可能由于插件目标被修改过导致激活器没有能够替换成功。
 常规插件目录可以百度搜一下都有。
 激活成功后，VSCode插件目录内的dist文件夹下应该多一个activator.js文件。
 

 <img src="https://data.golovin.cn/img/e9a0b9a80052254ccd7ba1537dfdeafa.image.png?imagevanblog" width="80%">


 - 其他软件的插件目录下的copilot-agent/bin文件夹下应该只有1个copilot-agent可执行文件，而不是4个。
 

 <img src="https://data.golovin.cn/img/7ba5ddfd15cef5e13da6de6d9cef1682.image.png?imagevanblog" width="80%">


 - 以上确认没有问题后，根据下面的常见问题自查。
 
# 常见问题

:::tip{title="显示激活成功，还是不好用怎么办？"}
1. 首先尝试关闭软件重新打开。
2. Copilot如果登录着其他github账号, 退出掉，VSCode点击左下角人头像退出，JetBrains点击右下角Copilot图标退出。关闭软件重新激活，这时候如果需要可以再次登录您自己的账号。
3. 还是不行的话把插件卸载重新安装，重新激活。
4. 排查网络问题，你的网络连不上Copilot服务器也不行。参考此问题Copilot Activator使用文档专用 
5. 对于jetbrians（主要是windows系统用户），可能你的插件目录和常规插件目录不一致，被修改过，这种情况下，请找到自己的插件目录，将plugins/github-copilot-intellij/copilot-agent/bin目录下的所有文件删除，把激活软件中的bin目录复制到该目录，然后就完事了就可以用了，不用再管激活器了。常规插件目录：%appdata%\JetBrains\软件名；非常规插件目录查找方法：参考这个https://www.bmqy.net/1773.html
:::

:::tip{title="MacOS激活后右下角图标还有斜杠，或者总是不稳定突然不好用怎么办？"}
1. 首先排除上面的通用问题，重启软件，登出原有账号
2. 升级激活器到版本0.3.3以上。
:::

:::tip{title="VSCode激活之后右下角copilot图标不见了？"}
升级VSCode以及copilot插件到最新版本。
:::

:::tip{title="已经激活，后续插件可以升级更新吗？"}
可以，升级后需要把上面的激活操作再做一遍。一般如果使用没问题不建议升级。
:::

:::tip{title="其他两个插件能用，但我为什么用不了Copilot Chat?"}
检查你购买的授权码是否有Chat权限，普通版授权码不可以使用Copilot Chat。
:::

:::tip{title="Copilot的图标一直在转圈? 提示激活成功 但是进入到编辑器中提示Connect ETIMEDOUT errorcode -32603错误?或者图标有斜杠，或者不提示，或者图标没翻译。"}
解决方法:
1.开梯子如果有TUN模式可以开TUN模式(注意Jet全家桶需要在ide的设置中设置代理, 否则梯子白开,就算开的全局模式也是!全家桶设置代理教程)
2.使用Github520的库(github.com/521xueweihan/GitHub520),如果使用请查看该库的自带的教程
3.使用Hosts库(github.com/ineo6/hosts),如果使用请查看该库的自带的教程
:::

:::tip{title="Jetbrains激活显示检测不到插件，自己是用ToolBox安装的软件怎么办？"}
1. 方法一：把激活软件中的bin目录复制到插件目录（一般在ToolBox安装目录下面）的 apps/应用名/plugins/github-copilot-intellij/copilot-agent/bin 路径下面，并删除原来bin目录下的所有文件。然后就完事了就可以用了，不用再管激活器了。
2. 方法二：升级ToolBox到最新版本，会自动执行迁移。
:::

:::tip{title="有效期内突然不能用了?"}
最常见的原因导致激活失效是GitHub Copilot扩展或插件的升级，这会导致会话被清除。在这种情况下，只需重新运行激活工具即可恢复激活状态。如果还是不行请联系客服
:::

Copilot Activator使用文档

Linux搭建私有GitLab社区版

# 一、JMeter介绍

**Apache JMeter** 是一个开源软件，是 **Apache Software Foundation** 的一部分，用于性能测试和评估 **Web** 应用程序的性能。


 <img src="https://data.golovin.cn/img/2cf73716a91c0832309dc66e51d2a384.image.png?imagevanblog" width="95%">


以下是关于 **JMeter** 的一些基本介绍：



1. **目的**：
 - **JMeter** 主要用于对软件、应用和服务进行加载测试、性能测试、压力测试和功能测试。

2. **功能**：
 - 可以测试 **Web** 应用程序、**Web** 服务、数据库、**FTP**、**SMTP**、**POP3** 等各种服务和协议。
 - 提供图形用户界面，便于创建和管理测试计划。
 - 可以模拟多个用户同时向服务器发送请求，以测试服务器的负载能力。
 - 支持多线程和并发用户加载。
 - 支持数据驱动的测试（例如，从 **CSV** 文件读取数据）。
 - 结果可视化，提供各种图形和表格展示测试结果。
 - 可以扩展功能，支持自定义插件。

3. **如何使用**：
 - **JMeter** 提供了一个图形用户界面（**GUI**）来创建和编辑测试计划。用户可以通过添加不同的“元件”（例如采样器、定时器、断言、逻辑控制器等）来定义测试的流程和行为。
 - 创建的测试计划可以保存为 **`.jmx`** 文件，之后可以重新加载进行编辑或执行。

4. **分布式测试**：
 - **JMeter** 还支持分布式测试，允许使用多台机器并发地执行测试，以模拟更大规模的用户负载。

5. **注意事项**：
 - 使用 **JMeter** 时，最好不要使用其图形界面进行大规模或高并发的测试，因为 **GUI** 可能会消耗额外的资源。通常建议在非 **GUI** 模式下执行这些测试。
 - 虽然 **JMeter** 主要用于 **Web** 应用测试，但它并非一个浏览器，因此可能不会执行像 **JavaScript** 这样的客户端代码。


# 二、下载安装

**1、点击**[**官网下载**](https://jmeter.apache.org/download_jmeter.cgi)。

> **或者点击文件图标，下载我的相同版本**：
[<img src="https://data.golovin.cn/img/5800ade5d0fbade79fe7747e6f4b0587.8168644_folder_document_file_format_icon.png?imagevanblog" width="50" alt="File Icon">](https://vlog-1320690590.cos.ap-shanghai.myqcloud.com/files/apache-jmeter-5.6.2.zip)


 <img src="https://data.golovin.cn/img/08030052ac30668500b4de6e59f7faa1.image.png?imagevanblog" width="75%">


**2、解压运行`jmeter.bat`文件**。一般在解压目录的这个位置：**`apache-jmeter-5.6.2\bin\jmeter.bat`**

**3、下载**[**插件管理器**](https://jmeter-plugins.org/install/Install/)，并放置在**Jmeter**的`/lib/ext`目录下，**重启**。

> **当然也可以直接下载我的相同版本**：[<img src="https://data.golovin.cn/img/145ecca758e6b6cdf3c59d5a2af6b3d3.3876350_executable_extension_file_jar_icon.png?imagevanblog" width="50" alt="File Icon">](https://vlog-1320690590.cos.ap-shanghai.myqcloud.com/files/jmeter-plugins-manager-1.9.jar)


 <img src="https://data.golovin.cn/img/f0c4d55c11fd3f10c6636445ef39e747.image.png?imagevanblog" width="90%">


**4、修改语言**。当然大家可能不习惯原界面是全英文，我们可以采用两种方式进行语言修改：

> **方式一**：我们可以通过系统设置中文：**`options`** -> **`Choose Language`** -> **`Chinese(Simplified)`**
>

 <img src="https://data.golovin.cn/img/642685f2999befe04534454e9d91a668.image.png?imagevanblog" width="80%">


> **方式二**：我们也可以修改配置文件：找到 **Jmeter** 的`bin`目录，打开 **`jmeter.properties`** 文件，找到语言配置`language=`这一行，可能一开始这行是被`#`给注释掉了，所以我们要去掉这个符号，然后我们把它设置为`zh_CN`即可：**language=zh_CN**，这样每次启动都会自动设置为中文界面。**别忘记编辑之后需要保存一下噢**。


 <img src="https://data.golovin.cn/img/7caa5e9a393d734a2061faa41b1e393f.image.png?imagevanblog" width="80%">


**5、这时候可以在选项栏看到最下方的`Plugins Manager`**


 <img src="https://data.golovin.cn/img/b6b64b32765d59d45046b544f29d176a.image.png?imagevanblog" width="60%">


**6、安装插件：**点击**`Available Plugins`**搜索`jpgc - Standard Set`，勾选后点击应用并重启，这时候就会自动下载对应的插件，**请耐心等待插件下载安装完毕后会自动重启**，如果这时候手动重启，插件就不会安装好。安装好后，再次打开**Plugins Manager**就可以在**Installed Plugins（已安装插件）** 位置看到它并且已经是勾选状态。

 <img src="https://data.golovin.cn/img/fa0b8bc8d761bebf71fcb73f64fd9cf1.image.png?imagevanblog" width="80%">


**7、查看插件是否成功启用。** 这时候我们就可以发现，在给我们的`测试计划`中，对`线程组`添加`监听器`时，会多出如下图所示的部分`结果分析`的插件，他们会**根据监听的结果生成图表**，其中常用的就是：**jp@gc - Transactions per Second（TPS）**


 <img src="https://data.golovin.cn/img/2d2d3194aa3743e1963b016263d07857.image.png?imagevanblog" width="80%">


# 三、Jmeter主要元件

## 1、各元件的基本介绍

在开始应用Jmeter前我们先对它的主要元件做一下了解：

1、**测试计划**：是使用 **JMeter** 进行测试的起点，它是其它 **JMeter** 测试元件的容器

2、**线程组**：代表一定数量的用户，它可以用来模拟用户并发发送请求。实际的请求内容在`Sampler`中定义，它被线程组包含。

3、**配置元件**：维护`Sampler`需要的配置信息，并根据实际的需要修改请求的内容。

4、**前置处理器**：负责在请求之前工作，常用来修改请求的设置

5、**定时器**：负责定义请求之间的延迟间隔。

6、**取样器(Sampler)**：是性能测试中向服务器发送请求，记录响应信息、响应时间的最小单元，如：`HTTP Request Sampler`、`FTP Request Sample`、`TCP Request Sample`、`JDBC Request Sampler`等，每一种不同类型的`sampler`可以根据设置的参数向服务器发出不同类型的请求。

7、**后置处理器**：负责在请求之后工作，常用获取返回的值。

8、**断言**：用来判断请求响应的结果是否如用户所期望的。

9、**监听器**：负责收集测试结果，同时确定结果显示的方式。

10、**逻辑控制器**：可以自定义`JMeter`发送请求的行为逻辑，它与`Sampler`结合使用可以模拟复杂的请求序列。

## 2、各元件的作用域和执行顺序

1. **元件作用域**

 **配置元件**：影响其作用范围内的所有元件。
 前置处理器：在其作用范围内的每一个sampler元件之前执行。

 **定时器**：在其作用范围内的每一个sampler有效

 **后置处理器**：在其作用范围内的每一个sampler元件之后执行。

 **断言**：在其作用范围内的对每一个sampler元件执行后的结果进行校验。

 **监听器**：在其作用范围内对每一个sampler元件的信息收集并呈现。

 **总结：从各个元件的层次结构判断每个元件的作用域。**

2. **元件执行顺序**：

 配置元件->前置处理器->定时器->取样器->后置处理程序->断言->监听器


:::tip{title="注意事项"}
1. **前置处理器、后置处理器和断言等组件只能对取样器起作用，因此，如果在它们的作用域内没有任何取样器，则不会被执行。**

2. **如果在同一作用域内有多个同一类型的元件，则这些元件按照它们在测试计划中的上下顺序依次执行。**
:::

# 三、接口测试流程介绍

## 1、基本步骤

1. **测试计划**

2. **线程组**

3. **HTTP Cookie管理器**

4. **Http请求默认值**

5. **Sampler**(**HTTP请求**)

6. **断言**

7. **监听器**(**查看结果树、图形结果、聚合报告等**)


## 2、测试流程步骤详解：

### 1、测试计划

打开Jmeter，在菜单左侧出现 “测试计划”。在这里测试计划我们可以把它理解成新建的空白项目，在这个空白项目下面可以添加一系列的接口。


 <img src="https://data.golovin.cn/img/33548aa17da34b918d465575fab0544e.image.png?imagevanblog" width="100%">


### 2、线程组

> **添加方法**：右键点击`Test Plan` -> `添加` -> `线程(用户)` -> `线程组`


 <img src="https://data.golovin.cn/img/31544ebca94c8b0235b1691f6afce12a.image.png?imagevanblog" width="80%">


> **元件描述**：一个线程组可以看做一个虚拟用户组，线程组中的每个线程都可以理解为一个虚拟用户。
> 


 <img src="https://data.golovin.cn/img/41717454123ebd9fe8b296362128068a.image.png?imagevanblog" width="60%">


:::note{title="属性参数"}
1. **线程数**：即虚拟用户数。设置多少个线程数也就是设置多少虚拟用户数

2. **Ramp-Up时间(秒)**：设置虚拟用户数全部启动的时长。如果线程数为20,准备时长为10秒,那么需要10秒钟启动20个线程。也就是平均每秒启动2个线程。

3. **循环次数**：每个线程发送请求的个数。如果线程数为20,循环次数为10,那么每个线程发送10次请求。总请求数为20*10=200。如果勾选了“永远”, 那么所有线程会一直发送请求,直到手动点击工具栏上的停止按钮,或者设置的线程时间结束。
:::

### 3、HTTP Cookie管理器

> **添加方法**：右键`线程组` -> `添加` -> `配置元件` -> `HTTP Cookie管理器`
>
> **元件描述**：(简单举例就是登录之后不需要再次登录类似的场景)**HTTP Cookie**管理器可以像浏览器一样存储和发送**cookie**，如果你要发送一个带**cookie**的**http**请求，**cookie manager**会自动存储该请求的**cookies**，并且后面如果发送同源站点的**http**请求时，都可以用这个**cookies**
> 

 <img src="https://data.golovin.cn/img/952e91e8247f0a9ef76252407a563801.image.png?imagevanblog" width="90%">


### 4、HTTP请求默认值

> **添加方法**：右键`线程组` -> `添加` -> `配置元件` -> `HTTP请求默认值`
>
> **元件描述**：**HTTP**请求默认值是为了方便填写后续内容而设置。主要填写[`服务器名称或IP`]和[`端口号`]，后续的**HTTP**请求中就不用每次都填写`IP地址`和`端口号`了。


 <img src="https://data.golovin.cn/img/350f2f41992521450a87ff7431f23357.image.png?imagevanblog" width="95%">


### 5、HTTP请求

> **添加方法**：右键`线程组` -> `添加` -> `Sampler(取样器)` -> `HTTP请求`
> 

 <img src="https://data.golovin.cn/img/17c10786f9f48733d77c71ea4a5cc926.image.png?imagevanblog" width="70%">


> **元件描述**：**HTTP**请求包括接口请求方法、请求路径和请求参数等。


 <img src="https://data.golovin.cn/img/4a181a3bd9c8dfb73da596242d7cff03.image.png?imagevanblog" width="95%">


:::note{title="HTTP请求参数配置详解"}

1. **名称**：本属性用于标识一个取样器，建议使用一个有意义的名称。
2. **注释**：对于测试没有任何作用，仅用户记录用户可读的注释信息。
3. **服务器名称或IP**：HTTP请求发送的目标服务器名称或IP地址。
4. **端口号**：目标服务器的端口号，默认值为80。
5. **协议**：向目标服务器发送HTTP请求时的协议，可以是HTTP或者是HTTPS，默认值为http。
6. **方法**：发送HTTP请求的方法，可用方法包括GET、POST、HEAD、PUT、TRACE、OPTIONS、DELETE等。
7. **路径**：目标URL路径（不包括服务器地址和端口）。
8. **内容编码**：内容的编码方式，默认值为iso8859。
9. **自动重定向**：如果选中该选项，当发送HTTP请求后得到的响应是302/301时，JMeter自动重定向到新的页面。
10. **使用keep Alive**：保持jmeter和目标服务器之间的活跃状态，默认选中。
11. **对Post使用multipart/from-data**：当发送POST请求时，使用multipart/from-data方法发送，默认不选中。
12. **同请求一起发送参数**：在请求中发送URL参数，对于带参数的URL，jmeter提供了一个简单的对参数化的方法。用户可以将URL中所有参数设置在本表中，表中的每一行是一个参数值对（对应RUL中的名称1=值1）。
:::

### 6、响应断言

> **添加方法**：右键`HTTP请求` -> `添加` -> `取样器` -> `HTTP请求`


 <img src="https://data.golovin.cn/img/6c495e66fd808820916d7513098ded33.image.png?imagevanblog" width="80%">


> **元件描述**：检查接口是否访问成功。如果检查失败的话会提示找不到断言的内容，没提示的话就代表成功了。
> 

 <img src="https://data.golovin.cn/img/dcb6f15d3edc6de35bda0d88afb63759.image.png?imagevanblog" width="95%">


:::note{title="配置属性释义"}
**1、Apply to**

**指断言作用范围，通常发出一个请求只触发一个请求，所以勾选“main sample only”就可以；若发一个请求可以触发多个服务器请求，就有main sample 和sub-sample之分了。**

1. **Main sample and sub-samples**：作用于主请求和子请求
2. **Main sample only**：仅仅只作用于主请求
3. **Sub-samples only**：仅仅只作用于子请求
4. **Jmeter Variable**：作用于jmeter变量(输入框内输入jmeter变量名称)

**2、测试字段**

- **响应文本**：匹配返回的`json`数据
- **响应代码**：匹配返回码, 如`200`, `404`, `500`等
- **响应信息**：匹配响应信息如“**OK**”字样
- **响应头**：匹配响应头
- **请求头**：匹配请求头
- **URL样本**：匹配请求的url链接,如果有重定向则包含**请求url** 和 **重定向url**
- **文档(文本)**: 匹配响应数据的文本形式
- **忽略状态**：一个请求有多个响应断言，第一个响应断言选中此项，当第一个响应断言失败时可以忽略此响应结果，继续进行下一个断言。如果下一个断言成功则还是判定事务是成功的
- **请求数据**：匹配请求数据

**3、模式匹配规则**

- **包括**：响应内容包含需要匹配的内容即代表响应成功，支持正则表达式。
- **匹配**：响应内容要完全匹配需要匹配的内容即代表响应成功，大小写不敏感，支持正则表达式。
- **字符串**：响应内容包含需要匹配的内容才代表响应成功，大小写敏感，不支持正则表达式
- **相等**：响应内容要完全等于需要匹配的内容才代表响应成功，大小写敏感，不支持正则表达式
- **否**：相当于取反，如果结果为**true**，勾上否就是**false**
- **或者**：如果不想用**AND**连接（所有的模式都必须匹配，断言才算成功），用**OR**选项可以用于将多个断言模式进行**OR**连接(只要一个模式匹配，断言就是成功的)

**4、测试模式**：其实就是断言的数据。点击“添加”按钮，输入要断言的数据。
:::

### 7、增加监听器

> **添加方法**：`线程组` -> 右键`添加` -> `监听器` -> `察看结果树`。一般还会一并添加图形结果、聚合报告。
>
> 元件描述：树状形式显示接口的访问结果，包括请求结果、请求内容、服务器的响应内容。


 <img src="https://data.golovin.cn/img/013da9c398168f303d44693c9b4d4073.image.png?imagevanblog" width="90%">


# 四、Jmeter的应用

## 例一：序列获取 - 简单请求压力测试

> **简单的GET单一请求接口的压力测试**

### 1、HTTP请求配置

1. 首先我们按照之前的基础流程建立`测试计划`、`线程组`和`HTTP请求`；然后根据我的代码的**Controller**层（以下以**Spring Boot**的**Java**项目为例），找到对应需要配置的参数：`端口信息`、`请求路径`、`请求类型` 和 `请求参数`，如图所示：


 <img src="https://data.golovin.cn/img/68a79de2ecfe4cfad6cd63438c9fd3d7.image.png?imagevanblog" width="80%">
 
 Controller参数要素




 <img src="https://data.golovin.cn/img/0de328b9327c3d3d0d7bc7c671fc77c5.image.png?imagevanblog" width="80%">
 
 HTTP请求参数配置


### 2、线程组参数配置

> **我边配置10个并发，在1秒内启动，每个并发用户循环请求序列2000次**


 <img src="https://data.golovin.cn/img/e08ef5beb110b56bf6905ad826e9b6dd.image.png?imagevanblog" width="90%">


### 3、设置监听器

> **我们给`线程组`添加`查看结果树`、`响应时间图`、`Transactions per Second`、`Response Time Over Time`, 如图所示：**


 <img src="https://data.golovin.cn/img/5313fd6e82e7fbd19d8404d729da0b5e.image.png?imagevanblog" width="90%">


> **此外我们还可以对`TPS图` 和 `RTOT图`进行预设设置，他们都有对应的配置，可以调整稍后执行计划后，对结果的分析展示的粒度**


 <img src="https://data.golovin.cn/img/a32ce979b1e2e684e3ef9ba64d01fbc6.image.png?imagevanblog" width="85%">
 
 TPS图配置



 <img src="https://data.golovin.cn/img/90d8697d2326db152135961fcbb6146e.image.png?imagevanblog" width="85%">
 
 PTOT图配置



### 4、执行测试计划

> **保存设定好的测试计划，然后点击绿色按钮，启动测试计划，如图所示：**


 <img src="https://data.golovin.cn/img/b0d8949d3f7db4322f55cf7975070820.image.png?imagevanblog" width="90%">


### 5、结果分析

1. **查看结果树**：每次的请求结果的详情都会展示在查看结果树中，如图所示：


 <img src="https://data.golovin.cn/img/794d4860db5794d2cefec7f254851095.image.png?imagevanblog" width="90%">



2. **响应时间图的生成**：


 <img src="https://data.golovin.cn/img/270a98d2d562fd365ff923bfcab4a201.image.png?imagevanblog" width="80%">
 
 响应时间图生成前配置



 <img src="https://data.golovin.cn/img/bbb4206298cd2ce2ddd8478a45abbe3e.image.png?imagevanblog" width="80%">
 
 生成的响应时间图


3. **TPS图：（自动实时生成）**


 <img src="https://data.golovin.cn/img/e4a9f69652a8917ff3cda75b5b87c700.image.png?imagevanblog" width="90%">


4. **Response Times Over Time图：（自动实时生成）**


 <img src="https://data.golovin.cn/img/25907d63a307fa49c556b0bd9993b367.image.png?imagevanblog" width="90%">


## 例二：登录后菜单列表获取 - 组合请求压力测试

> **复杂的组合请求，整个环节的联动压力测试**

部署方式

一、Local模式部署

1、启动 NameServer

思考和整理自己日常工作中架构相关事项，以班为单位，提交信息汇总

1、自己工作中的哪些任务是跟架构相关的?

激活步骤

一、GitLab简介

1、主要特点

一、JMeter介绍