Ent框架中GraphQL突变操作的字段排除技巧
2025-05-14 13:21:11作者:滑思眉Philip
概述
在使用Ent框架的GraphQL生成工具时,开发者经常会遇到需要从突变(Mutation)操作中排除某些字段的需求。这些字段通常是用于系统内部管理的元数据字段,如创建时间(created_at)、更新时间(updated_at)和ID等,它们应该由系统自动维护而不允许通过API直接修改。
常见场景
在实际开发中,我们经常会定义一些基础字段作为Mixin混入到多个实体中。这些字段包括:
- 创建时间(create_time):记录数据创建时间戳
- 更新时间(update_time):记录最后更新时间戳
- ID:唯一标识符
这些字段通常具有以下特点:
- 创建时间在记录创建时自动设置为当前时间,之后不可更改
- 更新时间在记录创建和每次更新时自动设置为当前时间
- ID由系统自动生成,不允许修改
解决方案
Ent框架提供了entgql.Skip注解来优雅地解决这个问题。开发者可以通过这个注解精确控制哪些字段应该从GraphQL的突变输入类型中排除。
基本用法
在字段定义中添加entgql.Skip注解,并指定要跳过的突变类型:
field.Time("create_time").
Default(time.Now).
Immutable().
Annotations(
entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
entgql.OrderField("CREATE_TIME"),
),
在Mixin中使用
对于混入多个实体的公共字段,可以在Mixin中统一配置:
func (CommonMixin) Fields() []ent.Field {
return []ent.Field{
field.Time("create_time").
Default(time.Now).
Immutable().
Annotations(
entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
entgql.OrderField("CREATE_TIME"),
),
field.Time("update_time").
Default(time.Now).
UpdateDefault(time.Now).
Immutable().
Annotations(
entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
entgql.OrderField("UPDATE_TIME"),
),
field.UUID("id", uuid.Nil).
Default(UUIDV7DefaultFn).
Immutable().
Annotations(
entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
),
}
}
使用mixin.AnnotateFields
对于已经定义好的Mixin,可以使用mixin.AnnotateFields来添加注解:
func (T) Mixin() []ent.Mixin {
return []ent.Mixin{
mixin.AnnotateFields(
mixin.Time{},
entgql.Skip(entgql.SkipMutationCreateInput|entgql.SkipMutationUpdateInput),
),
}
}
注意事项
- 使用
entgql.Skip只会从突变输入类型中排除字段,不会影响查询和排序功能 - 与
sensitive注解不同,被跳过的字段仍然会在查询结果中可见 - 建议同时使用
Immutable()来确保这些字段在业务逻辑层也无法被修改 - 对于ID字段,除了跳过突变外,还应该设置合适的默认值生成函数
最佳实践
- 将公共字段集中定义在Mixin中统一管理
- 为时间戳字段设置合适的默认值和更新逻辑
- 同时使用Immutable和Skip注解提供双重保护
- 为排序常用的字段添加OrderField注解
- 在文档中明确说明这些系统字段的行为
通过合理使用entgql.Skip注解,开发者可以构建出更加健壮和安全的GraphQL API,同时保持代码的整洁和一致性。
登录后查看全文
热门项目推荐
相关项目推荐
Kimi-K2.5Kimi K2.5 是一款开源的原生多模态智能体模型,它在 Kimi-K2-Base 的基础上,通过对约 15 万亿混合视觉和文本 tokens 进行持续预训练构建而成。该模型将视觉与语言理解、高级智能体能力、即时模式与思考模式,以及对话式与智能体范式无缝融合。Python00
GLM-4.7-FlashGLM-4.7-Flash 是一款 30B-A3B MoE 模型。作为 30B 级别中的佼佼者,GLM-4.7-Flash 为追求性能与效率平衡的轻量化部署提供了全新选择。Jinja00
VLOOKVLOOK™ 是优雅好用的 Typora/Markdown 主题包和增强插件。 VLOOK™ is an elegant and practical THEME PACKAGE × ENHANCEMENT PLUGIN for Typora/Markdown.Less00
PaddleOCR-VL-1.5PaddleOCR-VL-1.5 是 PaddleOCR-VL 的新一代进阶模型,在 OmniDocBench v1.5 上实现了 94.5% 的全新 state-of-the-art 准确率。 为了严格评估模型在真实物理畸变下的鲁棒性——包括扫描伪影、倾斜、扭曲、屏幕拍摄和光照变化——我们提出了 Real5-OmniDocBench 基准测试集。实验结果表明,该增强模型在新构建的基准测试集上达到了 SOTA 性能。此外,我们通过整合印章识别和文本检测识别(text spotting)任务扩展了模型的能力,同时保持 0.9B 的超紧凑 VLM 规模,具备高效率特性。Python00
KuiklyUI基于KMP技术的高性能、全平台开发框架,具备统一代码库、极致易用性和动态灵活性。 Provide a high-performance, full-platform development framework with unified codebase, ultimate ease of use, and dynamic flexibility. 注意:本仓库为Github仓库镜像,PR或Issue请移步至Github发起,感谢支持!Kotlin07
compass-metrics-modelMetrics model project for the OSS CompassPython00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
523
3.72 K
Ascend Extension for PyTorch
Python
329
388
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
877
578
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
335
161
暂无简介
Dart
762
188
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.33 K
745
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
12
1
React Native鸿蒙化仓库
JavaScript
302
349
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
113
136