掌握Rust中的cfg宏（Rust条件编译与平台适配完全指南）

什么是 cfg 宏？

cfg 是 Rust 内置的条件编译属性（attribute），不是传统意义上的“宏”，但它常被称作“cfg宏”。它的作用是在编译时根据预设的条件决定是否包含某段代码。

例如，你可能只想在 Windows 系统上编译某个函数，或者只在启用了 debug 模式时打印日志。这时就可以用 cfg 来实现。

基本语法

cfg 有两种主要用法：

1. 作为属性（Attribute）：用于函数、模块、结构体等项（item）上。
2. 作为表达式（Expression）：用于 if 或 match 中，在运行时判断（实际是编译时展开）。

1. 作为属性使用

#[cfg(target_os = "windows")]fn hello() {    println!("Hello from Windows!");}#[cfg(target_os = "linux")]fn hello() {    println!("Hello from Linux!");}fn main() {    hello(); // 根据当前操作系统调用对应的函数}

上面的代码中，只有匹配当前操作系统的 hello 函数会被编译进最终程序。这避免了在不支持的平台上引入无效代码。

2. 作为表达式使用（cfg! 宏）

你也可以在代码中使用 cfg! 宏（注意带感叹号），它返回一个布尔值，常用于 if 分支：

fn main() {    if cfg!(target_os = "macos") {        println!("Running on macOS");    } else if cfg!(target_os = "windows") {        println!("Running on Windows");    } else {        println!("Running on another OS");    }}

注意：cfg! 的判断也是在编译时完成的，未被选中的分支会被完全移除，不会影响运行时性能。

常用 cfg 条件

Rust 提供了许多内置的配置选项，以下是一些最常见的：

• target_os：目标操作系统，如 "windows"、"linux"、"macos"、"android" 等。
• target_arch：CPU 架构，如 "x86"、"x86_64"、"aarch64"。
• target_family：系统家族，如 "unix"、"windows"。
• debug_assertions：是否启用调试断言（通常在 debug 模式下为 true）。
• feature：配合 Cargo 的特性（features）使用，例如 #[cfg(feature = "serde")]。

自定义 cfg 条件

除了内置条件，你还可以通过 Cargo.toml 定义自己的特性（features），然后在代码中使用 cfg(feature = "xxx")。

Cargo.toml 示例：

[features]default = []logging = []extra_math = []

Rust 代码中使用：

#[cfg(feature = "logging")]fn log(message: &str) {    println!("[LOG] {}", message);}#[cfg(not(feature = "logging"))]fn log(_message: &str) {    // 什么都不做}fn main() {    log("This may or may not print");}

编译时可通过 cargo build --features logging 启用该功能。

组合条件与逻辑运算

cfg 支持使用 all()、any() 和 not() 进行逻辑组合：

// 仅在 Linux 且是 x86_64 架构时编译#[cfg(all(target_os = "linux", target_arch = "x86_64"))]fn optimized_routine() {    // 高度优化的汇编代码}// 在 Windows 或 macOS 上编译#[cfg(any(target_os = "windows", target_os = "macos"))]fn use_gui() {    // 初始化图形界面}// 不在调试模式下编译#[cfg(not(debug_assertions))]fn release_only() {    println!("This runs only in release mode");}

总结

通过本文，你应该已经掌握了 Rust cfg宏 的核心用法。它是实现跨平台兼容、功能开关和构建优化的关键工具。

记住：

• 所有 cfg 判断都在编译时完成，不影响运行时性能。
• 善用 cfg(feature = "...") 可以让你的库更灵活。
• 结合 all、any、not 可以处理复杂场景。

无论你是 Rust新手入门 还是进阶开发者，掌握 Rust条件编译 技巧都将极大提升你的代码质量与可维护性。希望这篇 Rust编程教程 对你有所帮助！