版權聲明：本文為博主原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接和本聲明。本文鏈接：https://blog.csdn.net/j_teng/article/details/100924973

“KoobooJson是一款體積小巧沒有任何依賴且性能表現強勁的Json工具”?

詳細介紹可以參考官方說明，項目地址：https://github.com/Kooboo/Json

ps：樓主目前使用的版本是：asp.net core 2.2

在 asp.net core 2.x 中，默認使用的json序列化工具是 Newtonsoft.Json ,如果你正在使用 asp.net core mvc/webapi ，并且需要對 Json 序列化進行一些配置（例如 首字母大小寫，日期格式化等），那么你可能在 Startup.cs 中看到過此方法（AddJsonOptions）的應用：

public void ConfigureServices(IServiceCollection services) { services .AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_2) .AddJsonOptions(opts?=> { //忽略循環引用 opts.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore; //不使用駝峰樣式的key opts.SerializerSettings.ContractResolver?=?new?DefaultContractResolver(); //設置時間格式 opts.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss"; }); }

通過配置以后，返回對象可以被直接序列化成你想要的 json 格式。

那么，使用 KoobooJson 的時候，是否也可以像這樣直接通過調用某個方法就進行使用和配置呢？

看了下官方的說明還未支持 web , 請教了作者以后，自己擼了個方法吧。原理是將 Input 和 Output 的格式化方式替換成自己想要的。廢話不多說，上代碼：

1.使用nuget添加：Kooboo.Json

2.定義輸入的序列化類

public class KoobooInputFormatter : IInputFormatter { protected?Kooboo.Json.JsonDeserializeOption?Options?{?get;?set;?}?=?new?Kooboo.Json.JsonDeserializeOption() { JsonCharacterReadState = Kooboo.Json.JsonCharacterReadStateEnum.IgnoreCase }; public?KoobooInputFormatter():?this(null){?} public KoobooInputFormatter(Kooboo.Json.JsonDeserializeOption options) { Options = options ?? Options; } public bool CanRead(InputFormatterContext context) { return true; } public async Task<InputFormatterResult> ReadAsync(InputFormatterContext context) { if (context == null) { throw new ArgumentNullException(nameof(context)); } var request = context.HttpContext.Request; string json; using (var reader = context.ReaderFactory(request.Body, Encoding.UTF8)) { json = await reader.ReadToEndAsync(); } var result = Kooboo.Json.JsonSerializer.ToObject(json, context.ModelType, Options); return await InputFormatterResult.SuccessAsync(result); } }

3.定義輸出的序列化類

public class KoobooOutputFormatter : IOutputFormatter { protected const string CONTENT_TYPE = "application/json"; protected virtual Kooboo.Json.JsonSerializerOption Options { get; set; } = new Kooboo.Json.JsonSerializerOption() { DatetimeFormat = Kooboo.Json.DatetimeFormatEnum.ISO8601, IsEnumNum = true, JsonCharacterRead = Kooboo.Json.JsonCharacterReadStateEnum.InitialLower, IsIgnoreValueNull = false, ReferenceLoopHandling = Kooboo.Json.JsonReferenceHandlingEnum.Remove }; public KoobooOutputFormatter() : this(null) { } public KoobooOutputFormatter(Kooboo.Json.JsonSerializerOption options) { Options = options ?? Options; } public bool CanWriteResult(OutputFormatterCanWriteContext context) { return true; } public Task WriteAsync(OutputFormatterWriteContext context) { if (context == null) { throw new ArgumentNullException(nameof(context)); } var response = context.HttpContext.Response; response.ContentType = CONTENT_TYPE; if (context.Object == null) { response.Body.WriteByte(192); //192 好像在 Response.Body 中表示 null return Task.CompletedTask; } using (var writer = new StreamWriter(response.Body, Encoding.UTF8)) { Kooboo.Json.JsonSerializer.ToJson(context.Object, writer, Options); return Task.CompletedTask; } } }

4.擴展MvcOptions

public static class KoobooMvcOptionsExtension { public static void UseKoobooFormatters(this MvcOptions opts, Action<Kooboo.Json.JsonDeserializeOption, Kooboo.Json.JsonSerializerOption> jsonOptionAction = null) { Kooboo.Json.JsonDeserializeOption deserializeOption = null; Kooboo.Json.JsonSerializerOption serializerOption = null; if (jsonOptionAction != null) { deserializeOption = new Kooboo.Json.JsonDeserializeOption(); serializerOption = new Kooboo.Json.JsonSerializerOption(); jsonOptionAction(deserializeOption, serializerOption); } opts.InputFormatters.Clear(); opts.InputFormatters.Add(new KoobooInputFormatter(deserializeOption)); opts.OutputFormatters.Clear(); opts.OutputFormatters.Add(new KoobooOutputFormatter(serializerOption)); } }

5.最終使用

public void ConfigureServices(IServiceCollection services) { services.AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_2) .AddMvcOptions(opts => { opts.UseKoobooFormatters((deserializeOption, serializerOption) => { //你可以在這里對反序列化/序列化進行配置 deserializeOption = null;//反序列化對象設置為null，則使用默認的設置 serializerOption.IsEnumNum = false;//枚舉不轉換為數字 serializerOption.IsIgnoreValueNull = true;//忽略值為null的字段 serializerOption.JsonCharacterRead = Kooboo.Json.JsonCharacterReadStateEnum.InitialLower;//首字母小寫 }); }); }

如果你只需要使用默認的配置。你可以直接這樣 opts.UseKoobooFormatters();

至此，已經可以在項目中使用了，效果如下：

demo 下載,百度網盤：

下載地址:https://pan.baidu.com/s/1O-OBn2hYcQFhDXQRc7-Wvg

提取碼:a4pw

?

-----------------------------分割線-------------------------------

以下是一些常用的特性（忽略字段，僅包含某字段，字段排序等）

/// <summary> /// IgnoreDefaultValue（忽略此類中所有字段為默認值的元素） /// </summary> [Kooboo.Json.IgnoreDefaultValue] public class StudentModel { /// <summary> /// Alias（字段別名） /// JsonOrder（字段排序） /// </summary> [Kooboo.Json.Alias("Name")] [Kooboo.Json.JsonOrder(3)] public string FullName { get; set; } /// <summary> /// IgnoreKey（忽略某字段） /// </summary> [Kooboo.Json.IgnoreKey] public string Address { get; set; } [Kooboo.Json.JsonOrder(2)] public byte Age { get; set; } [Kooboo.Json.JsonOrder(4)] public DateTime Dirthday { get; set; } [Kooboo.Json.JsonOrder(1)] public EnumGender Gender { get; set; } [Kooboo.Json.JsonOrder(5)] public string Mobile { get; set; } /// <summary> /// Base64ValueFormat（這個是自定義的值格式化特性） /// </summary> [Base64ValueFormat] public byte[] Avatar { get; set; } }

如果你需要對值的格式化進行個性設置，例如：你不管，我就需要這種時間格式：ffff.yyyy-MM-dd:HH-mm-ss 或者 上一段代碼中類型為 byte[] 的 Avatar ?屬性，可以使用：值格式化特性 來實現。

/// <summary> /// 可以自定義一個值格式化特性 /// </summary> public class Base64ValueFormatAttribute : Kooboo.Json.ValueFormatAttribute { public override string WriteValueFormat(object value, Type type, Kooboo.Json.JsonSerializerHandler handler, out bool isValueFormat) { isValueFormat = true; if (value == null) return string.Empty; else return Convert.ToBase64String((byte[])value); } public override object ReadValueFormat(string value, Type type, Kooboo.Json.JsonDeserializeHandler handler, out bool isValueFormat) { isValueFormat = true; if (string.IsNullOrWhiteSpace(value) || value == "null") return null; else return Convert.FromBase64String(value); } }

如果你想將這個自定義的格式化方式運用于全局，你可以在第5步的 UseKoobooFormatters 中，通過設置 serializerOption.GlobalValueFormat 和 deserializeOption.GlobalValueFormat 來實現

public?void?ConfigureServices(IServiceCollection?services) { services.AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_2) .AddMvcOptions(opts => { opts.UseKoobooFormatters((deserializeOption, serializerOption) => { //你可以在這里對反序列化/序列化進行配置 serializerOption.IsEnumNum = true;//枚舉轉換為數字 serializerOption.IsIgnoreValueNull = true;//忽略值為null的字段 serializerOption.JsonCharacterRead = Kooboo.Json.JsonCharacterReadStateEnum.InitialLower;//首字母小寫 serializerOption.GlobalValueFormat = KoobooGlobalValueFormat.Base64Serializer;//設置全局的對于byte[]類型的自定義序列化方式 deserializeOption.GlobalValueFormat = KoobooGlobalValueFormat.Base64Deserializer;//設置全局的對于byte[]類型的自定義反序列化方式 }); }); } public static class KoobooGlobalValueFormat { public static string Base64Serializer(object value, Type type, Kooboo.Json.JsonSerializerHandler jsonSerializeHandler, out bool isValueFormat) { if (type == typeof(byte[])) { isValueFormat = true; if (value == null) return string.Empty; else return Convert.ToBase64String((byte[])value); } else { isValueFormat = false; return null; } } public static object Base64Deserializer(string value, Type type, Kooboo.Json.JsonDeserializeHandler jsonDeserializeHandler, out bool isValueFormat) { if (type == typeof(byte[])) { isValueFormat = true; if (string.IsNullOrWhiteSpace(value) || value == "null") return null; else return Convert.FromBase64String(value); } else { isValueFormat = false; return null; } } }

值得注意的是,對于byte[]類型的base64解析行為, KoobooJson已經內嵌在配置項中, 只要設置serializerOption.IsByteArrayFormatBase64 = true 即可

public?void?ConfigureServices(IServiceCollection?services) { services.AddMvc() .SetCompatibilityVersion(CompatibilityVersion.Version_2_2) .AddMvcOptions(opts => { opts.UseKoobooFormatters((deserializeOption, serializerOption) => { //你可以在這里對反序列化/序列化進行配置 serializerOption.IsEnumNum = true;//枚舉轉換為數字 serializerOption.IsIgnoreValueNull = true;//忽略值為null的字段 serializerOption.JsonCharacterRead = Kooboo.Json.JsonCharacterReadStateEnum.InitialLower;//首字母小寫 serializerOption.IsByteArrayFormatBase64 = true;//使用KoobooJson自帶的對于byte[]類型的base64處理 //serializerOption.GlobalValueFormat = KoobooGlobalValueFormat.Base64Serializer;//設置全局的對于byte[]類型的自定義序列化方式 //deserializeOption.GlobalValueFormat = KoobooGlobalValueFormat.Base64Deserializer;//設置全局的對于byte[]類型的自定義反序列化方式 }); }); }

參考資料：

1.Asp.Net Core中Json序列化處理整理

2.將 .NET Core 2.0 的默認 JSON 解析器替換為 Jil

————————————————

版權聲明：本文為CSDN博主「j_teng」的原創文章，遵循 CC 4.0 BY-SA 版權協議，轉載請附上原文出處鏈接及本聲明。

原文鏈接：https://blog.csdn.net/j_teng/article/details/100924973 ?

---

https://github.com/dotnetcore

總結

以上是生活随笔為你收集整理的【C】KoobooJson在asp.net core中的使用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。