c# - Enum 类型属性的 RestSharp 反序列化

Question

我有一个对象

            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);

它给出了异常 System.InvalidCastException 并显示消息“指定的转换无效”。

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

我可能缺少一些东西(枚举属性的属性或类似的东西)。

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

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

Answer 1

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

此外，您可以使用 [EnumMember] 属性在反序列化期间定义自定义映射。

选项 1:实现使用 JSON.NET 的自定义序列化程序

要使用 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.NET

不必执行所有这些操作并在整个项目中使用自定义 JSON 序列化程序，只需使用此 nuget 包:https://www.nuget.org/packages/RestSharp.Newtonsoft.Json 。它允许您使用继承的 RestRequest 对象，该对象默认在内部使用 Newtonsoft.JSON，如下所示:

var request = new RestSharp.Newtonsoft.Json.RestRequest(); // Uses JSON.NET

另一个选项是在每个请求上设置它，如下所示:

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

免责声明:我在对项目中存在自定义序列化程序感到沮丧后创建了此项目。我创建这个是为了保持干净，并希望帮助其他想要向后兼容在 v103 之前工作的 RestSharp 代码的人。