gRPC-Go для Go: полное руководство с примерами

Что такое gRPC-Go и зачем он нужен?

gRPC-Go — это официальная реализация фреймворка gRPC для языка программирования Go. gRPC (gRPC Remote Procedure Calls) — это высокопроизводительная, открытая система удаленного вызова процедур (RPC), разработанная компанией Google. Она позволяет клиентским и серверным приложениям общаться друг с другом так, как будто они находятся в одном процессе, абстрагируя сетевые сложности.

Зачем использовать gRPC-Go?

• Высокая производительность: gRPC использует HTTP/2 для мультиплексирования запросов и Protobuf (Protocol Buffers) для эффективной бинарной сериализации данных. Это значительно быстрее, чем JSON/XML по HTTP/1.1.
• Строгая типизация: Контракты API определяются в .proto файлах, что позволяет генерировать строго типизированный код как для сервера, так и для клиента. Это устраняет множество ошибок на этапе компиляции.
• Поддержка потоковой передачи: gRPC поддерживает четыре вида RPC: унарные (запрос-ответ), серверный стриминг, клиентский стриминг и двунаправленный стриминг.
• Встроенная аутентификация и шифрование: gRPC из коробки поддерживает TLS/SSL и различные механизмы аутентификации.
• Идеально для микросервисов: gRPC является стандартом де-факто для связи между микросервисами благодаря своей скорости, надежности и поддержке множества языков.

Установка

Для работы с gRPC в Go вам потребуется установить несколько компонентов:

1. Установите Go: Убедитесь, что у вас установлен Go версии 1.18 или выше. Скачать можно с официального сайта.
2. Установите компилятор Protocol Buffers (protoc):

   # macOS (Homebrew)
   brew install protobuf
   
   # Ubuntu/Debian
   sudo apt install -y protobuf-compiler
   
   # Windows (скачайте бинарник с GitHub)
   # https://github.com/protocolbuffers/protobuf/releases
   

3. Установите плагины для Go:

   # Устанавливаем плагины protoc для Go
   go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
   go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
   
   # Обновляем PATH (добавьте в ~/.bashrc или ~/.zshrc)
   export PATH="$PATH:$(go env GOPATH)/bin"
   

4. Установите саму библиотеку gRPC-Go в ваш проект:

   # Инициализируйте модуль Go (если еще не сделали)
   go mod init my-grpc-project
   
   # Установите gRPC
   go get google.golang.org/grpc
   
   # Установите protobuf для Go
   go get google.golang.org/protobuf
   

Примечание: В отличие от Python (pip install grpcio), в Go используется система модулей go get.

Быстрый старт с примером кода

Давайте создадим простое приложение "Hello World" с использованием gRPC-Go.

Шаг 1: Определение протокола (файл hello.proto)

syntax = "proto3";

package hello;

option go_package = "github.com/yourusername/my-grpc-project/hello";

// Определяем сервис
service Greeter {
  // Унарный RPC
  rpc SayHello (HelloRequest) returns (HelloReply);
}

// Сообщение запроса
message HelloRequest {
  string name = 1;
}

// Сообщение ответа
message HelloReply {
  string message = 1;
}

Шаг 2: Генерация Go кода

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

Эта команда создаст два файла: hello.pb.go (структуры данных) и hello_grpc.pb.go (интерфейсы сервера и клиента).

Шаг 3: Реализация сервера (server/main.go)

package main

import (
    "context"
    "log"
    "net"

    "google.golang.org/grpc"
    pb "github.com/yourusername/my-grpc-project/hello" // Замените на ваш путь
)

// server реализует интерфейс GreeterServer
type server struct {
    pb.UnimplementedGreeterServer
}

// SayHello реализует метод сервиса
func (s *server) SayHello(ctx context.Context, req *pb.HelloRequest) (*pb.HelloReply, error) {
    log.Printf("Получен запрос: %v", req.GetName())
    return &pb.HelloReply{Message: "Привет, " + req.GetName() + "!"}, nil
}

func main() {
    lis, err := net.Listen("tcp", ":50051")
    if err != nil {
        log.Fatalf("Ошибка при прослушивании порта: %v", err)
    }

    s := grpc.NewServer()
    pb.RegisterGreeterServer(s, &server{})

    log.Println("Сервер запущен на :50051")
    if err := s.Serve(lis); err != nil {
        log.Fatalf("Ошибка при запуске сервера: %v", err)
    }
}

Шаг 4: Реализация клиента (client/main.go)

package main

import (
    "context"
    "log"
    "time"

    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    pb "github.com/yourusername/my-grpc-project/hello"
)

