c# - Converting newtonsoft code to System.Text.Json in .net core 3. what's equivalent of JObject.Parse and JsonProperty

Question

I am converting my newtonsoft implementation to new JSON library in .net core 3.0. I have the following code

public static bool IsValidJson(string json)
{
    try
    {                
        JObject.Parse(json);
        return true;
    }
    catch (Exception ex)
    {
        Logger.ErrorFormat("Invalid Json Received {0}", json);
        Logger.Fatal(ex.Message);
        return false;
    }
}

I am not able to find any equivalent for JObject.Parse(json);

Also what will be the attribute JsonProperty equivalent

public class ResponseJson
{
    [JsonProperty(PropertyName = "status")]
    public bool Status { get; set; }
    [JsonProperty(PropertyName = "message")]
    public string Message { get; set; }
    [JsonProperty(PropertyName = "Log_id")]
    public string LogId { get; set; }
    [JsonProperty(PropertyName = "Log_status")]
    public string LogStatus { get; set; }

    public string FailureReason { get; set; }
}

One more thing i will be looking for the equivalent of Formating.None.

Answer 1

You are asking a few questions here:

1. I am not able to find any equivalent for JObject.Parse(json);

   You can use JsonDocument to parse and examine any JSON, starting with its RootElement. The root element is of type JsonElement which represents any JSON value (primitive or not) and corresponds to Newtonsoft's JToken.

   But do take note of this documentation remark:

   This class utilizes resources from pooled memory to minimize the impact of the garbage collector (GC) in high-usage scenarios. Failure to properly dispose this object will result in the memory not being returned to the pool, which will increase GC impact across various parts of the framework.

   When you need to use a JsonElement outside the lifetime of its document, you must clone it:

   Gets a JsonElement that can be safely stored beyond the lifetime of the original JsonDocument.

   Also note that JsonDocument is currently read-only and does not provide an API for creating or modifying JSON. There is an open issue Issue #39922: Writable Json DOM tracking this.

   An example of use is as follows:

   //https://docs.microsoft.com/en-us/dotnet/csharp/whats-new/csharp-8#using-declarations 
   using var doc = JsonDocument.Parse(json);
   
   //Print the property names.
   var names = doc.RootElement.EnumerateObject().Select(p => p.Name);
   Console.WriteLine("Property names: {0}", string.Join(",", names)); // Property names: status,message,Log_id,Log_status,FailureReason
   
   //Re-serialize with indentation.
   using var ms = new MemoryStream();
   using (var writer = new Utf8JsonWriter(ms, new JsonWriterOptions { Indented = true }))
   {
       doc.WriteTo(writer);
   }
   var json2 = Encoding.UTF8.GetString(ms.GetBuffer(), 0, checked((int)ms.Length));
   
   Console.WriteLine(json2);
   

2. Also what will be the attribute JsonProperty equivalent?

   Attributes that can control JsonSerializer are placed in the System.Text.Json.Serialization namespace and inherit from an abstract base class JsonAttribute. Unlike JsonProperty, there is no omnibus attribute that can control all aspects of property serialization. Instead there are specific attributes to control specific aspects.

   As of .NET Core 3 these include:

   • [JsonPropertyNameAttribute(string)]:

     Specifies the property name that is present in the JSON when serializing and deserializing. This overrides any naming policy specified by JsonNamingPolicy.

     This is attribute you want to use to control the serialized names of your ResponseJson class:

     public class ResponseJson
     {
         [JsonPropertyName("status")]
         public bool Status { get; set; }
         [JsonPropertyName("message")]
         public string Message { get; set; }
         [JsonPropertyName("Log_id")]
         public string LogId { get; set; }
         [JsonPropertyName("Log_status")]
         public string LogStatus { get; set; }
     
         public string FailureReason { get; set; }
     }
     

   • [JsonConverterAttribute(Type)]:

     When placed on a type, the specified converter will be used unless a compatible converter is added to the JsonSerializerOptions.Converters collection or there is another JsonConverterAttribute on a property of the same type.

     Note that the documented priority of converters -- Attribute on property, then the Converters collection in options, then the Attribute on type -- differs from the documented order for Newtonsoft converters, which is the JsonConverter defined by attribute on a member, then the JsonConverter defined by an attribute on a class, and finally any converters passed to the JsonSerializer.

   • [JsonExtensionDataAttribute] - corresponds to Newtonsoft's [JsonExtensionData].

   • [JsonIgnoreAttribute] - corresponds to Newtonsoft's [JsonIgnore].

3. When writing JSON via Utf8JsonWriter, indentation can be controlled by setting JsonWriterOptions.Indented to true or false.

   When serializing to JSON via JsonSerializer.Serialize, indentation can be controlled by setting JsonSerializerOptions.WriteIndented to true or false.

Demo fiddle here showing serialization with JsonSerializer and parsing with JsonDocument.