Dialyxir宏代码转换类型检查问题及实现方案问询

1. Dialyzer是否应该检测非可执行配置的类型错误？ #

不会。Dialyzer是针对可执行代码/BEAM字节码的静态分析工具，核心是分析函数调用、类型规范与代码路径的一致性。如果宏输出的是纯粹的数据结构（比如配置列表、映射），而非可执行的函数调用或代码逻辑，Dialyzer无法自动关联这些数据和后续消费它们的函数的类型要求——因为这些数据本身只是静态值，Dialyzer不知道你会用什么规则处理它们。

举个例子：你生成的配置里包含["string", "wrong_atom"]，但只要这段配置没有直接作为参数传入SomeModule.run/2，Dialyzer不会主动检查它是否符合run/2的binary(), atom()参数类型要求。

2. 同时实现配置生成与Dialyzer类型检查的方法 #

为配置定义明确的类型规范 #

先用@type定义配置的结构类型，再为生成配置的宏添加@spec约束，让Dialyzer能识别配置的预期类型：

defmodule ConfigGenerator do
  @type run_config_entry :: %{
          func: (binary(), atom() -> any()),
          args: [binary(), atom()]
        }

  @spec generate_run_config() :: [run_config_entry()]
  defmacro generate_run_config do
    quote do
      [
        %{func: &SomeModule.run/2, args: ["valid_binary", :valid_atom]},
        # 如果这里写成["valid_binary", "invalid_string"]，Dialyzer会报错
        %{func: &SomeModule.run/2, args: ["valid_binary", "invalid_string"]}
      ]
    end
  end
end

在配置消费处绑定类型约束 #

当代码中使用生成的配置时，为消费函数添加@spec，让Dialyzer检查传入的配置是否符合类型要求：

defmodule ConfigExecutor do
  @type run_config_entry :: %{
          func: (binary(), atom() -> any()),
          args: [binary(), atom()]
        }

  @spec execute_config([run_config_entry()]) :: :ok
  def execute_config(config) do
    Enum.each(config, fn %{func: func, args: args} ->
      apply(func, args)
    end)
    :ok
  end
end

# 使用时，Dialyzer会检查generate_run_config()的返回值是否匹配execute_config的输入类型
ConfigExecutor.execute_config(ConfigGenerator.generate_run_config())

编译时主动验证配置 #

在宏内部添加编译阶段的类型验证逻辑，直接在编译时抛出错误，提前拦截问题：

defmacro generate_run_config do
  raw_config = [
    %{func: &SomeModule.run/2, args: ["test", :valid]},
    %{func: &SomeModule.run/2, args: ["test", "invalid"]}
  ]

  # 编译时检查每个配置项的参数类型
  Enum.each(raw_config, fn %{args: [bin, atom]} ->
    unless is_binary(bin) and is_atom(atom) do
      raise ArgumentError, "Invalid args in config: expected binary and atom, got #{inspect(bin)} and #{inspect(atom)}"
    end
  end)

  quote do: unquote(raw_config)
end

这种方式不需要依赖Dialyzer，在编译宏时就会直接报错，适合对配置正确性要求高的场景。

利用函数引用的类型推导 #

如果配置中包含函数引用（比如&SomeModule.run/2），可以让Dialyzer通过函数引用的类型推导参数类型。比如将配置的args类型直接绑定到函数的参数类型：

@type config_entry_for_fun(fun) :: %{
          func: fun,
          args: tuple_to_list(:erlang.element(2, :erlang.fun_info(fun, :type)))
        }

# 这样当你指定func为&SomeModule.run/2时，args会被约束为[binary(), atom()]

内容的提问来源于stack exchange，提问作者denis.peplin