0

0

如何用Golang构建gRPC服务 定义proto文件与生成代码

P粉602998670

P粉602998670

发布时间:2025-08-23 09:20:02

|

524人浏览过

|

来源于php中文网

原创

第一步是定义proto文件,使用Protocol Buffers编写接口和消息结构,如定义UserService服务和GetUser方法;接着安装protoc编译器及Go插件,执行protoc命令生成service.pb.go和service_grpc.pb.go文件;然后编写服务端代码实现GetUser逻辑,并启动gRPC服务器监听50051端口;最后编写客户端代码连接服务器并调用GetUser方法获取用户信息,完成整个gRPC服务构建流程。

如何用golang构建grpc服务 定义proto文件与生成代码

要用Golang构建gRPC服务,第一步是定义接口和消息结构,这通过Protocol Buffers(简称protobuf)完成。整个流程包括:编写

.proto
文件、使用
protoc
生成Go代码、编写服务端和客户端逻辑。下面一步步说明如何操作。

定义proto文件

在项目目录中创建一个

proto
文件夹,然后编写一个
service.proto
文件。例如,定义一个简单的用户信息服务:

syntax = "proto3"; package user; // 生成的Go包名 option go_package = "./userpb"; // 请求消息 message GetUserRequest { int32 id = 1; } // 响应消息 message User { int32 id = 1; string name = 2; string email = 3; } // 定义gRPC服务 service UserService { rpc GetUser(GetUserRequest) returns (User); }

说明:

  • syntax = "proto3":使用proto3语法。
  • package user:避免命名冲突,对应生成代码的包名。
  • option go_package:指定生成的Go代码的导入路径。
  • service UserService:定义一个gRPC服务,包含一个方法
    GetUser

安装工具与生成Go代码

要生成Go代码,需要安装以下工具:

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

  • protoc编译器:Protocol Buffers的编译器。
  • Go插件
    protoc-gen-go
    protoc-gen-go-grpc

安装Go相关插件:

go install google.golang.org/protobuf/cmd/protoc-gen-go@latest go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

确保

$GOPATH/bin
PATH
中,否则
protoc
找不到插件。

Haiper
Haiper

一个感知模型驱动的AI视频生成和重绘工具,提供文字转视频、图片动画化、视频重绘等功能

下载

proto
目录下执行命令生成代码:

protoc --go_out=. --go-grpc_out=. service.proto

生成两个文件:

  • service.pb.go
    :包含消息结构的Go类型和序列化方法。
  • service_grpc.pb.go
    :包含客户端和服务端接口。

编写gRPC服务端

创建

server/main.go
,实现UserService服务:

package main import ( "context" "log" "net" pb "your-module/proto/userpb" "google.golang.org/grpc" ) type server struct { pb.UnimplementedUserServiceServer } func (s *server) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.User, error) { // 模拟查询用户 return &pb.User{ Id: req.Id, Name: "Alice", Email: "alice@example.com", }, nil } func main() { lis, err := net.Listen("tcp", ":50051") if err != nil { log.Fatalf("failed to listen: %v", err) } s := grpc.NewServer() pb.RegisterUserServiceServer(s, &server{}) log.Println("gRPC server running on :50051") if err := s.Serve(lis); err != nil { log.Fatalf("failed to serve: %v", err) } }

编写gRPC客户端

创建

client/main.go
,调用远程服务:

package main import ( "context" "log" "time" pb "your-module/proto/userpb" "google.golang.org/grpc" "google.golang.org/grpc/credentials/insecure" ) 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) ctx, cancel := context.WithTimeout(context.Background(), time.Second) defer cancel() resp, err := client.GetUser(ctx, &pb.GetUserRequest{Id: 1}) if err != nil { log.Fatalf("could not get user: %v", err) } log.Printf("User: %v", resp) }

运行服务端后,执行客户端,将输出获取到的用户信息。

基本上就这些。定义proto、生成代码、实现服务和调用,是gRPC开发的核心流程。只要proto文件清晰,后续代码生成和调用都很自动化。注意保持proto与Go包路径一致,避免导入问题。

相关专题

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

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

174

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、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2024.02.23

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

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

206

2024.03.05

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

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

388

2024.05.21

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

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

193

2025.06.09

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

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

188

2025.06.10

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

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

191

2025.06.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
golang socket 编程
golang socket 编程

共2课时 | 0.1万人学习

nginx浅谈
nginx浅谈

共15课时 | 0.8万人学习

golang和swoole核心底层分析
golang和swoole核心底层分析

共3课时 | 0.1万人学习

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

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