grpc_server

package module
v1.0.0-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 22, 2026 License: MIT Imports: 9 Imported by: 0

README

Compogo gRPC Server

Go Reference

GRPC-сервер и утилиты для работы со стримами в фреймворке Compogo.

Предоставляет:

  • GRPC-сервер с настройками keepalive
  • Интеграцию с Runner для управления жизненным циклом
  • Утилиты для работы с серверными, клиентскими и двунаправленными стримами

Установка

go get github.com/Compogo/grpc_server

Быстрый старт

package main

import (
    "github.com/Compogo/compogo"
    "github.com/Compogo/grpc_server"
)

func main() {
    app := compogo.NewApp("myapp",
        compogo.WithComponents(&grpc_server.Component),
    )

    app.AddComponents(&compogo.Component{
        Name: "my_service",
        Init: compogo.StepFunc(func(container compogo.Container) error {
            return container.Invoke(func(server *grpc_server.Server) error {
                // Регистрация вашего GRPC-сервиса
                service.RegisterMyServiceServer(server.GetGRPC(), &MyService{})
                return nil
            })
        }),
    })

    if err := app.Serve(); err != nil {
        panic(err)
    }
}

Конфигурация

Флаги командной строки
# Сетевой интерфейс
--server.grpc.interface=0.0.0.0

# Порт
--server.grpc.port=9090

# Максимальное количество одновременных стримов
--server.grpc.max_concurrent_streams=1000

# Keepalive настройки
--server.grpc.min_time=1s
--server.grpc.keepalive.time=10s
--server.grpc.keepalive.timeout=20s
--server.grpc.permit_without_stream=true

Использование

Серверный стрим (Server Streaming)

Отправка сообщений клиенту:

type MyService struct {
    service.UnimplementedMyServiceServer
}

func (s *MyService) Subscribe(req *emptypb.Empty, stream grpc.ServerStreamingServer[MyResponse]) error {
    client := stream.NewClientServerStreamingServer[MyResponse](stream, 10)

    // Отправка сообщений
    for i := 0; i < 10; i++ {
        if err := client.Send(&MyResponse{Data: "message"}); err != nil {
            return err
        }
    }

    return client.Process(ctx)
}
Клиентский стрим (Client Streaming)

Получение сообщений от сервера:

func (s *MyService) Subscribe(ctx context.Context, callback func(ctx context.Context, *MyResponse) error) error {
    stream, err := s.client.Subscribe(ctx, &emptypb.Empty{})
    if err != nil {
        return err
    }

    client := stream.NewClientServerStreamingClient[MyResponse](stream, callback, logger)

    return client.Process(ctx)
}
Двунаправленный стрим (Bidirectional Streaming)

Одновременная отправка и получение сообщений:

// На сервере
func (s *MyService) Chat(stream grpc.BidiStreamingServer[ChatRequest, ChatResponse]) error {
    server := stream.NewClientBidiStreamingServer[ChatRequest, ChatResponse](
        stream,
        func(ctx context.Context, req *ChatRequest) error {
            // Обработка входящих сообщений
            return nil
        },
        logger,
        10,
    )

    // Отправка сообщений
    server.Send(&ChatResponse{Message: "Hello"})

    return server.Process(ctx)
}

// На клиенте
func (c *Client) Chat(ctx context.Context, callback func(ctx context.Context, *ChatResponse) error) error {
    stream, err := c.client.Chat(ctx)
    if err != nil {
        return err
    }

    client := stream.NewClientBidiStreamingServer[ChatRequest, ChatResponse](
        stream,
        callback,
        logger,
        10,
    )

    // Отправка сообщений
    client.Send(&ChatRequest{Message: "Hello"})

    return client.Process(ctx)
}

Зависимости

Лицензия

MIT License

Copyright (c) 2026 Compogo

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

Constants

