Elixir 如何查找所有通过自定义特定宏定义的函数
实现自定义宏定义函数的全量追踪方案
核心前提
BEAM 层面,自定义宏最终展开生成的函数和原生 def 定义的函数没有任何可区分的元数据,事后扫描模块导出函数的方案100%无法区分函数来源,必须在宏展开的编译阶段就埋入可追溯的标记,才能实现精准筛选。
具体实现步骤
1. 改造宏,增加元数据埋点
调整原来的 DefFooModule,新增自动注册持久化模块属性的逻辑,在宏生成函数的同时,把被定义函数的元信息写入模块的可持久化属性中,完全复用你原本设想的 :application.get_key 拿全应用模块的思路:
defmodule DefFooModule do # 自动注入模块属性注册逻辑 defmacro __using__(_opts) do quote do # 注册持久化、可累积的模块属性,用于存储所有deffoo定义的函数元信息 Module.register_attribute( __MODULE__, :deffoo_functions, accumulate: true, persist: true ) end end defmacro deffoo(head, body) do # 从函数头拆解函数名和参数元数 {func_name, arity} = case head do {name, _, args} when is_list(args) -> {name, length(args)} end quote bind_quoted: [func_name: func_name, arity: arity] do # 将当前函数元信息写入自定义模块属性 @deffoo_functions {__MODULE__, func_name, arity} # 保留原有函数定义逻辑 def unquote(head) do unquote(body[:do]) end end end def find_all_foos do {:ok, modules} = :application.get_key(:your_app_name, :modules) modules # 遍历所有应用内模块,读取持久化的deffoo标记 |> Enum.flat_map(fn module -> case module.__info__(:attributes)[:deffoo_functions] do nil -> [] funcs -> funcs end end) # 格式化为「模块.函数/元数」格式 |> Enum.map(fn {mod, func, arity} -> "#{mod}.#{func}/#{arity}" end) end end
关键参数说明:
persist: true:让模块属性的值被存入beam文件的持久化元数据,编译完成后不会被清除,打包为release后也能正常读取accumulate: true:让模块属性支持多值累积,否则每次写入都会覆盖之前的内容,最终只能记录最后一个deffoo定义的函数
2. 调整业务模块的引用方式
所有需要使用 deffoo 宏的模块,需要先引入 DefFooModule 才能生效:
defmodule AnotherModule do use DefFooModule deffoo do_something do :ok end deffoo do_something_else do :ok end end defmodule AnotherModule2 do use DefFooModule deffoo do_something_2 do :ok end end
3. 运行效果
调用 DefFooModule.find_all_foos/0 即可输出符合预期的函数列表:
[ "AnotherModule.do_something/0", "AnotherModule.do_something_else/0", "AnotherModule2.do_something_2/0" ]
方案对比
- 本方案是零额外性能开销的可靠实现,只在编译期做一次元数据写入,运行期读取的是beam文件自带的元数据,没有额外反射成本
- 不推荐用AST静态扫描的方案:需要手动实现完整的Elixir宏展开、import/alias解析逻辑,复杂度高、出错率高,远不如编译期埋点的方案稳定
内容的提问来源于stack exchange,提问作者GTDev
相关产品推荐
相关产品推荐

