Go Zero：强大的自动代码生成与.api文件运用

阿贾克斯的黎明

于 2024-09-18 21:02:28 发布

阅读量542

点赞数 9

分类专栏： golang 文章标签： golang 开发语言后端

本文链接：https://blog.csdn.net/m0_57836225/article/details/142343748

版权

golang 专栏收录该内容

182 篇文章 3 订阅

订阅专栏

《Go Zero：强大的自动代码生成与.api文件运用》

一、引言

二、Go Zero 自动代码生成与.api文件简介

五、工具使用（以goctl为例）及文件区分

1. 安装goctl

2. 生成代码

六、总结

一、引言

Go Zero 作为一个高效的微服务框架，其自动代码生成功能基于.api文件，为开发者带来了极大的便利。本文将深入介绍这一特性，包括其工作原理、好处、工具使用以及生成多个文件的示例，并说明如何区分不同文件。

二、Go Zero 自动代码生成与`.api`文件简介

Go Zero 允许使用 Protobuf 或 JSON-RPC 定义服务接口，这些定义存储在.api文件中。通过工具如goctl，可以根据.api文件自动生成服务端和客户端的代码框架。

三、好处

1. 提高开发效率

大幅减少手动编写代码的工作量，让开发者专注于业务逻辑的设计。

2. 一致性和规范性

生成的代码遵循统一规范，提高代码的可读性和可维护性。

3. 快速原型开发

便于快速构建代码框架进行原型验证。

4. 减少错误

经过严格测试和验证的自动生成代码，降低了出错的可能性。

四、`.api`文件示例及多文件生成

假设我们有一个更复杂的服务定义，包含多个服务和不同的方法。以下是一个.api文件示例：

syntax = "proto3";

package example;

service AuthService {
  rpc Login(LoginRequest) returns (LoginResponse);
  rpc Register(RegisterRequest) returns (RegisterResponse);
}

service ChatService {
  rpc SendMessage(SendMessageRequest) returns (SendMessageResponse);
}

service FriendService {
  rpc AddFriend(AddFriendRequest) returns (AddFriendResponse);
  rpc RemoveFriend(RemoveFriendRequest) returns (RemoveFriendResponse);
}

message LoginRequest {
  string username = 1;
  string password = 2;
}

message LoginResponse {
  string token = 1;
  string user_id = 2;
}

message RegisterRequest {
  string username = 1;
  string password = 2;
}

message RegisterResponse {
}

message SendMessageRequest {
  string message = 1;
  string recipient = 2;
}

message SendMessageResponse {
  string status = 1;
}

message AddFriendRequest {
  string friend_id = 1;
}

message AddFriendResponse {
  string result = 1;
}

message RemoveFriendRequest {
  string friend_id = 1;
}

message RemoveFriendResponse {
  string result = 1;
}

这个.api文件定义了三个不同的服务：AuthService（用户认证服务）、ChatService（聊天服务）和FriendService（好友服务）。每个服务都有不同的方法和请求 / 响应结构体。

五、工具使用（以`goctl`为例）及文件区分

1. 安装`goctl`

可以通过以下命令安装goctl：

go install github.com/zeromicro/go-zero/tools/goctl@latest

2. 生成代码

假设上面的.api文件名为example.proto，位于当前目录下。可以使用以下命令生成服务端代码：

goctl rpc protoc example.proto --go_out=. --go-grpc_out=. --zrpc_out=.

这将生成多个文件，主要按照服务进行区分：

对于每个服务，会生成一个对应的服务实现文件。例如，会有auth_service.go、chat_service.go和friend_service.go，分别包含各自服务的方法实现。

// auth_service.go
type AuthService struct{}

func (s *AuthService) Login(ctx context.Context, in *LoginRequest) (*LoginResponse, error) {
    // 实现登录逻辑
    return &LoginResponse{Token: "generated_token", UserID: "generated_user_id"}, nil
}

func (s *AuthService) Register(ctx context.Context, in *RegisterRequest) (*RegisterResponse, error) {
    // 实现注册逻辑
    return &RegisterResponse{}, nil
}

// chat_service.go
type ChatService struct{}

func (s *ChatService) SendMessage(ctx context.Context, in *SendMessageRequest) (*SendMessageResponse, error) {
    // 实现发送消息逻辑
    return &SendMessageResponse{Status: "message sent"}, nil
}

// friend_service.go
type FriendService struct{}

func (s *FriendService) AddFriend(ctx context.Context, in *AddFriendRequest) (*AddFriendResponse, error) {
    // 实现添加好友逻辑
    return &AddFriendResponse{Result: "friend added"}, nil
}

func (s *FriendService) RemoveFriend(ctx context.Context, in *RemoveFriendRequest) (*RemoveFriendResponse, error) {
    // 实现删除好友逻辑
    return &RemoveFriendResponse{Result: "friend removed"}, nil
}

还会生成路由注册文件，将各个服务注册到服务器。

func main() {
    s := engine.NewServer(
        rpc.NewServer(
            example.RegisterAuthServiceServer(&AuthService{}),
            example.RegisterChatServiceServer(&ChatService{}),
            example.RegisterFriendServiceServer(&FriendService{}),
        ),
    )
    s.Start()
}

对于客户端代码，可以使用以下命令：