当前位置:

首页 > 编程开发 > C#怎么创建gRPC服务_C# ASP.NET Core gRPC通信教程【高级】

C#怎么创建gRPC服务_C# ASP.NET Core gRPC通信教程【高级】

gRPC开发陷阱:服务类需继承GreeterBase并返回Task,由Grpc.Tools自动生成基类。MapGrpcService须在UseRouting后注册且仅支持HTTP/2。ServerCallContext获取取消信号,超时返回DeadlineExceeded。EnableDetailedErrors可获取错误详情,但生产环境应关闭。

在 gRPC 服务开发中,有几个细节如果没处理好,服务端看起来“编译通过”,客户端却直接报错,或者请求超时、收不到错误详情。今天咱们就挑最常踩坑的几个点,一个一个拆开说清楚。

C#怎么创建gRPC服务_C# ASP.NET Core gRPC通信教程【高级】

先从最基础的继承关系说起。如果你写了一个 GreeterService,它必须继承自 GreeterBase,并且重写的方法返回类型必须是 Task。这不是可选项——一旦漏掉,客户端那边收到的就是 StatusCode.Unimplemented 错误,而不是你辛辛苦苦写的业务逻辑。换句话说,连服务入口都没对上。

怎么让 .proto 文件生成服务基类

关键不是手写这些基类,而是让 Grpc.Tools 在构建时自动产出 GreeterBase、HelloRequest、HelloReply 这些类型。你只需要在项目文件里放对一行配置:

  
  • GrpcServices="Server" 表示只生成服务端基类,不生成客户端存根;如果你需要同时调用其他服务,改成 Both 就行。
  • Include 路径是相对于项目根目录的,.proto 文件必须真实存在于那个位置(比如 Protos/greet.proto)。
  • 千万别手动把生成的 .cs 文件加到项目里——它们会在 obj/ 目录下临时存在,每次构建都会被覆盖,手动加进去反而会冲突。

为什么 MapGrpcService 不生效

常见原因就两个:注册顺序不对,或者中间件冲突。ASP.NET Core 要求 gRPC 端点必须在 UseRouting() 之后、UseEndpoints() 或 UseAuthorization() 之前注册。典型正确顺序长这样:

app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
app.MapGrpcService(); // 必须放在这行
app.MapControllers();
  • 如果用了 UseEndpoints,记得检查里面有没有漏掉 endpoints.MapGrpcService() 调用。
  • MapGrpcService 只对 HTTP/2 请求有效。开发时如果你用浏览器直接访问 https://localhost:5001/greet.Greeter/SayHello,肯定会失败——浏览器不支持 gRPC-Web 以外的原生 gRPC。
  • 还要确认 Program.cs 是否启用了 HTTP/2:Kestrel 默认只在 HTTPS 下启用 HTTP/2,HTTP 端口(比如 5000)默认是不支持的。

一元方法里怎么获取请求上下文和取消信号

ServerCallContext 可不是摆设——它提供了真实的运行时信息:截止时间、客户端元数据、取消 CancellationToken,这些在复杂业务场景中特别有用。比如你想在超时前主动退出耗时操作:

public override async Task SayHello(HelloRequest request, ServerCallContext context)
{
    using var cts = CancellationTokenSource.CreateLinkedTokenSource(context.CancellationToken);
    cts.CancelAfter(TimeSpan.FromSeconds(3));
    try
    {
        var result = await Hea vyWorkAsync(cts.Token); // 传入组合后的 token
        return new HelloReply { Message = $"Hello {request.Name} -> {result}" };
    }
    catch (OperationCanceledException)
    {
        throw new RpcException(new Status(StatusCode.DeadlineExceeded, "Processing timed out"));
    }
}
  • context.CancellationToken 来自客户端发起的取消信号(比如移动端断网、前端主动 abort)。
  • 不要直接 await context.CancellationToken.WaitHandle,应该把它传给支持 CancellationToken 的异步 API。
  • 如果你忽略了 context.CancellationToken,服务端就无法响应客户端的中断,时间长了会导致连接堆积和资源泄漏,这是非常隐蔽的坑。

为什么客户端收不到错误详情

默认情况下,RpcException 的 Status.Detail 字段不会被序列化到网络上——除非你在服务器端显式开启详细错误模式。注意,这个开关只应该在开发环境打开:

builder.Services.AddGrpc(options =>
{
    options.EnableDetailedErrors = true; // ⚠️ 生产环境必须关掉
});
  • 关闭后,客户端收到的 RpcException.Status 仍然包含 StatusCode 和简短消息,但 Detail 会为空。
  • 生产环境如果需要结构化错误信息,应该通过自定义状态码加上响应体字段(比如 error_code、debug_id)来传递,而不是依赖 Status.Detail。
  • 这个开关不影响 StatusCode.Unimplemented 这类底层错误的传播——它们始终可见。

最后再总结两个容易被忽略的细节:ServerCallContext 决定了你能拿到什么运行时信息,GrpcServices 属性决定了构建时生成哪些类型。漏掉任意一个,服务就只是“能编译”,而不是“能通信”。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
作者最新文章
编程开发 C#
相关文章 更多
codex安装windows教程桌面版完整安装步骤指南
codex安装windows教程桌面版完整安装步骤指南

