使用 Json.NET 实现 Pascal 大小写动态属性

问题描述 投票：0回答：4

这就是我所拥有的：

using Newtonsoft.Json;

var json = "{\"someProperty\":\"some value\"}";
dynamic deserialized = JsonConvert.DeserializeObject(json);

这很好用：

Assert.That(deserialized.someProperty.ToString(), Is.EqualTo("some value"));

我希望它能够工作（属性的第一个字母大写）而不改变

json
：

Assert.That(deserialized.SomeProperty.ToString(), Is.EqualTo("some value"));
c# .net json.net
4个回答
17
投票

我同意 Avner Shahar-Kashtan 的观点。 您不应该这样做，特别是如果您无法控制 JSON。

也就是说，可以使用 ExpandoObject 和自定义 ExpandoObjectConverter 来完成。 JSON.NET 已经提供了一个 ExpandoObjectConverter，因此只需进行一些小的调整，您就可以得到您想要的。

请注意代码片段中的 //CHANGED 注释，以向您展示我更改的位置。

public class CamelCaseToPascalCaseExpandoObjectConverter : JsonConverter
{
  //CHANGED
  //the ExpandoObjectConverter needs this internal method so we have to copy it
  //from JsonReader.cs
  internal static bool IsPrimitiveToken(JsonToken token) 
  {
      switch (token)
      {
          case JsonToken.Integer:
          case JsonToken.Float:
          case JsonToken.String:
          case JsonToken.Boolean:
          case JsonToken.Null:
          case JsonToken.Undefined:
          case JsonToken.Date:
          case JsonToken.Bytes:
              return true;
          default:
              return false;
      }
  }

/// <summary>
/// Writes the JSON representation of the object.
/// </summary>
/// <param name="writer">The <see cref="JsonWriter"/> to write to.</param>
/// <param name="value">The value.</param>
/// <param name="serializer">The calling serializer.</param>
public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
{
  // can write is set to false
}

/// <summary>
/// Reads the JSON representation of the object.
/// </summary>
/// <param name="reader">The <see cref="JsonReader"/> to read from.</param>
/// <param name="objectType">Type of the object.</param>
/// <param name="existingValue">The existing value of object being read.</param>
/// <param name="serializer">The calling serializer.</param>
/// <returns>The object value.</returns>
public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
{
  return ReadValue(reader);
}

private object ReadValue(JsonReader reader)
{
  while (reader.TokenType == JsonToken.Comment)
  {
    if (!reader.Read())
      throw new Exception("Unexpected end.");
  }

  switch (reader.TokenType)
  {
    case JsonToken.StartObject:
      return ReadObject(reader);
    case JsonToken.StartArray:
      return ReadList(reader);
    default:
      //CHANGED
      //call to static method declared inside this class
      if (IsPrimitiveToken(reader.TokenType))
        return reader.Value;

      //CHANGED
      //Use string.format instead of some util function declared inside JSON.NET
      throw new Exception(string.Format(CultureInfo.InvariantCulture, "Unexpected token when converting ExpandoObject: {0}", reader.TokenType));
  }
}

private object ReadList(JsonReader reader)
{
  IList<object> list = new List<object>();

  while (reader.Read())
  {
    switch (reader.TokenType)
    {
      case JsonToken.Comment:
        break;
      default:
        object v = ReadValue(reader);

        list.Add(v);
        break;
      case JsonToken.EndArray:
        return list;
    }
  }

  throw new Exception("Unexpected end.");
}

private object ReadObject(JsonReader reader)
{
  IDictionary<string, object> expandoObject = new ExpandoObject();

  while (reader.Read())
  {
    switch (reader.TokenType)
    {
      case JsonToken.PropertyName:
        //CHANGED
        //added call to ToPascalCase extension method       
        string propertyName = reader.Value.ToString().ToPascalCase();

        if (!reader.Read())
          throw new Exception("Unexpected end.");

        object v = ReadValue(reader);

        expandoObject[propertyName] = v;
        break;
      case JsonToken.Comment:
        break;
      case JsonToken.EndObject:
        return expandoObject;
    }
  }

