首页 > 众成服务 > 技术交流

技术交流

Newtonsoft.Json高级用法

 作者：众成   文章来源：软件部    点击数：  更新时间:2018-10-25 14:46:17

 

        /// 构造函数

        ///

 

        /// 传入的属性数组

        /// true:表示props是需要保留的字段  false：表示props是要排除的字段

        public LimitPropsContractResolver(string[] props, bool retain=true)

        {

            //指定要序列化属性的清单

            this.props = props;

 

            this.retain = retain;

        }

 

        protected override IList CreateProperties(Type type,

 

        MemberSerialization memberSerialization)

        {

            IList list =

            base.CreateProperties(type, memberSerialization);

            //只保留清单有列出的属性

            return list.Where(p => {

                if (retain)

                {

                    return props.Contains(p.PropertyName);

                }

                else

                {

                    return !props.Contains(p.PropertyName);

                }     

            }).ToList();

        }

   

        public int Age { get; set; }

 

        [JsonIgnore]

        public bool IsMarry { get; set; }

 

        public string Sex { get; set; }

      JsonSerializerSettings jsetting=new JsonSerializerSettings();

      jsetting.ContractResolver = new LimitPropsContractResolver(new string[] { "Age", "IsMarry" });

      Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

  使用自定义的解析类，只输出"Age", "IsMarry"两个属性，看下最终结果.只输出了Age属性，为什么IsMarry属性没有输出呢，因为标注了JsonIgnore

 

 看到上面的结果想要实现pc端序列化一部分，手机端序列化另一部分就很简单了吧，我们改下代码实现一下

  string[] propNames = null;

  if (p.Age > 10)

  {

  　　propNames = new string[] { "Age", "IsMarry" };

  }

  else

  {

      propNames = new string[] { "Age", "Sex" };

  }

  jsetting.ContractResolver = new LimitPropsContractResolver(propNames);

  Console.WriteLine(JsonConvert.SerializeObject(p, Formatting.Indented, jsetting));

 

八.枚举值的自定义格式化问题

  默认情况下对于实体里面的枚举类型系统是格式化成改枚举对应的整型数值,那如果需要格式化成枚举对应的字符怎么处理呢？Newtonsoft.Json也帮我们想到了这点，下面看实例

    public enum NotifyType

    {

        ///

 

        /// Emil发送

        ///

 

        Mail=0,

 

        ///

 

        /// 短信发送

        ///

 

        SMS=1

    }

 

    public class TestEnmu

    {

        ///

 

        /// 消息发送类型

        ///

 

        public NotifyType Type { get; set; }

    }

    JsonConvert.SerializeObject(new TestEnmu());

输出结果：  现在改造一下，输出"Type":"Mail"

    public class TestEnmu

    {

        ///

 

        /// 消息发送类型

        ///

 

        [JsonConverter(typeof(StringEnumConverter))]

        public NotifyType Type { get; set; }

    }

其它的都不变，在Type属性上加上了JsonConverter(typeof(StringEnumConverter))表示将枚举值转换成对应的字符串,而StringEnumConverter是Newtonsoft.Json内置的转换类型,最终输出结果

 

九.自定义类型转换

默认情况下对于实体里面的Boolean系统是格式化成true或者false,对于true转成"是" false转成"否"这种需求改怎么实现了？我们可以自定义类型转换实现该需求，下面看实例

