rebar3最佳实践清单：避免常见陷阱的20个专业建议

rebar3最佳实践清单：避免常见陷阱的20个专业建议

【免费下载链接】rebar3Erlang build tool that makes it easy to compile and test Erlang applications and releases.项目地址: https://gitcode.com/gh_mirrors/re/rebar3

rebar3是Erlang生态系统中最流行的构建工具，它简化了Erlang应用程序和发布版本的编译、测试和部署流程。本文将分享20个专业建议，帮助开发者充分利用rebar3的强大功能，同时避免常见的使用陷阱。

一、环境配置与安装

1. 使用官方引导脚本安装

始终通过官方提供的引导脚本安装rebar3，确保获得最新稳定版本：

curl -fSL https://rebar3.org/install | sh

安装脚本位于项目根目录的bootstrap文件，这是获取正确版本的最可靠方式。

2. 保持rebar3自身更新

定期更新rebar3到最新版本，以获取性能改进和bug修复：

rebar3 local upgrade

升级功能由rebar_prv_local_upgrade.erl模块实现，确保你使用的是最新的构建逻辑。

二、项目结构与配置

3. 使用标准项目结构

遵循rebar3推荐的项目结构，便于工具自动发现和处理项目资源：

my_project/ ├── rebar.config ├── src/ │ ├── my_project.app.src │ ├── my_project.erl │ └── my_project_sup.erl ├── test/ └── priv/

rebar3的应用发现逻辑在rebar_app_discover.erl中实现，遵循标准结构可避免不必要的配置复杂性。

4. 合理使用rebar.config

保持rebar.config简洁明了，将不同环境的配置分离到相应的配置文件中：

• 基础配置：rebar.config
• 开发环境：rebar.config.dev
• 生产环境：rebar.config.prod

配置解析逻辑位于rebar_config.erl，正确的配置结构可以显著提高构建效率。

5. 明确指定依赖版本

在rebar.config中为所有依赖指定明确的版本约束，避免意外更新导致的兼容性问题：

{deps, [ {cowboy, "2.9.0"}, {jiffy, "1.1.1", {git, "https://gitcode.com/davisp/jiffy.git", {tag, "1.1.1"}}} ]}.

依赖管理由rebar_packages.erl处理，明确的版本号可以确保构建的可重复性。

三、依赖管理

6. 使用锁文件确保依赖一致性

提交rebar.lock文件到版本控制系统，确保团队成员和CI环境使用完全相同的依赖版本：

git add rebar.lock

锁文件生成逻辑在rebar_lock.erl中实现，它记录了所有依赖的精确版本信息。

7. 定期更新依赖

建立定期更新依赖的机制，及时获取安全补丁和功能改进：

rebar3 upgrade cowboy

升级功能由rebar_prv_upgrade.erl实现，可以单独升级特定依赖。

8. 合理使用私有仓库

对于企业内部项目，配置私有Hex仓库存储内部依赖：

{hex_repos, [ {my_private_repo, [ {url, "https://hex.example.com"}, {api_key, "my_api_key"} ]} ]}.

仓库配置由rebar_hex_repos.erl处理，正确配置可以保护知识产权并加速依赖下载。

四、构建与编译

9. 增量编译提高效率

利用rebar3的增量编译功能，只重新编译修改过的文件：

rebar3 compile

编译逻辑在rebar_compiler.erl中实现，它使用文件时间戳和依赖关系图来确定需要重新编译的模块。

10. 并行编译加速构建

启用并行编译充分利用多核CPU资源：

{erl_opts, [parallel]}.

并行编译由rebar_parallel.erl模块管理，可以显著减少大型项目的构建时间。

11. 配置编译器选项

根据项目需求合理配置编译器选项，平衡代码质量和性能：

{erl_opts, [ warn_unused_vars, warn_shadow_vars, {inline, [{my_function, 2}]}, {hipe, [o3]} ]}.

编译器选项处理在rebar_erlc_compiler.erl中实现，适当的选项可以提前发现潜在问题。

五、测试与质量保证

12. 编写全面的测试套件

利用rebar3的测试框架支持，编写单元测试、集成测试和EUnit测试：

rebar3 eunit rebar3 ct

测试功能由rebar_prv_eunit.erl和rebar_prv_common_test.erl实现，良好的测试覆盖率可以提高代码质量。

13. 集成静态代码分析

配置Dialyzer进行静态代码分析，提前发现类型相关问题：

rebar3 dialyzer

Dialyzer集成在rebar_prv_dialyzer.erl中，定期运行可以捕获许多运行时难以调试的问题。

14. 生成代码覆盖率报告

使用rebar3的覆盖工具评估测试覆盖率：

rebar3 cover

覆盖率分析由rebar_prv_cover.erl实现，帮助识别测试未覆盖的代码区域。

六、发布与部署

15. 使用relx配置发布

通过relx配置文件定义发布结构和启动脚本：

{relx, [ {release, {my_app, "1.0.0"}, [{my_app, "1.0.0"}]}, {sys_config, "config/sys.config"}, {vm_args, "config/vm.args"}, {include_erts, true}, {extended_start_script, true} ]}.

发布功能由rebar_relx.erl集成，合理的配置可以简化部署流程。

16. 生成文档

自动生成API文档并保持更新：

rebar3 edoc

文档生成由rebar_prv_edoc.erl处理，良好的文档可以提高团队协作效率。

17. 创建EScript可执行文件

将工具类应用打包为独立的EScript可执行文件：

{escript, [ {name, mytool}, {main_module, mytool_main}, {app, mytool} ]}.

EScript功能在rebar_prv_escriptize.erl中实现，便于工具的分发和使用。

七、高级技巧与陷阱避免

18. 正确使用配置文件模板

利用rebar3的模板功能生成一致的配置文件：

rebar3 new release myapp

模板系统由rebar_templater.erl实现，项目提供了多种模板位于priv/templates/目录。

19. 避免插件冲突

谨慎选择和管理插件，避免不同插件之间的冲突：

{plugins, [ {rebar3_hex, "6.10.0"}, {rebar3_format, "0.8.0"} ]}.

插件管理由rebar_plugins.erl处理，建议只使用必要的插件并保持其更新。

20. 利用命名空间隔离任务

使用命名空间功能组织自定义任务，避免与内置命令冲突：

{namespace, mynamespace}. {providers, [ {my_task, {my_module, my_function, []}, [{namespace, mynamespace}]} ]}.

命名空间支持在rebar_core.erl中实现，可以有效组织复杂项目的构建流程。

总结

rebar3是Erlang开发中不可或缺的工具，掌握这些最佳实践可以显著提高开发效率和代码质量。通过合理配置、依赖管理、测试策略和发布流程，你可以充分发挥rebar3的强大功能，避免常见陷阱，构建更可靠的Erlang应用程序。

记住，rebar3本身也是一个活跃的开源项目，其源代码位于apps/rebar/src/目录，深入了解其实现可以帮助你更好地定制构建流程，解决复杂问题。定期查阅官方文档和参与社区讨论，也是保持rebar3使用技能与时俱进的重要方式。

【免费下载链接】rebar3Erlang build tool that makes it easy to compile and test Erlang applications and releases.项目地址: https://gitcode.com/gh_mirrors/re/rebar3