Ash框架中手动操作访问私有属性的最佳实践

Ash框架作为一个强大的Elixir资源管理工具，在3.0版本中引入了一个重要变更：默认将私有字段设置为public?: false。这一变更虽然增强了安全性，但也带来了一些开发上的挑战，特别是在需要手动操作访问这些私有字段的场景下。

问题背景

在开发博客系统的Page资源时，我们经常会遇到需要创建新页面的场景。一个典型的实现方式是先检查是否存在没有slug的页面，如果没有才创建新页面。这种业务逻辑通常需要手动操作来实现。

action :new, :uuid do
  run(fn _, _ ->
    case(
      __MODULE__
      |> Ash.Query.filter(Ash.Expr.expr(is_nil(slug)))
      |> Ash.read_one()
    ) do
      {:ok, nil} ->
        {:ok, page} =
          %{
            title: "New Page",
            slug: nil,
            raw: "",
            rendered: ""
          }
          |> __MODULE__.create()

        {:ok, page.id}

      {:ok, page} ->
        {:ok, page.id}
    end
  end)
end

这段代码在Ash 3.0中会抛出NoSuchInput错误，因为框架默认阻止了对私有字段的直接访问。

解决方案

Ash框架提供了灵活的属性访问控制机制，开发者可以通过以下几种方式解决这个问题：

1. 显式声明可接受的输入字段： 使用accept关键字明确指定操作可以接收哪些字段作为输入，即使这些字段是私有的。

actions do
  create :create do
    accept [:title, :slug, :raw, :rendered]
  end
end

2. 避免使用通配符： 在3.0版本中，:*通配符仅适用于公共属性。对于需要访问私有字段的场景，应该使用明确的字段列表。

# 不推荐
defaults [:read, :destroy, create: :*, update: :*]

# 推荐
defaults [:read, :destroy, create: [:title, :slug, :raw, :rendered], update: [:title, :slug, :raw, :rendered]]

最佳实践

1. 最小权限原则：只为操作接受确实需要的字段，而不是全部字段。

2. 分离关注点：为不同的业务场景设计专门的操作，而不是依赖通用操作。

3. 文档注释：为每个操作添加文档说明，明确指出它接受的字段和预期行为。

4. 测试验证：编写测试用例验证私有字段在手动操作中的行为是否符合预期。

通过遵循这些最佳实践，开发者可以在保持Ash框架安全性的同时，灵活地处理各种业务场景中的私有字段访问需求。