Newtonsoft.Json support for Azure Core shared client library for .NET

Artikel
12/20/2023

The Azure.Core package contains types shared by the latest Azure SDK client libraries. This Newtonsoft.Json compatibility library:

Contains converters dependent upon the Newtonsoft.Json package.
Enables serialization and deserialization of custom model types using Newtonsoft.Json. Those custom model types may then be used with the following client libraries:
- Azure.DigitalTwins.Core
- Azure.Search.Documents

Getting started

Install the package

Install this package from NuGet using the .NET CLI:

dotnet add package Microsoft.Azure.Core.NewtonsoftJson

Key concepts

This support package contains the NewtonsoftJsonObjectSerializer class which can be passed to some Azure SDKs' client options classes, as shown in the examples below.

The following converters are added automatically to the NewtonsoftJsonObjectSerializer if you do not pass your own JsonSerializerSettings:

NewtonsoftJsonETagConverter to convert Azure.ETag properties.

See the example Using default converters below for getting an instance of JsonSerializerSettings with this default list you can then modify as needed.

Examples

The Azure.Search.Documents package is used in examples to show how search results can be deserialized. For more information and examples using Azure.Search.Documents, see its README.

Deserializing models

Consider a custom model class containing information about movies:

public class Movie
{
    [JsonProperty("uuid")]
    public string Id { get; private set; } = Guid.NewGuid().ToString();

    public string Title { get; set; }

    public string Description { get; set; }

    public float Rating { get; set; }
}

Our Azure Cognitive Search index is defined using camelCase fields, and the Id field is actually defined as "uuid"; however, we can provide an idiomatic model without having to attribute all properties by setting the JsonSerializerSettings.ContractResolver property as shown below:

// Get the Azure Cognitive Search endpoint and read-only API key.
Uri endpoint = new Uri(Environment.GetEnvironmentVariable("SEARCH_ENDPOINT"));
AzureKeyCredential credential = new AzureKeyCredential(Environment.GetEnvironmentVariable("SEARCH_API_KEY"));

// Create serializer options with default converters for Azure SDKs.
JsonSerializerSettings serializerSettings = NewtonsoftJsonObjectSerializer.CreateJsonSerializerSettings();

// Serialize property names using camelCase by default.
serializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

SearchClientOptions clientOptions = new SearchClientOptions
{
    Serializer = new NewtonsoftJsonObjectSerializer(serializerSettings)
};

SearchClient client = new SearchClient(endpoint, "movies", credential, clientOptions);
Response<SearchResults<Movie>> results = client.Search<Movie>("Return of the King");

foreach (SearchResult<Movie> result in results.Value.GetResults())
{
    Movie movie = result.Document;

    Console.WriteLine(movie.Title);
    Console.WriteLine(movie.Description);
    Console.WriteLine($"Rating: {movie.Rating}\n");
}

If searching an index full of movies, the following may be printed:

The Lord of the Rings: The Return of the King
Gandalf and Aragorn lead the World of Men against Sauron's army to draw his gaze from Frodo and Sam as they approach Mount Doom with the One Ring.
Rating: 9.1

Using default converters

If you instantiate a NewtonsoftJsonObjectSerializer using the default constructor, some converters for common Azure SDKs are added automatically as listed above in Key concepts. To modify these default settings, you can create a new JsonSerializerSettings like in the following example:

JsonSerializerSettings serializerSettings = NewtonsoftJsonObjectSerializer.CreateJsonSerializerSettings();

// Serialize property names using camelCase by default.
serializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

// Add converters as needed, for example, to convert movie genres to an enum.
serializerSettings.Converters.Add(new StringEnumConverter());

SearchClientOptions clientOptions = new SearchClientOptions
{
    Serializer = new NewtonsoftJsonObjectSerializer(serializerSettings)
};

You can add or remove converters, set the ContractResolver, or any other members of JsonSerializerSettings you need.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Impressions

Dela via