0

我有一种行为来抽象解析各种 Phoenix 端点的 URL 查询参数。它看起来像这样：

defmodule Query do
  @callback from_query_params(params :: %{optional(String.t()) => any()}) ::
              {:ok, parsed :: struct} | {:error, reason :: atom}
end

一个简单的实现如下所示：

defmodule SearchQuery do
  @moduledoc "Parses URL query params for search endpoint"
  @behaviour Query

  @enforce_keys [:search_term]
  defstruct @enforce_keys

  @typespec t :: %__MODULE__{search_term: String.t()}

  @impl Query
  def from_query_params(%{"query" => query}) when query != "" do
    {:ok, %__MODULE__{search_term: query}}
  end

  def from_query_params(_), do: {:error, :missing_search_term}
end

我在这里真正想说的是：

  • 实现模块应该提供一个结构（调用它t()）
  • 成功类型from_query_params/1应该使用那个struct t()，而不仅仅是任何 struct

我怀疑 Elixir 类型规范语言中没有办法表达这一点，但我很高兴被证明是错误的。

4

1 回答 1

3

虽然不可能在 typespec 中表达这一点，但可以通过一些元编程来部分覆盖需求。

如果您对每个实现都有自己的Query行为来区分返回类型感到满意，则可以使用

defmodule QueryBuilder do
  defmacro __using__(opts \\ []) do
    quote do
      impl = __MODULE__
      defmodule Query do
        @callback from_query_params(map()) :: {:ok, %unquote(impl){}}

        def __after_compile__(env, _bytecode),
          do: env.module.__struct__
      end

      @behaviour Query
      @after_compile Query
    end
  end
end

而不是@behaviour Query，使用use QueryBuilder. 这样，嵌套Query模块将具有正确的返回类型，并且如果目标模块未声明结构，编译器回调将引发。

于 2022-02-01T17:47:14.370 回答