c++ 动态库&静态库使用cmakelist注意事项

码农W

已于 2024-09-27 11:27:07 修改

阅读量379

点赞数 4

文章标签：单片机 stm32 嵌入式硬件

于 2024-09-16 09:41:19 首次发布

如履薄冰

本文链接：https://blog.csdn.net/wuhaibin8013/article/details/142205393

版权

在 C++ 项目中使用 CMake 构建系统来管理动态库和静态库时，有一些重要的注意事项。以下是一些关键点和示例，帮助您正确地使用 CMake 构建和链接动态库和静态库。

基本概念

静态库：在编译时将所有代码链接到最终的可执行文件中。静态库的文件扩展名通常是 .a（在 Unix 系统上）或 .lib（在 Windows 系统上）。
动态库：在运行时加载，文件扩展名通常是 .so（在 Unix 系统上）或 .dll（在 Windows 系统上）。

CMakeLists.txt 基本结构

1. 创建静态库假设我们有一个库 libfoo，包含源文件 foo.cpp 和头文件 foo.h。```cpp

// foo.h #ifndef FOO_H #define FOO_H

void foo();#endif // FOO_H

// foo.cpp #include "foo.h" #include void foo() { std::cout << "Hello from foo!" << std::endl; }


CMakeLists.txt 文件：

```cmake
cmake_minimum_required(VERSION 3.10)
project(FooLibrary)set(CMAKE_CXX_STANDARD 11)

# 添加源文件
set(SOURCES foo.cpp)

# 创建静态库
add_library(foo STATIC ${SOURCES})# 设置库的可见性
target_include_directories(foo PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})
```#### 2. 创建动态库

创建动态库的过程类似，只需将 `STATIC` 改为 `SHARED`。

```cmake
cmake_minimum_required(VERSION 3.10)
project(FooLibrary)set(CMAKE_CXX_STANDARD 11)

# 添加源文件
set(SOURCES foo.cpp)# 创建动态库
add_library(foo SHARED ${SOURCES})

# 设置库的可见性
target_include_directories(foo PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

3. 使用库

假设我们有一个主程序 main.cpp，使用 libfoo 库。```cpp // main.cpp #include "foo.h"int main() { foo(); return 0; }


```cmake
cmake_minimum_required(VERSION 3.10)
project(MainProgram)

set(CMAKE_CXX_STANDARD 11)

# 添加源文件
set(SOURCES main.cpp)

# 添加子目录
add_subdirectory(foo)

# 创建可执行文件
add_executable(main ${SOURCES})

# 链接库
target_link_libraries(main foo)

注意事项

1. 库的可见性

在跨平台开发时，确保导出的符号具有适当的可见性。使用宏来控制符号导出：

// foo.h
#ifndef FOO_H
#define FOO_H

#if defined(_WIN32) || defined(_WIN64)
  #ifdef BUILDING_FOO
    #define FOO_API __declspec(dllexport)
  #else
    #define FOO_API __declspec(dllimport)
  #endif
#else
  #define FOO_API
#endif

FOO_API void foo();#endif // FOO_H

```在 CMakeLists.txt 文件中定义 `BUILDING_FOO` 宏：```cmake
add_library(foo SHARED ${SOURCES})
target_compile_definitions(foo PRIVATE BUILDING_FOO)

2. 设置 RPATH

在使用动态库时，确保运行时能找到库文件。可以通过设置 RPATH 来实现：

set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)

3. 安装目标

使用 install 命令来设置库和头文件的安装路径：

# 安装库
install(TARGETS foo
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

# 安装头文件
install(FILES foo.h DESTINATION include)

4. 导出和导入库

使用 export 和 import 功能来支持库的导出和导入：

# 导出库
install(EXPORT FooLibraryConfig
        FILE FooLibraryConfig.cmake
        DESTINATION lib/cmake/FooLibrary)

# 导入库
find_package(FooLibrary CONFIG REQUIRED)
target_link_libraries(main FooLibrary::foo)

示例项目结构

project/
├── CMakeLists.txt
├── foo/
│   ├── CMakeLists.txt
│   ├── foo.cpp
│   └── foo.h
└── main.cpp

顶层 CMakeLists.txt 文件：

cmake_minimum_required(VERSION 3.10)
project(MyProject)

set(CMAKE_CXX_STANDARD 11)

# 添加子目录
add_subdirectory(foo)

# 创建主程序
add_executable(main main.cpp)# 链接库
target_link_libraries(main foo)

foo 目录下的 CMakeLists.txt 文件：

cmake_minimum_required(VERSION 3.10)
project(FooLibrary)

set(CMAKE_CXX_STANDARD 11)

# 添加源文件
set(SOURCES foo.cpp)

# 创建动态库
add_library(foo SHARED ${SOURCES})

# 设置库的可见性
target_include_directories(foo PUBLIC ${CMAKE_CURRENT_SOURCE_DIR})

# 安装库
install(TARGETS foo
        LIBRARY DESTINATION lib
        ARCHIVE DESTINATION lib)

# 安装头文件
install(FILES foo.h DESTINATION include)