为所有解决方案共享一个 gRPC proto 文件

时间:2021-03-28 17:27:18

标签: c# grpc-c#

我最近接触了 .net core 上的 gRPC,到目前为止我对它非常满意..

我遇到的唯一问题是 proto 文件,例如:如果我对我的 grpc 服务器解决方案中的 MyProtos.proto 文件进行了更改。我必须更新我所有客户端解决方案中的 MyProtos.proto 文件..

所以我想知道是否有共享原始文件的方法..

我尝试创建一个单独的解决方案并将 proto 文件放在那里,然后将其引用到所有其他解决方案,但无法使其工作。

1 个答案:

答案 0 :(得分:1)

您可以使用 nuget 包分发 proto 文件。使用 .nuspec 文件打包文件。例如,如果您的 *.proto 文件位于 proto 文件夹下,My.Server.Proto.nuspec 可能如下所示:

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2013/05/nuspec.xsd">
  <metadata>
    <id>My.Server.Proto</id>
    <version>1.0.0</version>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>My Server Proto Files</description>
    <authors>My Company Ltd.</authors>
  </metadata>
  <files>
    <file src="proto/**/*.proto" />
  </files>
</package>

然后在要使用文件的项目中安装grpc依赖

<ItemGroup>
  <PackageReference Include="Google.Protobuf" Version="3.14.0" />
  <PackageReference Include="Grpc.Tools" Version="2.34.0">
    <PrivateAssets>all</PrivateAssets>
    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
  </PackageReference>
</ItemGroup>

安装您的原型包:

<ItemGroup>
  <PackageReference Include="My.Server.Proto" Version="1.0.0" GeneratePathProperty="true" />
</ItemGroup>

注意 GeneratePathProperty="true"。这将允许您参考 nuget 安装文件夹。现在添加 Protobuf

<ItemGroup>
  <Protobuf Include="$(PkgMy_Server_Proto)/proto/**/*.proto" ProtoRoot="$(PkgMy_Server_Proto)" GrpcServices="Client" />
</ItemGroup>

$(PkgMy_Server_Proto) 变量将解析为 My.Server.Proto nuget 文件夹。变量名称以 Pkg 开头,当 . 替换为 _ 时,后跟包名称。