问题
在使用ASP.NET MVC 在写项目的时候发现,返回给前端的JSON数据,日期类型是 Date(121454578784541) 的格式,需要前端来转换一下才能用来使用。
C#对象属性名称转换成JSON自动转成“驼峰命名法”问题
在C#中推荐的属性命名方式是“帕斯卡命名法”【首字母大写】但是在前端推荐命名方式为“驼峰命名法”【首字母小写】,这样如果直接序列化C#对象,返回的属性就是大写的了
解决办法 创建新的 JsonResult 对象使用新的JSON序列化组件 Newtonsoft.Json
Install-Package Newtonsoft.Json
创建新的 JsonResult 对象
然后在新的 JsonResult 类型中将处理JSON序列化的对象改为 Newtonsoft.Json
并设置JSON转换的日期格式为 yyyy-MM-dd HH:mm:ss 例如:【2020-03-28 17:36:23】
并设置 转换的属性为“驼峰命名法”
///
/// JSON结果返回对象
///
public class JsonNetResult : JsonResult
{
///
/// 实例化JSON结果返回对象
///
/// 需要序列化的对象
/// JSON结果对象
public JsonNetResult(object data)
: this(data, JsonRequestBehavior.DenyGet)
{
}
///
/// 实例化JSON结果返回对象
///
/// 需要序列化的对象
/// 设置是否允许GET请求获取JSON结果对象
/// JSON结果对象
public JsonNetResult(object data, JsonRequestBehavior jsonRequestBehavior)
{
this.Data = data;
this.JsonRequestBehavior = jsonRequestBehavior;
this.Settings = new JsonSerializerSettings
{
ReferenceLoopHandling = ReferenceLoopHandling.Ignore, //忽略循环引用
DateFormatString = "yyyy-MM-dd HH:mm:ss", //输出的日期格式
ContractResolver = new CamelCasePropertyNamesContractResolver() //设置属性的名称为“驼峰命名法”
};
}
///
/// JSON序列化设置对象
///
public JsonSerializerSettings Settings { get; set; }
///
/// 向响应流返回结果方法
///
public override void ExecuteResult(ControllerContext context)
{
//判断当前请求是否为GET且判断是否允许GET获取JSON,不允许就报错
if ("GET".Equals(context.HttpContext.Request.HttpMethod, StringComparison.OrdinalIgnoreCase) &&
this.JsonRequestBehavior == JsonRequestBehavior.DenyGet)
throw new Exception("不允许GET请求返回JSON数据!");
//判断是否改变响应数据编码
if (this.ContentEncoding != null)
context.HttpContext.Response.ContentEncoding = this.ContentEncoding;
//如果当前需要序列化的数据为NULL就直接返回
if (this.Data == null)
return;
//设置响应数据内容格式为 json
context.HttpContext.Response.ContentType =
string.IsNullOrEmpty(this.ContentType) ? "application/json" : this.ContentType;
//向响应流写入序列化的数据
JsonSerializer.Create(Settings).Serialize(context.HttpContext.Response.Output, this.Data);
}
}
使用新的 JsonResult 对象 方法一
创建一个BaseController 来重写他的Json()方法
创建一个 BaseController 类 继承自 Controller 类
并重写他的 Json() 方法,其他Controller 类都继承自 BaseController
这样 可以直接沿用之前的 返回Json对象方法
///
/// 父 控制器
///
public class BaseController : Controller
{
///
/// 返回 JsonNetResult 对象
///
/// 需要返回序列化的对象
/// 内容格式
/// 内容编码
/// 指定是否允许来自客户端的 HTTP GET 请求。
/// JsonResult对象
protected override JsonResult Json(object data, string contentType, Encoding contentEncoding, JsonRequestBehavior behavior)
{
return new JsonNetResult(data)
{
ContentType = contentType,
ContentEncoding = contentEncoding,
JsonRequestBehavior = behavior
};
}
}
使用
public class HomeController : BaseController
{
public ActionResult GetStudent()
{
var student = new StudentDto
{
Id = 1,
Name = "张三",
Age = 18,
ClassName = "B36",
CreateDate = DateTime.Now,
};
//将当前对象序列化成JSON返回给前端
return Json(student);
}
}
返回给前端的JSON数据
{"id":1,"name":"张三","age":18,"className":"B36","createDate":"2020-03-28 17:47:29"}
使用新的 JsonResult 对象 方法二
创建一个JSON帮助类
///
/// JSON帮助类
///
public static class JsonHelper
{
///
/// 将一个对象序列化成JSON格式字符串返回给请求方
///
/// 需要序列化的对象
/// 设置是否允许GET请求获取JSON结果对象
/// JSON结果对象
public static JsonNetResult Json(object obj,
JsonRequestBehavior jsonRequestBehavior = JsonRequestBehavior.DenyGet)
{
return new JsonNetResult(obj);
}
///
/// 将当前对象序列化成JSON格式字符串返回给请求方
///
/// 需要序列化的对象
/// 设置是否允许GET请求获取JSON结果对象
/// JSON结果对象
public static JsonNetResult ToJsonResult(this object obj,
JsonRequestBehavior jsonRequestBehavior = JsonRequestBehavior.DenyGet)
{
return new JsonNetResult(obj);
}
}
使用
public ActionResult GetStudent()
{
var student = new StudentDto
{
Name = "张三",
Age = 18,
ClassName = "B36",
CreateDate = DateTime.Now,
};
//直接调用扩展方法 ToJsonResult 来获取新的 JsonResult
return student.ToJsonResult();
}
返回给前端的JSON数据
{"id":1,"name":"张三","age":18,"className":"B36","createDate":"2020-03-28 17:47:29"}