网易云信 IM 即时通讯服务提供一整套即时通讯基础能力，助您快速实现多样化的即时通讯场景。

本文主要介绍通过集成 NetEase IM SDK（NIM SDK）并调用 API，快速实现单聊/群聊消息收发功能。

群聊消息收发需要先进入群组，后续流程与单聊消息收发相同。群组相关操作请参考群组管理。

使用前准备

• 已在云信控制台创建应用，获取 App Key。
• 已注册云信 IM 账号，获取 IM 账号和 token。
• NIM SDK 兼容的系统包括 Windows 7、Windows 8/8.1、Windows 10、macOS 10.10（仅支持 x86_64 架构，不支持 i386）。

实现流程

流程概览

实现单聊消息收发的流程，可分为下图所示的 4 大步骤。

步骤 1：集成 SDK

为降低接入成本，NetEase IM SDK （以下简称 NIM SDK）C++ 封装层使用 CMake 进行管理，根据不同的情况您在接入 C++ 封装层时可能需要适当的修改，新的发布目录拆分为如下结构：

├─bin
├─include
├─lib
└─wrapper

• bin/lib 目录存放 NIM SDK 的动态库文件, 在您发布时请打包使用到的模块，lib后缀为 Windows 下的动态库符号链接文件
  • (lib)nim(.dll|.so|.dylib):即时通讯, 含圈组
  • (lib)nim_chatroom(.dll|.so|.dylib): 聊天室
  • (lib)h_available(.dll|.so|.dylib): 高可用模块, 被以上两个模块所依赖
  • (lib)nim_tools_http(.dll|.so|.dylib): http 工具库，若不使用wrapper/nim_tools_cpp_wrapper/nim_tools_http_cpp.h中的接口可去除
  • nim_audio.dll: 音频解码库，仅支持 Windows 环境，若不使用wrapper/nim_tools_cpp_wrapper/nim_audio_cpp.h中的接口可去除
  • nrtc.dll: 音视频通话库，仅支持 Windows 环境，若不使用wrapper/nim_cpp_wrapper/api/nim_cpp_vchat.h中的接口可去除
  • node-nim.node: NIM SDK Node 封装层, 用于 Electron 以及 Node.js 环境下的接入，其他情况可去除
  • 其他如msvcp120.dll、msvcr120.dll等（系统）依赖
• include 目录存放了 NIM C SDK 的导出头文件
• wrapper 目录存放了 C++ 封装层的源代码

如果您仅使用 V10 接口，只需将 include 目录添加到头文件搜索路径，代码中包含对应头文件即可使用，无需进行以下步骤。