详解如何在 Windows 电脑上通过 Microsoft Store 安装 Codex 桌面应用,包括启动登录、切换 Codex 模式、关联本地代码项目及终端环境配置的界面操作指引。

github配置ssh key windows
github配置ssh key windows

本文详解如何在Windows环境中使用PowerShell生成SSH密钥对,配置ssh-agent自动加载私钥,并将公钥安全添加至GitHub账户,最后通过git remote set-url切换为SSH地址,解决每次操作需输入账号密码的问题。

backdrop和background区别
backdrop和background区别

深入解析backdrop与background在网页开发及视觉设计中的区别。通过CSS代码示例,展示如何正确使用background设置元素背景,以及利用backdrop-filter创建弹窗遮罩模糊效果,避免概念混用。

windsurf ide download Windows版安装教程
windsurf ide download Windows版安装教程

详解 Windsurf IDE 在 Windows 系统的下载来源、安装步骤及首次启动界面。指导用户如何导入编辑器设置、打开项目文件夹及使用终端与 AI 功能,适合初次接触该工具的开发者阅读。

ServBay安装配置详细教程与操作指南
ServBay安装配置详细教程与操作指南

新手入门 ServBay 本地开发环境,详解安装包下载、Dashboard 状态监控、Packages 组件安装、Services 服务控制及 Websites 项目配置。掌握 .servbay.config 版本管理与日志排查技巧,快速搭建稳定的 PHP、Node.js 等多语言开发环境。

codekit环境配置指南从安装到环境搭建完整教程
codekit环境配置指南从安装到环境搭建完整教程

详解 CodeKit 在 macOS 下的安装步骤、项目导入方法、Sass与JavaScript编译设置及浏览器自动刷新功能,助您快速搭建高效的前端开发环境。

codex安装windows 命令行完整操作教程
codex安装windows 命令行完整操作教程

详解Windows环境下安装OpenAI Codex CLI的步骤,包括WSL环境检查、Node.js/npm配置、npm全局安装命令及首次启动验证,适合开发者快速上手。

NativeRest环境配置要求与完整操作教程
NativeRest环境配置要求与完整操作教程

学习如何配置 NativeRest REST API 客户端。涵盖 Windows/macOS/Linux 安装后的工作区创建、环境变量管理、请求编辑及响应查看步骤,帮助开发者快速完成基础环境搭建与连通性测试。

CSS设置透明度的注意事项有哪些?opacity属性详解
CSS设置透明度的注意事项有哪些?opacity属性详解

深入解析CSS中设置透明度的核心属性opacity,剖析子元素继承、事件穿透、层叠上下文等关键注意事项,并提供与rgba、hsla的实用选型对比。

flutter页面传值到后台的方法及示例代码
flutter页面传值到后台的方法及示例代码

flutter页面传值到后台的完整实现方法及示例代码,帮助读者快速掌握相关技术要点。

查看更多
精品专题 更多
装机必备
装机必备

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

Windows
Windows

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

PDF教程
PDF教程

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

Mac软件 更多
WPS Office macOS版
WPS Office macOS版
macOS

WPS Office是一款面向macOS用户的综合办公套件,将文字处理、电子表格、演示文稿、PDF工具、模板与云协作整合在同一应用中。它兼容常见Microsoft Office格式,支持Intel及Apple芯片Mac,基础功能可免费使用,

Shapr3D macOS版
Shapr3D macOS版
Mac

Shapr3D是一款面向工业设计、机械工程、建筑概念和三维打印工作流的CAD软件。Mac版采用Parasolid建模内核,支持草图约束、实体建模、工程图、可视化渲染及常见CAD格式交换,并可通过账户在多台设备之间同步项目。

REAPER macOS版
REAPER macOS版
Mac

REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

WINDOWS 更多
Adobe Photoshop Windows版
Adobe Photoshop Windows版
Windows

Adobe Photoshop 是面向摄影师、设计师和内容创作者的专业图像处理工具,可在 Windows 上完成照片修饰、选区抠图、图层合成、文字排版、绘画及生成式编辑。软件采用订阅授权,由 Creative Cloud 管理安装、更新与许

Adobe InDesign Windows版
Adobe InDesign Windows版
Windows

Adobe InDesign 是面向印刷与数字出版的专业页面排版工具,可制作书籍、杂志、宣传册、海报、交互式 PDF 和电子书。它提供精细的文字样式、多页面管理、印前检查及多格式输出能力,并能与 Photoshop、Illustrator

Adobe Illustrator Windows版
Adobe Illustrator Windows版
Windows

Adobe Illustrator 是用于绘制矢量图形、插画、图标、徽标和版式的专业设计工具。它以路径和锚点为核心,作品放大后仍能保持清晰,并提供画板、文字、渐变、图像描摹及精确变换等功能,适合品牌视觉、印刷物料、数字界面和商业插画创作。