当你的使用的Json库是System.Text.Json,而不是Newtonsoft.Json库的时候,你可能遇到以下问题及其解决办法。通常的解决办法是进行一些对应的配置。此外就需要根据情况使用自定义转换器实现你的需求。以下是通常遇到的使用自定义转换器解决的例子:
Q1.当遇到System.InvalidCastException:"Unable to cast object of type 'System.Text.Json.JsonElement' to type 'System.Int32'."这种错误的时候,是由于System.Text.Json类库进行json转化时,没有明确类型的基础类型导致的。通常可能是某一个属性类型使用object情况。
A1:解决办法是写一个 对象Json转换器 类,如下所示:
csharp
/// <summary>
/// 对象Json转化器
/// </summary>
public class ObjectJsonConverter : JsonConverter<Object>
{
public override object? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
switch (reader.TokenType)
{
case JsonTokenType.String:
if (DateTime.TryParse(reader.GetString(), out DateTime dateTime))
return dateTime;
return reader.GetString();
case JsonTokenType.Number:
if (reader.TryGetInt32(out int intValue))
return intValue;
else if (reader.TryGetDouble(out double doubleValue))
return doubleValue;
else if (reader.TryGetDecimal(out decimal decimalValue))
return decimalValue;
throw new JsonException("Unsupported number format");
case JsonTokenType.True:
return true;
case JsonTokenType.False:
return false;
case JsonTokenType.Null:
return null;
case JsonTokenType.StartObject:
return JsonSerializer.Deserialize<JsonElement>(ref reader, options);
case JsonTokenType.StartArray:
return JsonSerializer.Deserialize<JsonElement[]>(ref reader, options);
default:
throw new JsonException($"Unexpected token type: {reader.TokenType}");
}
}
public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
{
if (value == null) writer.WriteNullValue();
else if ((value is string || value is DateTime || value is Guid)) writer.WriteStringValue(value.ToString());
else if (value is int intValue) writer.WriteNumberValue(intValue);
else if (value is double doubleValue) writer.WriteNumberValue(doubleValue);
else if (value is decimal decimalValue) writer.WriteNumberValue(decimalValue);
else if (value is char charValue) writer.WriteNumberValue(charValue);
else if (value is bool boolValue) writer.WriteBooleanValue(boolValue);
else if (value is JsonElement jsonElement) jsonElement.WriteTo(writer);
else if (value is JsonElement[] jsonElements)
{
writer.WriteStartArray();
foreach (var element in jsonElements)
{
element.WriteTo(writer);
}
writer.WriteEndArray();
}
else JsonSerializer.Serialize(writer, value, value.GetType(), options);
}
}
使用如下:
csharp
builder.Services.AddJsonOptions(options =>
{
// 添加Object格式化转换器
options.JsonSerializerOptions.Converters.Add(new ObjectJsonConverter());
});
Q2:在webapi接口返回结果中,时间属性的值返回的形式如:"2024-01-01T10:00:00",而我们想要的是不带T的格式,比如"2024-01-01 10:00:00"这种。
A2:需要定义一个时间Json转换器DateTimeJsonConverter,代码如下:
csharp
/// <summary>
/// 设置Json默认DateTime格式化
/// </summary>
public class DateTimeJsonConverter : JsonConverter<DateTime>
{
private readonly string _format;
public DateTimeJsonConverter(string format)
{
_format = format;
}
public override void Write(Utf8JsonWriter writer, DateTime dateTime, JsonSerializerOptions options)
{
writer.WriteStringValue(dateTime.ToString(_format));
}
public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
if (reader.TokenType == JsonTokenType.String)
{
if (DateTime.TryParse(reader.GetString(), out DateTime dateTime))
return dateTime;
}
return reader.GetDateTime();
}
}
使用如下:
csharp
builder.Services.AddJsonOptions(options =>
{
// 添加时间格式化转换器
options.JsonSerializerOptions.Converters.Add(new DateTimeJsonConverter("yyyy-MM-dd HH:mm:ss"));
});
通常完整一点的配置如下:
csharp
builder.Services.AddJsonOptions(options =>
{
// 设置编码格式
options.JsonSerializerOptions.Encoder = JavaScriptEncoder.Create(UnicodeRanges.All);
// 是否格式化文本
options.JsonSerializerOptions.WriteIndented = true;
//不区分大小写
options.JsonSerializerOptions.PropertyNameCaseInsensitive = true;//不区分大小写
// 字段采用驼峰式命名
options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
// 忽略null值
//options.JsonSerializerOptions.DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull;
// 忽略只读字段
//options.JsonSerializerOptions.IgnoreReadOnlyProperties = true;
// 对字典的键进行驼峰命名
options.JsonSerializerOptions.DictionaryKeyPolicy = JsonNamingPolicy.CamelCase;
//不允许有注释的不标准json
options.JsonSerializerOptions.ReadCommentHandling = JsonCommentHandling.Disallow;
// 允许属性值末尾存在逗号
options.JsonSerializerOptions.AllowTrailingCommas = true;
// 处理循环引用类型
options.JsonSerializerOptions.ReferenceHandler = ReferenceHandler.IgnoreCycles;
//枚举类型转string配置(避免转int)
//options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
// 添加时间格式化转换器
options.JsonSerializerOptions.Converters.Add(new DateTimeJsonConverter("yyyy-MM-dd HH:mm:ss"));
// 添加Object格式化转换器
options.JsonSerializerOptions.Converters.Add(new ObjectJsonConverter());
});
Q3:遇到枚举的属性,如果想在接口返回的时候不返回数字,而想返回字符串的情况
A3:在配置的时候进行如下配置即可:
csharp
builder.Services.AddJsonOptions(options =>
{
//枚举类型转string配置(避免转int)
options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});
此外在枚举的地方添加[JsonConverter(typeof(JsonStringEnumConverter))]特性即可返回字符串,代码如下:
csharp
public class Sample
{
public int Id { get; set; }
public object Value { get; set; }
[JsonConverter(typeof(JsonStringEnumConverter))]
public SampleType Type { get; set; }
}
public enum SampleType
{
AAAA,
BBBB,
CCCC
}
如果有不够的地方,自行添加。