修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题 #3848

Copilot · 2026-01-14T03:47:05Z

修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题

主要改进（已完成代码审查反馈）

1. 解决并发竞态条件问题

问题: 在 initSdk() 和 incrementMsgAuditSdkRefCount() 之间存在时间窗口，可能导致引用计数操作在错误的SDK上

解决方案:

新增 acquireMsgAuditSdk() 原子操作方法，在一个同步块内完成SDK获取和引用计数增加
新增 releaseMsgAuditSdk() 原子操作方法，在一个同步块内完成引用计数减少和SDK销毁检查
新增 acquireSdk() 和 releaseSdk() 辅助方法封装原子操作逻辑
所有新API方法改用原子操作方法，消除竞态条件

2. 改进SDK不匹配时的返回值

问题: 当传入的SDK与缓存的SDK不匹配时，返回0无法区分是SDK不匹配还是引用计数为0

解决方案:

incrementMsgAuditSdkRefCount() SDK不匹配时返回-1（而非0）
decrementMsgAuditSdkRefCount() SDK不匹配时返回-1（而非0）
getMsgAuditSdkRefCount() SDK不匹配时返回-1（而非0）
调用方可以明确区分错误情况

3. 加强SDK销毁时的检查

问题: 在销毁SDK时需要再次检查SDK是否仍然是当前缓存的SDK

解决方案:

在 decrementMsgAuditSdkRefCount() 和 releaseMsgAuditSdk() 中，销毁前再次验证 this.msgAuditSdk == sdk
在 updateMsgAuditSdk() 中，如果有旧SDK且引用计数为0，先销毁旧SDK再更新
防止销毁已被替换的SDK

4. 新增原子操作接口

在 WxCpConfigStorage 接口中新增：

// 获取当前SDK并增加引用计数（原子操作）
long acquireMsgAuditSdk();

// 减少SDK引用计数并在必要时释放（原子操作）
void releaseMsgAuditSdk(long sdk);

核心改进对比

修复前:

// ❌ 存在竞态条件
long sdk = this.initSdk();  // 第1步
configStorage.incrementMsgAuditSdkRefCount(sdk);  // 第2步：SDK可能已被其他线程替换

修复后:

// ✅ 原子操作，无竞态条件
long sdk = this.acquireSdk();  // 在同步块内完成SDK获取和引用计数增加

技术实现细节

acquireSdk() 方法逻辑:

首先尝试原子获取现有有效SDK（acquireMsgAuditSdk()）
如果成功，直接返回
如果失败（SDK过期或未初始化），调用 initSdk() 初始化
初始化后增加引用计数
如果引用计数失败（SDK已被替换），递归重试

releaseSdk() 方法逻辑:

调用 releaseMsgAuditSdk() 原子减少引用计数
在同步块内检查是否需要销毁SDK
销毁前再次验证SDK是否仍然是当前缓存的SDK

测试验证

代码审查反馈处理

影响范围

破坏性变更: 无，完全向后兼容
影响模块: weixin-java-cp
主要改进: 消除并发竞态条件，提高多线程环境稳定性

Original prompt

This section details on the original issue you should resolve

<issue_title>企业微信会话存档下载时总是时不时出现报错，导致整个JVM直接崩溃</issue_title>
<issue_description>

简要描述

企业微信会话存档下载时总是时不时出现报错，导致整个JVM直接崩溃

模块版本情况

WxJava 模块名: weixin-java-cp
WxJava 版本号: 4.7.5-20250516.201941

详细描述

