Skir: Современная альтернатива Protocol Buffers для типобезопасного обмена данными

Что делает Skir

Skir — это современная альтернатива Protocol Buffers, которая служит единым источником истины для типов данных. Вы пишете схему один раз в файле .skir и генерируете идиоматичный, типобезопасный код для нескольких языков.

Ключевые особенности и рабочий процесс

Вся конфигурация находится в одном YAML-файле. Вы можете инициализировать проект с помощью npx skir init. Режим отслеживания автоматически перекомпилирует код при изменении файлов.

Вот пример схемы из источника:

struct Point {
  x: int32;
  y: int32;
  label: string;
}

struct Shape {
  points: [Point];
  /// Краткое описание этой фигуры.
  label: string;
}
const TOP_RIGHT_CORNER: Point = {
  x: 600,
  y: 400,
  label: "верхний правый угол",
};

Использование сгенерированного кода

Сгенерированный код включает методы сериализации и десериализации. Для TypeScript:

import { Point } from "../skirout/shapes";

const point = Point.create({
  x: 3,
  y: 4,
  label: "P"
});
const pointJson = Point.serializer.toJson(point);
console.log(pointJson); // [3, 4, "P"]
const restored = Point.serializer.fromJson(pointJson);
console.log(restored.label); // "P"

Эволюция схемы и поддержка RPC

Skir включает встроенные проверки и рекомендации для безопасной эволюции схем в долгоживущих или распределённых системах. Он также поддерживает RPC со сквозной типобезопасностью, аналогичной gRPC.

Пример определения RPC:

struct WhatToWearRequest {
  temperature_celsius: float32;
  raining: bool;
}

struct WhatToWearResponse {
  bottom_outfit: string;
  sunglasses: bool;
}
method WhatToWear(WhatToWearRequest): WhatToWearResponse = 770862;

Дополнительные возможности

• Сериализация в компактный JSON (плотный, позволяет эволюцию схемы), читаемый JSON (для отладки) или бинарный формат (для производительности)
• Встроенный менеджер пакетов, который импортирует типы напрямую из репозиториев GitHub
• Расширение для VS Code с валидацией в реальном времени, автодополнением кода и автоматическим форматированием
• Поддерживаемые языки: TypeScript, Python, C++, Java, Kotlin, Dart

Для кого это предназначено

Командам, использующим стеки из разных языков, которым нужен типобезопасный обмен данными между сервисами, особенно полезно для full-stack приложений с разными языками на фронтенде и бэкенде.