如何在Autotools中结合Rust实现VPATH构建

针对Autotools驱动的混合语言项目在VPATH构建时Rust子项目无法正确工作的问题，以下是几种实用的最佳实践方案：

方案一：同步Rust必要文件至构建目录并在构建目录执行Cargo #

该方案符合Autotools的VPATH设计原则，将Rust子项目的核心源文件同步到构建目录（builddir），让Cargo在构建目录内完成编译，避免污染源码目录（srcdir）。

修改后的Makefile.am核心代码： #

# 定义Rust子项目需要同步的核心文件（无需包含dependencies，Cargo会自动处理）
RUSTFOO_CORE_FILES = rustfoo/Cargo.toml rustfoo/Cargo.lock
RUSTFOO_CORE_FILES += $(wildcard rustfoo/src/**/*.rs)

# 构建目录下的Rust子项目路径
BUILDDIR_RUSTFOO = $(builddir)/rustfoo

# 同步单个文件到构建目录的规则
$(BUILDDIR_RUSTFOO)/%: $(srcdir)/rustfoo/%
	@mkdir -p $(@D)
	# 优先用符号链接，失败则复制文件
	$(LN_S) $< $@ || cp -f $< $@

# 编译Rust静态库的规则，依赖所有同步后的核心文件
$(BUILDDIR_RUSTFOO)/target/release/librustfoo.a: $(addprefix $(BUILDDIR_RUSTFOO)/, $(notdir $(RUSTFOO_CORE_FILES)))
	cd $(BUILDDIR_RUSTFOO); \
	cargo rustc --release -- --crate-type staticlib

# 更新库依赖指向构建目录的产物
libfoo_la_LIBADD += $(BUILDDIR_RUSTFOO)/target/release/librustfoo.a

# 保持原有的dist-hook规则，确保分发包包含Rust子项目
dist-hook:
	mkdir -p $(distdir)/rustfoo
	cp -a $(srcdir)/rustfoo/* $(distdir)/rustfoo
	rm -rf $(distdir)/rustfoo/target

方案二：通过CARGO_TARGET_DIR指定产物目录 #

无需同步Rust源文件，直接通过环境变量让Cargo将编译产物输出到构建目录，简化配置。

修改后的Makefile.am核心代码： #

# 指定Cargo产物输出到构建目录的rustfoo/target下
BUILDDIR_RUSTFOO_TARGET = $(builddir)/rustfoo/target

# 编译Rust静态库的规则，设置CARGO_TARGET_DIR
rustfoo/target/release/librustfoo.a:
	cd $(srcdir)/rustfoo; \
	CARGO_TARGET_DIR=$(BUILDDIR_RUSTFOO_TARGET) cargo rustc --release -- --crate-type staticlib

# 更新库依赖指向构建目录的产物
libfoo_la_LIBADD += $(BUILDDIR_RUSTFOO_TARGET)/release/librustfoo.a

# 保持原有的dist-hook规则
dist-hook:
	mkdir -p $(distdir)/rustfoo
	cp -a $(srcdir)/rustfoo/* $(distdir)/rustfoo
	rm -rf $(distdir)/rustfoo/target

注意：需确保srcdir/rustfoo/Cargo.lock存在且版本稳定，避免Cargo在构建时重新生成锁文件导致不一致。

方案三：预复制Rust核心文件到构建目录 #

如果不希望使用符号链接，可直接在构建前将Rust子项目的核心文件复制到构建目录，确保Cargo能正常读取。

修改后的Makefile.am核心代码： #

# 将Rust子项目核心文件加入分发列表
EXTRA_DIST += rustfoo/Cargo.toml rustfoo/Cargo.lock rustfoo/src

# 构建前复制核心文件到构建目录
rustfoo_prep:
	@mkdir -p $(builddir)/rustfoo
	cp -a $(srcdir)/rustfoo/Cargo.toml $(srcdir)/rustfoo/Cargo.lock $(builddir)/rustfoo/
	@mkdir -p $(builddir)/rustfoo/src
	cp -a $(srcdir)/rustfoo/src/* $(builddir)/rustfoo/src/

# 编译Rust静态库的规则，依赖预复制步骤
$(builddir)/rustfoo/target/release/librustfoo.a: rustfoo_prep
	cd $(builddir)/rustfoo; \
	cargo rustc --release -- --crate-type staticlib

# 更新库依赖指向构建目录的产物
libfoo_la_LIBADD += $(builddir)/rustfoo/target/release/librustfoo.a

# 确保预复制步骤在构建前执行
all-local: rustfoo_prep

# 保持原有的dist-hook规则
dist-hook:
	mkdir -p $(distdir)/rustfoo
	cp -a $(srcdir)/rustfoo/* $(distdir)/rustfoo
	rm -rf $(distdir)/rustfoo/target

方案选择建议 #

• 优先选择方案一：完全遵循Autotools的VPATH设计，符号链接减少冗余文件，构建效率更高。
• 若需要极简配置，选择方案二：仅通过环境变量调整产物路径，改动最小。
• 若环境限制无法使用符号链接，选择方案三：直接复制文件，兼容性最强。

内容的提问来源于stack exchange，提问作者Jose Gracia