Enum类型属性的RestSharp反序列化

本文关键字：RestSharp 反序列化 属性 类型 Enum | 更新日期: 2023-09-27 18:10:27

我有一个对象

            var testTcc = new TrendingConfigurationConfigDto
            {
                TrendingConfigurationId =1,
                ConfigId = 1,
                DeviceId = 1,
                Selected = true,
                YAxisPosition = YAxisPosition.Left,
                Order = 1,
                Color = "#ffffff",
                Configuration = new BO.Shared.Dtos.List.ConfigurationListDto
                {
                    Id = 1,
                    Name = "configuration",
                    Alias = "configuationAlias",
                    EnableEdit = true,
                    IsBusinessItem = true
                },
                Device = new BO.Shared.Dtos.List.DeviceListDto
                {
                    Id = 1,
                    Name = "Device"
                }
            };

当我将它序列化为json

时
var jsonTcc = SimpleJson.SerializeObject(testTcc);

它返回包含YAxisPosition = 1的json对象的字符串，当我尝试使用

对其进行反序列化时
testTcc = SimpleJson.DeserializeObject<TrendingConfigurationConfigDto>(jsonTcc);

它给出了一个异常系统。InvalidCastException，提示"指定的类型转换无效"。

我尝试将json字符串中的YAxisPosition值更改为字符串"1"或"Left"，它总是给我同样的错误，直到我从json字符串中删除属性YAxisPosition。

我可能遗漏了一些东西(枚举属性上的属性或类似的东西)。

请帮助我找到一种方法，使我可以序列化和反序列化一个对象，其中包含Enum类型的属性，使用RestSharp。

注意:我使用NewtonSoft尝试了成功的序列化和反序列化。但是我不希望我的Web API客户端依赖于nettwonsoft，因为我已经在使用RestSharp。

Enum类型属性的RestSharp反序列化

RestSharp删除了JSON。. NET支持v103.0。默认的Json序列化器不再与Json.NET兼容。如果您想继续使用JSON，有几个选项。NET并保持向后兼容性。除此之外，还有JSON。.NET有更多的功能，并且可以解决您使用RestSharp现在依赖的基本.NET序列化器的问题。

另外，你可以使用[EnumMember]属性在反序列化过程中定义自定义映射。

选项1:实现使用JSON的自定义序列化器。净

使用Json。. NET进行序列化，复制以下代码:

/// <summary>
/// Default JSON serializer for request bodies
/// Doesn't currently use the SerializeAs attribute, defers to Newtonsoft's attributes
/// </summary>
public class JsonNetSerializer : ISerializer
{
    private readonly Newtonsoft.Json.JsonSerializer _serializer;
    /// <summary>
    /// Default serializer
    /// </summary>
    public JsonSerializer() {
        ContentType = "application/json";
        _serializer = new Newtonsoft.Json.JsonSerializer {
            MissingMemberHandling = MissingMemberHandling.Ignore,
            NullValueHandling = NullValueHandling.Include,
            DefaultValueHandling = DefaultValueHandling.Include
        };
    }
    /// <summary>
    /// Default serializer with overload for allowing custom Json.NET settings
    /// </summary>
    public JsonSerializer(Newtonsoft.Json.JsonSerializer serializer){
        ContentType = "application/json";
        _serializer = serializer;
    }
    /// <summary>
    /// Serialize the object as JSON
    /// </summary>
    /// <param name="obj">Object to serialize</param>
    /// <returns>JSON as String</returns>
    public string Serialize(object obj) {
        using (var stringWriter = new StringWriter()) {
            using (var jsonTextWriter = new JsonTextWriter(stringWriter)) {
                jsonTextWriter.Formatting = Formatting.Indented;
                jsonTextWriter.QuoteChar = '"';
                _serializer.Serialize(jsonTextWriter, obj);
                var result = stringWriter.ToString();
                return result;
            }
        }
    }
    /// <summary>
    /// Unused for JSON Serialization
    /// </summary>
    public string DateFormat { get; set; }
    /// <summary>
    /// Unused for JSON Serialization
    /// </summary>
    public string RootElement { get; set; }
    /// <summary>
    /// Unused for JSON Serialization
    /// </summary>
    public string Namespace { get; set; }
    /// <summary>
    /// Content type for serialized content
    /// </summary>
    public string ContentType { get; set; }
}

