C / C++ / 系统课时
PUBLIC 和 PRIVATE 怎么选
PUBLIC 和 PRIVATE 怎么选
PUBLIC 和 PRIVATE 决定的不只是“这个库自己能不能用某项配置”,还决定配置是否继续传给下游目标。本节用公开头文件依赖第三方头文件的场景建立判断规则:公开接口需要消费者同步获得的要求用 PUBLIC,仅实现内部需要的要求用 PRIVATE。
学习目标
- 能根据公开接口判断
PUBLIC与PRIVATE - 会分别判断头文件目录、依赖库和编译配置是否需要传播
- 能通过一个完整示例验证传播是否生效
先看传播方向
假设 app 链接 calc,而 calc 的公开头文件又包含 format 提供的类型。此时 app 虽然没有直接调用 format,但编译 calc 的公开头文件时仍然需要 format 的头文件路径,所以这条依赖必须向下游传播。

判断时不要从“库重要不重要”出发,而要问:消费者在编译或链接自己的代码时,是否也必须知道这项要求?
用公开头文件验证 PUBLIC
下面项目把 format 做成头文件接口库。calc/calc.h 直接包含 format/value.h,因此任何包含 calc/calc.h 的消费者都必须能找到 format 的头文件。
cmake_minimum_required(VERSION 3.20)
project(ScopeDemo C)
# format 只有头文件,因此自身不编译,只向消费者提供使用要求。
add_library(format INTERFACE)
target_include_directories(format INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}/format/include)
# calc 的公开头文件会被 app 包含,所以 calc/include 必须传播。
add_library(calc STATIC calc/src/calc.c)
target_include_directories(calc PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/calc/include)
# calc 的公开头文件暴露了 format 类型,因此这条依赖必须是 PUBLIC。
target_link_libraries(calc PUBLIC format)
add_executable(app app/main.c)
target_link_libraries(app PRIVATE calc)format/include/format/value.h:
#ifndef FORMAT_VALUE_H
#define FORMAT_VALUE_H
/* 该类型会出现在 calc 的公开 API 中。 */
typedef struct {
int value;
} FormattedValue;
#endifcalc/include/calc/calc.h:
#ifndef CALC_CALC_H
#define CALC_CALC_H
/* 公开头文件直接依赖 format 的公开类型。 */
#include <format/value.h>
FormattedValue calc_add(int a, int b);
#endifcalc/src/calc.c:
#include <calc/calc.h>
FormattedValue calc_add(int a, int b) {
/* 局部对象按公开返回类型构造。 */
FormattedValue result = {a + b};
return result;
}app/main.c:
#include <stdio.h>
#include <calc/calc.h>
int main(void) {
/* app 能直接看到由 calc 公开接口暴露的 FormattedValue。 */
FormattedValue result = calc_add(2, 3);
printf("value=%d\n", result.value);
return 0;
}构建并运行:
# 隐藏构建日志,只验证传播配置最终能否让 app 正常编译并运行。
cmake -S . -B build >/dev/null && cmake --build build >/dev/null && ./build/app预期输出:
value=5这里 target_link_libraries(calc PUBLIC format) 同时满足两件事:calc 自己获得 format 的使用要求,链接 calc 的 app 也继续获得这些要求。如果把 PUBLIC 改成 PRIVATE,app 不再继承 format 的头文件目录,干净构建时通常会在编译 calc/calc.h 时报告找不到 format/value.h;具体错误文本取决于编译器。
不同命令用同一套判断规则
| 配置 | 适合 PUBLIC |
适合 PRIVATE |
|---|---|---|
target_include_directories |
公开头文件需要该目录 | 只有 .c 文件或私有头文件需要 |
target_link_libraries |
公开接口暴露依赖,消费者也需要其使用要求 | 依赖只服务于当前目标实现 |
target_compile_definitions |
宏出现在公开头文件或影响消费者看到的接口 | 宏只控制当前目标内部实现 |
target_compile_options |
消费者确实必须使用同一编译选项 | 警告、局部优化等只针对当前目标 |
INTERFACE 是第三种常见范围:当前目标自身不使用,只要求消费者使用。判断 PUBLIC 和 PRIVATE 时先抓住一条主线即可——公开 API 需要下游知道的配置就传播,纯实现细节就封装在当前目标内。