public List pullWeworkChatData(long seq, long limit, Predicate duplicateMessageFilter) throws Exception {

    // 本次请求获取消息记录开始的seq值。首次访问填写0，非首次使用上次企业微信返回的最大seq。允许从任意seq重入拉取。
    WxCpChatDatas chatDatas = wxCpService.getMsgAuditService().getChatDatas(seq, limit, null, null, 1000L);
    if (chatDatas == null || CollUtil.isEmpty(chatDatas.getChatData())) {
        log.info("未读取到数据，当前序列为： {}", seq);
        return Collections.emptyList();
    }

    List<WeworkMessage> weworkMessages = new ArrayList<>();
    for (WxCpChatDatas.WxCpChatData chatData : chatDatas.getChatData()) {
        seq = chatData.getSeq();

        // 过滤掉重复消息，判断是否重复，如果重复则跳过
        if (duplicateMessageFilter.test(chatData.getMsgId())) {
            WeworkMessage weworkMessage = new WeworkMessage();
            weworkMessage.setExists(true);
            weworkMessage.setMsgId(chatData.getMsgId());
            weworkMessage.setMsgSeq(chatData.getSeq());
            weworkMessages.add(weworkMessage);
            continue;
        }
        // 获取明文数据
        final String chatPlainText = wxCpService.getMsgAuditService().getChatPlainText(chatDatas.getSdk(), chatData, 2);
        final WxCpChatModel decryptData = WxCpChatModel.fromJson(chatPlainText);
        log.info("当前数据序列为：{},明文数据为：{}", seq, decryptData.toJson());

        WorkMessageType msgType = WorkMessageType.fromType(decryptData.getMsgType());
        if (msgType == null) {
            log.info("不支持的消息类型：{}", decryptData.getMsgType());
            continue;
        }

        WeworkMessage weworkMessage = new WeworkMessage();
        weworkMessages.add(weworkMessage);

        weworkMessage.setMsgType(msgType);
        weworkMessage.setMsgSeq(chatData.getSeq());
        weworkMessage.setMessageInfo(decryptData);
        weworkMessage.setMsgId(decryptData.getMsgId());


        if (!MEDIA_MESSAGE_TYPES.contains(decryptData.getMsgType())) {
            break;
        }

        try {
            WeworkMessage.Media media = downloadMediaFile(decryptData.getMsgType(), decryptData, weworkProperties.getTmpFileDirPath(), chatDatas);
            weworkMessage.setMediaInfo(media);
        } catch (WxErrorException e) {
            log.error("下载文件失败", e);
        }

        if (StrUtil.isNotBlank(decryptData.getRoomId())) {
            var groupChat = groupChatMap.get(decryptData.getRoomId());
            if (groupChat == null) {
                try {
                    groupChat = wxCpService.getMsgAuditService().getGroupChat(decryptData.getRoomId());
                    groupChatMap.put(decryptData.getRoomId(), groupChat);
                } catch (WxErrorException e) {
                    log.error("无法获取外部群，跳过本次群信息获取");
                }

            }

            weworkMessage.setGroupInfo(groupChat);
        }


    }


    // 批次数据拉取完毕后，释放此次sdk
    log.info("释放sdk {}", chatDatas.getSdk());
    Finance.DestroySdk(chatDatas.getSdk());
    return weworkMessages;
}

/**
 * 获取媒体文件，
 * 不同的文件类型，拼接好存放文件的绝对路径，写入文件流，获取媒体文件。
 * <p>
 * 目标文件绝对路径+实际文件名，比如：/tmp/workpulse/file/20220114/474f866b39d10718810d55262af82662.gif
 */
