.Net Core3.0 WebApi 十三：自定义返回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;将其按照时间转换为相应的格式。