.net7 通过 JsonTranscoding 实现 gRPC 与 Web API 一鱼两吃

2023-05-16

目标

在一个网站内，用一套proto即提供gPRC 调用，又提供 Web API 调用。

实现方法

根据微软官方James Newton King（Newtonsoft.json 作者）的文章，.net7 里面提供了 JsonTranscoding 特性，只需要三步（翻译自链接中的文档)：

第一步用vs2022创建一个 .net7的 gRPC service Create a gRPC client and service
第二步，添加nuget包 Microsoft.AspNetCore.Grpc.JsonTranscoding。在服务的 startup.cs 文件里添加一句 services.AddGrpc().AddJsonTranscoding()；
最后在 proto 文件里面加上 import "google/api/annotations.proto"; 要求将 annotations.proto 和 http.proto 两个文件下载放到你的proto文件所在文件夹下的 google/api 子文件夹中。

另外，可以观看我翻译配音的 James Newton King 的专题讲座.NET Conf 2022: .NET7 gRPC 性能提升同时兼具Web API。

上手比划

主要是找不到 google/api 文件夹编译报错，确保在自己proto文件相同的文件夹下就行了，不用额外安装google的其他包，下面是我的文件夹结构：

在我自己定义的schedulerpc.proto文件中，加上了 import "google/api/annotations.proto";

syntax = "proto3";

import "common.proto";
import "google/protobuf/wrappers.proto";
import "google/api/annotations.proto";

option csharp_namespace = "Easy.Flownet.Services";

service ScheduleRPC {
  rpc GetVariables (RequestName) returns (VariableInfoList){
	option(google.api.http)={
	  get:"/schedule/{name}"
	};
  }
}

在gRPC服务里面进行了方法实现：

    public class ScheduleService : ScheduleRPC.ScheduleRPCBase
    {
        public ScheduleService() : base()
        {
        }

        public override Task<VariableInfoList> GetVariables(RequestName request, ServerCallContext context)
        {
            //实现代码
        }
    }

在startup.cs（或program.cs）中加上了

services.AddGrpc().AddJsonTranscoding();

并注册了ScheduleService 服务

endpoints.MapGrpcService<ScheduleService>();

添加 Swagger

跟着.NET Conf 2022: .NET7 gRPC 性能提升同时兼具Web API一步一步操作，首先在服务所在工程文件中添加两个包

	<PackageReference Include="Microsoft.AspNetCore.Grpc.JsonTranscoding" Version="7.0.0" />
	<PackageReference Include="Microsoft.AspNetCore.Grpc.Swagger" Version="0.3.0" />

然后在startup.cs 或 program.cs 中添加代码

services.AddGrpcReflection();
services.AddGrpcSwagger();
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title="My API", Version="v1"});
});

...

app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});

...

endpoints.MapGrpcReflectionService();

That's all you need.

运行

启动gRPC服务后，在浏览器中键入我在schedulerpc.proto文件中给GetVariables指定的url地址，http://localhost:5002/schedule/{name} 正确返回了json。

然后我立刻删除了单独创建的web api项目，也不用再为gRPC与web api之间的互操作烦恼了，因为都在一个项目里，是不是很爽啊？！感谢James Newton King！

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)

net7

JsonTranscoding

gRPC

Web

API