【C】KoobooJson在asp.net core中的使用

最新推荐文章于 2024-08-29 08:34:56 发布
最新推荐文章于 2024-08-29 08:34:56 发布
阅读量205 收藏
点赞数

版权声明：本文为博主原创文章，遵循 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

640?wx_fmt=png

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();

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

640?wx_fmt=png

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

dotNET跨平台
关注
ASP.NET Core中的Controller使用示例
10-15
本文将深入探讨ASP.NET Core中的Controller使用，包括ControllerBase、Controller以及POCO Controller的特性。 首先，ControllerBase是ASP.NET Core MVC中控制器的基础类，它提供了许多用于创建RESTful API的方法。...
asp.net core项目中如何使用html文件
01-20
总结一下，要在ASP.NET Core项目中使用HTML文件，需要执行以下步骤： 1. 安装`Microsoft.AspNetCore.StaticFiles` NuGet包。 2. 在`Startup.cs`中配置静态文件中间件。 3. 将HTML文件放在`wwwroot`目录下。 4. 如果...
KoobooJson在asp.net core中的使用
J_Teng的专栏
09-17 406
“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/...
kooboo的操作流程
abc
12-25 1321
创建内容类型→内容→布局→视图→页面
Kooboo 完全介绍三：Kooboo建站，继承快速入门
weixin_33939380的博客
11-08 204
考虑到这篇文章会有很多截图，并且更注重实际操作，考虑再三，还是录制了一个视频来演示如何使用Kooboo来开发网站，并且实现继承。 由于找不到一个好的视频空间，所有的视频空间上传后都会造成比较严重的失真，所以提供视频下载地址，有兴趣的朋友可以下载。我们正在准备一些视频教程，在下周会上传到Koobo官方站点。最近在我博客也收到了一些朋友的建议，毕竟在这里会比较散乱，所以如果您有什么意见或建议请到：官方...
Kooboo.Json项目使用教程
gitblog_00063的博客
08-27 334
Kooboo.Json项目使用教程 JsonLighter and Faster Json Serialization tool. 项目地址:https://gitcode.com/gh_mirrors/json10/Json 1. 项目目录结构及介绍 Kooboo.Json是一个专注于高性能JSON处理的开源库，其目录结构设计以清晰和高效为核心。以下是该项目的基本目录结构概述： Kooboo....
探索高性能JSON的新大陆 —— KoobooJson深度剖析与应用指南
gitblog_00341的博客
08-29 847
探索高性能JSON的新大陆 —— KoobooJson深度剖析与应用指南 JsonLighter and Faster Json Serialization tool. 项目地址:https://gitcode.com/gh_mirrors/json10/Json 在当今高效能软件开发的时代，JSON作为一种轻量级的数据交换格式，成为了连接前后端的灵魂所在。面对市场上众多的JSON序列化工具，如...
使用Azure Active Directory和OpenID Connect在ASP.NET Core 2.0中进行身份验证和授权
04-05
在Azure AD中，你可以为用户分配角色，然后在你的应用中使用这些角色来控制访问。在ASP.NET Core中，你可以使用`[Authorize(Roles = "RoleName")]`属性来限制只有特定角色的用户才能访问控制器或操作。 在`...
在Asp.Net Core中使用ModelConvention实现全局过滤器隔离
10-15
主要介绍了在Asp.Net Core中使用ModelConvention实现全局过滤器隔离，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
详解Asp.net Core 使用Redis存储Session
10-20
在本文中，我们将深入探讨如何在Asp.NET Core应用程序中使用Redis作为Session存储。Redis是一个高性能的键值数据存储系统，常用于缓存和分布式系统。在Asp.NET Core中，我们可以利用Redis的高效特性来存储用户的...
Json：更轻松，更快的Json序列化工具
02-03
＃ KoobooJson-更小刷新的C＃JSON序列化工具（基于表达式树生成） 为什么需要KoobooJson？ KoobooJson是一款体积小巧没有任何依赖且性能表现强劲的Json工具。 当您需要一个体积较小，性能强大的Json序列化工具时，当您需要一定的特性支持时（现有15个特性），当您需要二次开发时（代码结构清晰，且表达式树易于维护），你需要KoobooJson ！ KoobooJson和Newtonsoft.Json（Json.Net）有什么区别？ KoobooJson与Json.Net的定位不同。 Json.Net是一个非常全面，体系及兼容性非常强大的库，因此它的多样性也带来
Kooboo完全介绍二：创建第一个Kooboo站点
weixin_34080951的博客
10-25 188
要介绍一个全新的产品，仅仅靠文字描述是远远不够的，从本篇开始，将会以图文并茂的方式来展开Kooboo的各个功能点。在这一篇中，我将会带大家来体验使用Kooboo如何来创建一个简单的站点。本篇的目的，并不拘束在各个功能的技术细节，而是希望以一个全景的方式，让大家对Kooboo有一个整体的印象。 知识准备 从实践角度上，创建一个Kooboo站点，主要有以下一些主要步骤: 创建一个新的站点，新的站点可...
开源 , KoobooJson一款高性能且轻量的JSON框架
dotNET跨平台
03-29 344
　　在C#领域，有很多成熟的开源JSON框架，其中最著名且使用最多的是Newtonsoft.Json ,然而因为版本迭代,其代码要兼容从net2.0到现在的最新的net...
c# json datatable_KoobooJson一款高性能且轻量的JSON库
weixin_39892800的博客
11-24 294
(给DotNet加星标，提升.Net技能)转自：小曾看世界cnblogs.com/1996V/p/10607916.htmlKoobooJson - 更小更快的C# JSON序列化工具(基于表达式树构建)C#领域有很多成熟的开源JSON框架，最著名且使用最多的是 Newtonsoft.Json ,然而因为版本迭代,其代码要兼容从.NET 2.0到现在的最新的.NET框架,并且要支持.NE...
java hbnet框架,.net 聊聊JSON框架的性能对比（KoobooJSON,NewtonsoftJSON,SwifterJSON）
weixin_35797901的博客
03-19 376
![.netcore](https://img.tnblog.net/arcimg/hb/c857299a86d84ee7b26d181a31e58234.jpg ".netcore")>#.net 聊聊JSON框架的性能对比[TOC]环境配置------------>.NET Framework 4.7.256000多条数据KoobooJSON------------>###K...
Jackson对时间的序列化和反序列化及时区问题
热门推荐
weixin_42449408的博客
06-06 1万+
问题描述： Jackson是springboot中集成的一个对象与字符串转换的工具，其中日期的格式转化问题困扰许多人，时间格式问题和时区问题。 入参时间格式（反序列化，接收json字符串转化为实体类） 当json字符串中包含有时间字符串存在时，反序列化可能会报错。 如果在spring和springmvc环境下可以使用： @DateTimeFormate(pattern = "yyyy-MM-dd HH:mm:ss") 如果在springboot环境下使用DateTimeFormate，可能会一下错误：
Kooboo 完全介绍一：概念介绍
weixin_34283445的博客
10-25 244
Kooboo的定位是一个CMS，内容管理平台，从更严格意义上来说，它更应该网站快速开发平台。针对一般网站开发过程的分析和提炼，着重在解决网站的一般需求，提出一套快速开发网站的理念和方法。在这些理念和方法的指导下，来进行网站的开发，规范开发过程，提高开发效率，减少维护成本，提高网站质量。 我们在开发一个网站，一般会面对如下问题： 内容存储，这是一个基础性问题。内容是整个网站的肉体，也是灵魂，失去了内...
Kooboo CMS - Html.FrontHtml[Helper.cs] 各个方法详解
weixin_33810006的博客
04-04 158
下面罗列了方法详解，每一个方法一篇文章。   Kooboo CMS - @Html.FrontHtml().HtmlTitle() 详解    Kooboo CMS - Html.FrontHtml.Position 详解   Kooboo CMS - @Html.FrontHtml().Meta()详解  ...
第四周实践课-课堂笔记.pdf
最新发布
09-16
第四周实践课-课堂笔记
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值