使用CMake编译含libevent库的C++代码时出现链接错误

问题场景 #

在Windows 10环境下，使用GCC 11.3.0 + VS Code构建依赖libevent的C++项目。CMake配置中同时使用find_package(LIBEVENT REQUIRED)和手动添加的链接选项，当不调用libevent函数时可正常编译，但调用event_base_dispatch等函数时，出现undefined reference to 'event_base_dispatch'类错误，怀疑是链接顺序导致的问题。

当前核心CMake配置：

find_package(LIBEVENT REQUIRED)

target_link_libraries(${PROJECT_NAME}
  PUBLIC
  ${LIBEVENT_LIB}
)

target_link_options(TEST-CMAKE PUBLIC "-L/E:/Projects/C++/.libraries/libevent-2.1.12-stable/build/lib -levent -levent_core")

测试代码：

#include <iostream>
#include <event2/event.h>
int main()
{    
    event_base* evbase;
    event_base_dispatch(evbase);
}

问题根源 #

1. 链接顺序冲突：GCC链接器对库的顺序敏感，依赖库必须放在引用它的目标文件之后。手动添加的-levent等选项位置错误，或与find_package生成的链接规则重复，导致链接器无法匹配函数定义。
2. 变量使用错误：libevent的CMake模块通常定义的库变量是LIBEVENT_LIBRARIES而非LIBEVENT_LIB，包含目录变量是LIBEVENT_INCLUDE_DIRS而非LIBEVENT_INCLUDE_DIR，错误变量会导致未正确链接库或引入头文件。
3. 冗余配置冲突：find_package已能自动处理库路径和链接依赖，手动添加target_link_options会造成配置混乱，干扰链接顺序。

解决方案 #

方案1：修正find_package变量并移除冗余配置 #

修改CMakeLists.txt，使用正确的变量并删除手动链接选项：

cmake_minimum_required(VERSION 3.0.2)
project(TEST-CMAKE VERSION 0.1.0)

include(CTest)
enable_testing()

add_executable(TEST-CMAKE main.cpp)

# 指定libevent的构建路径，确保find_package能找到
find_package(LIBEVENT REQUIRED PATHS "E:/Projects/C++/.libraries/libevent-2.1.12-stable/build")

# 使用正确的包含目录变量
target_include_directories(${PROJECT_NAME}
  PUBLIC
  ${LIBEVENT_INCLUDE_DIRS}
)

# 使用正确的库变量链接
target_link_libraries(${PROJECT_NAME}
  PUBLIC
  ${LIBEVENT_LIBRARIES}
)

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)

方案2：使用现代CMake目标链接（推荐） #

如果libevent的CMake配置支持导入目标，直接链接官方提供的目标，自动处理路径和依赖：

cmake_minimum_required(VERSION 3.0.2)
project(TEST-CMAKE VERSION 0.1.0)

include(CTest)
enable_testing()

add_executable(TEST-CMAKE main.cpp)

find_package(LIBEVENT REQUIRED PATHS "E:/Projects/C++/.libraries/libevent-2.1.12-stable/build")

# 直接链接预定义目标，自动处理包含目录和链接库
target_link_libraries(${PROJECT_NAME}
  PUBLIC
  LIBEVENT::Event
  LIBEVENT::Core
)

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)

方案3：手动指定正确链接顺序（仅find_package失效时用） #

若必须手动配置，拆分路径和库链接，确保库在目标之后：

cmake_minimum_required(VERSION 3.0.2)
project(TEST-CMAKE VERSION 0.1.0)

include(CTest)
enable_testing()

add_executable(TEST-CMAKE main.cpp)

# 手动指定头文件路径
target_include_directories(${PROJECT_NAME}
  PUBLIC
  "E:/Projects/C++/.libraries/libevent-2.1.12-stable/build/include"
)

# 指定库搜索路径
target_link_directories(${PROJECT_NAME}
  PUBLIC
  "E:/Projects/C++/.libraries/libevent-2.1.12-stable/build/lib"
)

# 按依赖顺序链接库，确保依赖库在前面
target_link_libraries(${PROJECT_NAME}
  PUBLIC
  event_core
  event
)

set(CPACK_PROJECT_NAME ${PROJECT_NAME})
set(CPACK_PROJECT_VERSION ${PROJECT_VERSION})
include(CPack)

验证步骤 #

1. 删除项目下的build目录，重新执行CMake配置和构建。
2. 检查CMake输出日志，确认Found LIBEVENT: ...类提示，说明库被正确识别。
3. 编译项目，确认undefined reference错误消失。

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