0

0

GolangRPC接口设计与自动生成示例

P粉602998670

P粉602998670

发布时间:2025-09-17 15:51:01

|

884人浏览过

|

来源于php中文网

原创

首先使用Protobuf定义gRPC接口并生成Go代码,接着实现UserService服务端逻辑,最后编写客户端调用GetUser方法获取用户信息。

golangrpc接口设计与自动生成示例

在微服务架构中,RPC(远程过程调用)是服务间通信的核心方式之一。Golang 以其高性能和简洁的并发模型,成为构建 RPC 服务的热门选择。结合 Protobuf 和 gRPC,可以实现高效、类型安全的接口定义与自动代码生成。本文将带你从零开始设计一个简单的 Golang RPC 接口,并展示如何自动生成服务代码。

定义 Protobuf 接口

使用 Protocol Buffers(Protobuf)定义接口是 gRPC 的标准做法。它支持跨语言、序列化高效,并能自动生成客户端和服务端代码。

首先安装必要的工具

protoc 编译器 和 protoc-gen-go 插件

可以通过以下命令安装:

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

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

接下来创建一个 user.proto 文件,定义用户查询接口:

syntax = "proto3";

package service;
option go_package = "./service";

service UserService {
  rpc GetUser(GetUserRequest) returns (GetUserResponse);
}

message GetUserRequest {
  int64 user_id = 1;
}

message GetUserResponse {
  int64 user_id = 1;
  string name = 2;
  string email = 3;
  bool active = 4;
}

这个接口定义了一个 GetUser 方法,接收用户 ID,返回用户信息。

生成 Go 代码

使用 protoc 命令生成 Go 代码:

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

执行后会生成两个文件:

迦恩计算机资源网源码(图书销售类)
迦恩计算机资源网源码(图书销售类)

采用三层架构开发,前台集成了产品在线展示,用户注册、在线调查、在线投稿后台有类别管理\图书管理\订单管理\会员管理\配送范围管理\邮件列表\广告管理\友情链接管理等后台添加图书时自动生成缩略图和文字水印主要参考了petshop的设计架构、使用了Asp.net2.0中很多MemberShip、master等新功能后台管理地址/web/admin/ 超级管理员账号密码均为aspx1特别提示:该系统需要

下载
  • user.pb.go:包含消息类型的结构体和序列化代码
  • user_grpc.pb.go:包含客户端和服务端的接口定义

生成的服务端接口如下:

type UserServiceServer interface {
  GetUser(context.Context, *GetUserRequest) (*GetUserResponse, error)
}

你只需实现这个接口即可。

实现服务端逻辑

创建一个 server.go 文件,实现 UserService 接口:

package main

import (
  "context"
  "log"
  "net"

  pb "your-module/service"
  "google.golang.org/grpc"
)

type userService struct {
  pb.UnimplementedUserServiceServer
}

func (s *userService) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.GetUserResponse, error) {
  // 模拟数据库查询
  user := &pb.GetUserResponse{
    UserId:   req.UserId,
    Name:     "Alice",
    Email:    "alice@example.com",
    Active:   true,
  }
  return user, 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)
  }
}

启动服务后,它将在 50051 端口监听 gRPC 请求。

编写客户端调用

创建 client.go 测试调用:

package main

import (
  "context"
  "log"

  pb "your-module/service"
  "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.Fatal("did not connect:", err)
  }
  defer conn.Close()

  client := pb.NewUserServiceClient(conn)

  resp, err := client.GetUser(context.Background(), &pb.GetUserRequest{UserId: 123})
  if err != nil {
    log.Fatal("could not get user:", err)
  }

  log.Printf("User: %+v", resp)
}

运行客户端,将输出:

User: userId:123 name:"Alice" email:"alice@example.com" active:true

通过 Protobuf 定义接口,Golang 能自动生成类型安全的 gRPC 代码,极大提升开发效率和系统稳定性。这套流程适用于大多数微服务场景,配合 Makefile 或脚本可进一步自动化编译过程。

基本上就这些。

相关专题

更多
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

热门下载

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

精品课程

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

共32课时 | 2.9万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

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

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