https://github.com/updevru/go-micro-kit
Набор преднастроенных библиотек для быстрого создания микро-сервисов на go.
https://github.com/updevru/go-micro-kit
Last synced: 4 months ago
JSON representation
Набор преднастроенных библиотек для быстрого создания микро-сервисов на go.
- Host: GitHub
- URL: https://github.com/updevru/go-micro-kit
- Owner: updevru
- License: apache-2.0
- Created: 2024-07-12T14:21:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-23T16:06:34.000Z (10 months ago)
- Last Synced: 2025-08-24T06:05:07.954Z (10 months ago)
- Language: Go
- Homepage:
- Size: 76.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Micro Kit
Набор преднастроенных бибилотек для быстрого создания микро-сервисов на go.
Набор инструментов создан для Schema-First подхода, когда описываются сервисы в формает [protocol buffers](https://developers.google.com/protocol-buffers)
формате и далее генерируется код этих сервисов.
## Возможности
### Bootstrap manager
Удобный запуск нескольких сервисов в одном приложении (например gRPC и HTTP API на разных портах).
### API Gateway
Генерация gRPC API из protobuf и автоматическое создание HTTP API с помощью [gRPC-Gateway](https://github.com/grpc-ecosystem/grpc-gateway).
### Configuration
Конфигурация на основе env переменных или .env файлов, это позволяет удобно запускать сервисы в виде контейнеров.
### Cron
Простой функционал для запуска фоновых задач по расписанию.
### Discovery
Автоматическая регистрация сервиса в системах service discovery ([Consul](https://developer.hashicorp.com/consul)).
### Observability
Трассировка, метрики и логи в формет [OpenTelemetry](https://opentelemetry.io/docs/languages/go/).
## Установка
```
go get github.com/updevru/go-micro-kit
```
## Генерация кода
Установка утилит:
```
$ go install \
github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
google.golang.org/protobuf/cmd/protoc-gen-go \
google.golang.org/grpc/cmd/protoc-gen-go-grpc
```
Установленные утилиты должны находиться в папке, на которую указывает переменная окружения `$GOBIN`.
Пример генерации кода:
```bash
protoc -I proto .\proto\store\store.proto \
--go_out=./gen/ --go_opt=paths=source_relative --go-grpc_out=./gen/ --go-grpc_opt=paths=source_relative \
--grpc-gateway_out ./gen --grpc-gateway_opt paths=source_relative --grpc-gateway_opt generate_unbound_methods=true \
--openapiv2_out ./docs --openapiv2_opt allow_merge=true,merge_file_name=api
```
Команда генерирует весь необходимый go код, gRPC-Gateway и openapi спецификацию.
## Примеры использования
### main.go
```go
func main() {
// Единый context, который закрывается при завершении программы
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()
// Инициализируем конфигурацию и наполняем структуру переменными окружения
var cfg config.Config
if err := configPkg.CreateConfig(ctx, &cfg); err != nil {
panic(err)
}
// Настройка OpenTelemetry
var telemetryConfig telemetry.Config
otelShutdown, err := telemetry.SetupTelemetry(ctx, telemetryConfig)
if err != nil {
panic(err)
}
defer func() {
err = errors.Join(err, otelShutdown(context.Background()))
}()
logger := telemetry.CreateLoggerWithTelemetry()
tracer := telemetry.CreateTracer()
meter := telemetry.CreateMeter()
// Создаем Bootstrap manager
app := server.NewServer(logger, tracer, meter)
// Инифализируем и добавляем gRPC сервисы
app.Grpc(&cfg.Grpc, []grpc.ServerOption{}, func(g *grpc.Server) {
pbStore.RegisterStoreServer(g)
})
//Инициализируем и добавляем gRPC-Gateway, так же можем добавить дополнительные роуты
app.Http(&cfg.Http, &cfg.Grpc, []runtime.ServeMuxOption{}, func(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error {
if err := pbStore.RegisterStoreHandler(ctx, mux, conn); err != nil {
return err
}
return nil
})
// Добавляем фоновые задачи по расписанию
app.Cron([]server.CronTask{
{
Name: "clock",
Cron: "*/1 * * * *",
Fn: func(ctx context.Context) error {
// TODO: implement cron job
return nil
},
},
})
// Добавляем автоматический service discovery
consul, err := discovery.NewConsul(&cfg.App, &cfg.Http, &cfg.Grpc)
app.AddDiscovery(consul)
// Запуск приложения
if err := app.Run(ctx); err != nil {
logger.ErrorContext(ctx, "Failed to run server: %v", err)
panic(err)
}
}
```
### Конфигурация приложения
Используются библиотеки [go-envconfig](https://github.com/sethvargo/go-envconfig) и [godotenv](https://github.com/joho/godotenv).
```go
package config
import "github.com/updevru/go-micro-kit/config"
type Config struct {
config.App
Http config.Http `env:",prefix=HTTP_"`
Grpc config.Grpc `env:",prefix=GRPC_"`
Option string `env:"OPTION, default=value"`
}
```
### Работа с базой данных
Библиотека предоставляет простой интерфейс для работы с базами данных через [GORM](https://gorm.io/).
Поддерживается подключение к PostgreSQL и автоматическая миграция схемы базы данных.
#### Подключение к базе данных
```go
import (
"github.com/updevru/go-micro-kit/database"
"gorm.io/gorm"
)
// Подключение к PostgreSQL
db, err := database.Connect("host=localhost user=postgres password=postgres dbname=postgres port=5432 sslmode=disable")
if err != nil {
panic(err)
}
// Использование GORM для работы с базой данных
result := db.First(&User{}, 1)
```
#### Миграция базы данных
Библиотека поддерживает автоматическую миграцию схемы базы данных на основе моделей GORM.
```go
import (
"context"
"github.com/updevru/go-micro-kit/database"
)
// Определение модели
type User struct {
gorm.Model
Name string
Email string `gorm:"uniqueIndex"`
}
// Регистрация модели для миграции
database.AddModel(&User{})
// Выполнение миграции
err := database.Migrate(ctx, tracer, db)
if err != nil {
panic(err)
}
```
Миграция автоматически создаст таблицы, индексы и связи на основе определенных моделей.
Процесс миграции также интегрирован с OpenTelemetry для трассировки.
#### Интеграция с основным приложением
Пример интеграции работы с базой данных в основное приложение:
```go
func main() {
// ... инициализация приложения ...
// Подключение к базе данных
db, err := database.Connect(cfg.Database.DSN)
if err != nil {
logger.ErrorContext(ctx, "Failed to connect to database", slog.String("error", err.Error()))
panic(err)
}
// Регистрация моделей для миграции
database.AddModel(&User{})
database.AddModel(&Product{})
// Выполнение миграции
if err := database.Migrate(ctx, tracer, db); err != nil {
logger.ErrorContext(ctx, "Failed to migrate database", slog.String("error", err.Error()))
panic(err)
}
// ... запуск приложения ...
}
```