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: "top-right corner",
};

生成コードの使用方法

生成されたコードには、シリアライズとデシリアライズのメソッドが含まれます。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には、長期間運用されるシステムや分散システムにおける安全なスキーマ進化のための組み込みチェックとガイドラインが含まれています。また、gRPCと同様のエンドツーエンドの型安全性を持つRPCもサポートしています。

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

対象ユーザー

サービス間で型安全なデータ交換を必要とする、複数言語スタックを運用するチーム。特に、フロントエンドとバックエンドで異なる言語を使用するフルスタックアプリケーションに有効です。