首页 > 其他分享> > 自定义返回Json大小写格式

自定义返回Json大小写格式

2022-09-08 13:32:44 作者：互联网

自定义返回Json大小写格式

.Net Core3.0 WebApi 目录

默认格式

在.net core 3中，默认的json返回格式为驼峰命名法（单驼峰）

有的时候，我们希望返回的全小写或者全大写等。当然微软爸爸已经提供了拓展的接口。

设置返回Json名称全大写（双驼峰）

startup.cs的ConfigureServices方法新加AddJsonOptions

services.AddControllers(option =>
{
    option.Filters.Add(typeof(GlobalExceptionsFilter));
}).AddJsonOptions(options =>
{
    options.JsonSerializerOptions.PropertyNamingPolicy = null;//解决后端传到前端全大写
    options.JsonSerializerOptions.Encoder = JavaScriptEncoder.Create(UnicodeRanges.All);//解决后端返回数据中文被编码
});

只要 ptions.JsonSerializerOptions.PropertyNamingPolicy = null就可以了。

这样返回的结果中，全是双驼峰了。

设置返回Json名称全小写

新建CustomJsonConvert文件夹，新建LowercasePolicy.cs，继JsonNamingPolicy

namespace WebApi.Core.Api.CustomJsonConvert
{
    /// <summary>
    /// 返回对象全小写
    /// </summary>
    public class LowercasePolicy : JsonNamingPolicy
    {
        public override string ConvertName(string name) =>
            name.ToLower();
    }
}

startup.cs的ConfigureServices方法修改AddJsonOptions

 services.AddControllers(option =>
 {
     option.Filters.Add(typeof(GlobalExceptionsFilter));
 }).AddJsonOptions(options =>
 {
     // options.JsonSerializerOptions.PropertyNamingPolicy = null;//解决后端传到前端变小写
     //空的字段不返回
     options.JsonSerializerOptions.IgnoreNullValues = true;
     //返回json小写
     options.JsonSerializerOptions.PropertyNamingPolicy = new LowercasePolicy();
     options.JsonSerializerOptions.Encoder = JavaScriptEncoder.Create(UnicodeRanges.All);//解决后端返回数据中文被编码
 });

运行项目，测试接口，就全小写了。

格式化时间

CustomJsonConvert文件夹新建DateTimeConverter和DateTimeNullableConverter

namespace WebApi.Core.Api.CustomJsonConvert
{
    public class DateTimeConverter : JsonConverter<DateTime>
    {
        public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            return DateTime.Parse(reader.GetString());
        }

        public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
        {
            writer.WriteStringValue(value.ToString("yyyy-MM-dd HH:mm:ss"));
        }
    }
}

namespace WebApi.Core.Api.CustomJsonConvert
{
    public class DateTimeNullableConverter : JsonConverter<DateTime?>
    {
        public override DateTime? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            return string.IsNullOrEmpty(reader.GetString()) ? default(DateTime?) : DateTime.Parse(reader.GetString());
        }

        public override void Write(Utf8JsonWriter writer, DateTime? value, JsonSerializerOptions options)
        {
            writer.WriteStringValue(value?.ToString("yyyy-MM-dd HH:mm:ss"));
        }
    }
}

AddJsonOptions添加进去

//时间格式格式化
options.JsonSerializerOptions.Converters.Add(new DateTimeConverter());
options.JsonSerializerOptions.Converters.Add(new DateTimeNullableConverter());

这样，如果我们的实体是Datetime类型那么最后输出的就是yyyy-MM-dd HH:mm:ss这种格式

其实这只是时间格式转换的一种方式。还有很多方式。比如，在响应实体里面，多加一个string类型的值，利用get;将其按照时间转换为相应的格式。

：SOA

.Net Core3.0 WebApi 十五：使用Serilog替换掉Log4j 冰乐 2020-10-15 00:32 阅读:932 评论:4 推荐:0 编辑 .Net Core3.0 WebApi 十四：基于AOP的切面redis缓存冰乐 2020-10-15 00:31 阅读:1099 评论:3 推荐:0 编辑 .Net Core3.0 WebApi 十三：自定义返回Json大小写格式冰乐 2020-10-15 00:30 阅读:1722 评论:0 推荐:0 编辑 .Net Core3.0 WebApi 十二：自定义全局消息返回过滤中间件冰乐 2020-10-15 00:29 阅读:899 评论:0 推荐:0 编辑 .Net Core3.0 WebApi 十一：基于Log4j的全局异常处理冰乐 2020-10-15 00:28 阅读:569 评论:0 推荐:0 编辑 .Net Core3.0 WebApi 十：使用AutoMapper实现模型映射冰乐 2020-10-15 00:27 阅读:641 评论:0 推荐:1 编辑 .Net Core3.0 WebApi 九:使用Nginx实现跨域冰乐 2020-10-11 00:20 阅读:546 评论:0 推荐:0 编辑 .Net Core3.0 WebApi 八:使用Redis做数据缓存冰乐 2020-10-11 00:19 阅读:1662 评论:2 推荐:1 编辑 .Net Core3.0 WebApi 七:AutoFac 冰乐 2020-10-11 00:18 阅读:771 评论:0 推荐:1 编辑 .Net Core3.0 WebApi 六: Sqlsugar+异步泛型仓储冰乐 2020-10-11 00:17 阅读:2321 评论:1 推荐:0 编辑 .Net Core3.0 WebApi 五:项目分层冰乐 2020-10-11 00:15 阅读:1887 评论:1 推荐:2 编辑 .Net Core3.0 WebApi 四:JWT权限验证冰乐 2020-10-11 00:14 阅读:3762 评论:12 推荐:1 编辑 .Net Core3.0 WebApi 三:读取appsettings.json 冰乐 2020-10-11 00:12 阅读:1611 评论:0 推荐:0 编辑 .Net Core3.0 WebApi 二：API 文档神器 Swagger 冰乐 2020-10-11 00:11 阅读:953 评论:0 推荐:1 编辑 .Net Core3.0 WebApi 一：实现简单的Resful Api 冰乐 2020-10-11 00:10 阅读:1037 评论:0 推荐:1 编辑 WebApi简介冰乐 2019-09-22 17:55 阅读:18910 评论:0 推荐:1 编辑 RESTFul&HTTP GET简介冰乐 2019-09-22 10:24 阅读:3030 评论:0 推荐:0 编辑 WebService简介冰乐 2019-09-22 00:31 阅读:697 评论:0 推荐:0 编辑

公告

昵称：冰乐
园龄： 4年4个月
粉丝： 68
关注： 49 +加关注

2022年9月

日

一

二

三

四

五

六

搜索

常用链接

我的标签

积分与排名

积分 - 137691
排名 - 8552

自定义返回Json大小写格式

自定义返回Json大小写格式

.Net Core3.0 WebApi 目录

默认格式

设置返回Json名称全大写（双驼峰）

设置返回Json名称全小写

格式化时间

：SOA

公告

搜索

常用链接

我的标签

积分与排名

随笔档案 (118)

阅读排行榜

评论排行榜

推荐排行榜

最新评论