使用 Newtonsoft 创建无效 Json - 允许无效对象？

Question

我故意尝试使用 Newtonsoft Json 创建无效的 JSON，以便放置 ESI 包含标签，这将获取另外两个 json 节点。

这是我的 JsonConverter 的 WriteJson 方法：

public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
    mApiResponseClass objectFromApi = (mApiResponseClass)value;

    foreach (var obj in objectFromApi.GetType().GetProperties())
    {
        if (obj.Name == "EsiObj")
        {
            writer.WriteRawValue(objectFromApi.EsiObj);
        }
        else
        {
            writer.WritePropertyName(obj.Name);
            serializer.Serialize(writer, obj.GetValue(value, null));
        }
    }
}

mApiResponseClass 中的 EsiObj 只是一个字符串，但需要将其写入 JSON 响应以在没有任何属性名称的情况下进行解释 - 这样 hte ESI 就可以工作了。

这当然会导致 Json Writer 出现异常，其值为：

Newtonsoft.Json.JsonWriterException: 'Token Undefined in state Object would result in an invalid JSON object. Path ''.'

有什么解决办法吗？

理想的输出是 JSON 格式，技术上是无效的，看起来像这样：

{
value:7,
string1:"woohoo",
<esi:include src="/something" />
Song:["I am a small API","all i do is run","but from who?","nobody knows"]
}

编辑： 使用 ESI 允许我们拥有单个响应的不同缓存长度 - 即我们可以将可以缓存很长时间的数据放在 JSON 的某些部分，并且只获取更新的部分，例如那些依赖关于特定于客户的数据。 ESI 不是 HTML 特定的。（正如下面的一些状态）它是运行通过 Varnish，它支持这些标签。不幸的是，它要求我们只放出 1 个文件作为响应，并且不需要客户的进一步请求。我们也不能改变我们的响应 - 所以我不能只添加一个 JSON 节点来专门包含其他节点。

编辑 2： "more json nodes" 部分由 ESI 解决，向我们的后端进一步请求 user/client 特定数据，即另一个端点。预期的结果是我们然后将原始 JSON 文档和后来请求的文档无缝地合并在一起。（这样原始文档可以是旧的，client-specific可以是新的）

编辑 3： 端点 /something 将输出 JSON-like 片段，如：

teapots:[ {Id: 1, WaterLevel: 100, Temperature: 74, ShortAndStout: true}, {Id: 2, WaterLevel: 47, Temperature: 32, ShortAndStout: true} ],

总响应为：

{
value:7,
string1:"woohoo",
teapots:[ {Id: 1, WaterLevel: 100, Temperature: 74, ShortAndStout: true}, {Id: 2, WaterLevel: 47, Temperature: 32, ShortAndStout: true} ],
Song:["I am a small API","all i do is run","but from who?","nobody knows"]
}

Answer 1

您的基本问题是 JsonWriter is a state machine, tracking the current JSON state 并验证从一个状态到另一个状态的转换，从而确保不编写结构错误的 JSON。这是以两种不同的方式绊倒你。

首先，您的 WriteJson() 方法没有调用 WriteStartObject() and WriteEndObject()。这些是围绕 JSON 对象编写 { 和 } 的方法。由于您的“理想输出”显示了这些大括号，因此您应该在 WriteJson().

的开头和结尾添加对这些方法的调用

其次，您在格式良好的 JSON 不允许出现值的位置调用 WriteRawValue()，特别是属性需要名称。预计这会导致异常，因为 documentation 声明：

Writes raw JSON where a value is expected and updates the writer's state.

您可以改用 WriteRaw()，即 documented，如下所示：

Writes raw JSON without changing the writer's state.

但是，WriteRaw()不会给你任何好处。具体来说，您需要自己编写任何分隔符和缩进。

解决方法 是将您的转换器修改为如下所示：