View Source
const (
	// MaxConcurrentStreamsFieldName максимальное количество одновременных стримов
	MaxConcurrentStreamsFieldName = "server.grpc.max_concurrent_streams"

	// MinTimeFieldName минимальное время между keepalive пингами
	MinTimeFieldName = "server.grpc.min_time"

	// PermitWithoutStreamFieldName разрешать keepalive без активных стримов
	PermitWithoutStreamFieldName = "server.grpc.permit_without_stream"

	// KeepaliveTimeFieldName интервал keepalive пингов
	KeepaliveTimeFieldName = "server.grpc.keepalive.time"

	// KeepaliveTimeoutFieldName таймаут keepalive
	KeepaliveTimeoutFieldName = "server.grpc.keepalive.timeout"

	// InterfaceFieldName сетевой интерфейс
	InterfaceFieldName = "server.grpc.interface"

	// PortFieldName порт
	PortFieldName = "server.grpc.port"
)

Variables

View Source
var (
	MaxConcurrentStreamsDefault = uint32(1000)
	MinTimeDefault              = time.Second
	PermitWithoutStreamDefault  = true
	KeepaliveTimeDefault        = time.Second * 10
	KeepaliveTimeoutDefault     = time.Second * 20
	InterfaceDefault            = "0.0.0.0"
	PortDefault                 = uint16(9090)
)
View Source
var Component = compogo.Component{
	Dependencies: compogo.Components{
		&runner.Component,
	},
	Init: compogo.StepFunc(func(container compogo.Container) error {
		return container.Provides(
			NewConfig,
			NewServer,
		)
	}),
	BindFlags: compogo.BindFlags(func(flagSet flag.FlagSet, container compogo.Container) error {
		return container.Invoke(func(config *Config) {
			flagSet.BoolVar(&config.PermitWithoutStream, PermitWithoutStreamFieldName, PermitWithoutStreamDefault, "")
			flagSet.Uint16Var(&config.Port, PortFieldName, PortDefault, "")
			flagSet.Uint32Var(&config.MaxConcurrentStreams, MaxConcurrentStreamsFieldName, MaxConcurrentStreamsDefault, "")
			flagSet.StringVar(&config.Interface, InterfaceFieldName, InterfaceDefault, "")
			flagSet.DurationVar(&config.MinTime, MinTimeFieldName, MinTimeDefault, "")
			flagSet.DurationVar(&config.KeepaliveTime, KeepaliveTimeFieldName, KeepaliveTimeDefault, "")
			flagSet.DurationVar(&config.KeepaliveTimeout, KeepaliveTimeoutFieldName, KeepaliveTimeoutDefault, "")
		})
	}),
	Configuration: compogo.StepFunc(func(container compogo.Container) error {
		return container.Invoke(Configuration)
	}),
	Execute: compogo.StepFunc(func(container compogo.Container) error {
		return container.Invoke(func(r runner.Runner, server *Server) error {
			return r.RunProcess(server)
		})
	}),
	Stop: compogo.StepFunc(func(container compogo.Container) error {
		return container.Invoke(func(server *Server) error {
			return server.Close()
		})
	}),
}

Component — компонент GRPC-сервера для Compogo. Регистрирует сервер в DI-контейнере и запускает его через Runner.

Пример:

app.AddComponents(&grpc_server.Component)

var s *grpc_server.Server
container.Invoke(func(server *grpc_server.Server) { s = server })
service.RegisterMyServiceServer(s.GetGRPC(), &MyService{})

Functions

This section is empty.

Types

type Config

type Config struct {
	PermitWithoutStream  bool
	Port                 uint16
	MaxConcurrentStreams uint32
	Interface            string
	MinTime              time.Duration
	KeepaliveTime        time.Duration
	KeepaliveTimeout     time.Duration
}

Config содержит конфигурацию GRPC-сервера.

func Configuration

func Configuration(config *Config, configurator compogo.Configurator) *Config

Configuration загружает конфигурацию из Configurator.

func NewConfig

func NewConfig() *Config

NewConfig создаёт новую конфигурацию.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server представляет GRPC-сервер с поддержкой graceful shutdown.

func NewServer

func NewServer(config *Config) *Server

NewServer создаёт новый GRPC-сервер с настройками из конфигурации.

func (*Server) Close

func (server *Server) Close() error

func (*Server) GetGRPC

func (server *Server) GetGRPC() *grpc.Server

GetGRPC возвращает внутренний GRPC-сервер для регистрации сервисов.

func (*Server) Name

func (server *Server) Name() string

func (*Server) Process

func (server *Server) Process(_ context.Context) error

Process запускает GRPC-сервер. Реализует интерфейс runner.Process.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL