如何将类序列化为适配Confluent Schema Registry的格式？

问题根源 #

你遇到的错误核心是：调用RegisterSchemaAsync时默认使用AVRO Schema类型，但你用Newtonsoft生成的是标准JSON Schema（类型为object），AVRO不支持这种格式，所以报错。同时Confluent对JSON Schema有特定规范要求，需要调整生成逻辑并明确指定Schema类型。

解决方案步骤 #

1. 调整Newtonsoft JSchemaGenerator配置 #

生成符合Confluent兼容的JSON Schema，需要指定正确的JSON Schema版本（比如Draft 7，Confluent官方支持的版本），并规范可空类型的生成逻辑：

var generator = new JSchemaGenerator();
generator.SchemaIdHandling = SchemaIdHandling.None; // 避免生成Confluent不需要的$id字段
generator.DefaultRequired = Required.Default; // 仅标记类中显式必填的字段
generator.DraftVersion = JSchemaDraftVersion.Draft7; // 匹配Confluent支持的JSON Schema版本

JSchema schema = generator.Generate(typeof(TotallyCoolCustomClass));
var stringSchema = schema.ToString();

2. 注册时明确指定SchemaType为Json #

调用RegisterSchemaAsync时必须显式指定第三个参数schemaType为SchemaType.Json，否则会默认使用AVRO类型导致兼容错误：

var subject = "TotallyCoolCustomClass";
var schemaId = await schemaRegistry.RegisterSchemaAsync(subject, stringSchema, SchemaType.Json);

完整可运行代码示例 #

using Newtonsoft.Json.Schema;
using Confluent.SchemaRegistry;

// 自定义业务类示例
public class TotallyCoolCustomClass
{
    public string? FavouriteQuote { get; set; }
    public int FavouriteNumber { get; set; }
}

// Schema注册逻辑
var config = new SchemaRegistryConfig { Url = "http://your-schema-registry-address:8081" };
using var schemaRegistry = new CachedSchemaRegistryClient(config);

var generator = new JSchemaGenerator();
generator.SchemaIdHandling = SchemaIdHandling.None;
generator.DefaultRequired = Required.Default;
generator.DraftVersion = JSchemaDraftVersion.Draft7;

JSchema schema = generator.Generate(typeof(TotallyCoolCustomClass));
var stringSchema = schema.ToString();

var subject = "TotallyCoolCustomClass";
var schemaId = await schemaRegistry.RegisterSchemaAsync(subject, stringSchema, SchemaType.Json);

额外注意事项 #

• 确保你的Confluent Schema Registry版本在5.5.0及以上，更低版本不支持JSON Schema类型。
• 若自定义类包含嵌套复杂类型，JSchemaGenerator会自动生成对应的嵌套JSON Schema，无需额外处理。
• 检查类属性类型与JSON Schema规范的匹配性：比如C#的int对应JSON Schema的integer，string?对应["string", "null"]格式。

内容的提问来源于stack exchange，提问作者Joshua Mee