收发流式消息 - IM 即时通讯

开发者中心

IM 即时通讯

集成开发

收发流式消息

更新时间： 2025/06/30 17:22:23

本文介绍通过网易云信即时通讯 SDK（NetEase IM SDK，简称 NIM SDK）实现消息流式输出的具体流程，通过实时分片传输接收到的内容，显著改善用户交互体验。

支持平台

本文内容适用的开发平台或框架如下表所示，涉及的接口请参考下文相关接口章节：

安卓	iOS	macOS/Windows	Web/uni-app/小程序	Node.js/Electron	鸿蒙	Flutter
✔️	✔️	✔️	✔️️️️	✔️	✔️	-

准备工作

在功能开发前，请确保：

已初始化 SDK，详情请参考各端 SDK 初始化文档。
已登录 IM，详情请参考登录及登出 IM。

注意事项

目前支持调用服务端 API 发送流式消息，客户端支持接收流式消息，实时分片传输接收到的内容。
目前 IM 消息的流式输出支持文本类型的 单聊消息。
针对 Web/uni-app/小程序/RN 平台，当选择通过 ESM 引入方式时，需要提前引入 AI 数字人模块（V2NIMAIService）才能正常接收流式消息。具体请参考 ESM 引入。

实现流程

API 调用时序

普通消息流式输出流程图.png

实现步骤

接收方 注册消息监听器，监听消息接收事件和消息更新事件。

安卓

接收方调用 addMessageListener 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages 和消息更新回调事件 onReceiveMessagesModified。

JavaV2NIMMessageService v2MessageService = NIMClient.getService(V2NIMMessageService.class);
V2NIMMessageListener messageListener = new V2NIMMessageListener() {

    @Override
    public void onReceiveMessages(List<V2NIMMessage> messages) {
    }

    @Override
    public void onReceiveMessagesModified(List<V2NIMMessage> messages) {
    }
};
v2MessageService.addMessageListener(messageListener);

iOS

接收方调用 addMessageListener 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages 和消息更新回调事件 onReceiveMessagesModified。

Objective-C[[[NIMSDK sharedSDK] v2MessageService] addMessageListener:listener];

macOS/Windows

接收方调用 addMessageListener 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages 和消息更新回调事件 onReceiveMessagesModified。

C++V2NIMMessageListener listener;
listener.onReceiveMessages = [](nstd::vector<V2NIMMessage> messages) {
    // receive messages
};
listener.onReceiveMessagesModified = [](nstd::vector<V2NIMMessage> messages) {
    // modify messages
};
messageService.addMessageListener(listener);

Web/uni-app/小程序

调用 on("EventName") 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages 和消息更新回调事件 onReceiveMessagesModified。

TypeScriptnim.V2NIMMessageService.on("onReceiveMessages", function (messages: V2NIMMessage[]) {})
nim.V2NIMMessageService.on("onReceiveMessagesModified", function (messages: V2NIMMessage[]) {})

Node.js/Electron

调用 on("EventName") 方法注册消息监听器，监听消息接收回调事件 receiveMessages 和消息更新回调事件 receiveMessagesModified。

TypeScriptv2.messageService.on("receiveMessages", function (messages: V2NIMMessage[]) {})
v2.messageService.on("receiveMessagesModified", function (messages: V2NIMMessage[]) {})

鸿蒙

调用 on("EventName") 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages 和消息更新回调事件 onReceiveMessagesModified。

TypeScriptnim.messageService.on("onReceiveMessages", function (messages: V2NIMMessage[]) {})
nim.messageService.on("onReceiveMessagesModified", function (messages: V2NIMMessage[]) {})

发送方 调用服务端 API 发送流式消息。

根据调用返回的状态，处理输出的流式消息。
接收方 处理流式消息。
- 通过 onReceiveMessages 回调收到占位消息。
- 通过 onReceiveMessagesModified 回调持续收到分片消息，直到消息接收完毕。
- 解析收到的 V2NIMMessage.streamConfig（V2NIMMessageStreamConfig）。通过 streamStatus 字段判断相应状态来不断刷新和展示 UI。

安卓

