cmake 同时生成共享库so及可执行文件的工程配置

最新推荐文章于 2024-08-07 10:18:30 发布
最新推荐文章于 2024-08-07 10:18:30 发布
阅读量557 收藏 6
点赞数 11
分类专栏： C++ 文章标签： c++ 算法 开发语言 cmake so文件 共享库
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u011119817/article/details/140971415
版权

文章目录

1、使用cmake生成共享库及调用该库的可执行文件

共享库文件.so，及调用该so的可执行文件，使用场景就是，so是用来提供给客户的，可执行文件是自己用来测试看so的效果的。
上代码。
这里是一个简单的C++项目的示例，它使用 CMake 来生成一个共享库（.so 文件）以及一个调用该共享库的可执行文件。

项目结构

MyProject/
├── CMakeLists.txt
├── lib/
│   ├── CMakeLists.txt
│   └── mylib.cpp
├── include/
│   └── mylib.h
└── app/
    ├── CMakeLists.txt
    └── main.cpp

顶层 CMakeLists.txt

cmake_minimum_required(VERSION 3.10)

# 项目信息
project(MyProject VERSION 1.0)

# 设置C++标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED True)

# 添加子目录
add_subdirectory(lib)
add_subdirectory(app)

lib/CMakeLists.txt

# 生成共享库
add_library(mylib SHARED mylib.cpp)

# 设置库的头文件路径
target_include_directories(mylib PUBLIC ${CMAKE_SOURCE_DIR}/include)

lib/mylib.cpp

#include "mylib.h"
#include <iostream>

void hello() {
    std::cout << "Hello from the library!" << std::endl;
}

include/mylib.h

#ifndef MYLIB_H
#define MYLIB_H

void hello();

#endif // MYLIB_H

app/CMakeLists.txt

# 添加可执行文件
add_executable(myapp main.cpp)

# 链接共享库
target_link_libraries(myapp PRIVATE mylib)

app/main.cpp

#include "mylib.h"

int main() {
    hello();
    return 0;
}

构建项目

  1. 创建并进入构建目录：

    mkdir build
cd build

  2. 生成构建文件：

    cmake ..

  3. 构建项目：

    make

这样，你将生成一个共享库 libmylib.so 以及一个调用该共享库的可执行文件 myapp。执行 myapp 时，它将输出 “Hello from the library!”。

整个项目通过使用 CMake 实现了生成共享库和调用该库的可执行文件的功能。你可以根据需要进一步扩展和调整这个项目的结构和内容。
关于生成链接库,public,private,interface的区别如下：
在 CMake 中，target_link_libraries 命令用于为目标添加库依赖项。PRIVATE 和 PUBLIC 是访问级别指示符，用于控制依赖关系传播的范围。它们的区别在于：

  1. PRIVATE：

    • 表示库的链接仅对当前目标可见，不会传播到依赖该目标的其他目标。
    • 仅当前目标需要知道所链接的库。

  2. PUBLIC：

    • 表示库的链接对当前目标和依赖当前目标的其他目标都可见。
    • 链接库不仅影响当前目标，还会传播到依赖该目标的其他目标。

  3. INTERFACE（虽然你没提到，但为了完整性也解释一下）：

    • 表示库的链接仅对依赖当前目标的其他目标可见，而不影响当前目标本身。
    • 当前目标不需要该库，但依赖当前目标的目标需要。

下面是一个简单的示例，演示这三者的区别：

# 顶层 CMakeLists.txt
cmake_minimum_required(VERSION 3.10)
project(LinkLibrariesExample)

add_subdirectory(libA)
add_subdirectory(libB)
add_subdirectory(app)

libA/CMakeLists.txt

add_library(libA STATIC libA.cpp)
target_include_directories(libA PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)

libA/libA.cpp

#include <iostream>
void funcA() {
    std::cout << "Function A" << std::endl;
}

libA/include/libA.h

#ifndef LIBA_H
#define LIBA_H

void funcA();

#endif // LIBA_H

libB/CMakeLists.txt

add_library(libB STATIC libB.cpp)
target_include_directories(libB PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/include)
target_link_libraries(libB PUBLIC libA) # libB 依赖 libA

libB/libB.cpp

#include "libA.h"
#include <iostream>

void funcB() {
    funcA();
    std::cout << "Function B" << std::endl;
}

libB/include/libB.h

#ifndef LIBB_H
#define LIBB_H

void funcB();

