自动为模式提供更好的 Jason 编码器

Question

我收到了这个警告

警告：Jason.Encoder 协议已经整合，Any 的实现无效。如果您想在编译后或测试期间实现协议，请查看 Kernel.defprotocol/2 文档中的“合并”部分 lib/encoder.ex:1

警告：重新定义模块 Jason.Encoder.Any（从 /Users/dev/projects/haitracker.com/haitracker-be/_build/dev/lib/jason/ebin/Elixir.Jason.Encoder 加载的当前版本.Any.beam) lib/encoder.ex:1

使用以下编码器

defimpl Jason.Encoder, for: Any do
  def encode(%{__struct__: _} = struct, _options) do
    skip_keys =
      case struct.__struct__ do
        Haitracker.User ->
          [
            :local_password_hash,
            :login_status_message
          ]

        # TODO: define skip keys for each model and pass to this function
        _whatever ->
          []
      end

    struct
    |> Map.from_struct()
    |> sanitize_map(skip_keys)
    |> Jason.encode!()
  end

  defp sanitize_map(map, skip_keys) do
    filter = fn {key, val} ->
      cond do
        key in [:__meta__, :__struct__] ->
          false

        is_map(val) ->
          Ecto.assoc_loaded?(val)

        key not in skip_keys ->
          true

        true ->
          false
      end
    end

    map
    |> Enum.filter(filter)
    |> Enum.into(%{})
  end
end

我想知道是否有更好的方法来编码我使用 Jason 的所有模式，只需一个编码器配置文件，以便在一个地方定义所有编码选项。

Answer 1

你显然不允许破坏默认的Jason 实现任何东西。你应该明确告诉Jason 你的结构是如何被序列化的。

摘自Jason README：

如果你需要对一些没有实现协议的结构进行编码，如果你拥有该结构，你可以派生指定哪些字段应该编码为 JSON 的实现：

@derive {Jason.Encoder, only: [....]}
defstruct # ...

也就是说，您应该使用@derive 模块属性明确指定要过滤掉的字段。