如何在Ecto模型中验证map字段是否包含指定键（而非控制器中）

嘿，这个需求我太熟了！Ecto内置的验证确实大多针对简单字段，但咱们完全可以自己写个自定义验证函数，把逻辑全放在模型里，不用去控制器里手动判断加错误。

方法：自定义验证函数 #

核心思路是在你的Ecto模型里写一个私有函数，专门检查map字段是否包含必填键，然后在changeset流程里调用它就行。

单必填键的情况 #

先给你个基础版，针对单个必填键的验证：

defmodule YourApp.YourModel do
  use Ecto.Schema
  import Ecto.Changeset

  schema "your_table" do
    field :data_map, :map # 这是你要存的map字段，对应JSON数据源
    # 其他字段...
  end

  @doc false
  def changeset(struct, attrs) do
    struct
    |> cast(attrs, [:data_map])
    |> validate_required_key(:data_map, :required_key) # 调用自定义验证
    # 其他内置验证...
  end

  # 自定义验证函数：检查指定map字段是否包含必填键
  defp validate_required_key(changeset, field, required_key) do
    get_change(changeset, field)
    |> case do
      # 如果map字段没被修改（或者原本是nil），可以根据需求选择是否报错
      # 这里默认不报错，如果你要求这个字段必须存在且有键，可以先加validate_required(:data_map)
      nil -> changeset
      # 确认是map类型后，检查键是否存在
      map when is_map(map) ->
        if Map.has_key?(map, required_key) do
          changeset
        else
          add_error(changeset, field, "必须包含键 #{inspect(required_key)}")
        end
      # 不是map类型的情况，直接报错
      _ ->
        add_error(changeset, field, "必须是有效的map格式")
    end
  end
end

多必填键的扩展版 #

如果需要检查多个必填键，稍微改一下函数就能支持：

defp validate_required_keys(changeset, field, required_keys) when is_list(required_keys) do
  get_change(changeset, field)
  |> case do
    nil -> changeset
    map when is_map(map) ->
      # 找出所有缺失的键
      missing_keys = Enum.filter(required_keys, &(!Map.has_key?(map, &1)))
      if Enum.empty?(missing_keys) do
        changeset
      else
        add_error(changeset, field, "必须包含以下键：#{inspect(missing_keys)}")
      end
    _ ->
      add_error(changeset, field, "必须是有效的map格式")
  end
end

调用的时候就传键的列表：

|> validate_required_keys(:data_map, [:key1, :key2, :key3])

额外说明 #

• 如果你要求data_map字段本身必须存在（不能为nil），记得先加validate_required(:data_map)，再调用自定义验证。
• 因为你的数据源是JSON，Ecto的:map类型会自动把合法的JSON转成Elixir Map，如果传入的JSON格式无效，cast步骤会先抛出错误，自定义验证只处理格式正确但缺键的情况。

内容的提问来源于stack exchange，提问作者xji