C / C++ / 系统课时

用 add_library 创建项目内部库

用 add_library 创建项目内部库

当一个可执行程序不断把网络、算法、存储等模块的 .c 文件直接堆进 add_executable() 时,模块边界会越来越模糊。add_library() 可以把这些源码变成独立 CMake 目标,再由应用程序显式链接,从而让编译选项、头文件目录和依赖关系都跟着模块自身管理。

学习目标

  • 使用 add_library() 创建静态库或共享库目标。
  • 把已有模块源码从可执行目标中拆出,并通过 target_link_libraries() 建立依赖。
  • 构建并运行最小项目,验证库目标被正确链接。

把源码拆成库目标

假设 math_utils.c 原本直接写在应用程序目标中。下面两段都是片段示例,依赖一个已经声明 CMake 项目的 CMakeLists.txt。

cmake
add_executable(app
    main.c
    math_utils.c
)

拆分后,让模块拥有自己的目标:

cmake
add_library(math_utils STATIC
    math_utils.c
)

add_executable(app
    main.c
)

target_link_libraries(app PRIVATE math_utils)

STATIC 表示生成静态库;改成 SHARED 则创建共享库。两种写法的核心区别在产物和运行时装载方式,而应用程序仍通过目标名 math_utils 建立链接关系,不需要手写 .a、.so、.lib 或 .dll 文件路径。

从源码直连到独立库目标的构建关系

静态库与共享库怎么选

STATIC 会把库代码在链接阶段合入最终程序,部署简单;SHARED 生成运行时需要装载的动态库,适合多个程序共享同一库或需要独立替换库文件的场景。对项目内部模块,先选满足部署需求的类型即可,不要因为“模块化”就默认必须使用共享库。

片段示例:如果同一项目已经定义或允许用户设置 BUILD_SHARED_LIBS,也可以省略库类型:

cmake
add_library(math_utils
    math_utils.c
)

CMake 会根据 BUILD_SHARED_LIBS 的值决定创建静态库还是共享库。希望构建结果固定时,直接写明 STATIC 或 SHARED 更清晰。

完成一个最小库项目

创建 math_utils.h:

c
#ifndef MATH_UTILS_H
#define MATH_UTILS_H

int add(int a, int b);

#endif

创建 math_utils.c:

c
#include "math_utils.h"

int add(int a, int b) {
    return a + b;
}

创建 main.c:

c
#include <stdio.h>
#include "math_utils.h"

int main(void) {
    printf("sum=%d\n", add(2, 3));
    return 0;
}

根目录 CMakeLists.txt:

cmake
cmake_minimum_required(VERSION 3.20)
project(internal_library_demo C)

add_library(math_utils STATIC
    math_utils.c
)

target_include_directories(math_utils
    PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}"
)

add_executable(app
    main.c
)

target_link_libraries(app PRIVATE math_utils)

这里把头文件目录设为 PUBLIC,因为 math_utils.c 自己和链接它的 app 都需要找到 math_utils.h。应用程序不再直接编译 math_utils.c,否则同一实现可能被重复加入不同目标,破坏清晰的模块归属。

构建并运行

在类 Unix 环境中执行:

bash
cmake -S . -B build >/dev/null && cmake --build build >/dev/null && ./build/app

预期输出:

text
sum=5

在支持常规共享库导出的类 Unix 工具链中,把 STATIC 改成 SHARED 后,业务输出仍应为 sum=5;变化主要体现在生成的库产物以及运行时装载方式。Windows 等平台还可能需要显式导出符号,因此不要把“改一个关键字”当作所有平台都成立的共享库迁移方案。

拆库时最容易犯的错误

最常见的问题是只创建了库,却忘记给应用程序建立链接关系。add_library() 只定义目标,不会自动让其他目标使用它;真正的依赖由 target_link_libraries() 建立。

另一个错误是把已经移入库目标的 .c 文件继续保留在 add_executable() 中。正确做法是让每份实现源码有明确归属,再通过目标之间的链接关系组合最终程序。这样后续添加编译选项、测试或第三方依赖时,都可以继续围绕库目标维护,而不必回到一个越来越庞大的可执行目标中。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 add_library 创建项目内部库

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通