Javapublic class MessageListenerImpl implements V2NIMMessageListener {
    private List<String> streamMessageIds = new ArrayList<>();
    
    @Override
    public void onReceiveMessages(List<V2NIMMessage> messages) {
        for (V2NIMMessage message : messages) {
            handleReceivedMessage(message);
        }
    }

    @Override
    public void onReceiveMessagesModified(List<V2NIMMessage> messages) {
        for (V2NIMMessage message : messages) {
            handleModifiedMessage(message);
        }
    }

    private void handleReceivedMessage(V2NIMMessage message) {
        // 检查是否为流式消息
        if (message.getStreamConfig() != null) {
            V2NIMMessageStreamConfig streamConfig = message.getStreamConfig();

            // 流式消息占位输出，status 为 V2NIM_MESSAGE_STREAM_STATUS_PLACEHOLDER 代表消息占位
            if (streamConfig.getStatus() == V2NIMMessageStreamStatus.V2NIM_MESSAGE_STREAM_STATUS_PLACEHOLDER) {
                streamMessageIds.add(message.getMessageClientId());
                System.out.println("收到流式消息占位：" + message.getMessageClientId());

                // 占位插入到消息列表里渲染
                renderPlaceholderToChatBox(message);
            }
        } else if (streamMessageIds.contains(message.getMessageClientId())) {
            // 最终结束后会输出完整消息体
            System.out.println("收到流式消息完整内容：" + message.getText());

            // 更新UI显示完整消息
            updateStreamMessageInChatBox(message);

            // 从流式消息ID列表中移除
            streamMessageIds.remove(message.getMessageClientId());
        } else {
            // 非流式的普通消息
            System.out.println("收到普通消息：" + message.getText());
            renderNormalMessageToChatBox(message);
        }
    }

    private void handleModifiedMessage(V2NIMMessage message) {
        // 客户端在此回调中收到流式消息的分片更新
        if (message.getStreamConfig() != null) {
            V2NIMMessageStreamConfig streamConfig = message.getStreamConfig();

            System.out.println("流式消息更新，状态：" + streamConfig.getStatus());

            // status 为 V2NIM_MESSAGE_STREAM_STATUS_STREAMING 代表正在流式输出中
            if (streamConfig.getStatus() == V2NIMMessageStreamStatus.V2NIM_MESSAGE_STREAM_STATUS_STREAMING) {
                System.out.println("流式消息正在更新：" + message.getText());
                V2NIMMessageStreamChunk lastChunk = streamConfig.getLastChunk();
                // 可以找到此消息然后更新
                updateStreamingMessageInChatBox(message,lastChunk);
            }
        }
    }

    // 渲染占位消息到聊天界面
    private void renderPlaceholderToChatBox(V2NIMMessage message) {
        System.out.println("渲染占位消息：" + message.getMessageClientId());
        // 实际UI更新逻辑
    }

    // 渲染普通消息到聊天界面
    private void renderNormalMessageToChatBox(V2NIMMessage message) {
        System.out.println("渲染普通消息：" + message.getText());
        // 实际UI更新逻辑
    }

    // 更新流式消息内容
    private void updateStreamingMessageInChatBox(V2NIMMessage message,V2NIMMessageStreamChunk lastChunk) {
        System.out.println("当前流式消息完整内容：" + message.getText()+"，最后一条分片内容："+lastChunk.getContent());
        // 实际UI更新逻辑
    }

    // 更新流式消息为最终完整内容
    private void updateStreamMessageInChatBox(V2NIMMessage message) {
        System.out.println("更新为完整消息：" + message.getText());
        // 实际UI更新逻辑
    }
}

Web/uni-app/小程序

TypeScriptconst streamMessageIds = []

// 客户端会在回调收到流式消息
nim.V2NIMMessageService.on("onReceiveMessages", function (messages: V2NIMMessage[]) {
  messages.forEach(message => {
    // 流式消息占位输出, streamConfig.status 为 1 代表消息占位
    if (message.streamConfig) {
      if (message.streamConfig.status === 1) {
        streamMessageIds.push(message.messageClientId)
        console.log(message)
        // renderToChatBox(message) // 占位插入到消息列表里渲染
      }
    } else if (streamMessageIds.includes(message.messageClientId)) {
       // 最终结束后会输出完整消息体
       
    } else {
      // 非流失的普通消息            
    }
  });
});

