スキーマ レジストリ: Avro、Protobuf、互換性およびスキーマの進化
スキーマ レジストリは、Kafka のデータ ガバナンスにとって重要なコンポーネントです。 Avro および Protobuf スキーム、互換性ルールの一元管理 ダウンタイムなしの後方/前方/完全および進化スキーマ戦略。
制度ガバナンスの問題
20 のチームが 50 の異なるトピックに関するメッセージを作成する Kafka システムを想像してください。
レジストリ スキーマがない場合、各チームはメッセージ形式を個別に決定します。
今日はフィールド付きのJSON user_id、明日はに変わります userId。
そのトピックを読んだ消費者は黙って泣き崩れます。届いたデータは
データレイク上にあり、一貫性がありません。不整合のデバッグが調査になる
異なるチームのコードバージョン間のフォレンジック。
Lo スキーマレジストリ (Confluent、オープンソース) はこれを次の方法で解決します。 正式な契約: プロデューサーがスキーマを登録し、コンシューマーがメッセージを検証します。 受信したデータは互換性のあるスキームに準拠しています。データを送信しようとする試み 互換性がない場合は、破損するのではなく、明示的なエラーが発生して直ちに失敗します。 下流システムはサイレントに動作します。
何を学ぶか
- スキーマ レジストリ アーキテクチャ: プロデューサおよびコンシューマとどのように対話するか
- Avro、Protobuf、JSON スキーマ: それぞれをいつ使用するか
- 互換性の種類: 逆方向、前方、完全、推移的
- スキーマの進化: 変更を破壊することなくフィールドを追加/削除
- Avro および Confluent の Avro シリアライザーを使用した Java セットアップ
- ベスト プラクティス: サブジェクトの名前付け、バージョン管理、グローバル構成とサブジェクトごとの構成
アーキテクチャ: スキーマ レジストリの仕組み
スキーマ レジストリは、REST API を公開する Kafka とは別の HTTP サービスです。
各スキームは、 主題 (通常は名前
トピック + サフィックス -value o -key) と数値バージョン。
コミュニケーションは次のように行われます。
# Flusso producer:
# 1. Producer crea un ProducerRecord con un oggetto Avro/Protobuf
# 2. L'Avro Serializer fa una chiamata HTTP GET al Registry:
# "Esiste lo schema X per il subject 'orders-value'?"
# 3. Se non esiste (o e cambiato), POST per registrarlo:
# Schema Registry valida la compatibilita con le versioni precedenti
# Se compatibile: OK, assegna schema ID intero (es: 42)
# 4. Il serializer scrive il messaggio come:
# [0x00] [schema_id: 4 bytes] [payload Avro serializzato]
# 5. I primi 5 byte identificano il formato "magic byte + schema ID"
# Flusso consumer:
# 1. Consumer riceve i byte del messaggio
# 2. L'Avro Deserializer legge i primi 5 byte: magic byte + schema ID
# 3. Chiama il Registry: GET /schemas/ids/42
# 4. Registry risponde con lo schema (cachato localmente dopo la prima chiamata)
# 5. Deserializza il payload usando lo schema writer (come e stato scritto)
# e lo schema reader (come il consumer si aspetta di leggerlo)
# 6. Avro fa la conversione automatica se gli schemi sono compatibili
# Struttura del payload serializzato:
# | 0x00 | schema_id (4 bytes BE) | avro binary payload |
# ^magic byte ^es: 0x0000002A = 42
# Avvia lo Schema Registry (via Docker)
docker run -d \
-p 8081:8081 \
-e SCHEMA_REGISTRY_HOST_NAME=schema-registry \
-e SCHEMA_REGISTRY_KAFKASTORE_BOOTSTRAP_SERVERS="kafka-1:9092,kafka-2:9092" \
-e SCHEMA_REGISTRY_KAFKASTORE_TOPIC="_schemas" \
confluentinc/cp-schema-registry:7.6.0
Avro: スキーマとシリアル化
アパッチ・アブロ Kafka で最もよく使用されるシリアル化形式です。 そのコンパクトさと Confluent エコシステムでの強力なサポートが評価されています。アブロ計画 これは JSON で定義され、レジストリに保存されます。
// Schema Avro per un ordine - orders-value v1
{
"type": "record",
"namespace": "dev.federicocalo.orders",
"name": "Order",
"doc": "Schema per gli ordini e-commerce",
"fields": [
{
"name": "order_id",
"type": "string",
"doc": "Identificatore univoco dell'ordine"
},
{
"name": "user_id",
"type": "string"
},
{
"name": "amount",
"type": {
"type": "bytes",
"logicalType": "decimal",
"precision": 10,
"scale": 2
}
},
{
"name": "currency",
"type": "string",
"default": "EUR"
},
{
"name": "created_at",
"type": {
"type": "long",
"logicalType": "timestamp-millis"
}
},
{
"name": "status",
"type": {
"type": "enum",
"name": "OrderStatus",
"symbols": ["PENDING", "CONFIRMED", "SHIPPED", "DELIVERED", "CANCELLED"]
},
"default": "PENDING"
},
{
"name": "items",
"type": {
"type": "array",
"items": {
"type": "record",
"name": "OrderItem",
"fields": [
{"name": "product_id", "type": "string"},
{"name": "quantity", "type": "int"},
{"name": "unit_price", "type": "double"}
]
}
}
}
]
}
// Producer con Avro serializer e Schema Registry (Maven: io.confluent:kafka-avro-serializer)
Properties props = new Properties();
props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, "kafka-1:9092");
props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
// Avro Value Serializer (registra automaticamente lo schema nel Registry)
props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG,
"io.confluent.kafka.serializers.KafkaAvroSerializer");
// URL dello Schema Registry
props.put("schema.registry.url", "http://schema-registry:8081");
// Opzionale: autenticazione al Registry (se con Confluent Cloud)
// props.put("basic.auth.credentials.source", "USER_INFO");
// props.put("basic.auth.user.info", "api-key:api-secret");
KafkaProducer<String, GenericRecord> producer = new KafkaProducer<>(props);
// Carica lo schema da file .avsc
Schema schema = new Schema.Parser().parse(
new File("src/main/avro/Order.avsc")
);
// Crea un record Avro generico
GenericRecord order = new GenericData.Record(schema);
order.put("order_id", UUID.randomUUID().toString());
order.put("user_id", "user-42");
order.put("amount", new BigDecimal("99.99"));
order.put("currency", "EUR");
order.put("created_at", Instant.now().toEpochMilli());
order.put("status", new GenericData.EnumSymbol(schema.getField("status").schema(), "CONFIRMED"));
List<GenericRecord> items = new ArrayList<>();
GenericRecord item = new GenericData.Record(schema.getField("items").schema().getElementType());
item.put("product_id", "prod-789");
item.put("quantity", 2);
item.put("unit_price", 49.99);
items.add(item);
order.put("items", items);
producer.send(new ProducerRecord<>("orders", order.get("order_id").toString(), order));
producer.flush();
互換性ルール
サブジェクトの互換性ルールによって、スキーマに対する変更が決定されます。 許可されています。これはレジストリの最も重要な機能です。これを誤解すると、 パラメーターを使用すると、実稼働環境のコンシューマーが中断される可能性があります。
# Tipi di compatibilita disponibili:
# BACKWARD (default): le nuove versioni dello schema possono leggere
# i dati scritti con la versione precedente.
# Operazioni consentite: aggiungere campi CON default, rimuovere campi senza default
# Use case: consumer viene aggiornato PRIMA del producer
# Esempio: aggiungi campo "shipping_address" con default ""
# FORWARD: le versioni precedenti dello schema possono leggere
# i dati scritti con la nuova versione.
# Operazioni consentite: aggiungere campi senza default, rimuovere campi CON default
# Use case: producer viene aggiornato PRIMA del consumer
# FULL: sia backward che forward. La piu restrittiva.
# Operazioni consentite: SOLO aggiungere/rimuovere campi CON default
# Use case: non sai quale viene aggiornato prima
# NONE: nessun controllo di compatibilita (pericoloso in produzione)
# BACKWARD_TRANSITIVE, FORWARD_TRANSITIVE, FULL_TRANSITIVE:
# Come le versioni non-transitive ma la compatibilita e verificata
# rispetto a TUTTE le versioni precedenti, non solo l'ultima
# Configurazione globale e per-subject via REST API:
# Configurazione globale (default per tutti gli subject nuovi):
curl -X PUT http://schema-registry:8081/config \
-H "Content-Type: application/json" \
-d '{"compatibility": "FULL"}'
# Configurazione per subject specifico (override del globale):
curl -X PUT http://schema-registry:8081/config/orders-value \
-H "Content-Type: application/json" \
-d '{"compatibility": "BACKWARD"}'
# Verifica compatibilita prima di registrare (dry-run):
curl -X POST http://schema-registry:8081/compatibility/subjects/orders-value/versions/latest \
-H "Content-Type: application/json" \
-d '{"schema": "{\"type\": \"record\", \"name\": \"Order\", ...}"}'
# Response: {"is_compatible": true}
進化スキーム: 実践例
// Schema v1 (attuale in produzione)
{
"type": "record",
"name": "Order",
"fields": [
{"name": "order_id", "type": "string"},
{"name": "amount", "type": "double"},
{"name": "currency", "type": "string", "default": "EUR"}
]
}
// Schema v2 - AGGIUNTA backward-compatible:
// Aggiungi campo con default -> OK con BACKWARD e FULL
{
"type": "record",
"name": "Order",
"fields": [
{"name": "order_id", "type": "string"},
{"name": "amount", "type": "double"},
{"name": "currency", "type": "string", "default": "EUR"},
// NUOVO: campo con default (null per Avro union o valore stringa)
{"name": "discount_code", "type": ["null", "string"], "default": null}
]
}
// Schema v3 - RIMOZIONE backward-compatible:
// Rimuovi campo che aveva default -> OK con BACKWARD
// (Consumer con schema v2 riceveranno il default per discount_code quando leggono v3)
{
"type": "record",
"name": "Order",
"fields": [
{"name": "order_id", "type": "string"},
{"name": "amount", "type": "double"},
{"name": "currency", "type": "string", "default": "EUR"}
// discount_code rimosso: OK perche aveva default null
]
}
// Schema v4 - CAMBIAMENTO di tipo NON COMPATIBILE:
// Cambiare "amount" da double a string ROMPE backward e forward
// -> Rifiutato da Schema Registry con BACKWARD/FORWARD/FULL
// -> Devi usare un nuovo subject (nuovo topic) oppure NONE (rischio!)
{
"type": "record",
"name": "Order",
"fields": [
{"name": "order_id", "type": "string"},
{"name": "amount", "type": "string"}, // BREAKING: double -> string
{"name": "currency", "type": "string", "default": "EUR"}
]
}
Avro の代替としての Protobuf
プロトコルバッファー (Protobuf) そして Google と多くのチームの選択 より表現力豊かな型システムとデータ分離された IDL を好む人。 バージョン 5.5 以降、Confluent のスキーマ レジストリでサポートされています。
// orders.proto - Schema Protobuf per ordini
syntax = "proto3";
package dev.federicocalo.orders;
option java_package = "dev.federicocalo.orders";
option java_outer_classname = "OrderProto";
message Order {
string order_id = 1;
string user_id = 2;
double amount = 3;
string currency = 4;
int64 created_at_ms = 5; // timestamp in milliseconds
OrderStatus status = 6;
repeated OrderItem items = 7;
// Campo aggiunto in v2: backward-compatible in Protobuf
// (campi non presenti vengono ignorati)
string shipping_address = 8;
}
enum OrderStatus {
PENDING = 0;
CONFIRMED = 1;
SHIPPED = 2;
DELIVERED = 3;
CANCELLED = 4;
}
message OrderItem {
string product_id = 1;
int32 quantity = 2;
double unit_price = 3;
}
// Producer con Protobuf serializer
Properties props = new Properties();
props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG,
"io.confluent.kafka.serializers.protobuf.KafkaProtobufSerializer");
props.put("schema.registry.url", "http://schema-registry:8081");
KafkaProducer<String, Order> producer = new KafkaProducer<>(props);
Order order = Order.newBuilder()
.setOrderId(UUID.randomUUID().toString())
.setUserId("user-42")
.setAmount(99.99)
.setCurrency("EUR")
.setCreatedAtMs(Instant.now().toEpochMilli())
.setStatus(OrderStatus.CONFIRMED)
.addItems(OrderItem.newBuilder()
.setProductId("prod-789")
.setQuantity(2)
.setUnitPrice(49.99)
.build())
.build();
producer.send(new ProducerRecord<>("orders-proto", order.getOrderId(), order));
Avro、Protobuf、JSON スキーマ: いつどちらを使用するか
比較表: シリアル化フォーマット
- アブロ: コンパクトで効率的な Hadoop/Spark スキーム 進化は十分に文書化されており、データエンジニアリングに最適です。後進性の欠如 タイプ別の互換性: タイプを変更するには戦略が必要です。使用する場合に選択してください Confluent プラットフォーム、またはデータ レイク (Parquet 上のネイティブ Avro) へのパイプラインがあります。
- プロトバッファ: gRPC マイクロサービス、より表現力豊かなタイプに最適 (いずれか、マップ、ネイティブ タイムスタンプ)、IDE サポートの向上。フィールド番号は保証します 自然な下位互換性 (新しいフィールド = 新しい番号を追加)。選択してください すでに gRPC に Protobuf がある場合、または型指定された IDL を好む場合。
- JSON スキーマ: 相互運用可能、人間が判読可能、なし 編集。より大きな積載量。 IaC の経験が少ないチーム向けに選択するか、 ツールなしで読み取れる必要がある API 用。
スキームガバナンスのベストプラクティス
# 1. Naming convention per i subject
# Default (TopicNameStrategy): {topic-name}-value, {topic-name}-key
# Record name strategy (piu flessibile): {namespace}.{record-name}
# Configura su producer:
# props.put("value.subject.name.strategy",
# "io.confluent.kafka.serializers.subject.RecordNameStrategy")
# 2. Schema versioning in CI/CD
# Aggiorna lo schema nel repository -> PR review -> test compatibilita
# pre-merge -> register nel Registry di staging -> deploy producer
# Script di verifica compatibilita in CI:
#!/bin/bash
SCHEMA_FILE="src/main/avro/Order.avsc"
SUBJECT="orders-value"
REGISTRY_URL="http://schema-registry-staging:8081"
# Verifica compatibilita prima del merge
RESPONSE=$(curl -s -o /dev/null -w "%{http_code}" \
-X POST "${REGISTRY_URL}/compatibility/subjects/${SUBJECT}/versions/latest" \
-H "Content-Type: application/json" \
-d "{\"schema\": $(cat $SCHEMA_FILE | jq -Rs .)}")
if [ "$RESPONSE" != "200" ]; then
echo "ERRORE: Schema non compatibile con la versione in produzione"
exit 1
fi
echo "Schema compatibile: OK"
# 3. Usa schema IDs fissi nei test (non schema content)
# Questo rende i test stabili anche se lo schema evolve
# 4. Documenta ogni campo con "doc" in Avro
# Il Registry mostra la documentazione nella UI
# 5. Backup del Registry:
# Lo Schema Registry persiste gli schemi su Kafka (_schemas topic)
# Il backup del topic = backup degli schemi
kafka-console-consumer.sh \
--bootstrap-server kafka-1:9092 \
--topic _schemas \
--from-beginning \
> schemas-backup-$(date +%Y%m%d).json
結論
スキーマ レジストリは、Kafka をメッセージング システムから実際のシステムに変換します。 ガバナンスを備えたデータプラットフォーム: 生産者と消費者の間の正式な契約、進化 制御されたパターン、サイレント破損ではなく明示的なエラー。 複数のチームを持つ組織では、これは最も重要なコンポーネントの 1 つです 本番環境に入る前に正しく構成する必要があります。







