C#之项目常用方法之静态扩展
阅读原文时间:2023年07月08日阅读:1

  一般项目中我们经常用到数据Json的序列化与反序列化,为了方便在需要的地方快速使用,一般建议都封装为静态扩展方法,在需要的地方可直接使用。

  而目前C#项目中序列化一般都是用的 Newtonsoft.Json 来做的,因此这里贴出通用静态扩展方法供大家参考。

PS:若要添加此扩展方法,必须得在Nuget包中添加  Newtonsoft.Json  的引用。

using System;
using System.Collections.Generic;
using System.Text;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Serialization;

namespace DemoFrame_Basic.Extensions
{
///

/// 静态帮助类 ///
public static class ObjStrExtension
{
/// /// 返回Json字符串 ///
/// 需要序列化的对象 例:T.ToJson()
/// 是否忽略Null字段,最终字符串中是否包含Null字段
/// 是否展示为具有Json格式的字符串
/// 是否忽略大小写
/// 时间转换格式
/// Json字符串
public static string ToJson(this object obj, bool isNullValueHandling = false, bool indented = false, bool isLowCase = false, string dateTimeFormat = "yyyy-MM-dd HH:mm:ss")
{
var options = new JsonSerializerSettings();

        if (indented)  
            options.Formatting = Formatting.Indented;  
        if (isLowCase)  
        {  
            options.ContractResolver = new CamelCasePropertyNamesContractResolver();  
        }  
        if (isNullValueHandling)  
            options.NullValueHandling = NullValueHandling.Ignore;  
        options.ReferenceLoopHandling = ReferenceLoopHandling.Ignore;  
        options.Converters = new List<JsonConverter> { new IsoDateTimeConverter { DateTimeFormat = dateTimeFormat } };  
        return obj.ToJson(options);  
    }  
    /// <summary>  
    /// Json字符串  
    /// </summary>  
    /// <param name="obj">需要序列化的对象  例:T.ToJson(settings)</param>  
    /// <param name="settings">Json序列化设置</param>  
    /// <returns>Json字符串</returns>  
    public static string ToJson(this object obj, JsonSerializerSettings settings)  
    {  
        return JsonConvert.SerializeObject(obj, settings);  
    }  
    /// <summary>  
    /// 返回相关设定格式字符串  
    /// </summary>  
    /// <param name="obj"></param>  
    /// <param name="format">格式 例:yyyy-MM-dd HH:mm:ss</param>  
    /// <returns>设定格式字符串</returns>  
    public static string ToDateTimeString(this object obj, string format)  
    {  
        DateTime.TryParse(obj?.ToString(), out var dateTime);  
        return dateTime.ToString(format);  
    }  
    /// <summary>  
    /// 得到字符串的Byte  
    /// </summary>  
    /// <param name="str"></param>  
    /// <returns>Byte</returns>  
    public static byte\[\] GetBytes(this string str)  
    {  
        if (string.IsNullOrEmpty(str))  
            return default(byte\[\]);  
        return Encoding.UTF8.GetBytes(str);  
    }

    public static bool ToBool(this string str, bool defaultValue = false)  
    {  
        bool.TryParse(str, out defaultValue);  
        return defaultValue;  
    }

    public static short ToShort(this string str, short defaultValue = )  
    {  
        short.TryParse(str, out defaultValue);  
        return defaultValue;  
    }

    public static int ToInt(this string str, int defaultValue = )  
    {  
        int.TryParse(str, out defaultValue);  
        return defaultValue;  
    }

    public static long ToLong(this string str, long defaultValue = )  
    {  
        long.TryParse(str, out defaultValue);  
        return defaultValue;  
    }

    public static double ToDouble(this string str, double defaultValue = )  
    {  
        double.TryParse(str, out defaultValue);  
        return defaultValue;  
    }

    public static TEnum ToEnum<TEnum>(this string str, bool ignoreCase = true, TEnum defaultValue = default(TEnum)) where TEnum : struct  
    {  
        Enum.TryParse(str, ignoreCase, out defaultValue);  
        return defaultValue;  
    }

    public static T ToNetType<T>(this string str, bool isIgnoreNull = true, bool isIgnoreEx = false)  
    {  
        var setting = new JsonSerializerSettings  
        {  
            NullValueHandling = isIgnoreNull ? NullValueHandling.Ignore : NullValueHandling.Include  
        };  
        try  
        {  
            if (string.IsNullOrEmpty(str))  
            {  
                return default(T);  
            }  
            else if ("\\"\\"" == str)  
            {  
                return default(T);  
            }  
            else  
            {  
                return JsonConvert.DeserializeObject<T>(str, setting);  
            }  
        }  
        catch (Exception)  
        {  
            if (!isIgnoreEx)  
                throw;  
            return default(T);  
        }  
    }

    public static T ToNetType<T>(this string str, JsonSerializerSettings settings)  
    {  
        try  
        {  
            if (string.IsNullOrEmpty(str))  
            {  
                return default(T);  
            }  
            else if ("\\"\\"" == str)  
            {  
                return default(T);  
            }  
            else  
            {  
                return JsonConvert.DeserializeObject<T>(str, settings);  
            }  
        }  
        catch (Exception)  
        {

            return default(T);  
        }  
    }

    /// <summary>  
    /// 比较是否相等,忽略大小写  
    /// </summary>  
    /// <param name="a"></param>  
    /// <param name="b"></param>  
    /// <returns></returns>  
    public static bool EqualsIgnoreCase(this string a, string b)  
    {  
        if (a != null)  
            return a.Equals(b, StringComparison.CurrentCultureIgnoreCase);  
        return b == null;  
    }  
}  

}