MockHub

切换主题

🎯 TCP 规则 ​

TCP 规则定义「什么报文命中、命中后如何处理」。管理后台「TCP 代理 → 规则」页面进行配置。

规则结构 ​

字段说明
名称规则名称
方向request（客户端→上游）/ response（上游→客户端）；空表示双向
监听器规则生效的监听器集合；空 = 应用到所有监听器
匹配条件基于解析字段的条件列表
动作proxy / mock / drop
延迟模拟延迟（毫秒）
录制是否录制该消息
关闭drop 时是否直接关闭连接
优先级数值越小越优先

匹配流程 ​

  • 按优先级（越小越优先）依次匹配，命中即执行动作
  • 未命中任何规则时默认透传到上游

匹配条件 ​

匹配基于 Codec 解析出的字段（见 协议 Codec）：

op说明示例
eq等于field: cmd, op: eq, value: "SET"
ne不等于field: cmd, op: ne, value: "QUIT"
contains包含field: body, op: contains, value: "error"
prefix前缀匹配field: orderNo, op: prefix, value: "order-"
suffix后缀匹配field: type, op: suffix, value: ".json"
regex正则匹配field: body, op: regex, value: "^\\d{6}$"
exists字段是否存在field: userId, op: exists

多个匹配条件同时满足才命中（AND 语义）。

动作类型 ​

动作说明
proxy透传到上游（可同时录制报文）
mock返回 mock 数据（支持模板），不转发到上游
drop丢弃该报文（close: true 时直接关闭连接）

mock 响应 ​

action.mock.data 支持模板渲染：

yaml
action:
    type: mock
    mock:
        data: "+OK\r\n"

可用模板变量：

  • {{ .fields.xxx }}：引用解析字段
  • {{ .session.id }}：引用会话 ID
  • 内置函数同 HTTP 模板函数（{{ uuid }}、{{ now }} 等）

配置示例 ​

示例 1：Redis SET 命令 Mock ​

yaml
name: redis-set-mock
enabled: true
priority: 1
direction: request
listeners:
    - redis-demo
match:
    - field: cmd
      op: eq
      value: "SET"
action:
    type: mock
    mock:
        data: "+OK\r\n"
    record: false
    close: false

示例 2：文本协议录制 ​

yaml
name: 文本协议录制
enabled: true
priority: 0
direction: request
listeners:
    - text-demo
match: []
action:
    type: proxy
    record: true
    close: false

录制与抓包 ​

录制 ​

规则 action.record: true 时，命中消息被录制到录制库。管理后台「TCP 代理 → 录制」页面可查询、删除。

  • 录制内容：会话 ID、监听器、方向、规则、原始报文（hex）、解析字段
  • 上限：tcp.maxRecords（默认 10000），超出自动淘汰最旧记录

抓包 ​

管理后台「TCP 代理 → 抓包」页面支持：

  • 实时抓包：开启后实时推送报文（SSE），不阻断转发
  • 临时抓取：页面内实时查看，关闭即停止
  • 持久化：将抓取内容保存到抓包库
  • 抓包记录保留上限：tcp.maxCaptures（见 配置详解）

相关 API ​

方法路径说明
GET/api/tcp/rules规则列表（按监听器归属过滤）
POST/api/tcp/rules新建规则
PUT/api/tcp/rules/:id更新规则
DELETE/api/tcp/rules/:id删除规则
GET/api/tcp/records录制列表
DELETE/api/tcp/records/:id删除单条录制
DELETE/api/tcp/records清空录制
GET/api/tcp/captures抓包列表
GET/api/tcp/captures/stream抓包实时流
GET/api/tcp/captures/temp/stream临时抓包实时流
GET/api/tcp/sessions会话列表

Copyright © 2024-2026