FastEndpoints中ProblemDetails的最佳实践:处理业务逻辑错误
2025-06-08 09:22:34作者:郜逊炳
在FastEndpoints框架中,RFC7807标准的ProblemDetails不仅适用于输入验证错误,同样适用于业务逻辑错误的处理。本文将详细介绍如何优雅地使用FastEndpoints的错误处理机制来构建符合标准的API响应。
错误处理的统一范式
FastEndpoints框架实现了RFC7807标准的问题详情规范,这个规范并没有区分输入验证错误和业务逻辑错误。这意味着开发者可以使用相同的机制来处理各种类型的错误,保持API响应的一致性。
业务逻辑错误的处理方式
在实际开发中,我们经常需要处理各种业务逻辑错误,例如:
- 用户邮箱未验证
- 账户被锁定
- 用户没有分配角色等
在FastEndpoints中,可以通过AddError
和ThrowIfAnyErrors
方法来处理这些错误。虽然这些方法最初设计用于DTO验证(产生400 Bad Request响应),但它们同样适用于业务逻辑错误。
简洁的错误抛出方式
从FastEndpoints v6.1.0-beta.6版本开始,提供了更简洁的错误抛出方式:
ThrowError("账户已被锁定!", errorCode: "AccountLocked", statusCode: 423);
这个方法一次性完成了错误信息添加、错误码设置和状态码指定的操作,大大简化了代码。
错误分类与客户端处理
在ProblemDetails响应中,错误可以分为两类:
- 字段特定错误:错误信息关联到特定表单字段,客户端可以将其显示在相应输入框旁边
- 通用错误:字段名为"generalErrors"(可自定义)的错误,适用于不直接关联特定输入字段的问题
通过errorCode
参数,开发者可以进一步分类通用错误,使客户端能够根据错误码做出更细致的处理决策。
实际应用示例
以下是处理用户登录时各种业务逻辑错误的典型示例:
if (!user.EmailConfirmed)
{
ThrowError("请先验证您的邮箱地址", errorCode: "EmailNotConfirmed", statusCode: 403);
}
if (await _userService.IsUserLockedOutAsync(user))
{
ThrowError("您的账户已被锁定,请联系支持", errorCode: "AccountLocked", statusCode: 423);
}
var roles = await _userService.GetUserRolesAsync(user);
if (roles == null || !roles.Any())
{
ThrowError("您的账户未分配任何角色,请联系管理员", errorCode: "NoRolesAssigned", statusCode: 403);
}
总结
FastEndpoints提供了灵活且符合标准的错误处理机制,使开发者能够:
- 统一处理各种类型的错误
- 使用简洁的API抛出业务逻辑错误
- 通过错误码实现精细的错误分类
- 保持API响应符合RFC7807标准
这种设计既保持了代码的简洁性,又为客户端提供了足够的信息来进行适当的错误处理和用户提示。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VL
PaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
openPangu-Ultra-MoE-718B-V1.1
昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++0135AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00Spark-Scilit-X1-13B
FLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile011
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
最新内容推荐
JavaWeb企业门户网站源码 - 企业级门户系统开发指南 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案 IEC61850建模工具及示例资源:智能电网自动化配置的完整指南 海能达HP680CPS-V2.0.01.004chs写频软件:专业对讲机配置管理利器 WebVideoDownloader:高效网页视频抓取工具全面使用指南 Python开发者的macOS终极指南:VSCode安装配置全攻略 瀚高迁移工具migration-4.1.4:企业级数据库迁移的智能解决方案 TJSONObject完整解析教程:Delphi开发者必备的JSON处理指南 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 电脑PC网易云音乐免安装皮肤插件使用指南:个性化音乐播放体验
项目优选
收起

deepin linux kernel
C
23
6

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
231
2.32 K

仓颉编译器源码及 cjdb 调试工具。
C++
112
78

React Native鸿蒙化仓库
JavaScript
216
291

暂无简介
Dart
532
117

仓颉编程语言运行时与标准库。
Cangjie
122
93

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
993
588

Ascend Extension for PyTorch
Python
75
105

仓颉编程语言测试用例。
Cangjie
34
61

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
401