Como garantir que a string seja JSON válida usando JSON.NET

Eu tenho uma string crua. Eu só quero validar se a string é JSON válida ou não. Estou usando o JSON.NET.

Através do código:

Sua melhor aposta é usar a análise dentro de try-catche capturar uma exceção em caso de falha na análise. (Não conheço nenhum TryParsemétodo) .

(Usando JSON.Net)

A maneira mais simples seria Parsea string usando JToken.Parse, e também para verificar se a string começa com {ou [e termina com }ou ]respectivamente (adicionado a partir desta resposta ) :

private static bool IsValidJson(string strInput)
{
    if (string.IsNullOrWhiteSpace(stringValue)) { return false;}
    strInput = strInput.Trim();
    if ((strInput.StartsWith("{") && strInput.EndsWith("}")) || //For object
        (strInput.StartsWith("[") && strInput.EndsWith("]"))) //For array
    {
        try
        {
            var obj = JToken.Parse(strInput);
            return true;
        }
        catch (JsonReaderException jex)
        {
            //Exception in parsing json
            Console.WriteLine(jex.Message);
            return false;
        }
        catch (Exception ex) //some other exception
        {
            Console.WriteLine(ex.ToString());
            return false;
        }
    }
    else
    {
        return false;
    }
}

O motivo para adicionar verificações para {ou [etc foi baseado no fato de que JToken.Parseanalisaria os valores como "1234"ou "'a string'"como um token válido. A outra opção poderia ser usar ambos JObject.Parsee JArray.Parsena análise e ver se algum deles foi bem-sucedido, mas acredito que procurar {}e []deve ser mais fácil. (Obrigado @RhinoDevel por apontar )

Sem JSON.Net

Você pode utilizar o namespace System.Json do .Net framework 4.5 , como:

string jsonString = "someString";
try
{
    var tmpObj = JsonValue.Parse(jsonString);
}
catch (FormatException fex)
{
    //Invalid json format
    Console.WriteLine(fex);
}
catch (Exception ex) //some other exception
{
    Console.WriteLine(ex.ToString());
}

(Mas você deve instalar System.Jsonatravés do gerenciador de pacotes Nuget usando o comando: PM> Install-Package System.Json -Version 4.0.20126.16343no Package Manager Console) (extraído daqui )

Maneira sem código:

Normalmente, quando há uma pequena string json e você está tentando encontrar um erro na string json, eu pessoalmente prefiro usar as ferramentas on-line disponíveis. O que eu costumo fazer é:

• Cole a cadeia JSON no JSONLint O JSON Validator e veja se é um JSON válido.
• Posteriormente, copie o JSON correto para http://json2csharp.com/ e gere uma classe de modelo para ele e des serialize-o usando JSON.Net.

Use o JContainer.Parse(str)método para verificar se o str é um Json válido. Se isso gera exceção, não é um Json válido.

JObject.Parse- Pode ser usado para verificar se a string é um objeto Json válido
JArray.Parse- Pode ser usado para verificar se a string é um Json Array válido
JContainer.Parse- Pode ser usado para verificar o objeto Json e a Matriz

Com base na resposta de Habib, você pode escrever um método de extensão:

public static bool ValidateJSON(this string s)
{
    try
    {
        JToken.Parse(s);
        return true;
    }
    catch (JsonReaderException ex)
    {
        Trace.WriteLine(ex);
        return false;
    }
}

Que pode ser usado assim:

if(stringObject.ValidateJSON())
{
    // Valid JSON!
}

Apenas para adicionar algo à resposta do @ Habib, você também pode verificar se o JSON fornecido é de um tipo válido:

public static bool IsValidJson<T>(this string strInput)
{
    strInput = strInput.Trim();
    if ((strInput.StartsWith("{") && strInput.EndsWith("}")) || //For object
        (strInput.StartsWith("[") && strInput.EndsWith("]"))) //For array
    {
        try
        {
            var obj = JsonConvert.DeserializeObject<T>(strInput);
            return true;
        }
        catch // not valid
        {             
            return false;
        }
    }
    else
    {
        return false;
    }
}

Descobri que o JToken.Parse analisa incorretamente o JSON inválido, como o seguinte:

{
"Id" : , 
"Status" : 2
}

Cole a sequência JSON em http://jsonlint.com/ - é inválida.

Então eu uso:

public static bool IsValidJson(this string input)
{
    input = input.Trim();
    if ((input.StartsWith("{") && input.EndsWith("}")) || //For object
        (input.StartsWith("[") && input.EndsWith("]"))) //For array
    {
        try
        {
            //parse the input into a JObject
            var jObject = JObject.Parse(input);

            foreach(var jo in jObject)
            {
                string name = jo.Key;
                JToken value = jo.Value;

                //if the element has a missing value, it will be Undefined - this is invalid
                if (value.Type == JTokenType.Undefined)
                {
                    return false;
                }
            }
        }
        catch (JsonReaderException jex)
        {
            //Exception in parsing json
            Console.WriteLine(jex.Message);
            return false;
        }
        catch (Exception ex) //some other exception
        {
            Console.WriteLine(ex.ToString());
            return false;
        }
    }
    else
    {
        return false;
    }

    return true;
}

Option️ Opção alternativa que não usa JSON.Net ⚠️

Para .Net Core / .Net 5 ( em pré-visualização até o momento em que este artigo foi escrito ), também é possível usar o System.Text.Jsonespaço para nome e analisar usando o JsonDocument. O exemplo é um método de extensão baseado nas operações do espaço para nome:

public static bool IsJsonValid(this string txt)
{
    try { return JsonDocument.Parse(txt) != null; } catch {}

    return false;
}

Em relação à resposta de Tom Beech; Eu vim com o seguinte:

public bool ValidateJSON(string s)
{
    try
    {
        JToken.Parse(s);
        return true;
    }
    catch (JsonReaderException ex)
    {
        Trace.WriteLine(ex);
        return false;
    }
}

Com o uso do seguinte:

if (ValidateJSON(strMsg))
{
    var newGroup = DeserializeGroup(strMsg);
}

JToken.Typeestá disponível após uma análise bem-sucedida. Isso pode ser usado para eliminar parte do preâmbulo nas respostas acima e fornecer informações para um controle mais preciso do resultado. Entrada totalmente inválida (por exemplo, "{----}".IsValidJson();ainda lançará uma exceção).

    public static bool IsValidJson(this string src)
    {
        try
        {
            var asToken = JToken.Parse(src);
            return asToken.Type == JTokenType.Object || asToken.Type == JTokenType.Array;
        }
        catch (Exception)  // Typically a JsonReaderException exception if you want to specify.
        {
            return false;
        }
    }

Referência do Json.Net para JToken.Type: https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JTokenType.htm

Este método não requer bibliotecas externas

using System.Web.Script.Serialization;
bool IsValidJson(string json)
    {
        try {
            var serializer = new JavaScriptSerializer();
            dynamic result = serializer.DeserializeObject(json);
            return true;
        } catch { return false; }
    }

Aqui está um método de extensão TryParse com base na resposta de Habib:

public static bool TryParse(this string strInput, out JToken output)
{
    if (String.IsNullOrWhiteSpace(strInput))
    {
        output = null;
        return false;
    }
    strInput = strInput.Trim();
    if ((strInput.StartsWith("{") && strInput.EndsWith("}")) || //For object
        (strInput.StartsWith("[") && strInput.EndsWith("]"))) //For array
    {
        try
        {
            output = JToken.Parse(strInput);
            return true;
        }
        catch (JsonReaderException jex)
        {
            //Exception in parsing json
            //optional: LogError(jex);
            output = null;
            return false;
        }
        catch (Exception ex) //some other exception
        {
            //optional: LogError(ex);
            output = null;
            return false;
        }
    }
    else
    {
        output = null;
        return false;
    }
}

Uso:

JToken jToken;
if (strJson.TryParse(out jToken))
{
    // work with jToken
}
else
{
    // not valid json
}

Eu estou usando este:

  internal static bool IsValidJson(string data)
  {
     data = data.Trim();
     try
     {
        if (data.StartsWith("{") && data.EndsWith("}"))
        {
           JToken.Parse(data);
        }
        else if (data.StartsWith("[") && data.EndsWith("]"))
        {
           JArray.Parse(data);
        }
        else
        {
           return false;
        }
        return true;
     }
     catch
     {
        return false;
     }
  }