Propriedades obrigatórias
A partir do .NET 7, você pode marcar determinadas propriedades para indicar que elas devem estar presentes na carga JSON para que a desserialização seja bem-sucedida. Se uma ou mais dessas propriedades necessárias não estiverem presentes, os métodos lançarão JsonSerializer.Deserialize um JsonExceptionarquivo .
Há três maneiras de marcar uma propriedade ou campo como necessário para a desserialização JSON:
- Adicionando o modificador necessário, que é novo no C# 11.
- Anotando-o com JsonRequiredAttributeo , que é novo no .NET 7.
- Modificando a JsonPropertyInfo.IsRequired propriedade do modelo de contrato, que é novo no .NET 7.
Da perspetiva do serializador, essas duas demarcações são equivalentes e ambas mapeiam para o mesmo pedaço de metadados, que é JsonPropertyInfo.IsRequired. Na maioria dos casos, você simplesmente usaria a palavra-chave C# integrada. No entanto, nos seguintes casos, você deve usar JsonRequiredAttribute em vez disso:
- Se você estiver usando uma linguagem de programação diferente de C# ou uma versão de nível inferior do C#.
- Se você quiser apenas que o requisito se aplique à desserialização JSON.
- Se você estiver usando
System.Text.Json
a serialização no modo de geração de origem. Nesse caso, seu código não será compilado se você usar o modificador, pois arequired
geração de código-fonte ocorre em tempo de compilação.
O trecho de código a seguir mostra um exemplo de uma propriedade modificada com a palavra-chave required
. Essa propriedade deve estar presente na carga JSON para que a desserialização seja bem-sucedida.
using System.Text.Json;
// The following line throws a JsonException at run time.
Console.WriteLine(JsonSerializer.Deserialize<Person>("""{"Age": 42}"""));
public class Person
{
public required string Name { get; set; }
public int Age { get; set; }
}
Em alternativa, pode utilizar JsonRequiredAttribute:
using System.Text.Json;
// The following line throws a JsonException at run time.
Console.WriteLine(JsonSerializer.Deserialize<Person>("""{"Age": 42}"""));
public class Person
{
[JsonRequired]
public string Name { get; set; }
public int Age { get; set; }
}
Também é possível controlar se um imóvel é necessário através do modelo de contrato usando o JsonPropertyInfo.IsRequired imóvel:
var options = new JsonSerializerOptions
{
TypeInfoResolver = new DefaultJsonTypeInfoResolver
{
Modifiers =
{
static typeInfo =>
{
if (typeInfo.Kind != JsonTypeInfoKind.Object)
return;
foreach (JsonPropertyInfo propertyInfo in typeInfo.Properties)
{
// Strip IsRequired constraint from every property.
propertyInfo.IsRequired = false;
}
}
}
}
};
// Deserialization now succeeds even though the Name property isn't in the JSON payload.
JsonSerializer.Deserialize<Person>("""{"Age": 42}""", options);