Rust 下 features 条件编译

最近咱在写一个 Rust 项目，然后项目需要分为不同的版本，就要用到条件编译，所以咱纪录一下（）。

定义 feature#

要编译不同的版本，必须定义一个 feature，在 Cargo.toml 里添加一个 [features] 部分：

1
[features]
2
# 这里方括号为空，表示这两个 feature 标志本身不启用其他额外功能
3
server = []
4
client = []

feature 的名字可以随便写，遵守规范即可。

当然，你可以精确控制某个 feature，比如添加特定的依赖，这些依赖只会在 feature 启用时才会被编译进去：

1
[features]
2
# 仅当 server feature 启用时，才编译 tokio 依赖
3
server = ["dep:tokio"]

也可以开启默认启用的 features：

1
[features]
2
default = ["server"]
3
server = []

条件代码#

定义了 feature 之后，就可以写 #[cfg(feature = "xxx")] 了！这么写的意思是判断启用了 xxx feature 时才 xxx，当然，还可以有更多用法。

模块#

rust 中可以用 mod xxx 来决定模块是否能被编译，在上面添加 #[cfg(feature = "xxx")] 就可以实现条件模块：

1
// 当启用 "server" feature 时，才编译 server 模块
2
#[cfg(feature = "server")]
3
pub mod server;

代码块和函数#

在代码块或函数上面添加 #[cfg(feature = "xxx")] 就可以实现条件逻辑：

1
// 如果编译时启用了 "server" feature，则编译这个函数
2
#[cfg(feature = "server")]
3
fn start_server() {
4
    println!("启动服务器...");
5
    // ...
6
}
7

8
fn main() {
9
    // 如果编译时启用了 "server" feature，则编译这个代码块
10
    #[cfg(feature = "server")]
11
    {
12
        start_server();
13
    }
14
    // 编译时没启用 "server" feature 就编译这个代码块
15
    #[cfg(not(feature = "server"))]
16
    {
17
        // ...
18
    }
19
}

const，static 和 struct 也可以：

1
#[cfg(feature = "server")]
2
const DEFAULT_NAME: &str = "server1";
3

4
#[cfg(feature = "server")]
5
static HTML: OnceLock<String> = OnceLock::new();
6

7
#[cfg(feature = "server")]
8
pub struct ServerConfig {
9
    pub port: u16,
10
    // ...
11
}

if 和 cfg! 宏#

也可以在 if 上使用 cfg! 宏！逻辑会在编译时计算出来：

1
// 在编译期，cfg! 宏会计算出 true 或 false
2
if cfg!(feature = "server") {
3
    println!("指定了 server feature 标志");
4
} else {
5
    // 如果没启用，这个分支的代码就会被编译进去
6
    println!("未指定 feature 标志");
7
}

编译#

写完代码就可以编译了！cargo 构建时可以通过 --features 参数指定要启用的 feature，如：

1
cargo build --release --features server
2
# 或多个
3
cargo build --release --features "server,xxx"
4
# 禁用默认 features
5
cargo build --release --no-default-features

总结#

不是很复杂的说~ 而且非常好用！（）

定义 feature#

条件代码#

模块#

代码块和函数#

if 和 cfg! 宏#

编译#

总结#

支持与分享

评论区

文章目录