Rust 构建脚本中的条件编译

在 Rust 中，构建脚本 build. rs 可以通过多种方式影响主项目的条件编译。以下是主要的实现方法：

1. 通过 cfg 属性传递标志

在构建脚本中，你可以使用 println! 宏输出 cargo: 指令来设置条件编译标志：

// build.rs
fn main() {
    if std::env::var("TARGET").unwrap().contains("windows") {
        println!("cargo:rustc-cfg=windows_platform");
    } else {
        println!("cargo:rustc-cfg=unix_platform");
    }
    
    // 检查某个特性是否可用
    if check_some_feature() {
        println!("cargo:rustc-cfg=has_feature");
    }
}

然后在主代码中使用 #[cfg] 属性：

#[cfg(windows_platform)]
fn platform_specific() {
    println!("Running on Windows");
}

#[cfg(unix_platform)]
fn platform_specific() {
    println!("Running on Unix");
}

2. 通过环境变量传递信息

构建脚本可以设置环境变量，然后在代码中检查：

// build.rs
fn main() {
    println!("cargo:rustc-env=BUILD_VERSION=1.2.3");
    println!("cargo:rustc-env=FEATURE_ENABLED=true");
}

在代码中使用：

if option_env!("FEATURE_ENABLED").unwrap_or("false") == "true" {
    // 特性启用时的代码
}

3. 生成代码并包含

构建脚本可以生成 Rust 代码文件，然后通过 include! 宏包含：

// build.rs
use std::fs::File;
use std::io::Write;
use std::path::Path;

fn main() {
    let out_dir = std::env::var("OUT_DIR").unwrap();
    let dest_path = Path::new(&out_dir).join("generated.rs");
    
    let mut f = File::create(&dest_path).unwrap();
    writeln!(f, "pub const BUILD_TIME: &str = \"{}\";", chrono::Local::now()).unwrap();
    
    println!("cargo:rerun-if-changed=build.rs");
}

在主代码中包含生成的文件：

include!(concat!(env!("OUT_DIR"), "/generated.rs"));

fn main() {
    println!("Build time: {}", BUILD_TIME);
}

4. 特性检测

构建脚本可以检测系统特性并设置相应的配置：

// build.rs
fn main() {
    if check_sse4_support() {
        println!("cargo:rustc-cfg=sse4");
    }
}

代码中使用：

#[cfg(sse4)]
fn optimized_function() {
    // 使用SSE4指令的实现
}

#[cfg(not(sse4))]
fn optimized_function() {
    // 通用实现
}

5. 依赖特定条件重新运行

告诉 Cargo 在什么情况下重新运行构建脚本：

// build.rs
fn main() {
    // 当这些文件改变时重新运行构建脚本
    println!("cargo:rerun-if-changed=build.rs");
    println!("cargo:rerun-if-changed=some-config-file");
    
    // 也可以基于环境变量
    if std::env::var("SOME_VAR").is_ok() {
        println!("cargo:rerun-if-env-changed=SOME_VAR");
    }
}

最佳实践

1. 使用 OUT_DIR 环境变量来存放生成的文件
2. 明确指定 rerun-if 条件以避免不必要的重新编译
3. 为生成的配置提供清晰的文档
4. 考虑跨平台兼容性

通过构建脚本的条件编译，你可以实现平台特定的代码路径、基于系统特性的优化、以及构建时配置等功能。