ejabberd项目中rebar3依赖管理的优化实践

在Erlang生态系统中，rebar3是最常用的构建工具之一，它为项目依赖管理提供了强大的支持。本文将以ejabberd项目为例，深入探讨rebar3依赖管理中的一个典型问题及其解决方案。

背景介绍

ejabberd是一个使用Erlang/OTP语言开发的高性能XMPP服务器。在构建过程中，它使用rebar3来管理Erlang依赖项。rebar3通过两个关键文件来管理依赖：

1. rebar.config：定义项目所需的依赖项及其版本约束
2. rebar.lock：锁定具体的依赖版本，确保构建的一致性

根据rebar3官方文档的建议，rebar.lock文件应该被纳入版本控制系统。ejabberd项目遵循了这一建议，将rebar.lock文件提交到了Git仓库中。

问题分析

ejabberd项目在构建时面临一个特殊场景：通过configure.ac脚本可以动态启用或禁用某些功能模块。当某个功能被禁用时，理论上其对应的依赖项也不应该被下载和编译。然而，实际情况却出现了以下问题链：

1. configure.ac脚本根据系统环境和用户配置决定禁用某些功能
2. 这一决策被记录在vars.config文件中
3. rebar.config.script读取vars.config并相应调整rebar.config中的依赖项
4. 但是rebar.lock文件中仍然包含这些已被禁用的依赖项
5. rebar3在构建时会读取rebar.lock文件，导致下载并尝试编译所有列出的依赖项，包括那些已被禁用的

这种行为不仅造成了不必要的网络下载和构建时间浪费，在某些情况下还可能导致构建失败，特别是当系统环境中缺少编译某些依赖所需的库时。

解决方案比较

针对这一问题，我们考虑了三种解决方案：

方案A：不跟踪rebar.lock文件

最简单的解决方案是从版本控制中移除rebar.lock文件。这种做法可以立即解决问题，因为rebar3在没有lock文件时会根据rebar.config中的配置动态解析依赖。但这样做的缺点是失去了版本锁定的优势，可能导致不同开发环境或构建环境中使用不同的依赖版本。

方案B：动态修改rebar.lock文件

更精细的解决方案是在configure.ac脚本中添加逻辑，当某个功能被禁用时，不仅调整rebar.config，还使用rebar3的unlock命令从rebar.lock文件中移除对应的依赖项。这种方法保持了版本控制的优势，同时避免了不必要的依赖下载。

方案C：修改rebar3行为

最彻底的解决方案是修改rebar3本身的行为，使其在处理依赖时像Mix工具(Elixir的构建工具)一样：只下载rebar.config中启用的依赖项，而rebar.lock仅用于确定具体版本。这需要向rebar3项目提交功能请求或补丁。

实施细节

ejabberd项目最终选择了方案B，通过在configure.ac中添加以下逻辑：

AS_CASE([$rebar],
 [*rebar3], [
  deps=""
  AS_IF([test "x$stun" = "xfalse"], [deps="stun,$deps"])
  AS_IF([test "x$sqlite" = "xfalse"], [deps="sqlite3,$deps"])
  # 其他依赖项检查...
  AS_IF([test "x$deps" = "x"], [],
   [echo "unlocking disabled rebar3 dependencies: $deps"
    $rebar unlock "$deps"])
 ])

这段脚本会：

1. 检查当前构建工具是否为rebar3
2. 收集所有被禁用的依赖项名称
3. 使用rebar3 unlock命令从rebar.lock中移除这些依赖项

效果验证

实施后，当用户运行configure脚本禁用某个功能时，例如PAM支持：

./configure --enable-all --disable-pam --with-rebar=rebar3

脚本会自动从rebar.lock中移除epam依赖项。随后的构建过程将不再下载和编译这个依赖，从而提高了构建效率并避免了潜在的构建失败。

最佳实践建议

基于这一案例，我们总结出以下Erlang项目依赖管理的最佳实践：

1. 对于可选功能模块，应该在配置阶段就确定是否需要其依赖项
2. 当使用rebar3时，如果项目有可选依赖，应考虑动态调整rebar.lock文件
3. 在持续集成环境中，应该确保构建配置与依赖管理策略一致
4. 定期审查rebar.lock文件，移除不再需要的依赖项

这一解决方案不仅解决了ejabberd项目的具体问题，也为其他Erlang项目提供了处理类似情况的参考模式。通过精细控制依赖项的下载和编译，可以显著提高项目的构建效率和可靠性。