.Net Core3.0 WebApi 项目框架搭建十四：自定义返回Json大小写格式

最新推荐文章于 2025-05-24 01:22:00 发布

转载最新推荐文章于 2025-05-24 01:22:00 发布 · 1.4k 阅读

1 ·

CC 4.0 BY-SA版权

原文链接：https://blog.youkuaiyun.com/WuLex

文章标签：

#json #.netcore #microsoft

NET Core跨平台+CoreCLR+C# 专栏收录该内容

212 篇文章

订阅专栏

本文介绍了如何在.NET Core 3中通过扩展JsonNamingPolicy实现返回对象的命名策略，并详细讲解了如何设置日期格式化，包括统一日期字符串和自定义DateTime转换器。

默认格式

在.net core 3中，默认的json返回格式为驼峰命名法
在这里插入图片描述
有的时候，我们希望返回的全小写或者全大写等。当然微软已经提供了拓展的接口。

设置返回`Json`名称全小写

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

/// <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(option =>
{
    //空的字段不返回
    option.JsonSerializerOptions.IgnoreNullValues = true;
    //返回json小写
    option.JsonSerializerOptions.PropertyNamingPolicy = new LowercasePolicy();
});

继续测试刚才的方法，发现已经转为小写了

格式化时间

JsonConv文件夹新建DateTimeConverter和DateTimeNullableConverter

  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"));
        }
    }

 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添加进去

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

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

.Net Core `WebApi`返回的`json`数据，自定义日期格式

基本上所有的人都在DateTime类型的字段，被序列化成json的时候，遇到过可恨的Date(1294499956278+0800)；但是又苦于不能全局格式化设置，比较难受。以往的方式，要么使用全局的Newtonsoft的配置，要么自己重写ActionResult，总之都比较麻烦。在Core提供了更为简单更为明了的办法；不多说，直接上代码！

//代码位置：Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc()
    .AddJsonOptions
    (
        json =>
        {
            //统一设置JsonResult中的日期格式    
            json.SerializerSettings.DateFormatString = "yyyy-MM-dd HH:mm:ss";
        }
    );
}