这里主要介绍以 CMake 工程接入的方式，更多接入方式（包括 VS、Qt、Xcode等传统方式）请参见[集成 SDK](https://doc.yunxin.163.com/messaging2/guide/zQ3MzQyMzQ?platform=client)。

1. 使用 add_subdirectory 命令将 wrapper 目录添加为子目录。

2. 使用 include_directories 方法将 include 和 wrapper 文件夹添加为头文件搜索路径。

3. 根据您的执行目标使用 target_link_libraries 按需添加链接库即可。链接库如下：

   • nim_cpp_wrapper NIM C++ 封装层库
   • nim_chatroom_cpp_wrapper Chatroom C++ 封装层库
   • nim_wrapper_util NIM 及 Chatroom C++ 封装层库通用的工具库
   • nim_tools_cpp_wrapper NIM HTTP 组件 C++ 封装层库
   • nim_qchat_cpp_wrapper NIM QChat 圈组 C++ 封装层库

• 不建议将 CMake 产生的工程文件直接引用到项目中使用，因为 CMake 使用将绝对路径写入到工程的配置文件（.vcxproj）中，您在自己设备上生成的工程文件无法在其他设备中顺利编译。
• 如果您的工程项目已经是基于 CMake 管理，则只需将 wrapper 工程作为您主项目的依赖即可，其他无需任何多余配置。如果您的工程项目不是基于 CMake 管理的，那么建议您在持续集成（Continuous Integration, CI） 或者与其他同事协作时，通过自定义脚本在项目编译前始终执行 CMake 来生成并编译工程得到需要的二进制文件产物。

示例代码如下：

# CMakeLists.txt
cmake_minimum_required(VERSION 3.10)
project(nim_demo)
 
include_directories(${CMAKE_CURRENT_LIST_DIR}/include
                    ${CMAKE_CURRENT_LIST_DIR}/wrapper)
add_subdirectory(wrapper)
add_executable(${PROJECT_NAME} main.cpp)
target_link_libraries(${PROJECT_NAME}
                      nim_cpp_wrapper
                      nim_chatroom_cpp_wrapper
                      nim_wrapper_util
                      nim_tools_cpp_wrapper
                      nim_qchat_cpp_wrapper)

步骤 2：初始化 SDK

将 SDK 集成到客户端后，需要先完成 SDK 的初始化才能使用其他功能。

1. 引入 SDK 动态库文件。

   将 V10 NIM SDK 提供了不同平台的动态库文件，不同平台下的区别如下：

   • Windows 下后缀为 .dll，您需要将动态库文件放置到应用程序相同目录。
   • macOS 下后缀为 .dylib，您需要在打包应用时将 .dylib 文件放置到 YouApp.app/Contents/Frameworks 目录下。
   • Linux 下后缀为 .so，与 Windows 一样与应用程序放置到同一个目录下即可。

   Windows SDK 基于 MSVC15（2017） 开发，如果 App 没有对应的运行时库文件，请在安装应用时部署微软提供的 MSVC 2017 运行时库组件。

2. 调用 init 方法初始化 SDK，推荐在应用程序启动时初始化。初始化成功后，即可使用 V10 所有的 API。

   int main(int argc, char* argv[]) {
   	v2::V2NIMInitOption option;
   	auto error = v2::V2NIMClient::get().init(option);
   	if (error) {
   		// handle error
   		return -1;
   	}
   	error = v2::V2NIMClient::get().uninit();
   	if (error) {
   		// handle error
   		return -1;
   	}
   	return 0;
   }
   

更多初始化相关说明，请参见初始化 SDK。

步骤 3：登录 IM 服务器

客户端用户在使用云信即时通讯功能前需要先登录云信 IM 服务器。

调用 login 方法进行登录。以静态 Token 登录为例，示例代码如下：

C++V2NIMLoginOption option;
loginService.login(
    "accountId",
    "token",
    option,
    []() {
        // login succeeded
    },
    [](V2NIMError error) {
        // login failed, handle error
    });

其他登录方式请参见登录及登出 IM。

步骤 4：单聊消息收发

本节以用户 A 和用户 B 的消息交互为例，介绍快速实现单聊消息收发的流程。

1. 用户 B 调用 addMessageListener 方法注册消息监听器，监听消息接收回调事件 onReceiveMessages。示例代码如下：

   cppV2NIMMessageListener listener;
   listener.onReceiveMessages = [](nstd::vector<V2NIMMessage> messages) {
   	// receive messages
   };
   messageService.addMessageListener(listener);
   

2. 用户 A 调用 createTextMessage 方法构建文本消息，然后调用 sendMessage 方法向用户 B 发送文本消息。示例代码如下：

   cpp// 以单聊类型为例
   auto conversationId = V2NIMConversationIdUtil::p2pConversationId("target_account_id");
   // 创建一条文本消息
   auto message = V2NIMMessageCreator::createTextMessage("hello world");
   auto params = V2NIMSendMessageParams();
   // 发送消息
   messageService.sendMessage(
   	message,
   	conversationId,
   	params,
   	[](V2NIMSendMessageResult result) {
   		// send message succeeded
   	},
   	[](V2NIMError error) {
   		// send message failed, handle error
   	});
   

   目前 NIM SDK 支持多种消息类型，包括文本消息、图片消息、语音消息、视频消息、文件消息、地理位置消息、提示消息、通知消息以及自定义消息，具体请参见消息收发。

3. 用户 B 通过 onReceiveMessages 回调收到文本消息。

后续步骤

为保障通信安全，如果您在调试环境中的使用的是云信控制台生成的测试用 IM 账号 和 token，请确保在后续的正式生产环境中，将其替换为通过IM 服务端 API生成的正式 IM 账号和 token。

常见问题

• 初始化失败，即调用 nim::Client::Init 返回 false。
  • SDK 未拷贝到可执行文件同级目录，导致加载失败。
  • 可执行文件和 SDK 架构不匹配。