#endif // LIBB_H

app/CMakeLists.txt

add_executable(myapp main.cpp)
target_link_libraries(myapp PRIVATE libB) # myapp 依赖 libB

app/main.cpp

#include "libB.h"

int main() {
    funcB();
    return 0;
}

在这个示例中：

  • libB 通过 target_link_libraries(libB PUBLIC libA) 明确表示 libA 对 libB 是公共依赖。因此，依赖 libB 的任何目标（如 myapp）也会自动链接 libA，并且可以访问 libA 的头文件和符号。

  • 如果 libB 通过 target_link_libraries(libB PRIVATE libA) 表示 libA 对 libB 是私有依赖，那么 myapp 不会自动链接 libA，也不能访问 libA 的符号。

  • 如果 libB 通过 target_link_libraries(libB INTERFACE libA) 表示 libA 对 libB 是接口依赖，那么 libB 本身不会链接 libA，但是任何依赖 libB 的目标（如 myapp）会自动链接 libA。

这种控制方式可以帮助更精确地管理依赖关系，避免不必要的库链接，确保编译和链接的效率。

2、包含保护

在 C++ 编程中，#ifndef、#define 和 #endif 常用于头文件的包含保护（include guard）。它们的作用是防止头文件被多次包含导致的重复定义问题。

具体解释

  1. #ifndef (if not defined)：

    • 该指令检查指定的宏是否未被定义。如果未定义，则处理后续的代码段。

  2. #define：

    • 该指令定义一个宏，通常在 #ifndef 之后使用，以确保后续包含同一个头文件时宏已经被定义，从而避免重复包含。

  3. #endif：

    • 该指令结束一个 #ifndef 或其他预处理条件。

包含保护示例

下面是一个包含保护的典型示例：

myheader.h
#ifndef MYHEADER_H
#define MYHEADER_H

// 头文件内容
void myFunction();

#endif // MYHEADER_H

工作原理

  1. 第一次包含 myheader.h 时：

    • #ifndef MYHEADER_H 检查 MYHEADER_H 是否未被定义。由于它尚未定义，条件为真。
    • #define MYHEADER_H 定义 MYHEADER_H，防止后续重复包含。
    • 包含头文件内容，定义 myFunction。

  2. 第二次及后续包含 myheader.h 时：

    • #ifndef MYHEADER_H 检查 MYHEADER_H 是否未被定义。由于它已被定义，条件为假。
    • 直接跳过头文件内容，避免重复定义。

实际效果

在代码中使用包含保护可以防止头文件重复包含引起的编译错误，例如重复定义函数、变量或类。以下是一个示例，演示头文件包含保护的实际效果：

main.cpp
#include "myheader.h"
#include "myheader.h" // 重复包含，但不会导致问题

int main() {
    myFunction();
    return 0;
}

在这个示例中，由于 myheader.h 使用了包含保护，尽管它被包含了两次，但编译器只会处理一次，不会出现重复定义的错误。

现代替代方案

C++20 引入了模块（modules），它提供了一种更现代化的头文件管理方式，可以从根本上避免这些问题。不过，包含保护仍然是目前广泛使用的解决方案，特别是在不支持模块的编译器和代码库中。

#pragma once 是一种用于防止头文件被多次包含的编译指示，它的作用与包含保护（include guard，即 #ifndef、#define、#endif 组合）类似，但更加简洁。

pragma once 的作用

当在一个头文件中使用 #pragma once 时，编译器会确保该头文件在一个编译单元中只会被处理一次，即使它被多次包含。这样可以防止重复定义的问题。

使用示例

myheader.h
#pragma once

// 头文件内容
void myFunction();

优缺点

优点：

  1. 简洁：#pragma once 使用起来比传统的包含保护更加简洁，没有定义宏的麻烦。
  2. 减少错误：避免了手动管理宏名称的错误，例如拼写错误或名称冲突。

缺点：

  1. 移植性：虽然大多数现代编译器都支持 #pragma once，但它不是 C++ 标准的一部分。在一些非常老旧或特定的编译器上可能不被支持。

兼容性

目前，几乎所有主流编译器（如 GCC、Clang 和 MSVC）都支持 #pragma once，因此在大多数情况下，它是一个安全且有效的选择。

对比示例

使用包含保护（include guard）
#ifndef MYHEADER_H
#define MYHEADER_H

// 头文件内容
void myFunction();

#endif // MYHEADER_H
使用 #pragma once
#pragma once

