将 $ref 替换为特定类型的自定义属性

Question

是否可以用自定义属性替换类型的 $ref 属性，但仅限于架构中的特定类型？似乎 JSON.NET 模式库对于自定义模式处理来说是全有或全无。

sample code 非常简单，但据我所知，一旦您将类型添加到 GenerationProviders，该库就不会为更深层次的类型提供自动架构生成 class层次结构。（我无法共享代码，这是一个无法访问互联网的锁定银行系统。）

我们使用从 .NET C# classes 的整个层次结构生成的模式文件来生成与 Java 的 Jackson 库对应的 Java classes。一些 class 属性是复杂类型，无法从模式中表示或生成，而是应该引用现有的 class 定义，而其余 class 属性（他们中的大多数）应该使用正常的 $ref 属性。

所以默认情况下，C# class 层次结构可能会生成如下内容：

"AccountType": {
    "$ref": "#/definitions/AccountTypeCode"
    },

而杰克逊需要这个：

"AccountType": {
    "existingJavaType": "com.foo.bar.pojo.AccountTypeCode"
    },

现在我们有点post-用 hokey 字符串替换处理模式，但这感觉像是一个可能受支持的用例。

Answer 1

您可以使用 custom JSchemaGenerationProvider 生成这样的架构，但完全抑制内部 "$ref" 属性的存在会带来额外的复杂性。

考虑以下简化示例：

public class Account
{
    public AccountTypeCode AccountType { get; set; }
    public SomeOtherData SomeOtherData { get; set; }
}

public class AccountTypeCode { }

public class SomeOtherData { }

您想为此数据模型生成一个架构，其中 AccountTypeCode 使用特定的现有 JavaType，其他所有内容均保持不变，如下所示：

{
  "definitions": {
    "SomeOtherData": {
      "type": [
        "object",
        "null"
      ]
    }
  },
  "type": "object",
  "properties": {
    "AccountType": {
      "existingJavaType": "com.foo.bar.pojo.AccountTypeCode"
    },
    "SomeOtherData": {
      "$ref": "#/definitions/SomeOtherData"
    }
  }
}

作为为 POCO 类型的任何子集注入现有 JavaType 模式的首次尝试，子类 JSchemaGenerationProvider 并覆盖 GetSchema() and CanGenerateSchema()，如下所示：

class ExistingJavaTypeSchemaProvider : JSchemaGenerationProvider
{
    readonly Dictionary<Type, string> existingJavaTypes;

    public ExistingJavaTypeSchemaProvider(Dictionary<Type, string> existingJavaTypes) 
        => this.existingJavaTypes = existingJavaTypes ?? throw new ArgumentNullException(nameof(existingJavaTypes));

    public override JSchema GetSchema(JSchemaTypeGenerationContext context)
        => existingJavaTypes.TryGetValue(context.ObjectType, out var existingJavaType) ? JSchema.Parse(new JObject(new JProperty("existingJavaType", existingJavaType)).ToString()) : null;

    public override bool CanGenerateSchema(JSchemaTypeGenerationContext context) 
        => existingJavaTypes.ContainsKey(context.ObjectType);
}

（通过覆盖 CanGenerateSchema()，您可以为除指定类型之外的所有类型回退到默认架构生成。这未在 docs 中显示，可能会让您想到 Json.NET 架构不支持混合使用默认架构和自定义架构。）

现在生成如下模式，为 AccountTypeCode 注入所需的现有 JavaType 值：

var generator =  new JSchemaGenerator
{
    GenerationProviders = { new ExistingJavaTypeSchemaProvider(new Dictionary<Type, string>
                                                               {{ typeof(AccountTypeCode), "com.foo.bar.pojo.AccountTypeCode" }}
                                                              ) },
};
generator.DefaultRequired = Required.Default;
var schema = generator.Generate(typeof(Account));

这导致以下架构（演示 fiddle #1 here）：

{
  "definitions": {
    "AccountTypeCode": {
      "existingJavaType": "com.foo.bar.pojo.AccountTypeCode"
    },
    "SomeOtherData": {
      "type": [
        "object",
        "null"
      ]
    }
  },
  "type": "object",
  "properties": {
    "AccountType": {
      "$ref": "#/definitions/AccountTypeCode"
    },
    "SomeOtherData": {
      "$ref": "#/definitions/SomeOtherData"
    }
  }
}

如您所见，我们已经完成了一半。 existingJavaType 已根据需要插入，但是 AccountTypeCode 已提取为本地定义而不是内联。虽然可以通过设置 JSchemaGenerator.SchemaLocationHandling to SchemaLocationHandling.Inline, there does not appear to be a way to force a particular type to be inlined. However, a quick perusal of the reference source shows that references are only generated for object, array and dictionary contracts. Thus creating a custom contract resolver that returns some other contract for AccountTypeCode, say JsonStringContract 来内联所有定义，但会强制内联。或者当然这也会修改生成的模式——但无论如何您已经手动生成了模式，因此这样做是无害的。

将这两部分放在一起，以下工厂可以为包含 AccountTypeCode:

的类型制造模式生成器

public static class ExistingJavaTypeJSchemaGeneratorFactory
{
    class ExistingJavaTypeSchemaProvider : JSchemaGenerationProvider
    {
        readonly Dictionary<Type, string> existingJavaTypes;
        
        public ExistingJavaTypeSchemaProvider(Dictionary<Type, string> existingJavaTypes) 
            => this.existingJavaTypes = existingJavaTypes ?? throw new ArgumentNullException(nameof(existingJavaTypes));
        
        public override JSchema GetSchema(JSchemaTypeGenerationContext context)
            => existingJavaTypes.TryGetValue(context.ObjectType, out var existingJavaType) ? JSchema.Parse(new JObject(new JProperty("existingJavaType", existingJavaType)).ToString()) : null;

        public override bool CanGenerateSchema(JSchemaTypeGenerationContext context) 
            => existingJavaTypes.ContainsKey(context.ObjectType);
    }

    class ExistingJavaTypeContractResolver : DefaultContractResolver
    {
        readonly Dictionary<Type, string> existingJavaTypes;
        
        public ExistingJavaTypeContractResolver(Dictionary<Type, string> existingJavaTypes) 
            => this.existingJavaTypes = existingJavaTypes ?? throw new ArgumentNullException(nameof(existingJavaTypes));

        protected override JsonContract CreateContract(Type objectType) 
            => existingJavaTypes.ContainsKey(objectType) ? new JsonStringContract(objectType) : base.CreateContract(objectType);
    }
    
    public static JSchemaGenerator CreateJSchemaGenerator(Dictionary<Type, string> existingJavaTypes)
        => new JSchemaGenerator
           {
               GenerationProviders = { new ExistingJavaTypeSchemaProvider(existingJavaTypes) },
               ContractResolver = new ExistingJavaTypeContractResolver(existingJavaTypes),
           };
}

然后使用如下：

var generator = ExistingJavaTypeJSchemaGeneratorFactory.CreateJSchemaGenerator(
    new Dictionary<Type, string>
    {
        {typeof(AccountTypeCode), "com.foo.bar.pojo.AccountTypeCode"}
    });
generator.DefaultRequired = Required.Default;
var schema = generator.Generate(typeof(Account));

演示 fiddle #2 here.

将 $ref 替换为特定类型的自定义属性

Replace $ref with custom attribute for specific types

json.net

jsonschema