使用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响应中，以便在不使用任何属性名的情况下进行解释-这样HSI ESI才能起作用。

当然，这会导致Json Writer发生异常，其值为：

Newtonsoft.Json.JsonWriterException：'状态对象中的令牌未定义将导致无效的JSON对象。路径“。”

有没有办法解决？

理想的输出是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： “更多json节点”部分是通过ESI解决的，它向我们的后端进一步请求用户/客户端特定的数据，即另一个端点。预期的结果是，我们随后将原始JSON文档与后来的JSON文档无缝地合并在一起。（这样，原始文档可能会很旧，而特定于客户的文档可能会很新）

编辑3： 端点/ something将输出类似JSON的片段，例如：

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

您的基本问题是a JsonWriter是状态机，它跟踪当前JSON状态并验证从一个状态到另一个状态的转换，从而确保不会编写结构错误的JSON。这以两种不同的方式使您绊倒。

首先，您的WriteJson()方法不调用WriteStartObject()和WriteEndObject()。这些是在JSON对象周围编写{和的方法}。由于“理想输出”显示了这些花括号，因此您应该在的开头和结尾添加对这些方法的调用WriteJson()。

其次，您正在调用WriteRawValue()一个格式正确的JSON不允许出现值的地方，特别是在期望使用属性名称的地方。预计这会导致异常，因为文档指出：

在期望值的地方写入原始JSON并更新编写者的状态。

您可以代替使用的是WriteRaw()，其记录如下：

编写原始JSON，而不会更改编写者的状态。

但是，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，以false如图这个答案来Json.Net -序列化的属性名称不带引号由克里斯托夫格尔斯：

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字符串和next属性之间包含一个逗号分隔符，但是在您的问题中没有分隔符：

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

事实证明，摆脱定界符是有问题的，因为 JsonTextWriter.WritePropertyName()当不在对象的开头时会自动写入定界符。但是，我认为这应该是可以接受的。ESI本身不知道它是要替换对象的first，last还是middle属性，因此似乎最好不要在替换字符串中包含定界符。

工作样本.Net 在这里摆弄。