生成代码（传统非泛型）参考

本页面描述了在使用 protoc 编译 .proto 文件时，通过 grpc 插件 protoc-gen-go-grpc 生成的代码。

你可以在服务定义中了解如何在 .proto 文件中定义 gRPC 服务。

线程安全：请注意，客户端 RPC 调用和服务端 RPC 处理程序是线程安全的，并且旨在在并发协程 (goroutines) 上运行。但还要注意，对于单个流，传入和传出数据是双向但串行的；例如，单个流不支持并发读或并发写（但读可以安全地与写并发进行）。

生成的服务接口方法

在服务端，.proto 文件中的每个 service Bar 会生成以下函数：

func RegisterBarServer(s *grpc.Server, srv BarServer)

应用程序可以使用此函数定义 BarServer 接口的具体实现，并将其注册到 grpc.Server 实例（在启动服务器实例之前）。

一元方法

这些方法在生成的服务接口上具有以下签名：

Foo(context.Context, *MsgA) (*MsgB, error)

在此上下文中，MsgA 是从客户端发送的 protobuf 消息，MsgB 是从服务器发送回的 protobuf 消息。

服务器流式方法

这些方法在生成的服务接口上具有以下签名：

Foo(*MsgA, <ServiceName>_FooServer) error

在此上下文中，MsgA 是来自客户端的单个请求，而 <ServiceName>_FooServer 参数表示从服务器到客户端的 MsgB 消息流。

<ServiceName>_FooServer 包含一个嵌入的 grpc.ServerStream 和以下接口：

type <ServiceName>_FooServer interface {
	Send(*MsgB) error
	grpc.ServerStream
}

服务器端处理程序可以通过此参数的 Send 方法向客户端发送 protobuf 消息流。服务器到客户端流的结束是通过处理程序方法的 return 引起的。

客户端流式方法

这些方法在生成的服务接口上具有以下签名：

Foo(<ServiceName>_FooServer) error

在此上下文中，<ServiceName>_FooServer 可用于读取客户端到服务器的消息流，并发送单个服务器响应消息。

<ServiceName>_FooServer 包含一个嵌入的 grpc.ServerStream 和以下接口：

type <ServiceName>_FooServer interface {
	SendAndClose(*MsgA) error
	Recv() (*MsgB, error)
	grpc.ServerStream
}

服务器端处理程序可以重复调用此参数上的 Recv 方法，以接收来自客户端的完整消息流。当达到流的末尾时，Recv 会返回 (nil, io.EOF)。通过在此 <ServiceName>_FooServer 参数上调用 SendAndClose 方法，发送来自服务器的单个响应消息。请注意，SendAndClose 必须且只能调用一次。

双向流式方法

这些方法在生成的服务接口上具有以下签名：

Foo(<ServiceName>_FooServer) error

在此上下文中，<ServiceName>_FooServer 可用于访问客户端到服务器的消息流和服务器到客户端的消息流。<ServiceName>_FooServer 包含一个嵌入的 grpc.ServerStream 和以下接口：

type <ServiceName>_FooServer interface {
	Send(*MsgA) error
	Recv() (*MsgB, error)
	grpc.ServerStream
}

服务器端处理程序可以重复调用此参数上的 Recv 方法，以读取客户端到服务器的消息流。当达到客户端到服务器流的末尾时，Recv 会返回 (nil, io.EOF)。通过重复调用此 ServiceName>_FooServer 参数上的 Send 方法，发送响应的服务器到客户端消息流。服务器到客户端流的结束由双向方法处理程序的 return 表示。

生成的客户端接口方法

对于客户端使用，.proto 文件中的每个 service Bar 还会生成以下函数：func BarClient(cc *grpc.ClientConn) BarClient，它返回 BarClient 接口的具体实现（此具体实现也位于生成的 .pb.go 文件中）。

一元方法

这些方法在生成的客户端存根上具有以下签名：

(ctx context.Context, in *MsgA, opts ...grpc.CallOption) (*MsgB, error)

在此上下文中，MsgA 是从客户端到服务器的单个请求，MsgB 包含从服务器发送回的响应。

服务器流式方法

这些方法在生成的客户端存根上具有以下签名：

Foo(ctx context.Context, in *MsgA, opts ...grpc.CallOption) (<ServiceName>_FooClient, error)

在此上下文中，<ServiceName>_FooClient 表示从服务器到客户端的 MsgB 消息流。

此流包含一个嵌入的 grpc.ClientStream 和以下接口：

type <ServiceName>_FooClient interface {
	Recv() (*MsgB, error)
	grpc.ClientStream
}

当客户端在存根上调用 Foo 方法时，流开始。然后客户端可以重复调用返回的 <ServiceName>_FooClient 流上的 Recv 方法，以读取服务器到客户端的响应流。当服务器到客户端流已完全读取后，此 Recv 方法会返回 (nil, io.EOF)。

客户端流式方法

这些方法在生成的客户端存根上具有以下签名：

Foo(ctx context.Context, opts ...grpc.CallOption) (<ServiceName>_FooClient, error)

在此上下文中，<ServiceName>_FooClient 表示从客户端到服务器的 MsgA 消息流。

<ServiceName>_FooClient 包含一个嵌入的 grpc.ClientStream 和以下接口：

type <ServiceName>_FooClient interface {
	Send(*MsgA) error
	CloseAndRecv() (*MsgB, error)
	grpc.ClientStream
}

当客户端在存根上调用 Foo 方法时，流开始。然后客户端可以重复调用返回的 <ServiceName>_FooClient 流上的 Send 方法，以发送客户端到服务器的消息流。必须且只能调用此流上的 CloseAndRecv 方法一次，以关闭客户端到服务器流并接收来自服务器的单个响应消息。

双向流式方法

这些方法在生成的客户端存根上具有以下签名：

Foo(ctx context.Context, opts ...grpc.CallOption) (<ServiceName>_FooClient, error)

在此上下文中，<ServiceName>_FooClient 表示客户端到服务器和服务器到客户端的消息流。

<ServiceName>_FooClient 包含一个嵌入的 grpc.ClientStream 和以下接口：

type <ServiceName>_FooClient interface {
	Send(*MsgA) error
	Recv() (*MsgB, error)
	grpc.ClientStream
}

当客户端在存根上调用 Foo 方法时，流开始。然后客户端可以重复调用返回的 <SericeName>_FooClient 流上的 Send 方法，以发送客户端到服务器的消息流。客户端也可以重复调用此流上的 Recv 方法，以接收完整的服务器到客户端消息流。

服务器到客户端流的结束由流的 Recv 方法返回 (nil, io.EOF) 值表示。客户端到服务器流的结束可以由客户端调用流的 CloseSend 方法表示。

包和命名空间

当使用 --go_out=plugins=grpc: 调用 protoc 编译器时，proto package 到 Go package 的转换方式与不使用 grpc 插件而使用 protoc-gen-go 插件时相同。

因此，例如，如果 foo.proto 声明其位于 package foo 中，则生成的 foo.pb.go 文件也将位于 Go 的 package foo 中。