  throw new Exception("Unexpected end.");
}

/// <summary>
/// Determines whether this instance can convert the specified object type.
/// </summary>
/// <param name="objectType">Type of the object.</param>
/// <returns>
///     <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
/// </returns>
public override bool CanConvert(Type objectType)
{
  return (objectType == typeof (ExpandoObject));
}

/// <summary>
/// Gets a value indicating whether this <see cref="JsonConverter"/> can write JSON.
/// </summary>
/// <value>
///     <c>true</c> if this <see cref="JsonConverter"/> can write JSON; otherwise, <c>false</c>.
/// </value>
public override bool CanWrite
{
  get { return false; }
}
}

一个简单的字符串到帕斯卡大小写转换器。如果需要的话，让它变得更聪明。

public static class StringExtensions
{
    public static string ToPascalCase(this string s)
    {
        if (string.IsNullOrEmpty(s) || !char.IsLower(s[0]))
            return s;

        string str = char.ToUpper(s[0], CultureInfo.InvariantCulture).ToString((IFormatProvider)CultureInfo.InvariantCulture);

        if (s.Length > 1)
            str = str + s.Substring(1);

        return str;
    }
}

现在你可以像这样使用它了。

var settings = new JsonSerializerSettings()
                   {
                       ContractResolver = new CamelCasePropertyNamesContractResolver(),
                       Converters = new List<JsonConverter> { new CamelCaseToPascalCaseExpandoObjectConverter() }
                   };

var json = "{\"someProperty\":\"some value\"}";

dynamic deserialized = JsonConvert.DeserializeObject<ExpandoObject>(json, settings);

Console.WriteLine(deserialized.SomeProperty); //some value

var json2 = JsonConvert.SerializeObject(deserialized, Formatting.None, settings);

Console.WriteLine(json == json2); //true


ContractResolver
CamelCasePropertyNamesContractResolver 在将对象序列化回 JSON 并使其再次成为 Camel 大小写时使用。这也是由 JSON.NET 提供的。如果不需要这个可以省略。

3
投票

我不禁觉得这不是一个好主意。看起来您正在尝试保留编码约定，但代价是维持有线格式（JSON 结构）和逻辑类之间的保真度。这可能会让希望保留 JSON 类的开发人员感到困惑，并且如果您还需要或将来需要将此数据重新序列化为相同的 JSON 格式，则可能会导致问题。

也就是说，这可能可以通过提前创建 .NET 类，然后使用 

DeserializeObject(string value, JsonSerializerSettings settings)
重载，向其传递带有 
JsonSerializerSettings
属性集的 
Binder
来实现。您还需要编写一个自定义 
SerializationBinder
，在其中手动定义 JSON 类和预定义的 .NET 类之间的关系。

也许可以在运行时生成 Pascal 大小写的类，而无需预先定义它们，但我还没有足够深入地研究 JSON.NET 实现。也许还有其他 

JsonSerializerSettings
设置之一，例如传递 CustomCreationConverter，但我不确定详细信息。

1
投票

对于 newtonsoft 将此属性添加到您的属性中：

[JsonProperty("schwabFirmId")]

如果您准备包含 MongoDB，则有一个更简单的选项（因为每个类只需执行一次）：尝试添加对 MongoDB.Bson.Serialization.Conventions 的引用。

然后将其添加到模型构造函数中：

var pack = new ConventionPack { new CamelCaseElementNameConvention(), new IgnoreIfDefaultConvention(true) };
            ConventionRegistry.Register("CamelCaseIgnoreDefault", pack, t => true);

任一者都会保留您最喜欢的 C# 属性 PascalCased 和 json CamelCased。

反序列化会将入站数据视为 PascalCased，序列化会将其更改为驼峰命名法。

0
投票

这是非常旧的，但我最近看了这个试图弄清楚，并对我找到的答案不满意，所以我总结了选项并将其添加到下面。

点网2.0

       [JsonProperty("baseUrl")]
       public string BaseUrl { get; set; }

点网3.0+

using Newtonsoft.Json;
using Newtonsoft.Json.Serialization;
       string json = @"
       {
           ""wsUrl"": ""http://example.com"",
           ""environment"": ""test"",
           ""domain"": ""example""
       }";

       var settings = new JsonSerializerSettings
       {
           ContractResolver = new CamelCasePropertyNamesContractResolver()
       };

       var myObject = JsonConvert.DeserializeObject<MyClass>(json, settings);

在 Mvc 6 中：

services.AddMvc(...)
.AddJsonOptions(jsonOptions =>
{
jsonOptions.JsonSerializerOptions.PropertyNamingPolicy = null;
});
最新问题
© www.soinside.com 2019 - 2024. All rights reserved.