Can System.Text.Json Achieve Selective Serialization Like Newtonsoft's IContractResolver?

Can System.Text.Json Implement Selective Serialization Like IContractResolver?

The new System.Text.Json namespace lacks an exact equivalent to Newtonsoft's IContractResolver. However, .NET 7 introduces contract customization, which offers similar functionality.

Contract Customization in .NET 7

Contract customization allows users to customize JSON serialization metadata using the IJsonTypeInfoResolver interface. By implementing this interface, developers can create their own contract resolvers to specify which properties to serialize.

Creating a Custom Contract Resolver

To create a custom contract resolver that selectively serializes fields, you can follow these steps:

1. Define fluent extension methods to modify the DefaultJsonTypeInfoResolver:

   public static DefaultJsonTypeInfoResolver SerializeSelectedFields(this DefaultJsonTypeInfoResolver resolver, IEnumerable<string> membersToSerialize);

2. Set the TypeInfoResolver in the JsonSerializerOptions:

   var options = new JsonSerializerOptions
   {
       TypeInfoResolver = new DefaultJsonTypeInfoResolver()
           .SerializeSelectedFields("FirstName,Email,Id"),
       ...
   };

Example

The following code demonstrates how to selectively serialize the "FirstName", "Email", and "Id" properties using contract customization:

var options = new JsonSerializerOptions
{
    TypeInfoResolver = new DefaultJsonTypeInfoResolver()
        .SerializeSelectedFields("FirstName,Email,Id"),
    ...
};

// Serialize the object
var json = JsonSerializer.Serialize(obj, options);

Additional Notes

• Use locale-invariant string logic to construct serialization metadata.
• System.Text.Json is case-sensitive by default, so you may need to match property names case-sensitively.

The above is the detailed content of Can System.Text.Json Achieve Selective Serialization Like Newtonsoft's IContractResolver?. For more information, please follow other related articles on the PHP Chinese website!