// 头文件内容
void myFunction();

总结

#pragma once 提供了一种简单有效的方式来防止头文件的重复包含。如果你确定你的编译器支持它，那么它是一个很好的选择。不过，如果你需要兼容非常老旧的编译器，包含保护（include guard）可能是更安全的选择。

3、指定共享库和可执行文件的保存路径

可以通过在 CMake 文件中设置适当的输出目录来指定生成的共享库（.so 文件）和可执行文件的保存位置。你可以使用 CMAKE_LIBRARY_OUTPUT_DIRECTORY 和 CMAKE_RUNTIME_OUTPUT_DIRECTORY 来分别设置共享库和可执行文件的输出目录。

以下是一个简单的 C++ 项目的 CMake 示例，它生成一个共享库（.so 文件）和一个可执行文件，并指定它们的保存位置。

项目结构

my_project/
├── CMakeLists.txt
├── src/
│   ├── main.cpp
│   └── mylib.cpp
├── include/
│   └── mylib.h
└── build/

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)

# 项目信息
project(MyProject VERSION 0.1)

# 设置C++标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED True)

# 输出源路径和二进制路径
message(STATUS "src path: ${CMAKE_SOURCE_DIR}")
message(STATUS "binary path: ${CMAKE_BINARY_DIR}")

# 设置库文件和可执行文件的输出目录
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)

message(STATUS "Library output path: ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}")
message(STATUS "Executable output path: ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")

# 包含头文件目录
include_directories(${CMAKE_SOURCE_DIR}/include)

# 设置源文件列表
set(SRC_LIST
    src/mylib.cpp
)

# 添加共享库
add_library(mylib SHARED ${SRC_LIST})

# 设置可执行文件源文件
set(MAIN_SRC
    src/main.cpp
)

# 添加可执行文件
add_executable(my_executable ${MAIN_SRC})

# 链接共享库到可执行文件
target_link_libraries(my_executable PRIVATE mylib)

src/mylib.cpp

#include "mylib.h"
#include <iostream>

void myFunction() {
    std::cout << "Hello from myFunction!" << std::endl;
}

include/mylib.h

#pragma once

void myFunction();

src/main.cpp

#include "mylib.h"

int main() {
    myFunction();
    return 0;
}

构建项目

  1. 在项目根目录创建 build 目录并进入：

    mkdir build
cd build

  2. 运行 CMake 配置和生成：

    cmake ..
cmake --build .

结果

构建完成后，你将在 lib 目录下找到生成的共享库文件 libmylib.so，在 bin 目录下找到生成的可执行文件 my_executable。

4、多个源文件处理

如果项目的源文件分布在多个文件夹中，你可以使用 file(GLOB ...) 或 aux_source_directory 来收集这些文件夹中的源文件。

示例项目结构

my_project/
├── CMakeLists.txt
├── src/
│   ├── main.cpp
│   └── lib/
│       ├── mylib.cpp
│       └── anotherlib.cpp
├── include/
│   ├── mylib.h
│   └── anotherlib.h
└── build/

CMakeLists.txt

cmake_minimum_required(VERSION 3.10)

# 项目信息
project(MyProject VERSION 0.1)

# 设置C++标准
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED True)

# 输出源路径和二进制路径
message(STATUS "src path: ${CMAKE_SOURCE_DIR}")
message(STATUS "binary path: ${CMAKE_BINARY_DIR}")

# 设置库文件和可执行文件的输出目录
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/lib)
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)

message(STATUS "Library output path: ${CMAKE_LIBRARY_OUTPUT_DIRECTORY}")
message(STATUS "Executable output path: ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}")

# 包含头文件目录
include_directories(${CMAKE_SOURCE_DIR}/include)

# 使用 GLOB 收集源文件
file(GLOB_RECURSE LIB_SOURCES
    "${CMAKE_SOURCE_DIR}/src/lib/*.cpp"
)

# 设置源文件列表
set(SRC_LIST ${LIB_SOURCES})

# 添加共享库
add_library(mylib SHARED ${SRC_LIST})

# 设置可执行文件源文件
set(MAIN_SRC
    src/main.cpp
)

# 添加可执行文件
add_executable(my_executable ${MAIN_SRC})

# 链接共享库到可执行文件
target_link_libraries(my_executable PRIVATE mylib)

src/lib/mylib.cpp

#include "mylib.h"
#include <iostream>