并注册到您的客户端:

var client = new RestClient();
client.JsonSerializer = new JsonNetSerializer();

选项2:使用nuget包来使用JSON。净

而不是做所有这些，并有一个自定义JSON序列化器分布在您的项目是使用这个nuget包:https://www.nuget.org/packages/RestSharp.Newtonsoft.Json。它允许您使用继承的RestRequest对象，默认使用Newtonsoft。 
var request = new RestSharp.Newtonsoft.Json.RestRequest(); // Uses JSON.NET

另一个选项是在每个请求上设置它，像这样:

var request = new RestRequest();
request.JsonSerializer = new NewtonsoftJsonSerializer();

免责声明:在我的项目中有一个自定义序列化器后，我创建了这个项目。我创建这个是为了保持整洁，并希望帮助那些希望向后兼容v103之前工作的RestSharp代码的人。

找到解决方案:

private IRestClient GetRestClient()
        {
            return new RestClient(url)
                .AddDefaultHeader("Authorization", $"Bearer {token.AccessToken}")
                .AddDefaultHeader("Accept", "*/*")
                .AddDefaultHeader("Accept-Encoding", "gzip, deflate, br")
                .AddDefaultHeader("Connection", "close")
                .UseSystemTextJson(new JsonSerializerOptions
                {
                    Converters = { new JsonStringEnumConverter() }
                });
        }

。指示RestSharp使用System.Text.Json序列化器，然后指示序列化器使用JsonStringEnumConverter类来序列化/反序列化枚举。

我在PocoJsonSerializerStrategy的帮助下得到了它的工作。RestSharp允许您指定自己的序列化/反序列化策略，因此我创建了自己的策略来处理枚举:

public class HandleEnumsJsonSerializerStrategy : PocoJsonSerializerStrategy
{
  public override object DeserializeObject(object value, Type type)
  {
    if (type.IsEnum)
      return Enum.Parse(type, (string)value);
    else
      return base.DeserializeObject(value, type);
  }
}

现在您可以将该类的对象传递给SimpleJson.DeserializeObject调用，就像这样，您的枚举被优雅地处理:

SimpleJson.DeserializeObject<JsonObject>(Response.Content, Strategy);

如果您正在使用枚举类模式，您可以使用JsonConverter方法。这意味着您需要创建一个自定义转换器，并在需要序列化的属性上使用JsonConverter属性。示例如下:

using Newtonsoft.Json;
using System;
namespace MyAwesomeAPI
{
    public class EnumerationConverter<TEnum> : JsonConverter
        where TEnum : Enumeration
    {
        public override bool CanConvert(Type objectType) => objectType == typeof(TEnum);
        public override bool CanRead { get => true; }
        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            var uknown = Enumeration.FromDisplayName<TEnum>("Unknown");
            if (reader.TokenType == JsonToken.Null)
            {
                return null;
            }
            if (reader.TokenType == JsonToken.String)
            {
                var enumText = reader.Value?.ToString();
                if (string.IsNullOrEmpty(enumText))
                {
                    return uknown;
                }
                try
                {
                    return Enumeration.FromDisplayName<TEnum>(enumText);
                }
                catch (Exception)
                {
                    return uknown;
                }
            }
            return uknown;
        }
        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
        {
            writer.WriteValue(value.ToString());
        }
    }
}

我们的enum看起来像:

public class CardType : Enumeration
{
    public static CardType Unknown = new(0, nameof(Unknown));
    public static CardType Amex = new(1, nameof(Amex));
    public static CardType Visa = new(2, nameof(Visa));
    public static CardType MasterCard = new(3, nameof(MasterCard));
    public CardType(int id, string name) : base(id, name)
    {
    }
}

最后是将属性应用于属性

public class CreditCardResponse
{
    [JsonProperty("card_number")]
    public string CardNumber { get; set; }
    [JsonProperty("card_type")]
    [JsonConverter(typeof(EnumerationConverter<CardType>))]
    public CardType CardType { get; set; }
}
相关文章：