如何在 .proto 文件中允许包名称的减号？答案

【问题标题】：How to allow minus sign for package name in .proto file?如何在 .proto 文件中允许包名称的减号？
【发布时间】：2020-11-23 07:33:09
【问题描述】：

这是我使用的.proto 文件：

pkg/apis/workflow/v1alpha1/generated.proto

syntax = 'proto2';

package go-server.com.argo-new.pkg.apis.workflow.v1alpha1;

import "k8s.io/api/core/v1/generated.proto";
import "k8s.io/api/policy/v1beta1/generated.proto";
import "k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto";
import "k8s.io/apimachinery/pkg/runtime/generated.proto";
import "k8s.io/apimachinery/pkg/runtime/schema/generated.proto";

// Package-wide variables from generator "generated".
option go_package = "v1alpha1";

// ArchiveStrategy describes how to archive files/directory when saving artifacts
message ArchiveStrategy {
  optional TarStrategy tar = 1;

  optional NoneStrategy none = 2;
}

当我尝试编译时：

protoc -I /usr/local/include -I . -I ./vendor -I /root/go/src \
       -I /root/go/pkg/mod/github.com/gogo/protobuf@v1.3.1/gogoproto \
       -I /root/go/pkg/mod/github.com/grpc-ecosystem/grpc-gateway@v1.12.2/third_party/googleapis \
       --include_imports --gogofast_out=plugins=grpc:/root/go/src \
       --grpc-gateway_out=logtostderr=true:/root/go/src \
       --swagger_out=logtostderr=true,fqn_for_swagger_name=true:. \ 
       pkg/apis/workflow/v1alpha1/generated.proto

它提醒我：

pkg/apis/workflow/v1alpha1/generated.proto:6:11: Expected ";"

这是一个编译错误，这意味着包名不应包含-。

是否有任何方法可以在包名称中使用- 或任何解决方法？

谢谢！

【问题讨论】：

破折号在 Go 包名中是非法的：play.golang.org/p/CWQknBi2suT
谢谢，但 Go 的导入路径中允许使用破折号，例如 go-server.com.argo-new.pkg.apis.workflow.v1alpha1。但是当我们在 protobuf 中使用这个包时，破折号是不允许的。我真正想要的是在protobuf的导入路径中使用破折号，这样我们就可以通过protobuf自动生成golang代码。

标签： go protocol-buffers protoc

【解决方案1】：

Protobuf

proto2 specs（如您的示例代码）和proto3 specs 都不允许。

如规范所示（上述任一），package 声明遵循以下模式：

package = "package" fullIdent ";"

即关键字package 后跟fullIdent 后跟一个; 分号，其中fullIdent 定义为：

fullIdent = ident { "." ident }

即至少一个ident 后跟零个或多个其他ident 前面是.，其中ident 定义为：

ident = letter { letter | decimalDigit | "_" }

即至少一个字母，后跟零个或多个字母（[A-Z]、[a-z]）、数字（[0-9]）或下划线_ 字符。

因此，总而言之，您的 protobuf 包名称中不能有减号（破折号）- 字符。

去

此外，正如@colm.anseo 指出的那样，Go package names 也不允许使用破折号- 字符：

PackageName = identifier . 其中identifier = letter { letter | unicode_digit } .

(The underscore character is considered a letter.)

【讨论】：

感谢您的快速回答。当然，Go 包名允许使用破折号 - 字符，如 permalink 所示
@KonnaseLee 不，它没有，您将package name 与import declaration 混淆了。包含破折号的是完整的导入路径，而不是包名。在该链接中，clientset 是包名，"k8s.io/client-go/kubernetes" 是导入路径。导入路径可以包含破折号。
抱歉混淆了包名和导入路径。我真正想要的是在 protobuf 的导入路径中使用破折号字符，这样我们就可以通过 protobuf 自动生成 golang 代码。看来我没有办法实现目标。还是谢谢！