void myFunction() {
    std::cout << "Hello from myFunction!" << std::endl;
}

include/mylib.h

#pragma once

void myFunction();

src/lib/anotherlib.cpp

#include "anotherlib.h"
#include <iostream>

void anotherFunction() {
    std::cout << "Hello from anotherFunction!" << std::endl;
}

include/anotherlib.h

#pragma once

void anotherFunction();

src/main.cpp

#include "mylib.h"
#include "anotherlib.h"

int main() {
    myFunction();
    anotherFunction();
    return 0;
}

构建项目

  1. 在项目根目录创建 build 目录并进入：

    mkdir build
cd build

  2. 运行 CMake 配置和生成：

    cmake ..
cmake --build .

结果

构建完成后，你将在 lib 目录下找到生成的共享库文件 libmylib.so，在 bin 目录下找到生成的可执行文件 my_executable。

这个方法使用了 file(GLOB_RECURSE ...) 来递归收集指定目录下的所有 .cpp 文件，你也可以根据需要调整目录路径和文件扩展名。

牛andmore牛
关注
  • 11
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
vs2022+cmake工程 静态库+动态库演示
02-28
静态库（.lib）在编译时会被链接到目标可执行文件中，形成一个独立运行的程序，无需在运行时依赖外部库文件。动态库（.dll）则是在运行时被加载的，程序运行需要对应的动态链接库文件。动态库可以节省磁盘空间和内存...
Dcmtk3.6.7动态库、静态库、可执行文件
05-10
动态库是运行时被程序加载的库文件，它们并不直接嵌入到可执行文件中，而是由操作系统在运行时加载到内存。使用动态库可以节省磁盘空间和内存，因为多个程序可以共享同一份库的副本。动态库的更新不会影响到已编译的...
cmake unicorn c arm so demo003.zip
07-12
这段示例展示了如何将 `main.c` 编译为可执行文件，并链接到 `libdemo002.so` 动态库。同时，它还指定了目标体系结构为 ARM，并设置了 ARM 编译器路径。 **Unicorn 模拟器**: Unicorn 模拟器在这个项目中的作用可能...
NDK CMakeList 模版工程
02-16
通过解压并运行`cmake`命令，CMake会生成适用于Android NDK的Makefile，然后通过`make`命令编译和链接cpp代码，最终生成可以在Android设备上运行的.so库或者可执行文件。 这个模版工程对于初学者来说是非常有价值的...
cmakelists 生成静态库，然后用静态库生成动态库，然后生成测试程序
10-12
静态库（.a 或 .lib）是在编译时将库代码直接嵌入到目标程序中，形成一个完整的可执行文件；而动态库（.so 或 .dll）则是在运行时被加载，多个程序可以共享同一份库资源，节省内存。在CMake中，我们可以方便地管理和...
C++ STL copy_backward, move_backward 用法
08-04 248
此处需要解释一下：从后向前并不是逆序，它的意思是: 源容器和目标容器都从尾部开始，然后向前迭代，执行拷贝/移动操作。反向（从后向前的顺序）拷贝/移动操作，将一个容器元素拷贝/移动到另一容器中。
C++ - 函数重载
jiaowenjie的专栏
08-06 224
/打印的是第二个函数的地址。//打印的是第一个函数的地址。-> 重载函数在本质上是相互独立的不同函数。-> 函数返回值不能作为函数重载的依据。-> 重载函数的函数类型不同。**3.函数默认参数和函数重载****函数重载的注意事项：****4.函数重载的本质**
C++ STL copy, move 用法
08-04 260
前向（从前向后的顺序）拷贝/移动操作，将一个容器元素拷贝/移动到另一容器中。
【C++】输入输出
2401_83948390的博客
08-02 605
在C++中，输入输出操作主要通过标准库中的iostream头文件提供的一系列对象和函数来完成。
C++ 继承 派生类的拷贝构造
gopher9511的博客
08-04 586
拷贝构造，也是一种构造函数，也没有被继承下来。
理解栈（Stack）及其在 C++ 中的应用【栈、数据结构】
最新发布
qq_22841387的博客
08-07 307
栈是一种数据结构，它遵循“后进先出”（LIFO - Last In, First Out）的原则。栈就像是一叠盘子，你只能从最上面拿盘子，也只能在最上面放盘子。栈的这一特性使其在很多场景中非常有用，例如递归、回溯算法和表达式计算等。通过这篇博客，我们详细介绍了栈的基本概念及其在 C++ 中的实现。栈是一种非常有用的数据结构，尤其在处理递归、回溯和表达式计算等问题时。我们还讨论了如何将栈中的字符转换为字符串，以及如何使用栈解决括号匹配问题。
C++｜设计模式（八）｜⭐️工厂模式？错！是工厂模式群！
糖炒栗子
08-02 963
首先我们按照与 Employee 类相同的方式来创建所有不同项目对应的基类（父类）Project，在这个类中我们还定义了与项目相关的接口 assignTo ，这个接口可以将某个项目指派给对应账户ID的员工，还是相同的方式我们定义 ITProject 与 UIProject 这两个不同项目的子类，并提供 assignTo 接口的不同实现。
string类的模拟实现(C++)
2302_80190394的博客
08-02 1165
C++ string的功能函数实现
在 Python 和 C++ 环境下安装和使用 ONNX Runtime
CDBmax的博客
08-03 423
对于 GPU 版本的 ONNX Runtime，需要安装 CUDA 和 cuDNN。请检查 CUDA 执行提供程序的要求以获取兼容版本的 CUDA 和 cuDNN。通过上述步骤和示例代码，您可以在 Python 和 C++ 环境下安装并使用 ONNX Runtime 进行模型推理。《windows端可以用 vs编辑器配置相应的头文件、库文件》《这部分可以去B站有很多教学视频讲的更详细》
C++ primer plus 第17 章 输入、输出和文件：使用 cin 进行输入
zhyjhacker的博客
08-05 1139
C++ primer plus 第17 章 输入、输出和文件：使用 cin 进行输入。
深入理解 C++ 中的 const 成员函数
威桑的博客
08-03 411
const 成员函数
C++标准模板（STL）- 低层内存管理 - 分配函数（operator new, operator new[]）
qq_40788199的博客
08-02 1234
分配请求数量的字节。这些分配函数为 new 表达式所调用，以分配将被初始化的对象所在的内存。亦可用常规函数调用语法调用它们。
gcc: string.c_str gcc-8.5的一个问题
mzhan017的博客
08-04 86
string的这个成员是返回c类型的一个字符数组指针。但是这个指针所对应的地址有赖于string对象的生命周期。所以如果返回一个函数内的局部string对象的指针，就是危险的。如果是危险的有没有静态代码检查工具可用帮助来检查这种书写的问题。这里需要注意的一个问题是在gcc的4.8版本是可用隐藏这个问题，但是到了8.5这个版本，就不再隐藏了。所以对生命周期比较长的c++工程来说，这是一个非常大的挑战。因为原来这么错误使用也没有问题，那得有多少处这种错误使用呢？
【LeetCode Cookbook（C++ 描述）】一刷哈希表（Hash Table）（下）
David Max 的博客
08-02 975
本系列文章仅是 GitHub 大神 @halfrost 的刷题笔记《LeetCode Cookbook》的提纲以及示例、题集的 C++转化。原书请自行下载学习。本篇文章涉及新手应该优先刷的几道经典哈希表算法题，分两篇文章，以后会更新“二刷”“三刷”等等。
cmake生成的可执行文件
09-10
cmake生成的可执行文件可以通过以下步骤来构建： 1. 在CMakeLists.txt目录执行以下命令以构建可执行文件： ``` mkdir -p build && cd build cmake .. cmake --build . ``` 这将使用cmake命令构建项目并生成可执行文件。 2. 使用cmake-gui工具可以通过以下步骤生成可执行文件： - 第一步，建立一个文件夹，并包含代码和处理图片。 - 第二步，添加cmake编译所需的文件CMakeLists.txt。找到该文件并修改其中的内容。 （注：这个文件可以在OpenCV源代码解压出来的文件夹下的/samples/c/example...。） 3. 如果只有一个源文件，可以使用最简单的方法创建CMakeLists.txt文件来生成可执行文件： - 设置满足条件的cmake最小版本。 - 设置项目名称和所使用的语言。 - 添加源文件test01.cpp并生成可执行文件printHello。 ``` # 设置满足条件的cmake最小版本 cmake_minimum_required(VERSION 3.25 FATAL_ERROR) # 设置项目名称，项目用到的语言 project(SingleSrc LANGUAGES CXX) # 生成可执行文件printHello，添加源文件test01.cpp add_executable(printHello test01.cpp) ``` 以上是使用cmake生成可执行文件的几种方法。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值