使用VCPKG+CMake编译gRPC项目时未正确链接静态库问题

核心问题分析 #

• 拼写错误：你在顶层CMake中误写了DBUILD_SHARED_LIBS（多了前缀D），导致CMake未正确启用静态库构建逻辑
• 缺少静态编译必需的预处理器宏：gRPC、Protobuf等库需要特定宏来切换静态链接的代码路径
• 未显式链接gRPC依赖的底层静态库：zlib、c-ares、re2、abseil等依赖未被纳入链接链条
• 可能存在运行时库不匹配：静态库需搭配静态CRT运行时，否则会出现依赖冲突

具体修复步骤 #

1. 修正顶层CMake的关键错误 #

将错误的set(DBUILD_SHARED_LIBS OFF)改为正确的静态库全局设置：

set(BUILD_SHARED_LIBS OFF)

2. 确保VCPKG三元组配置正确 #

检查CMakePresets.json，确保静态三元组和工具链配置生效：

{
  "name": "x64-windows-static",
  "cacheVariables": {
    "CMAKE_TOOLCHAIN_FILE": "C:/src/vcpkg/scripts/buildsystems/vcpkg.cmake",
    "VCPKG_TARGET_TRIPLET": "x64-windows-static",
    "CMAKE_MSVC_RUNTIME_LIBRARY": "MultiThreaded$<$<CONFIG:Debug>:Debug>"
  }
}

其中CMAKE_MSVC_RUNTIME_LIBRARY强制使用静态CRT，避免和静态库冲突。

3. 添加静态编译预处理器宏 #

在顶层CMake中添加宏定义，让gRPC和Protobuf启用静态编译逻辑：

# 启用gRPC静态编译模式
add_compile_definitions(GRPC_STATIC)
# 强制Protobuf使用静态库
set(protobuf_BUILD_SHARED_LIBS OFF CACHE BOOL "" FORCE)
add_compile_definitions(PROTOBUF_USE_STATIC_LIBS)

4. 显式链接所有依赖的静态库 #

在顶层CMake中补充查找gRPC的底层依赖，并在链接时加入这些静态库：

# 查找所有必需的静态依赖
find_package(gRPC CONFIG REQUIRED)
find_package(Protobuf REQUIRED)
find_package(ZLIB REQUIRED)
find_package(c-ares CONFIG REQUIRED)
find_package(re2 CONFIG REQUIRED)
find_package(absl CONFIG REQUIRED)

5. 清理构建目录重新生成 #

删除原build文件夹，重新通过CMakePresets加载配置并生成解决方案，确保所有依赖都拉取静态版本。

修改后的完整CMake示例 #

顶层CMakeLists.txt #

cmake_minimum_required (VERSION 3.8)

project ("server")

# 启用全局静态库构建
set(BUILD_SHARED_LIBS OFF)
set(CMAKE_FIND_LIBRARY_SUFFIXES ".lib")

# 配置静态CRT运行时
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")

# 静态编译宏定义
add_compile_definitions(GRPC_STATIC)
set(protobuf_BUILD_SHARED_LIBS OFF CACHE BOOL "" FORCE)
add_compile_definitions(PROTOBUF_USE_STATIC_LIBS)

# 查找所有依赖
find_package(gRPC CONFIG REQUIRED)
find_package(Protobuf REQUIRED)
find_package(ZLIB REQUIRED)
find_package(c-ares CONFIG REQUIRED)
find_package(re2 CONFIG REQUIRED)
find_package(absl CONFIG REQUIRED)

# 包含子项目
add_subdirectory("library")
add_subdirectory("proto")
add_subdirectory("example")

library模块CMakeLists.txt #

add_library(client_library STATIC "client_library.cpp" "client_library.h")
target_link_libraries(client_library PUBLIC 
  proto_library 
  gRPC::grpc++ 
  gRPC::grpc++_reflection 
  gRPC::gpr 
  gRPC::grpc 
  protobuf::libprotobuf 
  protobuf::libprotobuf-lite
  ZLIB::ZLIB
  c-ares::cares
  re2::re2
  absl::base absl::strings absl::synchronization absl::flags
)
target_include_directories(client_library PUBLIC "${PROJECT_SOURCE_DIR}/proto")

proto模块CMakeLists.txt #

add_library(proto_library STATIC "example.pb.cc" "example.pb.h" "example.grpc.pb.cc" "example.grpc.pb.h")
target_link_libraries(proto_library PRIVATE 
  gRPC::grpc++ 
  gRPC::grpc++_reflection 
  gRPC::gpr 
  gRPC::grpc 
  protobuf::libprotobuf 
  protobuf::libprotobuf-lite
  ZLIB::ZLIB
  c-ares::cares
  re2::re2
  absl::base absl::strings
)

example模块CMakeLists.txt #

add_executable(example "example.cpp" "example.h")
target_link_libraries(example PRIVATE client_library proto_library)
target_include_directories(example PUBLIC "${PROJECT_SOURCE_DIR}/library")

验证步骤 #

1. 确认vcpkg已安装静态版本依赖：vcpkg install grpc:x64-windows-static
2. 重新生成解决方案并编译
3. 运行生成的example.exe，确认不再提示缺失DLL

内容的提问来源于stack exchange，提问作者adastra