Ent框架中GraphQL突变操作的字段排除机制

概述

在使用Ent框架的GraphQL生成工具时，开发者经常会遇到需要限制某些字段在GraphQL突变操作中不可修改的需求。特别是对于数据库管理字段如created_at、updated_at和id等，这些字段通常应该由系统自动维护，而不应该通过GraphQL API暴露给客户端修改。

问题背景

在Ent框架中，当使用GraphQL生成工具时，默认情况下所有字段都会包含在GraphQL模式中，包括创建和更新操作的输入类型。这对于某些系统管理字段来说可能不是理想的行为，因为这些字段应该：

1. 在查询结果中可见
2. 可用于排序操作
3. 但不应允许通过突变操作修改

解决方案

Ent框架提供了entgql.Skip注解来解决这个问题。这个注解可以精确控制哪些字段应该从GraphQL的哪些部分中排除。

基本用法

func (T) Mixin() []ent.Mixin {
    return []ent.Mixin{
        mixin.AnnotateFields(
            mixin.Time{},
            entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
        ),
    }
}

注解选项

entgql.Skip支持以下选项组合：

• SkipMutationCreateInput - 从创建突变输入中排除字段
• SkipMutationUpdateInput - 从更新突变输入中排除字段
• 可以使用位或操作符|组合多个选项

实际应用示例

对于常见的数据库管理字段，可以这样定义：

func (CommonMixin) Fields() []ent.Field {
    return []ent.Field{
        field.Time("created_at").
            Default(time.Now).
            Immutable().
            Annotations(
                entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
                entgql.OrderField("CREATED_AT"),
            ),
        field.Time("updated_at").
            Default(time.Now).
            Immutable().
            UpdateDefault(time.Now).
            Annotations(
                entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
                entgql.OrderField("UPDATED_AT"),
            ),
        field.UUID("id").
            Default(uuid.New).
            Immutable().
            Annotations(
                entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
            ),
    }
}

注意事项

1. entgql.Skip只影响GraphQL模式生成，不会影响数据库层面的约束
2. 即使排除了字段，它们仍然会出现在查询结果中
3. 排除的字段仍然可以用于排序和过滤操作
4. 建议同时使用Immutable()来确保数据库层面的保护

最佳实践

对于系统管理字段，推荐同时使用以下保护措施：

1. GraphQL层面：使用entgql.Skip排除突变操作
2. 数据库层面：使用Immutable()防止直接修改
3. 业务逻辑层面：在必要时添加额外的验证

通过这种多层次的保护，可以确保关键系统字段不会被意外或恶意修改。