private WeworkMessage.Media downloadMediaFile(String msgType, WxCpChatModel decryptData, String path, WxCpChatDatas chatDatas) throws WxErrorException {
    // 文件后缀
    String suffix = "";
    // 文件名md5
    String md5Sum = "";
    String fileName = "";
    // sdkFileId
    String sdkFileId = "";
    switch (msgType) {
        case WxCpConsts.MsgAuditMediaType.IMAGE:
            suffix = WxCpConsts.MsgAuditMediaType.MsgAuditSuffix.JPG;
            md5Sum = decryptData.getImage().getMd5Sum();
            sdkFileId = decryptData.getImage().getSdkFileId();
            break;
        case WxCpConsts.MsgAuditMediaType.VOICE:
            suffix = WxCpConsts.MsgAuditMediaType.MsgAuditSuffix.AMR;
            md5Sum = decryptData.getVoice().getMd5Sum();
            sdkFileId = decryptData.getVoice().getSdkFileId();
            break;
        case WxCpConsts.MsgAuditMediaType.VIDEO:
            suffix = WxCpConsts.MsgAuditMediaType.MsgAuditSuffix.MP4;
            md5Sum = decryptData.getVideo().getMd5Sum();
            sdkFileId = decryptData.getVideo().getSdkFileId();
            break;
        case WxCpConsts.MsgAuditMediaType.FILE:
            md5Sum = decryptData.getFile().getMd5Sum();
            suffix = "." + decryptData.ge...

Custom agent used: 全部用中文
需要用中文，包括PR标题和分析总结过程

Fixes 企业微信会话存档下载时总是时不时出现报错，导致整个JVM直接崩溃 #3670

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: binarywang <[email protected]>

augmentcode · 2026-01-14T09:06:33Z

🤖 Augment PR Summary

Summary: 本PR修复企业微信会话存档 SDK 生命周期管理不当导致的 JVM 偶发崩溃（SIGSEGV）问题。

Changes:

引入会话存档 SDK 引用计数机制，在每次调用前后自动增减计数，计数归零时自动销毁并清理缓存状态
在 WxCpMsgAuditService 新增 4 个“安全 API”，不再向调用方暴露 SDK 句柄（getChatRecords/getDecryptChatData/getChatRecordPlainText/downloadMediaFile）
将旧的需要显式传入/销毁 SDK 的 API 标记为 @Deprecated，并在 Javadoc 中给出迁移路径
在 WxCpConfigStorage 增加引用计数相关接口，并在 Default/Redis 配置实现中落地
在实现类中使用 try/finally 确保引用计数一定被回收，降低多线程下错误释放 SDK 的概率
新增文档 CP_MSG_AUDIT_SDK_SAFE_USAGE.md 说明崩溃原因、迁移步骤与推荐用法
补充单测用例，覆盖新安全 API 的基本调用链路

Technical Notes: 核心思路是让框架统一管理 SDK 缓存 + 生命周期，避免业务方手动 Destroy 与内部缓存复用机制冲突。

_{🤖 Was this summary useful? React with 👍 or 👎}

augmentcode

Review completed. 4 suggestions posted.

Comment augment review to trigger a new review at any time.

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java

Copilot

Pull request overview

该 PR 修复了企业微信会话存档 SDK 生命周期管理混乱导致的 JVM 崩溃问题。核心解决方案是引入引用计数机制来自动管理 SDK 生命周期，并提供新的安全 API 方法，将 SDK 管理完全封装在框架内部。

Changes:

在配置存储层引入引用计数机制（incrementMsgAuditSdkRefCount、decrementMsgAuditSdkRefCount、getMsgAuditSdkRefCount）
新增 4 个安全 API 方法，不暴露 SDK 给调用方（getChatRecords、getDecryptChatData、getChatRecordPlainText、downloadMediaFile）
将旧 API 标记为 @deprecated，并在注释中说明迁移路径
新增完整的迁移指南文档和测试用例

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/WxCpConfigStorage.java	在接口中定义引用计数方法，用于 SDK 生命周期管理
weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java	实现引用计数机制，通过 synchronized 保证线程安全，计数归零时自动销毁 SDK
weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java	在 Redis 配置实现中添加引用计数机制，保持与默认实现一致
weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/WxCpMsgAuditService.java	定义 4 个新的安全 API 方法，将旧方法标记为 @deprecated
weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java	实现新的安全 API，使用 try-finally 模式自动管理引用计数
weixin-java-cp/src/test/java/me/chanjar/weixin/cp/api/WxCpMsgAuditTest.java	新增测试用例验证新 API 的功能
docs/CP_MSG_AUDIT_SDK_SAFE_USAGE.md	提供详细的迁移指南，包含问题背景、解决方案、使用示例和常见问题

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/api/impl/WxCpMsgAuditServiceImpl.java

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpDefaultConfigImpl.java

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/config/impl/WxCpRedisConfigImpl.java

docs/CP_MSG_AUDIT_SDK_SAFE_USAGE.md

binarywang · 2026-01-14T09:54:22Z

@copilot apply changes based on the comments in this thread

Co-authored-by: binarywang <[email protected]>

1. getChatRecords() 返回空列表而非 null，避免 NPE 2. downloadMediaFile() 正确传播文件写入异常 3. updateMsgAuditSdk() 确保旧 SDK 被销毁，避免资源泄漏

Initial plan

c849913

Copilot AI assigned Copilot and binarywang Jan 14, 2026

Copilot started work on behalf of binarywang January 14, 2026 03:47 View session

Copilot AI and others added 4 commits January 14, 2026 03:55

添加SDK引用计数机制和新的安全API方法

54be19d

Co-authored-by: binarywang <[email protected]>

添加新API的单元测试

54c51bd

Co-authored-by: binarywang <[email protected]>

添加会话存档SDK安全使用文档

6e3039c

Co-authored-by: binarywang <[email protected]>

修复代码审查反馈：完善SDK自动销毁逻辑和测试代码

7d63739

Co-authored-by: binarywang <[email protected]>

Copilot AI changed the title ~~[WIP] Fix error causing JVM crash during WeChat chat data download~~ 修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题 Jan 14, 2026

Copilot AI requested a review from binarywang January 14, 2026 04:07

Copilot finished work on behalf of binarywang January 14, 2026 04:07

binarywang marked this pull request as ready for review January 14, 2026 09:03

Copilot AI review requested due to automatic review settings January 14, 2026 09:03

Copilot started reviewing on behalf of binarywang January 14, 2026 09:03 View session

augmentcode bot reviewed Jan 14, 2026

View reviewed changes

Copilot AI reviewed Jan 14, 2026

View reviewed changes

Copilot started work on behalf of binarywang January 14, 2026 09:54 View session

修复并发问题：改进SDK引用计数机制，使用原子操作避免竞态条件

1d4e08c

Co-authored-by: binarywang <[email protected]>

Copilot finished work on behalf of binarywang January 14, 2026 10:04

binarywang force-pushed the develop branch 3 times, most recently from bbc138a to 30914f3 Compare January 15, 2026 09:59

fix: 修复会话存档SDK生命周期管理的审查问题

048b51e

1. getChatRecords() 返回空列表而非 null，避免 NPE 2. downloadMediaFile() 正确传播文件写入异常 3. updateMsgAuditSdk() 确保旧 SDK 被销毁，避免资源泄漏

binarywang merged commit 47b4431 into develop Jan 16, 2026
1 check was pending

binarywang added this to the 4.8.1 milestone Jan 16, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题 #3848

修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题 #3848

Copilot AI commented Jan 14, 2026 •

edited

Loading

Uh oh!

augmentcode bot commented Jan 14, 2026

Uh oh!

augmentcode bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

binarywang commented Jan 14, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题 #3848

修复企业微信会话存档SDK生命周期管理导致的JVM崩溃问题 #3848

Conversation

Copilot AI commented Jan 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!