Compare commits

4 Commits

Author SHA1 Message Date
bef70dd032 feat: 文档更新
All checks were successful
序列化结构检查 / serialization-schema-check (push) Successful in 3s
2026-07-15 18:06:31 +08:00
4361fe767f Merge remote-tracking branch origin/dev-1.0-MQ into dev-1.0-MQ
All checks were successful
序列化结构检查 / serialization-schema-check (push) Successful in 2s
保留本地 Phase M2(MQ03~05 / MQ-K03/K04 / MQ-R),解决与远程一阶段提交的冲突。
2026-07-15 17:43:59 +08:00
bb406cd354 feat: 二阶段 2026-07-15 17:38:02 +08:00
d884aa36ff feat: 一阶段 2026-07-15 16:50:04 +08:00
28 changed files with 1083 additions and 125 deletions

View File

@@ -4,7 +4,7 @@
# 说明:
# - 本配置文件为业务覆盖配置,会与 jar 内 default-config.yaml 深度合并
# - 未声明的项沿用工具内置默认值(忽略规则、检测模式等)
# - 当前覆盖 Redis 缓存 + MQRocketMQ/Kafka生产侧投递检测
# - 当前覆盖 Redis 缓存 + MQRocketMQ/Kafka生产侧投递与 MQ-R 读侧补强
# 总开关 true-执行检测 false-跳过检测(流水线直接通过,不发通知)
enabled: true

View File

