0

0

如何在Golang中使用Protobuf定义RPC接口

P粉602998670

P粉602998670

发布时间:2025-10-23 20:16:02

|

764人浏览过

|

来源于php中文网

原创

首先定义.proto文件声明RPC服务和消息结构,然后通过protoc生成Go代码,接着实现服务端逻辑并启动gRPC服务器,最后编写客户端代码调用远程方法。整个流程依赖Protobuf定义接口,结合gRPC框架自动处理通信与序列化,开发者只需关注业务逻辑实现。

如何在golang中使用protobuf定义rpc接口

在Golang中使用Protobuf定义RPC接口,核心是通过Protocol Buffers(简称Protobuf)定义服务方法,再结合gRPC框架实现远程调用。整个流程包括定义.proto文件、生成Go代码、实现服务端和客户端逻辑。

定义.proto文件描述RPC服务

首先创建一个.proto文件,在其中定义你想要暴露的RPC方法和消息结构。使用syntax = "proto3";声明语法版本,并通过service关键字定义服务。

例如,创建user.proto

syntax = "proto3";

package example;

// 定义请求和响应消息
message GetUserRequest {
  string user_id = 1;
}

message UserResponse {
  string name = 1;
  int32 age = 2;
}

// 定义RPC服务
service UserService {
  rpc GetUser(GetUserRequest) returns (UserResponse);
}

这个文件定义了一个名为UserService的服务,包含一个GetUser方法,接收GetUserRequest并返回UserResponse

立即学习go语言免费学习笔记(深入)”;

生成Go代码

需要安装Protobuf编译器protoc以及Go插件:

  • 安装protoc:从GitHub release页面下载对应平台的二进制文件
  • 安装Go插件:
    go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
    go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

执行命令生成Go代码:

Subtxt
Subtxt

生成有意义的文本并编写完整的故事。

下载
protoc --go_out=. --go-grpc_out=. user.proto

会生成两个文件:user.pb.gouser_grpc.pb.go,分别包含消息结构体和服务接口定义。

实现服务端逻辑

在Go中实现服务接口,注册到gRPC服务器:

package main

import (
	"context"
	"log"
	"net"

	"google.golang.org/grpc"
	pb "your-module-path/proto" // 替换为你的模块路径
)

type userService struct {
	pb.UnimplementedUserServiceServer
}

func (s *userService) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.UserResponse, error) {
	return &pb.UserResponse{
		Name: "Alice",
		Age:  30,
	}, nil
}

func main() {
	lis, err := net.Listen("tcp", ":50051")
	if err != nil {
		log.Fatalf("failed to listen: %v", err)
	}
	grpcServer := grpc.NewServer()
	pb.RegisterUserServiceServer(grpcServer, &userService{})
	log.Println("gRPC server running on :50051")
	if err := grpcServer.Serve(lis); err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

这里实现了GetUser方法,并启动gRPC服务器监听指定端口

编写客户端调用代码

客户端连接服务器并调用RPC方法:

package main

import (
	"context"
	"log"

	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials/insecure"
	pb "your-module-path/proto"
)

func main() {
	conn, err := grpc.Dial("localhost:50051", grpc.WithTransportCredentials(insecure.NewCredentials()))
	if err != nil {
		log.Fatalf("did not connect: %v", err)
	}
	defer conn.Close()

	client := pb.NewUserServiceClient(conn)
	resp, err := client.GetUser(context.Background(), &pb.GetUserRequest{UserId: "123"})
	if err != nil {
		log.Fatalf("could not get user: %v", err)
	}
	log.Printf("User: %s, Age: %d", resp.Name, resp.Age)
}

客户端通过Dial建立连接,使用生成的客户端接口发起调用。

基本上就这些。只要定义好.proto文件,工具链会帮你处理序列化和通信细节,专注业务逻辑即可。注意保持.proto文件与生成代码同步,避免调用失败。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

173

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

224

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

334

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

204

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

387

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

184

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.2万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号