Livebook 中使用 Ecto 复合类型(TypeID)的注意事项

问题背景

在使用 Livebook 进行 Elixir 开发时，开发者可能会遇到 Ecto 模型加载失败的问题，特别是当模型使用了复合类型(TypeID)作为主键或外键时。TypeID 是一种用于增强 UUID 可读性的复合类型，它结合了类型前缀和 UUID 值。

典型错误表现

当在 Livebook 中尝试加载使用 TypeID 作为主键或外键的 Ecto 模型时，可能会遇到类似以下的错误：

** (ArgumentError) cannot load `<<1, 148, 110, 151, 128, 191, 127, 35, 189, 106, 236, 14, 17, 10, 40, 163>>` as type #TypeID<%{type: :string, prefix: nil, field: :account, schema: Mailcast.Models.Domain}> for field :account_id in #Mailcast.Models.Domain<...>

问题根源分析

这个问题的根本原因通常不是 Livebook 本身的问题，而是 TypeID 库的配置不完整。TypeID 需要正确的配置才能正常工作，特别是在以下方面：

1. 前缀配置：TypeID 通常需要一个类型前缀来增强可读性
2. 类型转换：需要正确定义如何将数据库原始值转换为 TypeID 类型

解决方案

要解决这个问题，需要确保正确配置 TypeID 库。以下是关键配置步骤：

1. 在项目的配置文件中添加 TypeID 的全局配置
2. 为每个使用 TypeID 的模型指定正确的前缀
3. 确保数据库字段类型与 TypeID 配置匹配

配置示例

# 在 config/config.exs 中添加
config :typeid,
  default_prefix: "default",
  type_map: %{
    "dom" => Mailcast.Models.Domain,
    "acc" => Mailcast.Models.Account
  }

模型定义示例

defmodule Mailcast.Models.Domain do
  use Ecto.Schema
  
  @primary_key {:domain_id, TypeID, prefix: "dom", type: :uuid, autogenerate: true}
  @foreign_key_type TypeID
  
  schema "domains" do
    field :name, :string
    field :valid, :boolean
    field :sending_enabled, :boolean
    # 其他字段...
  end
end

最佳实践

1. 始终为 TypeID 指定明确的前缀
2. 在测试环境中验证 TypeID 的加载和存储
3. 确保所有开发环境使用相同的配置
4. 考虑为 TypeID 添加自定义类型转换函数

总结

在 Livebook 中使用 Ecto 复合类型(TypeID)时，配置是关键。通过正确配置 TypeID 库，可以避免模型加载失败的问题，并充分利用 TypeID 提供的可读性优势。开发者应当仔细检查 TypeID 的配置，确保所有必需参数都已正确设置。