展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > C#怎么实现REPR端点模式_C# FastEndpoints最小API教程【进阶】

C#怎么实现REPR端点模式_C# FastEndpoints最小API教程【进阶】

REPR模式(Request-Endpoint-Response)通过显式定义TResponse类确保Swagger文档与类型安全;路径动词需准确,否则404;Pre/PostProcessor在固定生命周期执行且不可修改响应体;DTO验证失败由FluentValidation自动返回400,无需手动抛异常。

本文目录

    说 REPR 之前,得先澄清一件事——它并不是什么框架内置的抽象接口,更不是 C# 语言自带的特性。这是 FastEndpoints 社区对端点组织逻辑的一种模式归纳:Request → Endpoint → Response。它不强制你非得把代码拆成三个文件,但一旦你按照这个结构来组织,路由、验证、序列化、日志、测试这些事,自然就解耦了。别被名字吓到,直接上手用起来就好。

    Endpoint 是 REPR 的落地载体

    这是最贴近 REPR 设计意图的基类。它显式声明了输入和输出的契约,编译期就能约束好类型流,比 EndpointWithoutRequest 或者裸的 Endpoint 更适合那些 API 契约明确的场景。

    经常有人踩的坑是:SendAsync(new { ... }) 直接返回匿名对象。后果就是,Swagger 文档里看不到响应结构,前端生成的 TypeScript 客户端也缺字段,单元测试更是无从下手 mock。

    正确的做法是:

    • 必须定义一个具名的 TResponse 类(哪怕里面就一个字段),否则 FastEndpoints.Swagger 没法推导出 200 的响应体。
    • 在 HandleAsync 方法里,调用 SendAsync(new MyResponse { ... }) 来返回响应。不是 return,不是 Ok(),也不是 Results.Ok()。
    • 如果需要返回其他状态码,比如 400,就用 SendNotFound()、SendValidationFailure() 这些内置方法。它们会自动匹配对应的 HTTP 状态,并且保留 TResponse 的类型上下文。

    Configure() 里写错动词或路径,端点会直接“消失”

    FastEndpoints 不像传统控制器那样靠扫描来注册路由。它是通过 Configure 方法里的 Get、Post、Patch 这些调用来注册端点的。只要漏写、拼错、或者多写了一个斜杠,这个 API 就 404 了,而且连个提示都不会有。

    几个典型的翻车现场:

    • Post("/api/user") 和 Post("api/user") —— 后者少了开头的 /,会被注册成相对路径,实际上根本不会生效。
    • Get("/users/{id}") 但是 DTO 里没声明 public string id { get; set; } —— 运行时参数绑定失败,直接返回 400,控制台却一声不吭。
    • 多个端点用了同一个路径加动词 —— 后注册的会静默地把前一个覆盖掉。没有编译错误,启动日志里也看不出任何异常。

    一个实用的建议:在 Configure 方法的结尾,显式地加上 AllowAnonymous() 或 RequireAuthorization() 来声明权限,避免因为中间件执行顺序的问题,导致认证拦截被莫名其妙地跳过。

    PreProcessor / PostProcessor 不是装饰器,是独立的生命周期阶段

    IPreProcessor 和 IPostProcessor 的执行时机是固定的:Pre 在模型绑定之后、HandleAsync 之前执行;Post 在 SendAsync 被调用之后、响应被写出之前执行。它们不能修改 HandleAsync 的返回值,也不能中途终止流程(除非你抛异常)。

    这里有几个容易中招的地方:

    • 在 PreProcessor 里直接调用 ctx.HttpContext.Response.WriteAsync() —— 这会导致冲突。因为后续 SendAsync 还会尝试再次写入响应体,从而触发 System.InvalidOperationException: Headers are read-only。
    • 想做请求日志,但 ctx.Request 是已经反序列化后的对象。如果请求里包含敏感字段(比如密码),它们可能已经被脱敏了,这时候日志内容和原始的 JSON 字符串对不上。
    • 在 PostProcessor 里试图修改 ctx.Response 的属性 —— 这时候响应体都已经序列化完成了,改了也没用。你只能改改 Header 或者 StatusCode。

    DTO 验证失败时,别手动 throw ValidationException

    FastEndpoints 默认就集成了 FluentValidation。只要你的 TRequest 类有对应的 IValidator 实现,验证失败后,框架会自动返回 400 状态码,并附带格式化的错误详情(一个 ValidationFailure 数组)。你要是手动去 throw 一个异常,反而会让全局异常中间件接管,把标准错误结构给搞丢了。

    几个关键点值得留意:

    • 验证器的类名必须是 TRequest 的名字加上 Validator(比如 MyRequestValidator),否则不会被自动发现。
    • 验证器构造函数里注入的服务(比如 ILogger)会被正确解析,不需要额外配置。
    • 如果你想自定义 400 响应的格式,应该重写端点的 OnValidationFailure 方法,而不是去拦截异常。

    真正麻烦的地方在于:当 DTO 里包含嵌套对象或者集合时,FluentValidation 产生的错误路径(PropertyName)默认是 Address.Street 这种格式。但前端的表单通常按 address.street 来绑定。这就需要在验证器里显式调用 OverridePropertyName,或者统一转换成小驼峰格式,否则错误信息定位会不准,给前端调试带来麻烦。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 C#
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。