经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » ASP.net » 查看文章
gRPC之.Net6中的客户端和服务端共用proto协议文件
来源:cnblogs  作者:Qubernet  时间:2023/3/14 10:25:55  对本文有异议

1、说明

在上一篇文章gRPC之.Net6中的初步使用介绍中,我们简单的介绍了gRPC在服务端、客户端以及Web项目中的使用。

有一个问题,不知道大家发现没有,就是不管在服务端项目还是客户端项目中,我们都需要创建相同的proto协议文件,这样就会显得很麻烦,有没有一种办法只创建一次proto协议文件呢?答案是肯定的:有。

在介绍实现之前,建议大家先查看一下前一篇文章gRPC之.Net6中的初步使用介绍,方便后面关联性的讲解。


2、实现

2.1、新建类库项目

首先我们新建一个名称为Quber.Grpc.Common的类库项目,目的就是用于存放proto协议文件协议文件生成的对应类文件,如下图所示:

image

image

image

2.2、添加引用

接下来我们在Quber.Grpc.Common的类库项目中分别添加如下引用:

  1. Google.Protobuf
  2. Grpc.Core.Api
  3. Grpc.Tools

image

2.3、创建proto协议文件

我们在Quber.Grpc.Common类库项目中新建一个文件夹Protos,用于存放各种proto协议文件,然后我们把Quber.Grpc.Service项目中的user.proto协议文件复制过来,复制过来后,将user.proto协议文件中的命名空间修改为Quber.Grpc.Common.Protos和该类库保持一致),如下图所示:

image

2.4、修改协议文件属性

鼠标右键user.proto协议文件,选择属性(或者鼠标选中user.proto协议文件,然后按ALT+Enter快捷键打开文件属性窗体),在打开的属性窗体中,将Build Action选项设置为Protobuf compiler,将gRPC Stub Classes选项设置为Client and Server,然后点击应用确定即可,如下图所示:

image

此时,我们双击Quber.Grpc.Common类库项目,在编辑文件中,我们会发现有一个Protobuf节点设置,并且该节点中的GrpcServices属性值为BothBoth表示我们刚才选择的Client and ServiceClient表示客户端,Service表示服务端),如下图所示:

image

注意:如果项目的编辑文件中,没有Protobuf节点设置,请手动增加进去,不然到时候在生成的时候不会生成协议文件对应的类文件

2.5、生成项目

此时我们重新生成下Quber.Grpc.Common类库项目,会发现在obj\Debug\net6.0\Protos目录下生成了user.proto协议文件对应的2个类文件,如下图所示:

image

2.6、改造服务端和客户端项目

  1. 改造Quber.Grpc.Service项目

    Quber.Grpc.Service项目中,我们添加对Quber.Grpc.Common类库项目的引用,如下图所示:

    image

    然后我们将Quber.Grpc.Service项目中的整个Protos文件夹删除掉,如下图所示:

    image

    修改UserService.cs服务文件中的命名空间,如下图所示:

    image

    此时我们注意到User.UserBaseUserInfoResultUserInfoRequest都来自我们新建的Quber.Grpc.Common类库项目。

    运行Quber.Grpc.Service项目,如下图所示:

    image

    如上图所示,Quber.Grpc.Service服务端就运行成功了。

  2. 改造Quber.Grpc.Client项目

    Quber.Grpc.Client项目中,我们添加对Quber.Grpc.Common类库项目的引用,如下图所示:

    image

    然后我们将Quber.Grpc.Client项目中的整个Protos文件夹删除掉,如下图所示:

    image

    修改服务文件UserTest.csUserTestIoc.cs以及启动文件Program.cs中的命名空间,如下图所示:

    image

    image

    image

    此时我们注意到User.UserClientUserInfoRequest都来自我们新建的Quber.Grpc.Common类库项目。

    运行Quber.Grpc.Client项目,如下图所示:

    image

    如上图所示,Quber.Grpc.Client客户端就运行成功了。


同理,我们可以将Quber.Grpc.Web项目也按照上述说明进行调整,此处就不一一演示了。

通过上述步骤的演示,我们就达到了客户端和服务端公用一份proto协议文件的目的,就不用在每个项目中新建相同的proto协议文件了,后期只需要维护一份proto协议文件即可。

原文链接:https://www.cnblogs.com/qubernet/p/17214011.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号