@@ -15,7 +15,7 @@ Gitea Actions 触发
java -jar 执行(对比 before → after累计 diff
有结构变更 → 企微通知(按 Key 骨架;删除橙/新增绿)
有结构变更 → 企微通知(按 Key 骨架;删除橙/新增绿/修改灰
mode=block 且含任意结构变更 → exit 1流水线失败
```
@@ -95,18 +95,18 @@ java -jar serialization-schema-checker-1.0.0.jar \
## 5. 与现有流水线的关系
| 流水线 | 作用 | 关系 |
|--------|------|------|
|--------|----------------|------|
| `demo.yaml` (AI代码质量分析) | AI Code Review | 并行,互不影响 |
| `code-check` (CodeChecker) | 通用变更检测 | **同模式**,可并列执行 |
| `serialization-schema-check` | 缓存结构检测 | 新增 |
| `serialization-schema-check` | 序列化结构检测 | 新增 |
---
## 6. 工具发布流程(redisCheck 仓库)
## 6. 工具发布流程(schemaCheck 仓库)
```bash
# 在 redisCheck 仓库根目录
# 在 schemaCheck 仓库根目录
mvn clean package -DskipTests
# 发布到 Nexus需配置 settings.xml
@@ -144,7 +144,7 @@ com/codechecker/serialization-schema-checker/1.0.0/
| 大量 Redis 误报 | 锁/计数器未过滤 | 补充 ignore.key_patterns |
| 大量 MQ 误报 | 压测/临时 topic | 补充 ignore.mq_destinations |
| commit 数显示为 1实际多个 | 浅克隆下 `rev-list` 看不到中间提交 | 已修复:优先事件 `commits` 长度;并 deepen 到 before 为祖先 |
| 漏报(模式/模块) | W0x/MQ 未开 / include_modules 过窄 | 确认 W01~W05 与 mq_patterns;检查模块过滤 |
| 漏报(模式/模块) | W0x/MQ 未开 / include_modules 过窄 | 确认 W01~W05 与 mq_patterns(含 MQ03~05、MQ-K03/K04检查 `mq_read_hints_enabled`模块过滤 |
| 类型展开不完整 | 类型在依赖 jar 中 | 补充 `manual_mappings.value_type` |
---
@@ -177,6 +177,6 @@ java -jar /path/to/serialization-schema-checker-1.0.0.jar \
| 文档 | 说明 |
|------|------|
| [实施方案.md](./实施方案.md) | 缓存检测总体方案 |
| [实施方案.md](redis序列化结构检测实施方案.md) | 缓存检测总体方案 |
| [配置说明.md](./配置说明.md) | YAML 配置项 |
| [MQ序列化结构检测方案.md](./MQ序列化结构检测方案.md) | MQ 消息体 SchemaRocketMQ + Kafka方案已落地 |
| [MQ序列化结构检测方案.md](MQ序列化结构检测实施方案.md) | MQ 消息体 SchemaRocketMQ + Kafka方案已落地 |

View File

@@ -1,8 +1,8 @@
# MQ 消息体序列化结构变更检测 — 方案
> 版本v0.3
> 版本v0.4
> 日期2026-07-15
> 状态:**Phase M1 已实现**MQ01/MQ02 + MQ-K01/MQ-K02M2/M3 未启动
> 状态:**Phase M1 + M2 已实现**生产侧 MQ01~05 / MQ-K01~K04 + 读侧 MQ-R
> 关联:复用 `serialization-schema-checker` 的 Schema 提取、Diff、企微通知与 CI 框架
> 业务样本仓:`jnpf-java-cloud`**RocketMQ + Kafka**
@@ -37,7 +37,7 @@
在 push 时静态分析 **消息体类型的序列化 Schema** 是否相对对比区间发生变更,覆盖 **RocketMQ + Kafka**,并复用现有企微通知 / notify|block 能力。
### 1.3 非目标(本方案首版)
### 1.3 非目标
- 不连接真实 Broker不拉取积压消息做运行时校验
- 不解析依赖 jar 内消息类型(仅本仓 `src/main/java`
@@ -56,8 +56,9 @@
| `rocketMQTemplate.syncSend(dest, dto)` | 高(如钱包扣费) | **纳入** |
| `asyncSend` / `syncSendOrderly` 等 | 中 | **纳入** |
| `convertAndSend` | 视封装而定 | **纳入** |
| `JSON.toJSONString` 再发 String | 较低 | unwrap 后取类型 |
| 只发 `String` / `byte[]` / `MessageExt` | | **默认忽略** |
| `MessageBuilder.withPayload` 再 send | 中(如 IM 延时消息) | **纳入**MQ04 |
| `JSON.toJSONString` 再发 String | 较低 | unwrap 后取类型MQ05 |
| 只发 `String` / `byte[]` / 无泛型 `Message` | 有 | **默认忽略** |
样本(资金钱包):
@@ -68,12 +69,14 @@ rocketMQTemplate.syncSend(CapitalMqConstants.TOPIC + ":" + tag, req); // WalletD
public class WalletDeductConsumer implements RocketMQListener<WalletDeductReq> { ... }
```
### 2.2 Kafka(已确认需纳入)
### 2.2 Kafka
| 写法 | 出现情况 | 策略 |
|------|----------|------|
| `kafkaTemplate.send(topic, dto)` | 中(值班食安项等) | **纳入** |
| `kafkaTemplate.send(topic, List<Xxx>)` | 中(巡店食安项列表) | **纳入**rootArray |
| `kafkaTemplate.send(ProducerRecord)` | 中 | **纳入**MQ-K03 |
| 先 JSON 再 `send(topic, json)` | 较低 | unwrapMQ-K04 |
| `@KafkaListener` + `String` + `JSONObject.parseObject(..., Xxx.class)` | 有(数据分析中差评) | **读侧补强 MQ-R** |
| `KafkaTopicUtil` 仅创建 Topic | 有(租户) | **忽略**(无消息体) |
@@ -102,7 +105,7 @@ public void handleMessage(String message) {
动态 Topic如按租户拼接静态推断结果形如 `patrol-store-topic:*`,与 Redis key `*` 规则一致。
### 2.3 「Key」等价物destination
### 2.3 「Key」等价物
| 中间件 | 聚合键形态 | 来源 |
|--------|------------|------|
@@ -111,13 +114,15 @@ public void handleMessage(String message) {
无法解析时:展示表达式 + `<font color="comment">destination 未解析)</font>`
### 2.4 读侧补强(类比 W06
### 2.4 读侧补强
| 中间件 | 补强来源 |
|--------|----------|
| RocketMQ | `RocketMQListener<T>``onMessage(T)` + `@RocketMQMessageListener` |
| Kafka | `@KafkaListener` 方法参数类型;或方法内 `parseObject/parseArray(..., Xxx.class)`(与现有 W06 共享解析能力) |
开关:`detection.mq_read_hints_enabled`(默认 **true**)。
---
## 3. 方案总览
@@ -135,8 +140,8 @@ public void handleMessage(String message) {
```text
Git Diff → 变更 Java 文件
├─ RedisW01~W05 + W06 ← 已有
└─ MQRocketMQMQ01~+ KafkaMQ-K*
+ Listener / parse 补强MQ-R本方案
└─ MQRocketMQMQ01~05+ KafkaMQ-K01~K04
+ Listener / parse 补强MQ-R已实现
同一套 TypeSchema / SchemaDiffer / Skeleton / WeCom
```
@@ -161,7 +166,7 @@ Git Diff → 变更 Java 文件
| MQ01 | `rocketMQTemplate.syncSend(dest, payload, …)` | dest、payload 类型 |
| MQ02 | `asyncSend` / `syncSendOrderly` / `sendOneWay` 等 | 同上 |
| MQ03 | `convertAndSend(dest, payload)` | 同上 |
| MQ04 | `MessageBuilder.withPayload(obj)` 再 send | payload 类型 |
| MQ04 | `MessageBuilder.withPayload(obj)` 再 send,或 `Message<T>` | payload / `T` |
| MQ05 | 先 `toJSONString`/`getObjectToString` 再 send String | unwrap 后类型 |
### 4.2 生产侧 — Kafka
@@ -170,7 +175,7 @@ Git Diff → 变更 Java 文件
|---------|------------|------|
| MQ-K01 | `kafkaTemplate.send(topic, payload)` | topic、payload 类型 |
| MQ-K02 | `kafkaTemplate.send(topic, key, payload)` | 同上(忽略分区 key |
| MQ-K03 | `send(ProducerRecord)` / `ListenableFuture` 封装若可解析 | topic + value 类型 |
| MQ-K03 | `send(ProducerRecord)` | topic + value 类型 |
| MQ-K04 | 先 JSON 序列化为 String 再 `send(topic, json)` | unwrap 后类型 |
Payload 为 `List<Xxx>` / `Collection` 时标记 **rootArray**,骨架为 JSON 数组(与 Redis List 一致)。
@@ -187,7 +192,7 @@ Payload 为 `List<Xxx>` / `Collection` 时标记 **rootArray**,骨架为 JSON
|---------|------|------|
| MQ-R01 | `RocketMQListener<T>` / `@RocketMQMessageListener` | 补强同 destination 生产点 |
| MQ-R02 | `@KafkaListener` + 参数类型 `T`(非 String | 补强同 topic |
| MQ-R03 | Listener 内 `parseObject`/`parseArray(..., Xxx.class)` | 补强(复用 W06 检测器 |
| MQ-R03 | Listener 内 `parseObject`/`parseArray(..., Xxx.class)` | 补强(复用 parse AST |
开关:`detection.mq_read_hints_enabled`(默认 true
@@ -220,7 +225,6 @@ Payload 为 `List<Xxx>` / `Collection` 时标记 **rootArray**,骨架为 JSON
- 删除字段橙 `warning`;新增绿 `info`
- destination 未解析时灰色提示
- 可选后缀:「请评估消费积压与兼容反序列化」
「通道」字段用于区分中间件;若模板求简,可省略通道仅靠 Topic 形态区分。
@@ -272,37 +276,36 @@ manual_mappings:
## 7. 分阶段交付
### Phase M1 — MVPRocketMQ + Kafka 基础投递)
### Phase M1 — MVPRocketMQ + Kafka 基础投递)
| 任务 | 说明 |
|------|------|
| MQ01/MQ02 | RocketMQ `syncSend` / `asyncSend` |
| MQ-K01/MQ-K02 | Kafka `send(topic, payload)` / 三参 send |
| destination 推断 | 字面量、常量、拼接Kafka 动态 topic → `*` |
| Schema Diff + 骨架通知 | 复用 ReportBuilder可选「通道」行 |
| Schema Diff + 骨架通知 | 复用 ReportBuilder「通道」行 |
| 夹具 | `fixtures/mq/rocket-wallet/``fixtures/mq/kafka-patrol/` |
| 配置 | `mq_patterns`(含 MQ-K*)、`ignore.mq_destinations` |
| List 根数组骨架 | `List<CheckItemDetailVo>` 等(与 M2 需求合并交付) |
**验收**
1. 删 `WalletDeductReq` 字段 → 企微出现 RocketMQ Topic 骨架变更
2. 删 `CheckItemDetailVo` 字段 → 企微出现 Kafka Topic 骨架变更
### Phase M2 — 增强
### Phase M2 — 增强
| 任务 | 说明 |
|------|------|
| MQ03~MQ05、MQ-K03/K04 | convertAndSend、MessageBuilder、JSON 字符串发送、ProducerRecord |
| MQ03~MQ05、MQ-K03/K04 | convertAndSend、MessageBuilder/`Message<T>`、JSON 字符串发送、ProducerRecord |
| MQ-R01~R03 | RocketMQ Listener + Kafka `@KafkaListener` / parse 补强 |
| List 根数组骨架 | 巡店 `List<CheckItemDetailVo>` |
| 夹具 | `fixtures/mq/rocket-im/``fixtures/mq/kafka-record/` |
### Phase M3 — 运营
**验收**
| 任务 | 说明 |
|------|------|
| 积压风险提示文案 | 统一提示评估消费 lag / 积压 |
| 更多夹具 | 值班 Kafka、中差评 Listener、IM Favorite 等 |
| 分 webhook / 标题前缀 | 缓存 vs MQ 可选拆分 |
1. `MessageBuilder.withPayload(DutyImNotice)` + `asyncSend` → 命中 MQ04改 VO 字段可告警
2. `kafkaTemplate.send(ProducerRecord)` → 命中 MQ-K03
3. Listener / `parseObject` 可补强同 Topic 弱类型生产点
---
@@ -312,7 +315,7 @@ manual_mappings:
|------|------|
| Kafka topic 按租户动态拼接 | 归一 `prefix:*``manual_mappings` |
| RocketMQ / Kafka 混用同一 VO | 各投递点独立告警(符合预期) |
| Listener 收 String、parse 在方法深处 | MQ-R03 + 复用 W06 AST |
| Listener 收 String、parse 在方法深处 | MQ-R03 + parse AST |
| 生产/消费跨模块对不齐 | 同仓索引 + destination 对齐;失败则仅写侧 |
| Jackson / Fastjson / Kafka JsonSerializer 细节差 | 首版字段名;必要时方言或 mapping |
| 只改消费未改生产类型 | 不告警(工具职责是消息体 Schema |
@@ -323,10 +326,8 @@ manual_mappings:
| 项 | 结论 |
|----|------|
| 中间件范围 | **RocketMQ + Kafka**本仓已确认Rabbit 暂不纳入 |
| 中间件范围 | **RocketMQ + Kafka**|
| 对比区间 | `gitea.event.before``gitea.sha` |
| 阻断 | 与现网 `mode` 共用 |
| 级别 | 不引入 P0/P1/P2 产品展示 |
| 交付 | 同一 jarpatterns 区分 Redis / MQ含 MQ-K* |
---
@@ -334,6 +335,5 @@ manual_mappings:
## 10. 下一步
1. ~~按 Phase M1 开发~~ **已完成**MQ01/02 + MQ-K01/K02
2. Phase M2MQ03~05、MQ-K03/K04、MQ-R 读侧补强
3. 业务仓验收 Topic`capital-topic:WALLET_DEDUCT`RocketMQ、巡店/值班 Kafka topic
4. 观察期按需扩大 `include_modules`
2. ~~按 Phase M2 开发~~ **已完成**MQ03~05、MQ-K03/K04、MQ-R
3. 业务仓验收`MessageBuilder` IM Topic、巡店/值班 Kafka、`capital-topic:WALLET_DEDUCT`

View File

@@ -4,7 +4,7 @@
> 日期2026-07-15
> 技术栈Java 11 + Maven + JavaParser
> 目标仓库:`schemaCheck`(工具) / `jnpf-java-cloud`(被检测业务仓库)
> 当前阶段:**Phase 1 + Phase 2 已完成**Phase 3 运营待做;**MQ 扩展方案已文档落地**(见 `docs/MQ序列化结构检测方案.md`
> 当前阶段:**Phase 1 + Phase 2 已完成****MQ 扩展方案已文档落地**(见 `docs/MQ序列化结构检测方案.md`
---
@@ -161,13 +161,11 @@ flowchart TB
| 报告 | Jackson | 2.15.x | JSON/Markdown 报告序列化 |
| 测试 | JUnit 5 | 5.10.x | 单元测试 + 夹具样本 |
**不采用** Spoon / Eclipse JDT 的原因JavaParser 足够覆盖第一版需求依赖更轻CLI 启动更快。
**Lombok 处理策略**:基于源码字段 + `@Data` 等注解推断序列化字段;对 `@Builder``@SuperBuilder` 等复杂场景标记为低置信度提示。后续可选集成 `lombok.ast` 或 delombok 预处理。
---
## 5. 工程结构(redisCheck 仓库)
## 5. 工程结构(schemaCheck 仓库)
```text
schemaCheck/
@@ -527,31 +525,6 @@ notify:
| 企微高亮 | 删除橙 `warning` / 新增绿 `info`;位置+类型通用项 | ✅ |
| W06 读侧辅助 | `parseObject`/`parseArray` 等补强写入 value 类型 | ✅ |
### Phase 3 — 运营
| 任务 | 说明 |
|------|------|
| 报告落盘 | 可选输出 JSON 报告文件 |
| 误报反馈 | `suppressions` 按写入点 / change_types 精细忽略 |
| 更多业务场景覆盖 | 考勤、文件下载进度等 |
### Phase 4 — MQ 消息体结构检测(方案已落地,含 Kafka开发待启
业务仓同时存在:
- **RocketMQ**`RocketMQTemplate.syncSend(topic:tag, dto)` / `RocketMQListener<T>`
- **Kafka**`KafkaTemplate.send(topic, vo|List)` / `@KafkaListener` + `parseObject`
消息体字段变更会导致积压旧消息反序列化失败,风险模型与 Redis 同类。
| 任务 | 说明 | 状态 |
|------|------|------|
| 方案文档 | RocketMQ + Kafka 模式、destination、复用 Schema Diff/企微 | ✅ 见专用文档 |
| Phase M1 | RocketMQ syncSend + Kafka send + 骨架通知 + 夹具 | 待启 |
| Phase M2/M3 | Listener/parse 补强、更多投递形态、运营 | 待启 |
**专用方案:** [`docs/MQ序列化结构检测方案.md`](./MQ序列化结构检测方案.md)
---
## 11. 测试策略
@@ -561,6 +534,8 @@ notify:
- `SchemaDifferTest`:纯字段路径对比逻辑
- `JavaSchemaExtractorTest`:类字段展开、注解、内部类
- `RedisWritePointDetectorTest`:各种写入 AST 模式匹配
- `MqWritePointDetectorTest`RocketMQ/Kafka 投递(含 MQ04 MessageBuilder、MQ-K03 ProducerRecord
- `MqReadHintDetectorTest`MQ-R Listener / parseObject 补强
- `RedisKeyResolverTest`常量、format、拼接推断
### 11.2 样本夹具测试fixtures
@@ -574,6 +549,10 @@ notify:
| `fixtures/tenant/` | 包装结构变更TenantVO → CacheEnvelope |
| `fixtures/lock/` | 锁/计数器/token 应被忽略 |
| `fixtures/template/` | W04 Template 直写 |
| `fixtures/mq/rocket-wallet/` | RocketMQ syncSendMQ01 |
| `fixtures/mq/rocket-im/` | MessageBuilder + asyncSendMQ04、convertAndSendMQ03 |
| `fixtures/mq/kafka-patrol/` | Kafka List 根数组MQ-K01 |
| `fixtures/mq/kafka-record/` | ProducerRecordMQ-K03、JSON 字符串 sendMQ-K04 |
### 11.3 端到端测试
@@ -605,7 +584,7 @@ notify:
| 4 | 上线策略 | 先 `notify` ,稳定后手动切 `block` |
| 5 | 检测范围 | **仅 `src/main/java`**,不扫描测试代码 |
以上决策已纳入实施方案;**Phase 1 / Phase 2 已交付**。缓存侧可进入 Phase 3MQ 侧以 [`MQ序列化结构检测方案.md`](./MQ序列化结构检测方案.md) 为准评审后开发。
以上决策已纳入实施方案;**Phase 1 / Phase 2 已交付**。缓存侧可进入 Phase 3MQ 侧以 [`MQ序列化结构检测方案.md`](MQ序列化结构检测实施方案.md) 为准评审后开发。
相关文档:

View File

@@ -43,9 +43,9 @@ include_modules:
`redisCheck` 仓库维护,随 jar 发布,默认包含:
- `detection.patterns`**W01~W05**JSON 字符串写入 + Template 直写 + Hash
- `detection.mq_patterns`**MQ01/MQ02、MQ-K01/MQ-K02**RocketMQ / Kafka 生产侧)
- `detection.mq_patterns`**MQ01~MQ05、MQ-K01~MQ-K04**RocketMQ / Kafka 生产侧)
- `detection.read_hints_enabled`W06 读侧反序列化类型辅助(默认 true
- `detection.mq_read_hints_enabled`MQ 读侧补强Phase M2默认 false
- `detection.mq_read_hints_enabled`MQ-R 读侧 Listener / parse 补强(默认 true
- `ignore.key_patterns`(锁 / 计数器 / token
- `ignore.mq_destinations`MQ destination 忽略,默认真空)
- `detection.min_confidence``max_field_depth`
@@ -113,18 +113,23 @@ detection:
- W04 # redisTemplate 直写对象
- W05 # opsForHash().put
# MQ 生产侧投递Phase M1
# MQ 生产侧投递Phase M1 + M2
mq_patterns:
- MQ01 # rocketMQTemplate.syncSend
- MQ02 # asyncSend / syncSendOrderly / sendOneWay
- MQ03 # convertAndSend
- MQ04 # MessageBuilder.withPayload / Message<T>
- MQ05 # 先 toJSONString 再 send String
- MQ-K01 # kafkaTemplate.send(topic, payload)
- MQ-K02 # kafkaTemplate.send(topic, key, payload)
- MQ-K03 # kafkaTemplate.send(ProducerRecord)
- MQ-K04 # 先 JSON 序列化为 String 再 send
# W06读侧反序列化类型辅助不产生独立告警
read_hints_enabled: true
# MQ-R 读侧补强(Phase M2默认关闭
mq_read_hints_enabled: false
# MQ-R 读侧补强(Listener / parseObject
mq_read_hints_enabled: true
# 类型推断最低置信度,低于此值标记为低置信度提示
min_confidence: 0.6
@@ -240,7 +245,7 @@ detection:
- **不是写入模式**:不会单独因为「多了一处 parse」而告警
- 能关联到 `redis get(key)` 时,还可补强 unresolved key
- 覆盖优先级:`manual_mappings` > W06 > 写侧 AST
- **仅补强 Redis 写入点**MQ 投递点W06MQ-R 为 Phase M2
- **仅补强 Redis 写入点**MQ 投递点走 `mq_read_hints_enabled`MQ-R
关闭示例:
@@ -249,17 +254,17 @@ detection:
read_hints_enabled: false
```
### 3.5.2 detection.mq_patterns / ignore.mq_destinationsMQ Phase M1
### 3.5.2 detection.mq_patterns / ignore.mq_destinationsMQ
| 配置项 | 说明 |
|--------|------|
| `mq_patterns` | `MQ01`/`MQ02`RocketMQ`MQ-K01`/`MQ-K02`Kafka;默认已开启 |
| `mq_read_hints_enabled` | MQ-R 读侧补强,**默认 false** |
| `mq_patterns` | RocketMQ`MQ01`~`MQ05`Kafka`MQ-K01`~`MQ-K04`;默认已全部开启 |
| `mq_read_hints_enabled` | MQ-R 读侧补强Listener / parse**默认 true** |
| `ignore.mq_destinations` | 忽略 destinationglob`benchmark:*` |
企微 MQ 块:`- Topic --> ...`,并带 `> **通道**: RocketMQ|Kafka`
详见:[MQ序列化结构检测方案.md](./MQ序列化结构检测方案.md)
详见:[MQ序列化结构检测方案.md](MQ序列化结构检测实施方案.md)
### 3.6 manual_mappings
@@ -374,11 +379,3 @@ include_modules: [] # 全仓
```
---
## 7. MQ 消息体检测Phase M1 已落地)
同一 jar 默认启用 RocketMQ / Kafka **生产侧**投递检测(`detection.mq_patterns`),与 Redis 共用 Diff、骨架与企微模板。
- 配置说明见 §3.5.2
- 读侧 MQ-R、`MessageBuilder` / `ProducerRecord` 等见方案 Phase M2
- 完整设计:[MQ序列化结构检测方案.md](./MQ序列化结构检测方案.md)

View File

@@ -3,6 +3,7 @@ package com.codechecker.cache.analyze;
import com.codechecker.cache.config.CheckerConfig;
import com.codechecker.cache.detector.CacheReadHint;
import com.codechecker.cache.detector.CacheReadHintDetector;
import com.codechecker.cache.detector.MqReadHintDetector;
import com.codechecker.cache.detector.MqWritePointDetector;
import com.codechecker.cache.detector.RedisWritePointDetector;
import com.codechecker.cache.detector.WritePoint;
@@ -105,6 +106,9 @@ public class SchemaCheckAnalyzer {
SchemaDiffer differ = new SchemaDiffer();
SkeletonJsonRenderer skeletonRenderer = new SkeletonJsonRenderer();
List<CacheReadHint> mqHintsNew = collectMqReadHints(newContents, newIndex);
List<CacheReadHint> mqHintsOld = collectMqReadHints(oldContents, oldIndex);
List<SchemaChange> allChanges = new ArrayList<>();
Map<String, KeyStructureChange> keyChanges = new LinkedHashMap<>();
@@ -129,6 +133,8 @@ public class SchemaCheckAnalyzer {
if (oldContent != null) {
applyReadHints(oldWps, path, oldContent, oldIndex);
}
applyMqReadHints(newWps, mqHintsNew);
applyMqReadHints(oldWps, mqHintsOld);
newWps.forEach(this::applyManualMappings);
oldWps.forEach(this::applyManualMappings);
@@ -474,12 +480,38 @@ public class SchemaCheckAnalyzer {
}
for (WritePoint wp : writePoints) {
if (wp.isMq()) {
continue; // Redis W06 不补强 MQ 投递点MQ-R 为 Phase M2
continue; // MQ 投递点MQ-R 补强
}
enrichWritePointFromHints(wp, hints);
}
}
private List<CacheReadHint> collectMqReadHints(Map<String, String> contents, SourceIndex index) {
if (!config.getDetection().isMqReadHintsEnabled() || contents == null || contents.isEmpty()) {
return Collections.emptyList();
}
MqReadHintDetector detector = new MqReadHintDetector(index);
List<CacheReadHint> all = new ArrayList<>();
for (Map.Entry<String, String> e : contents.entrySet()) {
all.addAll(detector.detect(e.getKey(), e.getValue()));
}
return all;
}
/** MQ-R按 destination 匹配,补强低置信度 / 缺类型的 MQ 投递点。 */
private void applyMqReadHints(List<WritePoint> writePoints, List<CacheReadHint> hints) {
if (!config.getDetection().isMqReadHintsEnabled()
|| writePoints == null || writePoints.isEmpty()
|| hints == null || hints.isEmpty()) {
return;
}
for (WritePoint wp : writePoints) {
if (wp.isMq()) {
enrichWritePointFromHints(wp, hints);
}
}
}
private void enrichWritePointFromHints(WritePoint wp, List<CacheReadHint> hints) {
boolean needType = wp.getResolvedValueType() == null || wp.getResolvedValueType().isEmpty()
|| wp.getConfidence() < config.getDetection().getMinConfidence();

View File

@@ -118,14 +118,14 @@ public class CheckerConfig {
public static class Detection {
private List<String> patterns = new ArrayList<>();
/** MQ 投递检测模式MQ01/MQ02/MQ-K01/MQ-K02… */
/** MQ 投递检测模式MQ01~MQ05、MQ-K01~MQ-K04 */
private List<String> mqPatterns = new ArrayList<>();
private double minConfidence = 0.6;
private int maxFieldDepth = 8;
/** W06是否启用读侧反序列化类型辅助补强 */
private boolean readHintsEnabled = true;
/** MQ-R读侧 Listener / parse 补强Phase M2M1 默认 false */
private boolean mqReadHintsEnabled = false;
/** MQ-R读侧 Listener / parse 补强 */
private boolean mqReadHintsEnabled = true;
public List<String> getPatterns() {
return patterns;

View File

@@ -103,7 +103,7 @@ public final class ConfigLoader {
d.setMinConfidence(dbl(detection, "min_confidence", 0.6));
d.setMaxFieldDepth((int) lng(detection, "max_field_depth", 8));
d.setReadHintsEnabled(bool(detection, "read_hints_enabled", true));
d.setMqReadHintsEnabled(bool(detection, "mq_read_hints_enabled", false));
d.setMqReadHintsEnabled(bool(detection, "mq_read_hints_enabled", true));
Map<String, Object> severityOverrides = asMap(map.get("severity_overrides"));
Map<String, String> so = new LinkedHashMap<>();

View File

@@ -0,0 +1,365 @@
package com.codechecker.cache.detector;
import com.codechecker.cache.key.RedisKeyResolver;
import com.codechecker.cache.schema.SourceIndex;
import com.github.javaparser.StaticJavaParser;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
import com.github.javaparser.ast.body.Parameter;
import com.github.javaparser.ast.expr.AnnotationExpr;
import com.github.javaparser.ast.expr.ArrayInitializerExpr;
import com.github.javaparser.ast.expr.ClassExpr;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.ast.expr.MarkerAnnotationExpr;
import com.github.javaparser.ast.expr.MemberValuePair;
import com.github.javaparser.ast.expr.MethodCallExpr;
import com.github.javaparser.ast.expr.NormalAnnotationExpr;
import com.github.javaparser.ast.expr.SingleMemberAnnotationExpr;
import com.github.javaparser.ast.type.ClassOrInterfaceType;
import com.github.javaparser.ast.type.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
/**
* MQ-R消费侧类型提示补强同 destination 生产点的 value 类型(不单独告警)。
* <ul>
* <li>MQ-R01{@code RocketMQListener<T>} + {@code @RocketMQMessageListener}</li>
* <li>MQ-R02{@code @KafkaListener} 非 String 参数类型</li>
* <li>MQ-R03Listener 内 {@code parseObject/parseArray(..., Xxx.class)}</li>
* </ul>
*/
public class MqReadHintDetector {
private static final Set<String> OBJECT_PARSE = new HashSet<>(Arrays.asList(
"parseObject", "parse", "getJsonToBean", "toJavaObject", "readValue"));
private static final Set<String> ARRAY_PARSE = new HashSet<>(Arrays.asList(
"parseArray", "getJsonToList", "parseArrayObject"));
private static final Set<String> SKIP_PARAM_TYPES = new HashSet<>(Arrays.asList(
"String", "byte", "Byte", "ConsumerRecord", "MessageExt", "Message"));
private final SourceIndex index;
private final RedisKeyResolver keyResolver;
public MqReadHintDetector(SourceIndex index) {
this.index = index;
this.keyResolver = new RedisKeyResolver(index);
}
public List<CacheReadHint> detect(String filePath, String content) {
List<CacheReadHint> result = new ArrayList<>();
if (content == null || content.isEmpty()) {
return result;
}
CompilationUnit cu;
try {
cu = StaticJavaParser.parse(content);
} catch (RuntimeException e) {
return result;
}
for (ClassOrInterfaceDeclaration clazz : cu.findAll(ClassOrInterfaceDeclaration.class)) {
result.addAll(detectRocketListener(clazz, filePath));
for (MethodDeclaration md : clazz.getMethods()) {
result.addAll(detectKafkaListener(md, clazz, filePath));
result.addAll(detectParseInListener(md, clazz, filePath));
}
}
return result;
}
/** MQ-R01 */
private List<CacheReadHint> detectRocketListener(ClassOrInterfaceDeclaration clazz, String filePath) {
List<CacheReadHint> result = new ArrayList<>();
Optional<ClassOrInterfaceType> listenerType = findRocketListenerType(clazz);
if (!listenerType.isPresent()) {
return result;
}
AnnotationExpr ann = findAnnotation(clazz.getAnnotations(), "RocketMQMessageListener");
if (ann == null) {
return result;
}
String dest = resolveRocketDestination(ann, clazz);
InferredType payload = resolveTypeArg(listenerType.get(), index.get(
clazz.getFullyQualifiedName().orElse(clazz.getNameAsString())));
if (payload.fqn == null) {
return result;
}
CacheReadHint hint = baseHint(filePath, clazz, "<listener>", dest, payload);
hint.setConfidence(0.85);
result.add(hint);
return result;
}
/** MQ-R02 */
private List<CacheReadHint> detectKafkaListener(MethodDeclaration md,
ClassOrInterfaceDeclaration clazz,
String filePath) {
List<CacheReadHint> result = new ArrayList<>();
AnnotationExpr ann = findAnnotation(md.getAnnotations(), "KafkaListener");
if (ann == null) {
return result;
}
List<String> topics = resolveKafkaTopics(ann, clazz);
if (topics.isEmpty()) {
return result;
}
SourceIndex.IndexedType context = index.get(
clazz.getFullyQualifiedName().orElse(clazz.getNameAsString()));
InferredType payload = null;
for (Parameter p : md.getParameters()) {
InferredType t = resolveParamPayload(p.getType(), context);
if (t != null && t.fqn != null) {
payload = t;
break;
}
}
if (payload == null) {
return result;
}
for (String topic : topics) {
CacheReadHint hint = baseHint(filePath, clazz, md.getNameAsString(), topic, payload);
hint.setConfidence(0.85);
result.add(hint);
}
return result;
}
/** MQ-R03在已标注 KafkaListener 的方法,或 RocketMQListener 类内 parse */
private List<CacheReadHint> detectParseInListener(MethodDeclaration md,
ClassOrInterfaceDeclaration clazz,
String filePath) {
List<CacheReadHint> result = new ArrayList<>();
boolean kafka = findAnnotation(md.getAnnotations(), "KafkaListener") != null;
boolean rocket = findRocketListenerType(clazz).isPresent();
if (!kafka && !rocket) {
return result;
}
List<String> destinations = new ArrayList<>();
if (kafka) {
destinations.addAll(resolveKafkaTopics(
findAnnotation(md.getAnnotations(), "KafkaListener"), clazz));
}
if (rocket) {
AnnotationExpr ann = findAnnotation(clazz.getAnnotations(), "RocketMQMessageListener");
if (ann != null) {
String dest = resolveRocketDestination(ann, clazz);
if (dest != null && !dest.isEmpty()) {
destinations.add(dest);
}
}
}
if (destinations.isEmpty()) {
destinations.add(null);
}
SourceIndex.IndexedType context = index.get(
clazz.getFullyQualifiedName().orElse(clazz.getNameAsString()));
for (MethodCallExpr mce : md.findAll(MethodCallExpr.class)) {
String name = mce.getNameAsString();
boolean array = ARRAY_PARSE.contains(name);
boolean object = OBJECT_PARSE.contains(name);
if (!array && !object || mce.getArguments().size() < 2) {
continue;
}
Expression classArg = mce.getArgument(1);
if (!(classArg instanceof ClassExpr)) {
continue;
}
Type type = ((ClassExpr) classArg).getType();
if (!(type instanceof ClassOrInterfaceType)) {
continue;
}
String fqn = index.resolveFqn(((ClassOrInterfaceType) type).getNameWithScope(), context);
if (fqn == null) {
fqn = index.resolveFqn(((ClassOrInterfaceType) type).getNameAsString(), context);
}
if (fqn == null) {
continue;
}
InferredType payload = new InferredType(fqn, array);
for (String dest : destinations) {
CacheReadHint hint = baseHint(filePath, clazz, md.getNameAsString(), dest, payload);
hint.setLineNumber(mce.getBegin().map(p -> p.line).orElse(0));
hint.setConfidence(dest == null ? 0.7 : 0.8);
result.add(hint);
}
}
return result;
}
private CacheReadHint baseHint(String filePath, ClassOrInterfaceDeclaration clazz,
String method, String dest, InferredType payload) {
CacheReadHint hint = new CacheReadHint();
hint.setFilePath(filePath);
hint.setLineNumber(clazz.getBegin().map(p -> p.line).orElse(0));
hint.setEnclosingClass(clazz.getFullyQualifiedName().orElse(clazz.getNameAsString()));
hint.setEnclosingMethod(method);
hint.setResolvedKeyPattern(dest);
hint.setResolvedValueType(payload.fqn);
hint.setRootArray(payload.isArray);
return hint;
}
private Optional<ClassOrInterfaceType> findRocketListenerType(ClassOrInterfaceDeclaration clazz) {
for (ClassOrInterfaceType t : clazz.getImplementedTypes()) {
String n = t.getNameAsString();
if ("RocketMQListener".equals(n) || "RocketMQReplyListener".equals(n)) {
return Optional.of(t);
}
}
return Optional.empty();
}
private InferredType resolveParamPayload(Type type, SourceIndex.IndexedType context) {
if (!(type instanceof ClassOrInterfaceType)) {
return null;
}
ClassOrInterfaceType cit = (ClassOrInterfaceType) type;
String simple = cit.getNameAsString();
if (SKIP_PARAM_TYPES.contains(simple) && !"ConsumerRecord".equals(simple)) {
return null;
}
if ("ConsumerRecord".equals(simple) || "List".equals(simple) || "ArrayList".equals(simple)) {
Optional<Type> last = cit.getTypeArguments()
.filter(a -> !a.isEmpty())
.map(a -> a.get(a.size() - 1));
if (!last.isPresent()) {
return null;
}
InferredType inner = resolveTypeArgFromType(last.get(), context);
if (inner != null && ("List".equals(simple) || "ArrayList".equals(simple))) {
return new InferredType(inner.fqn, true);
}
return inner;
}
return resolveTypeArgFromType(type, context);
}
private InferredType resolveTypeArg(ClassOrInterfaceType listenerType, SourceIndex.IndexedType context) {
Optional<Type> arg = listenerType.getTypeArguments().filter(a -> !a.isEmpty()).map(a -> a.get(0));
if (!arg.isPresent()) {
return new InferredType(null, false);
}
return resolveTypeArgFromType(arg.get(), context);
}
private InferredType resolveTypeArgFromType(Type type, SourceIndex.IndexedType context) {
if (!(type instanceof ClassOrInterfaceType)) {
return new InferredType(null, false);
}
ClassOrInterfaceType cit = (ClassOrInterfaceType) type;
if ("List".equals(cit.getNameAsString()) || "ArrayList".equals(cit.getNameAsString())) {
Optional<Type> el = cit.getTypeArguments().filter(a -> !a.isEmpty()).map(a -> a.get(0));
if (el.isPresent() && el.get() instanceof ClassOrInterfaceType) {
return new InferredType(resolveFqn((ClassOrInterfaceType) el.get(), context), true);
}
return new InferredType(null, true);
}
String simple = cit.getNameAsString();
if (SKIP_PARAM_TYPES.contains(simple)) {
return new InferredType(null, false);
}
return new InferredType(resolveFqn(cit, context), false);
}
private String resolveFqn(ClassOrInterfaceType cit, SourceIndex.IndexedType context) {
String fqn = index.resolveFqn(cit.getNameWithScope(), context);
if (fqn == null) {
fqn = index.resolveFqn(cit.getNameAsString(), context);
}
return fqn;
}
private String resolveRocketDestination(AnnotationExpr ann, ClassOrInterfaceDeclaration clazz) {
SourceIndex.IndexedType context = index.get(
clazz.getFullyQualifiedName().orElse(clazz.getNameAsString()));
Expression topicExpr = annotationValue(ann, "topic");
if (topicExpr == null) {
return null;
}
String topicPattern = keyResolver.resolve(topicExpr, clazz, context);
Expression tagExpr = annotationValue(ann, "selectorExpression");
if (tagExpr != null) {
String tagPattern = keyResolver.resolve(tagExpr, clazz, context);
if (tagPattern != null && !tagPattern.isEmpty()
&& !"*".equals(tagPattern) && !tagPattern.contains("||")) {
return topicPattern + ":" + tagPattern;
}
}
return topicPattern;
}
private List<String> resolveKafkaTopics(AnnotationExpr ann, ClassOrInterfaceDeclaration clazz) {
List<String> result = new ArrayList<>();
if (ann == null) {
return result;
}
SourceIndex.IndexedType context = index.get(
clazz.getFullyQualifiedName().orElse(clazz.getNameAsString()));
Expression topicsExpr = annotationValue(ann, "topics");
if (topicsExpr == null && ann instanceof SingleMemberAnnotationExpr) {
topicsExpr = ((SingleMemberAnnotationExpr) ann).getMemberValue();
}
if (topicsExpr == null) {
return result;
}
List<Expression> items = new ArrayList<>();
if (topicsExpr instanceof ArrayInitializerExpr) {
items.addAll(((ArrayInitializerExpr) topicsExpr).getValues());
} else {
items.add(topicsExpr);
}
for (Expression item : items) {
String resolved = keyResolver.resolve(item, clazz, context);
if (resolved != null && !resolved.isEmpty()) {
result.add(resolved);
}
}
return result;
}
private static Expression annotationValue(AnnotationExpr ann, String name) {
if (ann instanceof NormalAnnotationExpr) {
for (MemberValuePair pair : ((NormalAnnotationExpr) ann).getPairs()) {
if (name.equals(pair.getNameAsString())) {
return pair.getValue();
}
}
}
return null;
}
private static AnnotationExpr findAnnotation(List<AnnotationExpr> annotations, String simpleName) {
for (AnnotationExpr ann : annotations) {
String n;
if (ann instanceof MarkerAnnotationExpr) {
n = ((MarkerAnnotationExpr) ann).getNameAsString();
} else if (ann instanceof SingleMemberAnnotationExpr) {
n = ((SingleMemberAnnotationExpr) ann).getNameAsString();
} else if (ann instanceof NormalAnnotationExpr) {
n = ((NormalAnnotationExpr) ann).getNameAsString();
} else {
n = ann.getNameAsString();
}
if (n.equals(simpleName) || n.endsWith("." + simpleName)) {
return ann;
}
}
return null;
}
private static final class InferredType {
final String fqn;
final boolean isArray;
InferredType(String fqn, boolean isArray) {
this.fqn = fqn;
this.isArray = isArray;
}
}
}

View File

@@ -32,7 +32,12 @@ import java.util.Optional;
import java.util.Set;
/**
* 检测 RocketMQ / Kafka 生产侧投递点Phase M1MQ01/MQ02、MQ-K01/MQ-K02
* 检测 RocketMQ / Kafka 生产侧投递点Phase M1 + M2
* <ul>
* <li>M1MQ01/MQ02、MQ-K01/MQ-K02</li>
* <li>M2MQ03 convertAndSend、MQ04 MessageBuilder/`Message&lt;T&gt;`、MQ05 JSON 字符串、
* MQ-K03 ProducerRecord、MQ-K04 JSON 字符串</li>
* </ul>
*/
public class MqWritePointDetector {
@@ -41,12 +46,15 @@ public class MqWritePointDetector {
private static final Set<String> ROCKET_SYNC = new HashSet<>(Arrays.asList("syncSend"));
private static final Set<String> ROCKET_ASYNC = new HashSet<>(Arrays.asList(
"asyncSend", "syncSendOrderly", "sendOneWay", "asyncSendOrderly"));
private static final Set<String> ROCKET_CONVERT = new HashSet<>(Arrays.asList("convertAndSend"));
private static final Set<String> TRIVIAL_VALUE_CALLS = new HashSet<>(Arrays.asList(
"randomUUID", "toString", "valueOf"));
private static final Set<String> COLLECTION_SIMPLE = new HashSet<>(Arrays.asList(
"List", "ArrayList", "LinkedList", "Set", "HashSet", "Collection"));
private static final Set<String> IGNORE_PAYLOAD_TYPES = new HashSet<>(Arrays.asList(
"String", "byte", "Byte", "MessageExt", "Message", "ProducerRecord"));
private static final Set<String> ENVELOPE_TYPES = new HashSet<>(Arrays.asList(
"Message", "MessageExt", "ProducerRecord"));
private static final Set<String> IGNORE_BARE_TYPES = new HashSet<>(Arrays.asList(
"String", "byte", "Byte"));
private final SourceIndex index;
private final Set<String> enabledPatterns;
@@ -83,19 +91,19 @@ public class MqWritePointDetector {
private WritePoint tryDetectRocketMq(MethodCallExpr mce, String filePath) {
String method = mce.getNameAsString();
String pattern = null;
String basePattern = null;
if (ROCKET_SYNC.contains(method) && enabledPatterns.contains("MQ01")) {
pattern = "MQ01";
basePattern = "MQ01";
} else if (ROCKET_ASYNC.contains(method) && enabledPatterns.contains("MQ02")) {
pattern = "MQ02";
basePattern = "MQ02";
} else if (ROCKET_CONVERT.contains(method) && enabledPatterns.contains("MQ03")) {
basePattern = "MQ03";
}
if (pattern == null || !isRocketMqScope(mce) || mce.getArguments().size() < 2) {
if (basePattern == null || !isRocketMqScope(mce) || mce.getArguments().size() < 2) {
return null;
}
Expression destArg = mce.getArgument(0);
Expression payloadArg = mce.getArgument(1);
return buildMqWritePoint(mce, filePath, pattern, WritePoint.CHANNEL_ROCKETMQ,
destArg, payloadArg);
return buildMqWritePoint(mce, filePath, basePattern, WritePoint.CHANNEL_ROCKETMQ,
mce.getArgument(0), mce.getArgument(1), "MQ04", "MQ05");
}
private WritePoint tryDetectKafka(MethodCallExpr mce, String filePath) {
@@ -103,32 +111,80 @@ public class MqWritePointDetector {
return null;
}
int argc = mce.getArguments().size();
String pattern;
if (argc == 1 && enabledPatterns.contains("MQ-K03")) {
return buildFromProducerRecord(mce, filePath);
}
String basePattern;
Expression topicArg;
Expression payloadArg;
if (argc == 2 && enabledPatterns.contains("MQ-K01")) {
pattern = "MQ-K01";
basePattern = "MQ-K01";
topicArg = mce.getArgument(0);
payloadArg = mce.getArgument(1);
} else if (argc >= 3 && enabledPatterns.contains("MQ-K02")) {
pattern = "MQ-K02";
basePattern = "MQ-K02";
topicArg = mce.getArgument(0);
payloadArg = mce.getArgument(argc - 1);
} else {
return null;
}
return buildMqWritePoint(mce, filePath, pattern, WritePoint.CHANNEL_KAFKA,
topicArg, payloadArg);
return buildMqWritePoint(mce, filePath, basePattern, WritePoint.CHANNEL_KAFKA,
topicArg, payloadArg, null, "MQ-K04");
}
private WritePoint buildMqWritePoint(MethodCallExpr mce, String filePath, String pattern,
String channel, Expression destArg, Expression payloadArg) {
Expression serialized = unwrapSerializer(payloadArg);
Expression typeExpr = serialized != null ? serialized : payloadArg;
if (serialized == null && isTrivialValue(payloadArg)) {
private WritePoint buildFromProducerRecord(MethodCallExpr mce, String filePath) {
Expression recordArg = mce.getArgument(0);
ObjectCreationExpr creation = findProducerRecordCreation(recordArg, mce);
if (creation == null || creation.getArguments().size() < 2) {
return null;
}
if (isBareStringOrBytesPayload(typeExpr, mce)) {
Expression topicArg = creation.getArgument(0);
Expression payloadArg = creation.getArgument(creation.getArguments().size() - 1);
WritePoint wp = buildMqWritePoint(mce, filePath, "MQ-K03", WritePoint.CHANNEL_KAFKA,
topicArg, payloadArg, null, "MQ-K04");
if (wp != null) {
wp.setValueExpression(recordArg.toString());
}
return wp;
}
private ObjectCreationExpr findProducerRecordCreation(Expression expr, MethodCallExpr contextCall) {
if (expr instanceof ObjectCreationExpr) {
ObjectCreationExpr oce = (ObjectCreationExpr) expr;
if ("ProducerRecord".equals(oce.getType().getNameAsString())) {
return oce;
}
return null;
}
if (expr instanceof NameExpr) {
String name = ((NameExpr) expr).getNameAsString();
Optional<CallableDeclaration> callable = contextCall.findAncestor(CallableDeclaration.class);
if (!callable.isPresent()) {
return null;
}
for (VariableDeclarator var : callable.get().findAll(VariableDeclarator.class)) {
if (!var.getNameAsString().equals(name) || !var.getInitializer().isPresent()) {
continue;
}
Expression init = var.getInitializer().get();
if (init instanceof ObjectCreationExpr
&& "ProducerRecord".equals(((ObjectCreationExpr) init).getType().getNameAsString())) {
return (ObjectCreationExpr) init;
}
}
}
return null;
}
private WritePoint buildMqWritePoint(MethodCallExpr mce, String filePath, String basePattern,
String channel, Expression destArg, Expression payloadArg,
String messagePattern, String jsonPattern) {
PayloadResolution resolved = resolvePayload(payloadArg, mce, messagePattern, jsonPattern);
if (resolved == null) {
return null;
}
String pattern = resolved.overridePattern != null ? resolved.overridePattern : basePattern;
if (!enabledPatterns.contains(pattern)) {
return null;
}
@@ -146,7 +202,7 @@ public class MqWritePointDetector {
.findAncestor(ClassOrInterfaceDeclaration.class).orElse(null);
wp.setResolvedKeyPattern(keyResolver.resolve(destArg, enclosingDecl, context));
InferredType inferred = inferType(typeExpr, mce, context);
InferredType inferred = inferType(resolved.typeExpr, mce, context);
if (inferred != null) {
wp.setResolvedValueType(inferred.fqn);
wp.setRootArray(inferred.isArray);
@@ -157,6 +213,150 @@ public class MqWritePointDetector {
return wp;
}
/**
* 解析 payloadMessage/MessageBuilderMQ04、JSON 字符串MQ05/MQ-K04、直传对象。
* 无法解析的 Message/纯 String 返回 null忽略
*/
private PayloadResolution resolvePayload(Expression payloadArg, MethodCallExpr mce,
String messagePattern, String jsonPattern) {
if (payloadArg == null) {
return null;
}
// MQ04Message&lt;T&gt; 泛型 / MessageBuilder.withPayload
if (messagePattern != null && enabledPatterns.contains(messagePattern)) {
Expression fromMessage = unwrapMessagePayload(payloadArg, mce);
if (fromMessage != null) {
return new PayloadResolution(fromMessage, messagePattern);
}
if (isEnvelopeBare(payloadArg, mce)) {
return null;
}
} else if (isEnvelopeBare(payloadArg, mce)) {
return null;
}
// 内联 JSON 序列化
Expression serialized = unwrapSerializer(payloadArg);
if (serialized != null) {
if (jsonPattern != null && enabledPatterns.contains(jsonPattern)) {
return new PayloadResolution(serialized, jsonPattern);
}
return new PayloadResolution(serialized, null);
}
// 局部 String = toJSONString(...)
if (jsonPattern != null && enabledPatterns.contains(jsonPattern)) {
Expression fromLocalJson = unwrapJsonStringVar(payloadArg, mce);
if (fromLocalJson != null) {
return new PayloadResolution(fromLocalJson, jsonPattern);
}
}
if (isTrivialValue(payloadArg) || isBareStringOrBytesPayload(payloadArg, mce)) {
return null;
}
return new PayloadResolution(payloadArg, null);
}
private Expression unwrapMessagePayload(Expression payloadArg, MethodCallExpr mce) {
Expression fromBuilder = unwrapMessageBuilderPayload(payloadArg, mce);
if (fromBuilder != null) {
return fromBuilder;
}
// Message&lt;DutyImNotice&gt; → DutyImNotice无 withPayload 也可)
if (payloadArg instanceof NameExpr) {
Type declared = findVariableType(((NameExpr) payloadArg).getNameAsString(), mce);
if (declared instanceof ClassOrInterfaceType) {
ClassOrInterfaceType cit = (ClassOrInterfaceType) declared;
if (ENVELOPE_TYPES.contains(cit.getNameAsString())) {
Optional<Type> payloadType = cit.getTypeArguments()
.filter(a -> !a.isEmpty())
.map(a -> a.get(a.size() - 1));
if (payloadType.isPresent() && payloadType.get() instanceof ClassOrInterfaceType) {
// 用伪 ObjectCreation 表达类型不便;改为在 infer 前用 NameExpr 不够
// 返回一个标记:借助 CastExpr 包装类型信息
return new CastExpr(payloadType.get(), payloadArg);
}
}
}
}
return null;
}
private Expression unwrapMessageBuilderPayload(Expression payloadArg, MethodCallExpr mce) {
Expression chain = payloadArg;
if (payloadArg instanceof NameExpr) {
String name = ((NameExpr) payloadArg).getNameAsString();
Optional<CallableDeclaration> callable = mce.findAncestor(CallableDeclaration.class);
if (callable.isPresent()) {
for (VariableDeclarator var : callable.get().findAll(VariableDeclarator.class)) {
if (var.getNameAsString().equals(name) && var.getInitializer().isPresent()) {
chain = var.getInitializer().get();
break;
}
}
}
}
return findWithPayloadArg(chain);
}
private Expression findWithPayloadArg(Expression expr) {
Expression current = expr;
int guard = 0;
while (current instanceof MethodCallExpr && guard++ < 16) {
MethodCallExpr call = (MethodCallExpr) current;
if ("withPayload".equals(call.getNameAsString()) && !call.getArguments().isEmpty()) {
return call.getArgument(0);
}
if (!call.getScope().isPresent()) {
break;
}
current = call.getScope().get();
}
return null;
}
private Expression unwrapJsonStringVar(Expression payloadArg, MethodCallExpr mce) {
if (!(payloadArg instanceof NameExpr)) {
return null;
}
String name = ((NameExpr) payloadArg).getNameAsString();
Type declared = findVariableType(name, mce);
if (declared != null) {
String simple = declared.isClassOrInterfaceType()
? declared.asClassOrInterfaceType().getNameAsString()
: declared.asString();
if (!"String".equals(simple)) {
return null;
}
}
Optional<CallableDeclaration> callable = mce.findAncestor(CallableDeclaration.class);
if (!callable.isPresent()) {
return null;
}
for (VariableDeclarator var : callable.get().findAll(VariableDeclarator.class)) {
if (!var.getNameAsString().equals(name) || !var.getInitializer().isPresent()) {
continue;
}
return unwrapSerializer(var.getInitializer().get());
}
return null;
}
private boolean isEnvelopeBare(Expression typeExpr, MethodCallExpr contextCall) {
if (!(typeExpr instanceof NameExpr)) {
return false;
}
Type declared = findVariableType(((NameExpr) typeExpr).getNameAsString(), contextCall);
if (declared == null) {
return false;
}
String simple = declared.isClassOrInterfaceType()
? declared.asClassOrInterfaceType().getNameAsString()
: declared.asString();
return ENVELOPE_TYPES.contains(simple);
}
private boolean isRocketMqScope(MethodCallExpr mce) {
String scope = mce.getScope().map(Expression::toString).orElse("").toLowerCase();
return scope.contains("rocketmqtemplate") || scope.contains("rocketmq");
@@ -177,7 +377,7 @@ public class MqWritePointDetector {
String simple = declared.isClassOrInterfaceType()
? declared.asClassOrInterfaceType().getNameAsString()
: declared.asString();
if (IGNORE_PAYLOAD_TYPES.contains(simple) || "byte[]".equals(declared.asString())) {
if (IGNORE_BARE_TYPES.contains(simple) || "byte[]".equals(declared.asString())) {
return true;
}
}
@@ -306,6 +506,15 @@ public class MqWritePointDetector {
}
return new InferredType(null, true);
}
if (ENVELOPE_TYPES.contains(simple)) {
Optional<Type> payload = cit.getTypeArguments()
.filter(a -> !a.isEmpty())
.map(a -> a.get(a.size() - 1));
if (payload.isPresent()) {
return resolveTypeNode(payload.get(), context);
}
return new InferredType(null, false);
}
return new InferredType(resolveFqn(cit, context), false);
}
@@ -317,6 +526,16 @@ public class MqWritePointDetector {
return fqn;
}
private static final class PayloadResolution {
final Expression typeExpr;
final String overridePattern;
PayloadResolution(Expression typeExpr, String overridePattern) {
this.typeExpr = typeExpr;
this.overridePattern = overridePattern;
}
}
private static final class InferredType {
final String fqn;
final boolean isArray;

View File

@@ -46,16 +46,21 @@ detection:
- W03 # stringRedisTemplate.opsForValue().set(key, JsonUtil.getObjectToString(x), ...)
- W04 # redisTemplate.opsForValue().set(key, obj, ...)
- W05 # redisTemplate.opsForHash().put(key, field, obj)
# MQ 生产侧投递检测Phase M1
# MQ 生产侧投递检测Phase M1 + M2
mq_patterns:
- MQ01 # rocketMQTemplate.syncSend(dest, payload)
- MQ02 # asyncSend / syncSendOrderly / sendOneWay
- MQ03 # convertAndSend(dest, payload)
- MQ04 # MessageBuilder.withPayload / Message<T>
- MQ05 # 先 toJSONString 再 send String
- MQ-K01 # kafkaTemplate.send(topic, payload)
- MQ-K02 # kafkaTemplate.send(topic, key, payload)
- MQ-K03 # kafkaTemplate.send(ProducerRecord)
- MQ-K04 # 先 JSON 序列化为 String 再 send
# W06 读侧辅助:用 parseObject / getJsonToBean 等补强写入点 value 类型(非写入模式)
read_hints_enabled: true
# MQ-R 读侧补强(Phase M2默认关闭
mq_read_hints_enabled: false
# MQ-R 读侧补强(Listener / parseObject
mq_read_hints_enabled: true
# 类型推断最低置信度,低于此值标记为低置信度提示
min_confidence: 0.6
# 字段展开最大深度(防止循环引用)

View File

@@ -1,5 +1,7 @@
package com.codechecker.cache;
import com.codechecker.cache.detector.CacheReadHint;
import com.codechecker.cache.detector.MqReadHintDetector;
import com.codechecker.cache.detector.MqWritePointDetector;
import com.codechecker.cache.detector.WritePoint;
import com.codechecker.cache.diff.ChangeType;
@@ -19,6 +21,7 @@ import java.util.Set;
import java.util.stream.Collectors;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
class MqScenarioTest {
@@ -120,4 +123,63 @@ class MqScenarioTest {
assertTrue(md.contains("> **通道**: Kafka"), md);
assertTrue(md.contains("> **类型**: List<CheckItemDetailVo>"), md);
}
@Test
void messageBuilderProducerResolvesDutyImNotice() {
String notice = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNotice.txt");
String producer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeProducer.txt");
SourceIndex index = new SourceIndex();
index.addSource(notice);
index.addSource(producer);
Set<String> patterns = new HashSet<>();
patterns.add("MQ02");
patterns.add("MQ04");
WritePoint wp = new MqWritePointDetector(index, patterns)
.detect("DutyImNoticeProducer.java", producer).stream()
.filter(w -> "MQ04".equals(w.getPattern()))
.findFirst()
.orElseThrow(() -> new AssertionError("应命中 MQ04"));
assertEquals("duty-im-notice-topic", wp.getResolvedKeyPattern());
assertTrue(wp.getResolvedValueType().endsWith("DutyImNotice"));
}
@Test
void mqReadHintEnrichesWritePointByDestination() {
String notice = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNotice.txt");
String producer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeProducer.txt");
String consumer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeConsumer.txt");
SourceIndex index = new SourceIndex();
index.addSource(notice);
index.addSource(producer);
index.addSource(consumer);
List<CacheReadHint> hints = new MqReadHintDetector(index)
.detect("DutyImNoticeConsumer.java", consumer);
assertFalse(hints.isEmpty());
Set<String> patterns = new HashSet<>();
patterns.add("MQ02");
patterns.add("MQ04");
WritePoint wp = new MqWritePointDetector(index, patterns)
.detect("DutyImNoticeProducer.java", producer).stream()
.filter(w -> "MQ04".equals(w.getPattern()))
.findFirst()
.orElseThrow(() -> new AssertionError("应命中 MQ04"));
// 模拟无泛型 Message 导致类型缺失时MQ-R 可按 destination 补强
wp.setResolvedValueType(null);
wp.setConfidence(0.4);
CacheReadHint hint = hints.get(0);
assertEquals(wp.getResolvedKeyPattern(), hint.getResolvedKeyPattern());
if (hint.getResolvedValueType() != null) {
wp.setResolvedValueType(hint.getResolvedValueType());
wp.setConfidence(Math.max(wp.getConfidence(), hint.getConfidence()));
}
assertTrue(wp.getResolvedValueType().endsWith("DutyImNotice"));
assertTrue(wp.getConfidence() >= 0.8);
}
}

View File

@@ -21,7 +21,9 @@ class ConfigLoaderTest {
assertTrue(config.getDetection().getPatterns().contains("W01"));
assertTrue(config.getDetection().getMqPatterns().contains("MQ01"));
assertTrue(config.getDetection().getMqPatterns().contains("MQ-K01"));
assertFalse(config.getDetection().isMqReadHintsEnabled());
assertTrue(config.getDetection().getMqPatterns().contains("MQ04"));
assertTrue(config.getDetection().getMqPatterns().contains("MQ-K03"));
assertTrue(config.getDetection().isMqReadHintsEnabled());
assertFalse(config.isScanTestSources());
}

View File

@@ -0,0 +1,51 @@
package com.codechecker.cache.detector;
import com.codechecker.cache.TestSupport;
import com.codechecker.cache.schema.SourceIndex;
import org.junit.jupiter.api.Test;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
class MqReadHintDetectorTest {
@Test
void detectsRocketMqListenerGenericType() {
String notice = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNotice.txt");
String producer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeProducer.txt");
String consumer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeConsumer.txt");
SourceIndex index = new SourceIndex();
index.addSource(notice);
index.addSource(producer);
index.addSource(consumer);
List<CacheReadHint> hints = new MqReadHintDetector(index)
.detect("DutyImNoticeConsumer.java", consumer);
assertFalse(hints.isEmpty());
CacheReadHint hint = hints.get(0);
assertTrue(hint.getResolvedValueType().endsWith("DutyImNotice"));
assertEquals("duty-im-notice-topic", hint.getResolvedKeyPattern());
assertFalse(hint.isRootArray());
}
@Test
void detectsKafkaListenerParseObject() {
String vo = TestSupport.fixture("fixtures/mq/kafka-record/PatrolNotifyVo.txt");
String listener = TestSupport.fixture("fixtures/mq/kafka-record/PatrolNotifyListener.txt");
SourceIndex index = new SourceIndex();
index.addSource(vo);
index.addSource(listener);
List<CacheReadHint> hints = new MqReadHintDetector(index)
.detect("PatrolNotifyListener.java", listener);
assertTrue(hints.stream().anyMatch(h ->
h.getResolvedValueType() != null
&& h.getResolvedValueType().endsWith("PatrolNotifyVo")
&& "patrol-notify-topic".equals(h.getResolvedKeyPattern())));
}
}

View File

@@ -28,6 +28,9 @@ class MqWritePointDetectorTest {
Set<String> patterns = new HashSet<>();
patterns.add("MQ01");
patterns.add("MQ02");
patterns.add("MQ03");
patterns.add("MQ04");
patterns.add("MQ05");
List<WritePoint> wps = new MqWritePointDetector(index, patterns)
.detect("WalletDeductProducer.java", producer);
@@ -63,4 +66,110 @@ class MqWritePointDetectorTest {
assertTrue(wp.getResolvedValueType().endsWith("CheckItemDetailVo"));
assertTrue(wp.isRootArray());
}
@Test
void detectsMessageBuilderAsyncSendAsMq04() {
String notice = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNotice.txt");
String producer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeProducer.txt");
SourceIndex index = new SourceIndex();
index.addSource(notice);
index.addSource(producer);
Set<String> patterns = allRocketPatterns();
List<WritePoint> wps = new MqWritePointDetector(index, patterns)
.detect("DutyImNoticeProducer.java", producer);
WritePoint mq04 = findByPattern(wps, "MQ04");
assertEquals(WritePoint.CHANNEL_ROCKETMQ, mq04.getChannel());
assertEquals("duty-im-notice-topic", mq04.getResolvedKeyPattern());
assertTrue(mq04.getResolvedValueType().endsWith("DutyImNotice"), mq04.getResolvedValueType());
}
@Test
void detectsConvertAndSendAsMq03() {
String notice = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNotice.txt");
String producer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeProducer.txt");
SourceIndex index = new SourceIndex();
index.addSource(notice);
index.addSource(producer);
WritePoint mq03 = findByPattern(
new MqWritePointDetector(index, allRocketPatterns())
.detect("DutyImNoticeProducer.java", producer),
"MQ03");
assertTrue(mq03.getResolvedValueType().endsWith("DutyImNotice"));
}
@Test
void detectsJsonStringSyncSendAsMq05() {
String notice = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNotice.txt");
String producer = TestSupport.fixture("fixtures/mq/rocket-im/DutyImNoticeProducer.txt");
SourceIndex index = new SourceIndex();
index.addSource(notice);
index.addSource(producer);
WritePoint mq05 = findByPattern(
new MqWritePointDetector(index, allRocketPatterns())
.detect("DutyImNoticeProducer.java", producer),
"MQ05");
assertTrue(mq05.getResolvedValueType().endsWith("DutyImNotice"));
}
@Test
void detectsProducerRecordSendAsMqK03() {
String vo = TestSupport.fixture("fixtures/mq/kafka-record/PatrolNotifyVo.txt");
String producer = TestSupport.fixture("fixtures/mq/kafka-record/PatrolNotifyProducer.txt");
SourceIndex index = new SourceIndex();
index.addSource(vo);
index.addSource(producer);
Set<String> patterns = allKafkaPatterns();
WritePoint wp = findByPattern(
new MqWritePointDetector(index, patterns).detect("PatrolNotifyProducer.java", producer),
"MQ-K03");
assertEquals("patrol-notify-topic", wp.getResolvedKeyPattern());
assertTrue(wp.getResolvedValueType().endsWith("PatrolNotifyVo"));
}
@Test
void detectsKafkaJsonStringAsMqK04() {
String vo = TestSupport.fixture("fixtures/mq/kafka-record/PatrolNotifyVo.txt");
String producer = TestSupport.fixture("fixtures/mq/kafka-record/PatrolNotifyProducer.txt");
SourceIndex index = new SourceIndex();
index.addSource(vo);
index.addSource(producer);
WritePoint wp = findByPattern(
new MqWritePointDetector(index, allKafkaPatterns())
.detect("PatrolNotifyProducer.java", producer),
"MQ-K04");
assertTrue(wp.getResolvedValueType().endsWith("PatrolNotifyVo"));
}
private static Set<String> allRocketPatterns() {
Set<String> patterns = new HashSet<>();
patterns.add("MQ01");
patterns.add("MQ02");
patterns.add("MQ03");
patterns.add("MQ04");
patterns.add("MQ05");
return patterns;
}
private static Set<String> allKafkaPatterns() {
Set<String> patterns = new HashSet<>();
patterns.add("MQ-K01");
patterns.add("MQ-K02");
patterns.add("MQ-K03");
patterns.add("MQ-K04");
return patterns;
}
private static WritePoint findByPattern(List<WritePoint> wps, String pattern) {
return wps.stream()
.filter(w -> pattern.equals(w.getPattern()))
.findFirst()
.orElseThrow(() -> new AssertionError("缺少模式 " + pattern + ",实际: " + wps));
}
}

View File

@@ -0,0 +1,6 @@
package demo.kafka;
public class CheckItemDetailVo {
private String itemId;
private String itemName;
}

View File

@@ -0,0 +1,7 @@
package demo.kafka;
public class CheckItemDetailVo {
private String itemId;
private String itemName;
private Integer score;
}

View File

@@ -0,0 +1,14 @@
package demo.kafka;
import java.util.List;
import org.springframework.kafka.core.KafkaTemplate;
public class PatrolService {
private KafkaTemplate kafkaTemplate;
private static final String TOPIC = "patrol-store-food-safe:%s";
public void sendFoodSafeData(String tenantId, List<CheckItemDetailVo> thousandsData) {
String topic = String.format(TOPIC, tenantId);
kafkaTemplate.send(topic, thousandsData);
}
}

View File

@@ -0,0 +1,10 @@
package demo.kafka;
import org.springframework.kafka.annotation.KafkaListener;
public class PatrolNotifyListener {
@KafkaListener(topics = "patrol-notify-topic", groupId = "patrol-group")
public void handle(String message) {
PatrolNotifyVo vo = JSONObject.parseObject(message, PatrolNotifyVo.class);
}
}

View File

@@ -0,0 +1,19 @@
package demo.kafka;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.springframework.kafka.core.KafkaTemplate;
public class PatrolNotifyProducer {
private KafkaTemplate kafkaTemplate;
private static final String TOPIC = "patrol-notify-topic";
public void sendRecord(PatrolNotifyVo vo) {
ProducerRecord<String, PatrolNotifyVo> record = new ProducerRecord<>(TOPIC, vo);
kafkaTemplate.send(record);
}
public void sendJson(PatrolNotifyVo vo) {
String json = JSON.toJSONString(vo);
kafkaTemplate.send(TOPIC, json);
}
}

View File

@@ -0,0 +1,6 @@
package demo.kafka;
public class PatrolNotifyVo {
private String storeId;
private String status;
}

View File

@@ -0,0 +1,7 @@
package demo.mq;
public class DutyImNotice {
private String tenantId;
private String id;
private String content;
}

View File

@@ -0,0 +1,10 @@
package demo.mq;
import org.apache.rocketmq.spring.annotation.RocketMQMessageListener;
import org.apache.rocketmq.spring.core.RocketMQListener;
@RocketMQMessageListener(topic = DutyImNoticeProducer.MQ_TOPIC, consumerGroup = "duty-im-group")
public class DutyImNoticeConsumer implements RocketMQListener<DutyImNotice> {
public void onMessage(DutyImNotice message) {
}
}

View File

@@ -0,0 +1,28 @@
package demo.mq;
import org.apache.rocketmq.spring.core.RocketMQTemplate;
import org.springframework.messaging.Message;
import org.springframework.messaging.support.MessageBuilder;
public class DutyImNoticeProducer {
private RocketMQTemplate rocketMQTemplate;
public static final String MQ_TOPIC = "duty-im-notice-topic";
public void addMq(DutyImNotice message, long timestamp) {
String uniqueKey = message.getTenantId() + "_" + message.getId();
Message<DutyImNotice> mqMessage = MessageBuilder.withPayload(message)
.setHeader("KEYS", uniqueKey)
.setHeader("executeTime", timestamp)
.build();
rocketMQTemplate.asyncSend(MQ_TOPIC, mqMessage);
}
public void convertSend(DutyImNotice message) {
rocketMQTemplate.convertAndSend(MQ_TOPIC, message);
}
public void sendJson(DutyImNotice message) {
String body = JSON.toJSONString(message);
rocketMQTemplate.syncSend(MQ_TOPIC, body);
}
}

View File

@@ -0,0 +1,6 @@
package demo.mq;
public final class CapitalMqConstants {
public static final String TOPIC = "capital-topic";
public static final String TAG_WALLET_DEDUCT = "WALLET_DEDUCT";
}

View File

@@ -0,0 +1,11 @@
package demo.mq;
import org.apache.rocketmq.spring.core.RocketMQTemplate;
public class WalletDeductProducer {
private RocketMQTemplate rocketMQTemplate;
public void send(WalletDeductReq req) {
rocketMQTemplate.syncSend(CapitalMqConstants.TOPIC + ":" + CapitalMqConstants.TAG_WALLET_DEDUCT, req);
}
}

View File

@@ -0,0 +1,6 @@
package demo.mq;
public class WalletDeductReq {
private String walletId;
private Long amount;
}

View File

@@ -0,0 +1,7 @@
package demo.mq;
public class WalletDeductReq {
private String walletId;
private Long amount;
private String remark;
}