public class BoolConvert : JsonConverter

    {

        private string[] arrBString { get; set; }

 

        public BoolConvert()

        {

            arrBString = "是,否".Split(',');

        }

 

        ///

 

        /// 构造函数

        ///

 

        /// 将bool值转换成的字符串值

        public BoolConvert(string BooleanString)

        {

            if (string.IsNullOrEmpty(BooleanString))

            {

                throw new ArgumentNullException();

            }

            arrBString = BooleanString.Split(',');

            if (arrBString.Length != 2)

            {

                throw new ArgumentException("BooleanString格式不符合规定");

            }

        }

 

 

        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)

        {

            bool isNullable = IsNullableType(objectType);

            Type t = isNullable ? Nullable.GetUnderlyingType(objectType) : objectType;

 

            if (reader.TokenType == JsonToken.Null)

            {

                if (!IsNullableType(objectType))

                {

                    throw new Exception(string.Format("不能转换null value to {0}.", objectType));

                }

 

                return null;

            }

 

            try

            {

                if (reader.TokenType == JsonToken.String)

                {

                    string boolText = reader.Value.ToString();

                    if (boolText.Equals(arrBString[0], StringComparison.OrdinalIgnoreCase))

                    {

                        return true;

                    }

                    else if (boolText.Equals(arrBString[1], StringComparison.OrdinalIgnoreCase))

                    {

                        return false;

                    }

                }

 

                if (reader.TokenType == JsonToken.Integer)

                {

                    //数值

                    return Convert.ToInt32(reader.Value) == 1;

                }

            }

            catch (Exception ex)

            {

                throw new Exception(string.Format("Error converting value {0} to type '{1}'", reader.Value, objectType));

            }

            throw new Exception(string.Format("Unexpected token {0} when parsing enum", reader.TokenType));

        }

 

        ///

 

        /// 判断是否为Bool类型

        ///

 

        /// 类型

        /// 为bool类型则可以进行转换

        public override bool CanConvert(Type objectType)

        {

            return true;

        }

 

 

        public bool IsNullableType(Type t)

        {

            if (t == null)

            {

                throw new ArgumentNullException("t");

            }

            return (t.BaseType.FullName=="System.ValueType" && t.GetGenericTypeDefinition() == typeof(Nullable<>));

        }

 

        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)

        {

            if (value == null)

            {

                writer.WriteNull();

                return;

            }

 

            bool bValue = (bool)value;

 

            if (bValue)

            {

                writer.WriteValue(arrBString[0]);

            }

            else

            {

                writer.WriteValue(arrBString[1]);

            }

        }

    }

 自定义了BoolConvert类型，继承自JsonConverter。构造函数参数BooleanString可以让我们自定义将true false转换成相应字符串。下面看实体里面怎么使用这个自定义转换类型

    public class Person

    {

        [JsonConverter(typeof(BoolConvert))]

        public bool IsMarry { get; set; }

    }

‘

相应的有什么个性化的转换需求，都可以使用自定义转换类型的方式实现。

 

十.全局序列化设置

文章开头提出了Null值字段怎么不返回的问题，相应的在高级用法也给出了相应的解决方案使用jsetting.NullValueHandling = NullValueHandling.Ignore; 来设置不返回空值。这样有个麻烦的地方，每个不想返回空值的序列化都需设置一下。可以对序列化设置一些默认值方式么？下面将解答

　　Newtonsoft.Json.JsonSerializerSettings setting = new Newtonsoft.Json.JsonSerializerSettings();

   JsonConvert.DefaultSettings = new Func(() =>

   {
　　　　//日期类型默认格式化处理

   　　setting.DateFormatHandling = Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat;

      setting.DateFormatString = "yyyy-MM-dd HH:mm:ss";
　　　 //空值处理

      setting.NullValueHandling = NullValueHandling.Ignore;

      //高级用法九中的Bool类型转换 设置

      setting.Converters.Add(new BoolConvert("是,否"));

 

      return setting;

   });

 

这样设置以后，以后使用序列化的地方就不需要单独设置了，个人最喜欢设置的是空值处理这一块。

回到顶部

总结

　　Newtonsoft.Json序列化库替我们想了很多特性，也实现了很多特性，除了上面介绍的几种高级用法外，还有其它的特殊用法，可以去官网进行学习。当然这里我目前最喜欢的特性就是那个忽略部分属性序列化的功能，很小的代码改动实现了接口的优化，提升了用户体验。

转自：http://www.cnblogs.com/yanweidie/p/4605212.html