func main() {
    // Устанавливаем соединение с сервером
    conn, err := grpc.Dial("localhost:50051", grpc.WithTransportCredentials(insecure.NewCredentials()))
    if err != nil {
        log.Fatalf("Не удалось подключиться: %v", err)
    }
    defer conn.Close()

    client := pb.NewGreeterClient(conn)

    // Таймаут для контекста
    ctx, cancel := context.WithTimeout(context.Background(), time.Second)
    defer cancel()

    // Вызываем RPC
    resp, err := client.SayHello(ctx, &pb.HelloRequest{Name: "Мир"})
    if err != nil {
        log.Fatalf("Ошибка при вызове SayHello: %v", err)
    }
    log.Printf("Ответ от сервера: %s", resp.GetMessage())
}

Шаг 5: Запуск

# Запустите сервер
go run server/main.go

# В другом терминале запустите клиента
go run client/main.go

# Вывод клиента: Ответ от сервера: Привет, Мир!

Основные методы и функции gRPC-Go

Ниже представлены ключевые функции и методы библиотеки google.golang.org/grpc.

1. grpc.Dial()

Что делает: Устанавливает клиентское соединение с gRPC сервером. Это блокирующая функция, которая возвращает *grpc.ClientConn.

Параметры:

• target string — адрес сервера (например, "localhost:50051").
• opts ...grpc.DialOption — опции соединения (например, для TLS, балансировки нагрузки).

Пример:

conn, err := grpc.Dial("localhost:50051", grpc.WithInsecure())
if err != nil {
    log.Fatalf("Ошибка подключения: %v", err)
}
defer conn.Close()

2. grpc.NewServer()

Что делает: Создает новый экземпляр gRPC сервера без зарегистрированных сервисов.

Параметры:

• opt ...grpc.ServerOption — опции сервера (например, для TLS, перехватчиков).

Пример:

s := grpc.NewServer(
    grpc.MaxRecvMsgSize(10*1024*1024), // Максимальный размер сообщения 10MB
)

3. Server.Serve()

Что делает: Запускает сервер для обработки входящих запросов на заданном слушателе (net.Listener). Блокирует выполнение до остановки.

Параметры:

• lis net.Listener — слушатель (обычно TCP).

Пример:

lis, _ := net.Listen("tcp", ":50051")
if err := s.Serve(lis); err != nil {
    log.Fatalf("Ошибка сервера: %v", err)
}

4. Server.GracefulStop()

Что делает: Останавливает сервер корректно: перестает принимать новые запросы, но завершает обработку уже активных. Рекомендуется использовать вместо Stop().

Параметры: Нет.

Пример:

// В обработчике сигнала SIGINT/SIGTERM
s.GracefulStop()

5. ClientConn.Close()

Что делает: Закрывает клиентское соединение и освобождает ресурсы. Все активные вызовы RPC будут прерваны.

Параметры: Нет.

Пример:

conn, _ := grpc.Dial("localhost:50051", grpc.WithInsecure())
defer conn.Close() // Гарантированное закрытие при выходе из функции

6. grpc.WithTransportCredentials()

Что делает: Создает опцию для настройки TLS/SSL аутентификации на стороне клиента.

Параметры:

• creds credentials.TransportCredentials — объект с настройками TLS.

Пример:

// Для продакшена используйте реальные сертификаты
creds, _ := credentials.NewClientTLSFromFile("server.crt", "")
conn, _ := grpc.Dial("localhost:50051", grpc.WithTransportCredentials(creds))

7. grpc.WithUnaryInterceptor()

Что делает: Добавляет перехватчик (interceptor) для унарных RPC на стороне клиента. Позволяет выполнять дополнительную логику (логирование, метрики, аутентификация) до и после вызова.

Параметры:

• interceptor grpc.UnaryClientInterceptor — функция-перехватчик.

Пример:

// Клиентский перехватчик для логирования
logInterceptor := func(ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, opts ...grpc.CallOption) error {
    log.Printf("Вызов метода: %s", method)
    err := invoker(ctx, method, req, reply, cc, opts...)
    log.Printf("Ответ получен: %v", reply)
    return err
}

conn, _ := grpc.Dial("localhost:50051", grpc.WithUnaryInterceptor(logInterceptor), grpc.WithInsecure())

8. grpc.StreamInterceptor()

Что делает: Добавляет перехватчик для потоковых RPC на стороне сервера. Аналогичен WithUnaryInterceptor, но для стримов.

Параметры:

• interceptor grpc.StreamServerInterceptor — функция-перехватчик.

Пример:

// Серверный перехватчик для стримов
streamInterceptor := func(s