c#：序列化json常见问题及处理方法

环境：

• .netcore 3.1

在c#中，一般json序列化使用Newtonsoft.Json包，使用方法如下：

//序列化
var json = Newtonsoft.Json.JsonConvert.Serialize(new { Id = 1, Name = "小明" });
//反序列化
var person = Newtonsoft.Json.JsonConvert.DeSerialize<Person>(json);

class Person
{
    public int Id{set;get;}
    public string Name{set;get;}
}

问题1： datetime格式问题

解释：一般我们期望的格式是: yyyy-MM-dd HH:mm:ss，但默认的不是我们想要的，那么，我们可以通过以下两种方式解决：

注意时区：
DateTime createTime=null;
//将得到的时间转换为本地时间，防止跨时区
createTime.ToLocalTime().ToString(“yyyy-MM-dd HH:mm:ss”);

解决办法：

• 转换时设置：

  new Newtonsoft.Json.JsonSerializerSettings()
  {
      DateFormatString = "yyyy-MM-dd HH:mm:ss"
  })
  

• 基于特性

  /// 
  
  /// 时间日期序列化
  /// 
  public sealed class DateTimeConverter : IsoDateTimeConverter
  {
      /// 
  
      /// 构造函数
      /// 
      /// 
      public DateTimeConverter(string format) : base()
      {
          base.DateTimeFormat = format;
      }
  }
  
  public class Person
  {
      [JsonConverter(typeof(DateTimeConverter), "yyyy-MM-dd HH:mm:ss")]
      public DateTime Birth { get; set; }
  }
  

问题2: long型转string

解释：因为前端对long型数据的处理不好，会有溢出，而基于雪花算法的分布式id都是long型的，所以需要返回给前端的时候，将long型转成string。

解决办法：
先写一个转换器：

/// 

///大数据json序列化重写
/// 
public sealed class NumberConverter : JsonConverter
{
    /// 

    /// 转换成字符串的类型
    /// 
    private readonly NumberConverterShip _ship;

    /// 

    /// 大数据json序列化重写实例化
    /// 
    public NumberConverter()
    {
        _ship = (NumberConverterShip)0xFF;
    }

    /// 

    /// 大数据json序列化重写实例化
    /// 
    /// 转换成字符串的类型
    public NumberConverter(NumberConverterShip ship)
    {
        _ship = ship;
    }

    /// 
    /// 

    /// 确定此实例是否可以转换指定的对象类型。
    /// 
    /// 对象的类型。
    /// 如果此实例可以转换指定的对象类型，则为：true，否则为：false
    public override bool CanConvert(Type objectType)
    {
        var typecode = Type.GetTypeCode(objectType.Name.Equals("Nullable`1") ? objectType.GetGenericArguments().First() : objectType);
        switch (typecode)
        {
            case TypeCode.Decimal:
                return (_ship & NumberConverterShip.Decimal) == NumberConverterShip.Decimal;
            case TypeCode.Double:
                return (_ship & NumberConverterShip.Double) == NumberConverterShip.Double;
            case TypeCode.Int64:
                return (_ship & NumberConverterShip.Int64) == NumberConverterShip.Int64;
            case TypeCode.UInt64:
                return (_ship & NumberConverterShip.UInt64) == NumberConverterShip.UInt64;
            case TypeCode.Single:
                return (_ship & NumberConverterShip.Single) == NumberConverterShip.Single;
            default: return false;
        }
    }

    /// 
    /// 

    /// 读取对象的JSON表示。
    /// 
    /// 从  中读取。
    /// 对象的类型。
    /// 正在读取的对象的现有值。
    /// 调用的序列化器实例。
    /// 对象值。
    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        return AsType(reader.Value.ToString(), objectType);
    }

    /// 

    /// 字符串格式数据转其他类型数据
    /// 
    /// 输入的字符串
    /// 目标格式
    /// 转换结果
    public static object AsType(string input, Type destinationType)
    {
        try
        {
            var converter = TypeDescriptor.GetConverter(destinationType);
            if (converter.CanConvertFrom(typeof(string)))
            {
                return converter.ConvertFrom(null, null, input);
            }

            converter = TypeDescriptor.GetConverter(typeof(string));
            if (converter.CanConvertTo(destinationType))
            {
                return converter.ConvertTo(null, null, input, destinationType);
            }
        }
        catch
        {
            return null;
        }
        return null;
    }

    /// 
    /// 

    /// 写入对象的JSON表示形式。
    /// 
    /// 要写入的  。
    /// 要写入对象值
    /// 调用的序列化器实例。
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        if (value == null)
        {
            writer.WriteNull();
        }
        else
        {
            var objectType = value.GetType();
            var typeCode = Type.GetTypeCode(objectType.Name.Equals("Nullable`1") ? objectType.GetGenericArguments().First() : objectType);
            switch (typeCode)
            {
                case TypeCode.Decimal:
                    writer.WriteValue(((decimal)value).ToString("f6"));
                    break;
                case TypeCode.Double:
                    writer.WriteValue(((double)value).ToString("f4"));
                    break;
                case TypeCode.Single:
                    writer.WriteValue(((float)value).ToString("f2"));
                    break;
                default:
                    writer.WriteValue(value.ToString());
                    break;
            }
        }
    }
}

