以“TryParse”方式反序列化 json

Question

当我向服务（我不拥有该服务）发送请求时，它可能会以请求的 JSON 数据或如下所示的错误进行响应：

{
    "error": {
        "status": "error message",
        "code": "999"
    }
}

在这两种情况下，HTTP 响应代码都是 200 OK，因此我无法使用它来确定是否存在错误 - 我必须反序列化响应以进行检查。 所以我有一些看起来像这样的东西：

bool TryParseResponseToError(string jsonResponse, out Error error)
{
    // Check expected error keywords presence
    // before try clause to avoid catch performance drawbacks
    if (jsonResponse.Contains("error") &&
        jsonResponse.Contains("status") &&
        jsonResponse.Contains("code"))
    {
        try
        {
            error = new JsonSerializer<Error>().DeserializeFromString(jsonResponse);
            return true;
        }
        catch
        {
            // The JSON response seemed to be an error, but failed to deserialize.
            // Or, it may be a successful JSON response: do nothing.
        }
    }

    error = null;
    return false;
}

在这里，我有一个空的 catch 子句，它可能位于标准执行路径中，这是一种难闻的气味……嗯，不仅仅是难闻的气味：它很臭。

您知道“TryParse”响应以避免在标准执行路径中捕获的更好方法吗？

[编辑]

感谢Yuval Itzchakov 的回答，我改进了这样的方法：

bool TryParseResponse(string jsonResponse, out Error error)
{
    // Check expected error keywords presence :
    if (!jsonResponse.Contains("error") ||
        !jsonResponse.Contains("status") ||
        !jsonResponse.Contains("code"))
    {
        error = null;
        return false;
    }

    // Check json schema :
    const string errorJsonSchema =
        @"{
              'type': 'object',
              'properties': {
                  'error': {'type':'object'},
                  'status': {'type': 'string'},
                  'code': {'type': 'string'}
              },
              'additionalProperties': false
          }";
    JsonSchema schema = JsonSchema.Parse(errorJsonSchema);
    JObject jsonObject = JObject.Parse(jsonResponse);
    if (!jsonObject.IsValid(schema))
    {
        error = null;
        return false;
    }

    // Try to deserialize :
    try
    {
        error = new JsonSerializer<Error>.DeserializeFromString(jsonResponse);
        return true;
    }
    catch
    {
        // The JSON response seemed to be an error, but failed to deserialize.
        // This case should not occur...
        error = null;
        return false;
    }
}

我保留了 catch 子句……以防万一。

Answer 1

@Victor LG 使用 Newtonsoft 的答案很接近，但从技术上讲，它并不能避免原始海报要求的问题。它只是将它移到别处。此外，虽然它创建了一个设置实例来启用捕获丢失的成员，但这些设置不会传递给 DeserializeObject 调用，因此它们实际上被忽略了。

这是他的扩展方法的“免费”版本，其中还包括缺少成员标志。避免捕获的关键是将设置对象的Error 属性设置为 lambda，然后设置一个标志以指示失败并清除错误，以免导致异常。

 public static bool TryParseJson<T>(this string @this, out T result)
 {
    bool success = true;
    var settings = new JsonSerializerSettings
    {
        Error = (sender, args) => { success = false; args.ErrorContext.Handled = true; },
        MissingMemberHandling = MissingMemberHandling.Error
    };
    result = JsonConvert.DeserializeObject<T>(@this, settings);
    return success;
}

这是一个使用它的例子：

if(value.TryParseJson(out MyType result))
{ 
    // Do something with result…
}

Answer 2

使用Json.NET，您可以根据架构验证您的 json：

 string schemaJson = @"{
 'status': {'type': 'string'},
 'error': {'type': 'string'},
 'code': {'type': 'string'}
}";

JsonSchema schema = JsonSchema.Parse(schemaJson);

JObject jobj = JObject.Parse(yourJsonHere);
if (jobj.IsValid(schema))
{
    // Do stuff
}

然后在 TryParse 方法中使用它。

public static T TryParseJson<T>(this string json, string schema) where T : new()
{
    JsonSchema parsedSchema = JsonSchema.Parse(schema);
    JObject jObject = JObject.Parse(json);

    return jObject.IsValid(parsedSchema) ? 
        JsonConvert.DeserializeObject<T>(json) : default(T);
}

然后做：

var myType = myJsonString.TryParseJson<AwsomeType>(schema);

更新：

请注意，架构验证不再是主要 Newtonsoft.Json 包的一部分，您需要添加 Newtonsoft.Json.Schema 包。

更新 2：

如 cmets 中所述，“JSONSchema”具有定价模型，这意味着它不是免费的。您可以找到所有信息here

Answer 3

@Yuval 答案的略微修改版本。

static T TryParse<T>(string jsonData) where T : new()
{
  JSchemaGenerator generator = new JSchemaGenerator();
  JSchema parsedSchema = generator.Generate(typeof(T));
  JObject jObject = JObject.Parse(jsonData);

  return jObject.IsValid(parsedSchema) ?
      JsonConvert.DeserializeObject<T>(jsonData) : default(T);
}

当您没有可用于任何类型的文本模式时，可以使用此选项。

Answer 4

只是提供一个 try/catch 方法的示例（它可能对某些人有用）。

public static bool TryParseJson<T>(this string obj, out T result)
{
    try
    {
        // Validate missing fields of object
        JsonSerializerSettings settings = new JsonSerializerSettings();
        settings.MissingMemberHandling = MissingMemberHandling.Error;

        result = JsonConvert.DeserializeObject<T>(obj, settings);
        return true;
    }
    catch (Exception)
    {
        result = default(T);
        return false;
    }
}

那么，可以这样使用：

var result = default(MyObject);
bool isValidObject = jsonString.TryParseJson<MyObject>(out result);

if(isValidObject)
{
    // Do something
}

Answer 5

您可以deserialize JSON to a dynamic，并检查根元素是否为error。请注意，您可能不必像实际那样检查status 和code 的存在，除非服务器也在error 节点内发送有效的非错误响应。

除此之外，我认为你不能比try/catch 做得更好。

真正令人讨厌的是服务器发送 HTTP 200 来指示错误。 try/catch 仅显示为检查输入。

Answer 6

要测试文本是否是有效的 JSON 而不管架构，您还可以检查字符串响应中的引号：" 的数量，如下所示：

// Invalid JSON
var responseContent = "asgdg"; 
// var responseContent = "{ \"ip\" = \"11.161.195.10\" }";

// Valid JSON, uncomment to test these
// var responseContent = "{ \"ip\": \"11.161.195.10\", \"city\": \"York\",  \"region\": \"Ontartio\",  \"country\": \"IN\",  \"loc\": \"-43.7334,79.3329\",  \"postal\": \"M1C\",  \"org\": \"AS577 Bell Afgh\",  \"readme\": \"https://ipinfo.io/missingauth\"}";
// var responseContent = "\"asfasf\"";
// var responseContent = "{}";

int count = 0;
foreach (char c in responseContent)
    if (c == '\"') count++; // Escape character needed to display quotation
if (count >= 2 || responseContent == "{}") 
{
    // Valid Json
    try {
        JToken parsedJson = JToken.Parse(responseContent);
        Console.WriteLine("RESPONSE: Json- " + parsedJson.ToString(Formatting.Indented));
    }  
    catch(Exception ex){
        Console.WriteLine("RESPONSE: InvalidJson- " + responseContent);
    }
}
else
    Console.WriteLine("RESPONSE: InvalidJson- " + responseContent);