C / C++ / 系统课时

打包安装并验证下游接入

打包安装并验证下游接入

源码仓库里能编译成功,不代表网络库已经可交付。本节把头文件、库文件和 CMake 包配置安装到统一前缀,再用完全独立的业务工程通过 find_package 查找并链接它,最后启动 RPC 服务端与客户端完成一次端到端验收。

学习目标

  • 为 C++ 网络库配置标准安装规则和 CMake 包导出
  • 让下游通过 find_package 和命名空间目标完成链接
  • 用独立 RPC 客户端与服务端验证安装包可真实使用

明确最终交付物

一个可被 CMake 下游消费的安装包至少包含公共头文件、静态或动态库、包配置文件三部分。下游不应该知道源码目录,也不应该手工拼接 -I、-L 和具体库文件名。

网络库从构建到下游消费的交付链路

推荐形成下面的安装布局:

text
<PREFIX>/
├── include/anystack/...
└── lib/
    ├── libanystack_net.so
    └── cmake/anystack_net/
        ├── AnystackNetConfig.cmake
        ├── AnystackNetConfigVersion.cmake
        └── AnystackNetTargets.cmake

Windows、macOS 或静态库构建时具体库文件名可能不同,但 CMake 导出目标名称应该保持稳定。

配置安装与包导出

下面片段放在网络库顶层 CMakeLists.txt。假设真实库目标名为 anystack_net,公共头文件位于 include/anystack。

cmake
include(GNUInstallDirs)
include(CMakePackageConfigHelpers)

install(TARGETS anystack_net
    EXPORT AnystackNetTargets
    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
    INCLUDES DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)

install(
    DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/include/anystack
    DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
)

install(
    EXPORT AnystackNetTargets
    FILE AnystackNetTargets.cmake
    NAMESPACE anystack::
    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/anystack_net
)

configure_package_config_file(
    cmake/AnystackNetConfig.cmake.in
    ${CMAKE_CURRENT_BINARY_DIR}/AnystackNetConfig.cmake
    INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/anystack_net
)

write_basic_package_version_file(
    ${CMAKE_CURRENT_BINARY_DIR}/AnystackNetConfigVersion.cmake
    VERSION ${PROJECT_VERSION}
    COMPATIBILITY SameMajorVersion
)

install(
    FILES
        ${CMAKE_CURRENT_BINARY_DIR}/AnystackNetConfig.cmake
        ${CMAKE_CURRENT_BINARY_DIR}/AnystackNetConfigVersion.cmake
    DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/anystack_net
)

cmake/AnystackNetConfig.cmake.in 只负责加载导出的目标:

cmake
@PACKAGE_INIT@

include("${CMAKE_CURRENT_LIST_DIR}/AnystackNetTargets.cmake")
check_required_components(AnystackNet)

这两段属于配置文件,不要求直接产生控制台输出。验证方法是完成安装后,在独立目录调用 find_package(AnystackNet CONFIG REQUIRED),并确认整个下游工程不引用网络库源码路径。

安装到隔离前缀

在网络库仓库根目录执行:

bash
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release
cmake --install build --prefix <PATH>

预期结果是安装命令成功结束,并出现与下面等价的安装记录:

text
-- Installing: <PATH>/include/anystack/...
-- Installing: <PATH>/lib/libanystack_net.so
-- Installing: <PATH>/lib/cmake/anystack_net/AnystackNetConfig.cmake
-- Installing: <PATH>/lib/cmake/anystack_net/AnystackNetTargets.cmake

<PATH> 需要替换成实际安装目录。Windows、macOS、不同生成器或静态库构建的具体文件名可能不同,但头文件、库和包配置三类交付物都必须存在。

建立独立下游工程

下游工程不要放在网络库源码树内,否则相对路径可能掩盖缺失的安装文件。假设网络库已经稳定提供 anystack/rpc/rpc_server.h、anystack/rpc/rpc_client.h,并导出 anystack::anystack_net 目标。

业务工程的 CMakeLists.txt 可以保持很小:

cmake
cmake_minimum_required(VERSION 3.20)
project(rpc_consumer LANGUAGES CXX)

find_package(AnystackNet CONFIG REQUIRED)

add_executable(rpc_server server.cc)
target_link_libraries(rpc_server PRIVATE anystack::anystack_net)

add_executable(rpc_client client.cc)
target_link_libraries(rpc_client PRIVATE anystack::anystack_net)

下面是完整服务端入口。它注册 echo 方法后监听本机端口;如果你的网络库已经确定了不同的稳定 API,只替换公共调用名称,不要让 Reactor、Channel 等私有类型进入业务代码。

cpp
#include <anystack/rpc/rpc_server.h>
#include <iostream>
#include <string>

int main() {
    anystack::rpc::RpcServer server({"127.0.0.1", 9000, 1});

    server.register_handler("echo", [](const std::string& request) {
        return "echo:" + request;
    });

    std::cout << "rpc server listening on 127.0.0.1:9000\n";
    server.start();
    return 0;
}

客户端只依赖公共 RPC API:

cpp
#include <anystack/rpc/rpc_client.h>
#include <iostream>

int main() {
    anystack::rpc::RpcClient client("127.0.0.1", 9000);
    const auto response = client.call("echo", "hello");
    std::cout << response << '\n';
    return response == "echo:hello" ? 0 : 1;
}

这两个程序都有完整入口,但依赖当前网络库已经实现对应公共 API。它们的任务是验证安装后的包是否能被真实业务消费,而不是重新实现 RPC 协议。

编译并完成端到端验收

在独立业务工程目录中配置时,只向 CMake 提供安装前缀:

bash
cmake -S . -B build -DCMAKE_PREFIX_PATH=<PATH>
cmake --build build

预期输出的关键结果是两个目标都成功链接:

text
[100%] Built target rpc_server
[100%] Built target rpc_client

先启动服务端:

bash
./build/rpc_server

预期输出:

text
rpc server listening on 127.0.0.1:9000

再在另一个终端启动客户端:

bash
./build/rpc_client

预期输出:

text
echo:hello

如果 find_package 失败,先检查 <PATH>/lib/cmake/anystack_net 是否存在,再确认 CMAKE_PREFIX_PATH 指向安装前缀而不是某个配置文件本身。如果能够找到包却链接失败,应核对导出目标名是否与 target_link_libraries 一致,以及库自身依赖是否通过 PUBLIC 或 INTERFACE 正确传递。

真正的库级交付应以脱离源码树仍可接入为验收标准:下游只拿到安装前缀,就能够配置、编译、链接并跑通一次 RPC 请求,才说明头文件安装、目标导出、依赖传播和运行时链接边界都已经闭合。

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

目录与阅读设置

阅读设置

17

记录一个想法

打包安装并验证下游接入

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

登录哪都通