【vcpkg】cpprestsdk之64位编译链接及踩坑

🛫 问题

描述

cpprestsdk之前编译过32位，已经踩了一些坑，本以为64位编译会顺风顺水，然而事与愿违，特此记录几个问题。
最终编译命令为vcpkg install cpprestsdk[websockets]:x64-windows-static --recurse --editable。

1️⃣ 多版本vs报错

目标编译为2019，但是由于重装系统后，直接安装了2022的vs，导致没有了2019的x64 Native Tools Command Prompt for VS 2019环境，后又安装2019才解决问题。

指定VS路径

vs2019和2022共存的情况下，直接运行install命令，将报下面错误。
这个错误信息，一开始看的挺头晕，后来认真看了错误提示，发现vcpkg找到的路径是2022，但是它也给出了文档连接https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md#VCPKG_VISUAL_STUDIO_PATH，可以解决该问题。

小编以安装根目录J:\_ALL\CODE\vcpkg\vcpkg\和x64-windows-static的编译目标为例，所以我们需要修改的文件是J:\_ALL\CODE\vcpkg\vcpkg\triplets\x64-windows-static.cmake。修改内容如下：

set(VCPKG_VISUAL_STUDIO_PATH "C:\\Program Files (x86)\\Microsoft Visual Studio\\2019\\Community")
set(VCPKG_PLATFORM_TOOLSET v142)

2️⃣ error LNK2001: 问题排查

运行install命令，生成的lib进行集成的时候，提示未找到__imp_?close_pending_tasks_with_error@websocket_client_task_impl@details@client@websockets@web@@QEAAXAEBVwebsocket_exception@345@@Z（web::websockets::client::details::websocket_client_task_impl::close_pending_tasks_with_error）的错误。
各种搜索，没找到解决方案，只能编译链接原理通过一步步排查了

通过IDA打开lib文件，确认导出内容

通过删选关键字web::websockets::client::details::websocket_client_task_impl::，查看导出列表，的确没有导出函数close_pending_tasks_with_error。

查看源码

搜索源码，定位到源码文件 J:\_ALL\CODE\vcpkg\vcpkg\buildtrees\cpprestsdk\src\ecb9e168c5-96a8d6ba89.clean\Release\src\websockets\client\ws_client.cpp。
函数close_pending_tasks_with_error的编译条件是#if !defined(CPPREST_EXCLUDE_WEBSOCKETS)，也就是说，当不定义CPPREST_EXCLUDE_WEBSOCKETS的时候就能将函数编译进去。

定位宏定义，最终在文件J:\_ALL\CODE\vcpkg\vcpkg\buildtrees\cpprestsdk\src\ecb9e168c5-96a8d6ba89.clean\Release\include\cpprest\details\basic_types.h中找到下面代码。

#if defined(_WIN32)
// Include on everything except Windows Desktop ARM, unless explicitly excluded.
#if !defined(CPPREST_EXCLUDE_WEBSOCKETS)
#if defined(WINAPI_FAMILY)
#if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && defined(_M_ARM)
#define CPPREST_EXCLUDE_WEBSOCKETS
#endif
#else
#if defined(_M_ARM)
#define CPPREST_EXCLUDE_WEBSOCKETS
#endif
#endif
#endif
#endif

不必管这些定义，在代码最后直接取消宏定义

#undef CPPREST_EXCLUDE_WEBSOCKETS

增加参数–editable，重新编译

--editable的含义是不清空代码，直接编译，最终命令为：
vcpkg install cpprestsdk[websockets]:x64-windows-static --recurse --editable
再次通过IDA查看导出函数，可以看到lib中已经有函数close_pending_tasks_with_error了。

ps： 貌似参数 --no-downloads也是可以的。

3️⃣ error LNK2001: 外部符号__imp_?close_...

去除__imp_

通过上面的操作，命名已经将函数编译到lib中了，为啥还是报错呢？想来想去只能是编译的类型不一样，通过BCompare工具，比较两个函数名，可以看出，需要的函数带__imp_。

查资料，发现：如果函数声明增加了__declspec(dllimport) ，链接的时候函数名会加上__imp_前缀，所以如果链接静态库， 函数的声明不用增加__declspec(dllimport) 。如果链接动态库，再增加__declspec(dllimport)。
定位到函数声明，可以看到声明为_ASYNCRTIMP void close_pending_tasks_with_error(const websocket_exception& exc);，查看_ASYNCRTIMP的定义：

所以在项目中，增加_NO_ASYNCRTIMP即可。
也可以在引入cpprest头文件之前，定义_NO_ASYNCRTIMP宏，如下图所示：

🛬 结论

解决思路：

• 确认lib中包含目标函数
• 确保目标函数编译后的名字一模一样。

vcpkg卸载重载

开发过程中，经常要修改参数，重新编译库，已经安装的库无法重新安装，只能先卸载才能继续安装。

vcpkg remove cpprestsdk:x64-windows-static  --recurse

编译指定版本的源码（未验证）

通过命令.\vcpkg x-history cpprestsdk，查看cpprestsdk历史版本。

小编以安装根目录J:\_ALL\CODE\vcpkg\vcpkg\为例，所以我们需要修改的文件是J:\_ALL\CODE\vcpkg\vcpkg\ports\cpprestsdk\vcpkg.json。修改内容如下：

也就是指定字段version-semver。

参考资料：

• 随心所欲地对vcpkg依赖进行版本控制 https://zhuanlan.zhihu.com/p/352709760
• https://learn.microsoft.com/zh-cn/vcpkg/users/versioning

修改源码进行编译

vcpkg install每次默认都将代码删除，然后再下载解压代码，所以直接修改代码会被清除。
执行命令中，增加参数--editable，将不再删除代码。命令如下所示：
vcpkg install cpprestsdk[websockets]:x64-windows-static --recurse --editable。

📖 参考资料

• 【vcpkg】cpprestsdk编译链接及实战 Chrome Devtool Protocol https://blog.csdn.net/kinghzking/article/details/125772160
• vcpkg环境变量官方文档 https://github.com/microsoft/vcpkg/blob/master/docs/users/triplets.md#VCPKG_VISUAL_STUDIO_PATH
• VCPKG 环境变量 https://www.cnblogs.com/vcpkg/p/15019968.html
• vcpkg版本说明： https://learn.microsoft.com/zh-cn/vcpkg/users/versioning