使用CMake构建DLL时如何正确指定导出宏？

问题解答 #

1. target_compile_definitions与DEFINE_SYMBOL的使用是否正确？ #

你的写法存在冗余，不需要同时设置。DEFINE_SYMBOL是CMake针对动态库目标的专用属性，当你为动态库设置DEFINE_SYMBOL my_project_EXPORTS时，CMake会自动在编译该库的所有源文件时添加/Dmy_project_EXPORTS（MSVC编译器）或-Dmy_project_EXPORTS（GCC类编译器）的编译选项。

多余的target_compile_definitions(my_project PRIVATE my_project_EXPORTS)完全没必要，甚至可能在某些场景下引发宏定义冲突，建议删除这一行。

2. 配置正确但仍显示dllimport而非dllexport的可能原因 #

GenerateExportHeader生成的头文件逻辑是：

• 当my_project_EXPORTS宏被定义时，my_project_EXPORT会展开为__declspec(dllexport)（用于编译DLL自身）
• 未定义该宏时，my_project_EXPORT会展开为__declspec(dllimport)（用于调用DLL的客户端代码）

出现异常的常见原因：

• 目标类型错误：如果my_project是静态库（add_library(my_project STATIC ...)），DEFINE_SYMBOL属性不会生效，CMake不会添加my_project_EXPORTS宏，导致头文件默认使用dllimport。必须确保目标是动态库（SHARED）。
• CMake缓存残留：之前构建的缓存文件保留了错误配置，导致新的DEFINE_SYMBOL设置未生效。清理整个构建目录后重新生成项目即可。
• 宏定义作用范围错误：如果误将my_project_EXPORTS设置为PUBLIC或INTERFACE，会导致客户端代码也会看到该宏，同时库自身的编译单元可能因为优先级问题未正确触发dllexport。
• 头文件包含顺序错误：如果在包含my_project_export.h之前，其他头文件或代码提前定义了影响逻辑的宏，可能会干扰导出宏的展开。

Windows平台CMake构建DLL完整分步流程 #

1. 搭建项目结构 #

my_project/
├── include/
│   └── my_project/
│       └── my_api.h
├── src/
│   └── my_api.cpp
└── CMakeLists.txt

2. 编写导出接口头文件（include/my_project/my_api.h） #

用生成的导出宏标记需要对外暴露的函数和类：

#ifndef MY_PROJECT_MY_API_H
#define MY_PROJECT_MY_API_H

// 引入CMake自动生成的导出头文件
#include "my_project_export.h"

// 导出C风格函数（可选，方便跨语言调用）
extern "C" my_project_EXPORT void hello_world();

// 导出C++类
class my_project_EXPORT MyClass {
public:
    void print_message();
};

#endif // MY_PROJECT_MY_API_H

3. 编写接口实现文件（src/my_api.cpp） #

#include "my_project/my_api.h"
#include <iostream>

void hello_world() {
    std::cout << "Hello from my_project DLL!" << std::endl;
}

void MyClass::print_message() {
    std::cout << "Message from MyClass in DLL!" << std::endl;
}

4. 编写根目录CMakeLists.txt #

cmake_minimum_required(VERSION 3.15)
project(my_project VERSION 1.0.0 LANGUAGES CXX)

# 定义动态库目标
add_library(my_project SHARED
    src/my_api.cpp
    include/my_project/my_api.h
)

# 设置头文件搜索路径：
# - BUILD_INTERFACE：构建库自身时使用的源码目录头文件
# - INSTALL_INTERFACE：安装后客户端使用的头文件路径
# - 包含构建目录，因为导出头文件会生成在这里
target_include_directories(my_project
    PUBLIC
        $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/include>
        $<INSTALL_INTERFACE:include>
        $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
)

# 生成导出头文件
include(GenerateExportHeader)
generate_export_header(my_project
    BASE_NAME my_project
    EXPORT_MACRO_NAME my_project_EXPORT
    EXPORT_FILE_NAME my_project_export.h
)

# 配置动态库属性
set_target_properties(my_project PROPERTIES
    PREFIX ""  # 可选：移除MSVC默认的"lib"前缀
    DEFINE_SYMBOL my_project_EXPORTS  # 自动添加导出宏定义
    RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/bin"  # DLL输出目录
    VERSION ${PROJECT_VERSION}
    SOVERSION ${PROJECT_VERSION_MAJOR}
)

# 可选：添加安装规则，方便其他项目导入使用
install(TARGETS my_project
    EXPORT my_projectTargets
    RUNTIME DESTINATION bin
    LIBRARY DESTINATION lib
    ARCHIVE DESTINATION lib
)

# 安装头文件
install(DIRECTORY include/ DESTINATION include)
install(FILES ${PROJECT_BINARY_DIR}/my_project_export.h DESTINATION include/my_project)

# 安装CMake配置文件，支持find_package导入
install(EXPORT my_projectTargets
    FILE my_projectTargets.cmake
    DESTINATION lib/cmake/my_project
)

5. 编译构建 #

1. 打开CMake GUI，选择项目源码目录和构建输出目录
2. 点击Configure，选择对应版本的Visual Studio编译器
3. 点击Generate生成VS解决方案
4. 打开生成的解决方案，编译my_project目标，DLL和LIB文件会输出到build/bin目录

6. 测试DLL调用（可选） #

创建测试项目，编写main.cpp调用DLL接口，并通过CMake链接库：

#include "my_project/my_api.h"

int main() {
    hello_world();
    MyClass obj;
    obj.print_message();
    return 0;
}

测试项目的CMakeLists.txt：

cmake_minimum_required(VERSION 3.15)
project(test_project LANGUAGES CXX)

add_executable(test_project src/main.cpp)

# 导入my_project库
find_package(my_project REQUIRED PATHS "path/to/my_project/install/lib/cmake/my_project")
target_link_libraries(test_project PRIVATE my_project)

配置CMake并编译运行，即可验证DLL功能正常。

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