Jak upewnić się, że ciąg jest prawidłowym kodem JSON przy użyciu JSON.NET

Mam surowy sznurek. Chcę tylko sprawdzić, czy ciąg jest prawidłowym JSON, czy nie. Używam JSON.NET.

Poprzez kod:

Najlepszym rozwiązaniem jest użycie parsowania wewnątrz try-catchwyjątku i catch w przypadku niepowodzenia parsowania. (Nie znam żadnej TryParsemetody) .

(Przy użyciu JSON.Net)

Najprostszym sposobem byłoby Parseużycie łańcucha JToken.Parse, a także sprawdzenie, czy ciąg zaczyna się od {lub [i kończy odpowiednio na }lub (dodane z tej odpowiedzi ) :]

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;
    }
}

Powodem dodania czeków dla {lub [itp. Był fakt, JToken.Parseże przeanalizowałoby wartości, takie jak "1234"lub "'a string'"jako prawidłowy token. Inną opcją może być użycie obu JObject.Parsei JArray.Parsepodczas analizowania i sprawdzenie, czy komuś się powiedzie, ale uważam, że sprawdzanie {}i []powinno być łatwiejsze. (Dzięki @RhinoDevel za wskazanie tego)

Bez JSON.Net

Możesz wykorzystać przestrzeń nazw System.Json .Net framework 4.5 , na przykład:

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());
}

(Ale musisz zainstalować System.Jsonprzez menedżera pakietów Nuget za pomocą polecenia: PM> Install-Package System.Json -Version 4.0.20126.16343w konsoli Menedżera pakietów) (pobrane stąd )

Sposób niekodowany:

Zwykle, gdy występuje mały ciąg json i próbujesz znaleźć błąd w łańcuchu json, wtedy osobiście wolę użyć dostępnych narzędzi on-line. Zwykle robię:

• Wklej ciąg JSON w JSONLint Walidator JSON i sprawdź, czy jest to prawidłowy kod JSON.
• Później skopiuj poprawny JSON do http://json2csharp.com/ i wygeneruj dla niego klasę szablonu, a następnie zdeserializuj go za pomocą JSON.Net.

Użyj JContainer.Parse(str)metody, aby sprawdzić, czy str jest prawidłowym plikiem Json. Jeśli zgłasza wyjątek, nie jest to poprawna Json.

JObject.Parse- Może być użyty do sprawdzenia, czy ciąg jest prawidłowym obiektem Json
JArray.Parse- Może być użyty do sprawdzenia, czy ciąg jest prawidłową tablicą Json
JContainer.Parse- Może być użyty do sprawdzenia zarówno obiektu Json, jak i tablicy

Opierając się na odpowiedzi Habiba, możesz napisać metodę rozszerzającą:

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

Które można następnie wykorzystać w następujący sposób:

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

Aby dodać coś do odpowiedzi @ Habib, możesz również sprawdzić, czy podany JSON pochodzi z prawidłowego typu:

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;
    }
}

Okazało się, że JToken.Parse niepoprawnie analizuje nieprawidłowy kod JSON, na przykład:

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

Wklej ciąg JSON do http://jsonlint.com/ - jest nieprawidłowy.

Więc używam:

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;
}

⚠️ Alternatywna opcja bez użycia JSON.Net ⚠️

W przypadku .Net Core / .Net 5 ( w wersji zapoznawczej w chwili pisania tego tekstu ) można również użyć System.Text.Jsonprzestrzeni nazw i przeanalizować za pomocą JsonDocument. Przykład to metoda rozszerzenia oparta na operacjach w przestrzeni nazw:

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

    return false;
}

Odnośnie odpowiedzi Toma Beecha; Zamiast tego wymyśliłem:

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

Korzystając z:

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

JToken.Typejest dostępny po pomyślnym przeanalizowaniu. Można to wykorzystać do wyeliminowania części preambuły z powyższych odpowiedzi i zapewnienia wglądu w lepszą kontrolę wyniku. Całkowicie nieprawidłowe dane wejściowe (np. "{----}".IsValidJson();Nadal będzie zgłaszać wyjątek).

    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;
        }
    }

Dokumentacja Json.Net dla JToken.Type: https://www.newtonsoft.com/json/help/html/T_Newtonsoft_Json_Linq_JTokenType.htm

Ta metoda nie wymaga bibliotek zewnętrznych

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

Oto metoda rozszerzenia TryParse oparta na odpowiedzi Habiba:

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;
    }
}

Stosowanie:

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

Używam tego:

  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;
     }
  }