public class EsiObjConverter<T> : JsonConverter
{
    const string EsiObjName = "EsiObj";

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var contract = serializer.ContractResolver.ResolveContract(value.GetType()) as JsonObjectContract;
        if (contract == null)
            throw new JsonSerializationException(string.Format("Non-object type {0}", value));
        writer.WriteStartObject();
        int propertyCount = 0;
        bool lastWasEsiProperty = false;
        foreach (var property in contract.Properties.Where(p => p.Readable && !p.Ignored))
        {
            if (property.UnderlyingName == EsiObjName && property.PropertyType == typeof(string))
            {
                var esiValue = (string)property.ValueProvider.GetValue(value);
                if (!string.IsNullOrEmpty(esiValue))
                {
                    if (propertyCount > 0)
                    {
                        WriteValueDelimiter(writer);
                    }
                    writer.WriteWhitespace("\n");
                    writer.WriteRaw(esiValue);
                    // If it makes replacement easier, you could force the ESI string to be on its own line by calling
                    // writer.WriteWhitespace("\n");

                    propertyCount++;
                    lastWasEsiProperty = true;
                }
            }
            else
            {
                var propertyValue = property.ValueProvider.GetValue(value);

                // Here you might check NullValueHandling, ShouldSerialize(), ...

                if (propertyCount == 1 && lastWasEsiProperty)
                {
                    WriteValueDelimiter(writer);
                }
                writer.WritePropertyName(property.PropertyName);
                serializer.Serialize(writer, propertyValue);

                propertyCount++;
                lastWasEsiProperty = false;
            }
        }
        writer.WriteEndObject();
    }

    static void WriteValueDelimiter(JsonWriter writer)
    {
        var args = new object[0];
        // protected virtual void WriteValueDelimiter() 
        // https://www.newtonsoft.com/json/help/html/M_Newtonsoft_Json_JsonWriter_WriteValueDelimiter.htm
        // Since this is overridable by client code it is unlikely to be removed.
        writer.GetType().GetMethod("WriteValueDelimiter", BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic).Invoke(writer, args);
    }

    public override bool CanConvert(Type objectType)
    {
        return typeof(T).IsAssignableFrom(objectType);
    }

    public override bool CanRead { get { return false; } }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

序列化输出为：

{
  "value": 7,
  "string1": "woohoo",
<esi:include src="/something" />,
  "Song": [
    "I am a small API",
    "all i do is run",
    "but from who?",
    "nobody knows"
  ]
}

现在，在您的问题中，您想要的 JSON 输出显示 JSON 属性名称未正确引用。如果你真的需要这个并且它不仅仅是问题中的错字，你可以通过设置 JsonTextWriter.QuoteName to false as shown in this answer to Json.Net - Serialize property name without quotes by Christophe Geers:

来完成

var settings = new JsonSerializerSettings
{
    Converters = { new EsiObjConverter<mApiResponseClass>() },
};    
var stringWriter = new StringWriter();
using (var writer = new JsonTextWriter(stringWriter))
{
    writer.QuoteName = false;
    writer.Formatting = Formatting.Indented;
    writer.Indentation = 0;
    JsonSerializer.CreateDefault(settings).Serialize(writer, obj);
}

这导致：

{
value: 7,
string1: "woohoo",
<esi:include src="/something" />,
Song: [
"I am a small API",
"all i do is run",
"but from who?",
"nobody knows"
]
}

这是几乎您问题中显示的内容，但不完全是。它在 ESI 字符串和下一个属性之间包含一个逗号分隔符，但在您的问题中没有分隔符：

<esi:include src="/something" /> Song: [ ... ]

摆脱定界符被证明是有问题的，因为 JsonTextWriter.WritePropertyName() 在不在对象开头时自动写入定界符。然而，我认为这应该是可以接受的。 ESI 本身并不知道它是在替换对象的第一个、最后一个还是中间属性，因此最好不要在替换字符串中包含定界符。

工作示例 .Net fiddle here.

使用 Newtonsoft 创建无效 Json - 允许无效对象？

Create invalid Json with Newtonsoft - Allow invalid objects?

c#

json

json.net

esi