// 客户端在此回调中收到流式消息的分片更新
nim.V2NIMMessageService.on("onReceiveMessagesModified", function (messages: V2NIMMessage[]) {
  messages.forEach(message => {
    if (message.streamConfig) {
      // todo: 流式消息更新
      console.log(message) 
      // streamConfig: {status: -1, lastChunk: {…}}
      // -streamConfig.status 为 -1 代表正在流式输出中
      // 可以找到此消息然后更新
      // findMessage(message.messageClientId) -> updateMessageBody(message.text)
    }
  });
});

macOS/Windows

C++V2NIMMessageListener messageListener;
messageListener.onReceiveMessages = [=](nstd::vector<V2NIMMessage> messages) {
    // Push messages to UI list
};
messageListener.onReceiveMessagesModified = [=](const std::vector<V2NIMMessage>& messages) {
    for (const auto& message : messages) {
        // Find message from UI list and update
    }
};
auto& messageService = v2::V2NIMClient::get().getMessageService();
messageService.addMessageListener(messageListener);

Node.js/Electron

TypeScriptimport { v2 } from 'node-nim'
import { V2NIMMessage } from 'node-nim/types/v2_def/v2_nim_struct_def'

// Handle receive message event
v2.messageService?.on('receiveMessages', (messages: V2NIMMessage[]) => {
  // push messages to UI list
  messageList.value.push(...messages)
})

// Handle message modified event
v2.messageService?.on('receiveMessagesModified', (messages: V2NIMMessage[]) => {
  messages.forEach((modifiedMessage) => {
    if (modifiedMessage.conversationId === conversationStore.currentConversation?.conversationId) {
      // Find the corresponding message in the message list
      const index = messageList.value.findIndex(
        (msg) => msg.messageClientId === modifiedMessage.messageClientId
      )
      // If the message is found, update it
      if (index !== -1) {
        messageList.value[index] = modifiedMessage
      }
    }
  })
})

鸿蒙

TypeScriptconst streamMessageIds = []

// 客户端会在回调收到流式消息
nim.messageService.on('onReceiveMessages', (messages: V2NIMMessage[]) => {
  messages.forEach(message => {
    // 流式消息占位输出, streamConfig.status 为 1 代表消息占位
    if (message.streamConfig) {
      if (message.streamConfig.status === 1) { 
        streamMessageIds.push(message.messageClientId)
        console.log(message)
        // renderToChatBox(message) // 占位插入到消息列表里渲染
      }
    } else if (streamMessageIds.includes(message.messageClientId)) {
       // 最终结束后会输出完整消息体
    } else {
      // 非流式的普通消息            
    }
    
  });
});

// 客户端在此回调中收到流式消息的分片更新
nim.messageService.on('onReceiveMessagesModified', (messages: V2NIMMessage[]) => {
  messages.forEach(message => {
    if (message.streamConfig) {
      // todo: 流式消息更新
      console.log(message) 
      // streamConfig: {status: -1, lastChunk: {…}}
      // -streamConfig.status 为 -1 代表正在流式输出中
      // 可以找到此消息然后更新
      // findMessage(message.messageClientId) -> updateMessageBody(message.text)
    }
  });
});

API	说明
`addMessageListener`	注册消息相关监听器。
`V2NIMMessageStreamConfig`	消息体中的流式输出相关配置信息。若存在该配置信息说明是流式消息，否则是非流式消息。
`V2NIMMessageStreamStatus`	消息的流式输出状态。
`V2NIMMessageStreamChunk`	消息的流式输出最近分片信息。

API	说明
`on("EventName")`	注册消息相关监听器。
`V2NIMMessageStreamConfig`	消息体中的流式输出相关配置信息。若存在该配置信息说明是流式消息，否则是非流式消息。
`V2NIMMessageStreamStatus`	消息的流式输出状态。
`V2NIMMessageStreamChunk`	消息的流式输出最近分片信息。

参考文档

此文档是否对你有帮助？

有帮助

去反馈

支持平台
准备工作
注意事项
实现流程
API 调用时序
实现步骤
相关接口
参考文档