/// 

/// 转换成字符串的类型
/// 
[Flags]
public enum NumberConverterShip
{
    /// 

    /// 长整数
    /// 
    Int64 = 1,

    /// 

    /// 无符号长整数
    /// 
    UInt64 = 2,

    /// 

    /// 浮点数
    /// 
    Single = 4,

    /// 

    /// 双精度浮点数
    /// 
    Double = 8,

    /// 

    /// 大数字
    /// 
    Decimal = 16
}

• 基于特性

  public class Person
  {
      [JsonConverter(typeof(NumberConverter), NumberConverterShip.Int64)]
      public long Id { get; set; }
  }
  

• 转换时设置

  var settings = new Newtonsoft.Json.JsonSerializerSettings()
  {
      Converters = new List<JsonConverter>()
      {
          new NumberConverter(NumberConverterShip.Int64)
      }
  };
  

问题3：忽略某个属性

解释：有的时候，我们可能期望某个字段对前端隐藏，比如：PassWord。。。

解决办法：使用特性，标记单个属性

[JsonIgnore] //反序列化的时候也会忽略
public string Addr { set; get; }

问题4： 序列化和反序列化改变名称

解释：有的时候，我们的类定义的属性名称和前端期望的名称不一致，这就需要我们序列化时设置了。
解决办法：使用特性，标记映射的属性名称

[JsonProperty("OtherName")]//序列化和反序列时都以OtherName为准
public string Name { set; get; }

问题5: 忽略默认值

解释： 当属性的值为默认值时，不将该属性输出到json字符串中。
这个场景，我还没找到，估计是想输出更少的字符串吧。

解决办法：

• 使用特性，将DefaultValueHandling默认为include

  [JsonProperty(DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
  public int StudentId { get; set; }
  

• 转换时，进行设置

  new Newtonsoft.Json.JsonSerializerSettings()
  {
      DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate
  }
  

问题6: 忽略null值

解释： 当属性值为null的时候，不将该属性输出到json字符串中。

解决办法：

• 使用特性

  [JsonProperty(NullValueHandling = NullValueHandling.Include)]
  public int? ClassId { get; set; }
  

• 转换时，进行设置

  new Newtonsoft.Json.JsonSerializerSettings()
  {
      NullValueHandling=NullValueHandling.Ignore
  }
  

问题7: 枚举值转字符串

解释：默认情况下，枚举值序列化后是数字，阅读起来比较困难，我们可以将它转为字符串以方便阅读。

解决办法：

• 使用特性

  [JsonConverter(typeof(StringEnumConverter))]
  public EnumState State { set; get; }
  

• 转换时，进行设置

  //反序列化时,遇到字符串的枚举时会自动转
  new Newtonsoft.Json.JsonSerializerSettings()
  {
      Converters = new List<JsonConverter>()
      {
          new StringEnumConverter()
      }
  };
  

问题8: 首字母小写

解释： 默认情况下，将类序列化后，它的属性会原样输出，但是asp.net core中却默认是将属性的首字母小写，应该是为了适应js的习惯吧。那么，我们手动调用序列化方法时怎样设置首字母消息呢？

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

问题9：序列化后的json缩进

解释：有缩进的json美观，无缩进的紧凑（默认），仅此而已。

new JsonSerializerSettings()
{
	//缩进
    Formatting = Formatting.Indented
};

问题10: 全局设置默认值

上面说了常见的设置，那么能不能有一个全局的设置呢？看代码：

Newtonsoft.Json.JsonConvert.DefaultSettings = () =>
{
    return new JsonSerializerSettings(){};
};

最后，可以参考代码：
https://gitee.com/jackletter/DotNetCommon.git