为什么 :atom 不能通过 Enumerable.t() 类型检查Hammox 契约测试 Protocol 判定机制揭秘【免费下载链接】hammox automated contract testing via type checking for Elixir functions and mocks项目地址: https://gitcode.com/gh_mirrors/ha/hammoxHammox 是一个 Elixir 契约测试contract testing库它基于类型检查type checking对 mock 和真实实现做自动化校验。本文从一个新手最常见的困惑切入为什么传一个:atom就通不过Enumerable.t()类型检查我们将逐层拆解 Hammox 的 Protocol 类型判定机制。先认识 Hammox给 mock 加上契约很多 Elixir 开发者用 Mox 做 mock 时都踩过这个坑行为behaviour的契约改了mock 没跟上测试依然是绿的可一接上真实实现就炸了。Hammox 在 Mox 之上做了一件事用 behaviour 里的 typespec在运行时自动校验 mock 和实现的入参与返回值。它解决的核心问题正是契约被悄悄打破这类隐蔽 bug并抛出一个信息量很大的Hammox.TypeMatchError帮你快速定位问题。 有新手会问我已经有 Dialyzer 做静态类型检查了还需要 Hammox 吗答案是需要。Dialyzer 是静态分析看不到 Mox 风格的 mockHammox 是动态契约测试工具两者互补。一个反直觉的例子:atom vs Enumerable.t()Hammox 的测试支撑文件test/support/behaviour.ex中定义了这样一个回调callback foo_protocol_remote_type() :: Enumerable.t()在test/hammox_test.exs的 protocol 相关测试里返回值[]能通过而:a一个 atom会被拦截** (Hammox.TypeMatchError) Returned value :a does not match type Enumerable.t(). Value :a does not implement the Enumerable protocol.这里的困惑点在于Enumerable.t()的底层定义看起来像term()万物皆 term为什么:atom反而过不了揭秘Hammox 的 Protocol 类型判定三步走核心判定逻辑集中在 type_engine 这个类型匹配引擎中源码路径lib/hammox/type_engine.ex处理流程可以概括为三步。第 1 步识别出这是一个远端类型remote_typeEnumerable.t()不是一个原子类型而是引用了另一个模块中的类型定义编译后在类型 AST 里表现为remote_type。Hammox 的TypeEngine.match_type/2遇到它时会走进专门的分支而不是按atom、map、list这些内置类型去处理。第 2 步impl_for 探测——它是协议吗这是问题的关键。Hammox 会先检查该模块是否是一个Protocol模块里同时导出了__protocol__/1和impl_for/1两个函数就说明它是协议。确认是协议后Hammox 直接调用Enumerable.impl_for(value)探测这个值是否实现了该协议返回非 nil → 探测通过继续下一步返回 nil → 立刻返回:protocol_type_mismatch错误。:atom之所以失败正是死在这一步Elixir 没有为 atom 实现Enumerable协议impl_for返回了 nil。这也是 Hammox 的官方设计立场README 中Protocol types一节有明确说明协议上的t()类型在 Hammox 看来就意味着实现了该协议的值比按底层类型定义宽松放行要严格得多。第 3 步解析真实类型定义递归匹配对于非协议类型或协议探测通过后Hammox 会通过Code.Typespec.fetch_types/1取出目标模块的类型定义把类型变量替换成实际参数再递归调用match_type/2逐层比对。解析结果会写入:persistent_term缓存见lib/hammox/cache.ex所以同样的类型在多次测试中只解析一次性能开销很小。怎么读懂 TypeMatchError 的报错错误信息的人性化翻译由lib/hammox/type_match_error.ex完成。它的排版很有讲究是一棵原因树顶层最外层的不匹配比如返回值不符合Enumerable.t()缩进的下一层具体原因比如该值没有实现 Enumerable 协议。所以排查时先看顶层定位是入参还是返回值出问题再顺着缩进读具体原因几秒钟就能定位到字段级别。新手常见疑问 FAQ某个 mock 想临时跳过类型检查怎么办Hammox 本身就依赖 Mox。你只需要对那一个 mock 直接使用原生 Mox如import Mox两者可以无缝共存互不影响。匿名函数类型的检查深度如何按 README 的Limitations说明typespec 中的匿名函数只检查 arity元数参数类型与返回类型不做检查。protect 和 expect 有什么区别expect/stub用于 mock 场景Hammox 会自动套用其对应 behaviour 的 typespec入口在lib/hammox.exHammox.protect/2、/3用于真实实现返回一个加了保护壳的匿名函数可配合setup_all批量使用use Hammox.Protect见lib/hammox/protect.ex宏写法像import一样直接使用受保护的函数适合图省事的团队。想看源码从这几个文件入手文件路径职责lib/hammox.ex主入口protect、expect、stub、typespec 获取lib/hammox/type_engine.ex类型匹配引擎Protocol 探测在这里lib/hammox/protect.ex宏方式批量保护函数lib/hammox/type_match_error.ex错误信息的人类可读化lib/hammox/cache.ex基于 persistent_term 的类型缓存test/hammox_test.exs含 protocol remote type 的判定测试test/support/behaviour.ex定义了Enumerable.t()回调的测试行为总结三句话记住 Protocol 判定机制:atom过不了Enumerable.t()因为 Hammox 把协议的t()解释为实现了该协议的值而不是宽松的底层类型判定流程三步走识别 remote_type →impl_for/1探测协议实现 → 解析类型定义并递归匹配遇到Hammox.TypeMatchError先看顶层定方向入参/返回值再按缩进读具体原因修复效率最高。掌握这套机制后你就不只会绕过报错而是能准确判断契约该改 mock、该改实现、还是该改 typespec 本身。【免费下载链接】hammox automated contract testing via type checking for Elixir functions and mocks项目地址: https://gitcode.com/gh_mirrors/ha/hammox创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考