ABP 入門シリーズでの Json フォーマットの使用法についての紹介

,JSON (JavaScript Object Notation) は軽量のデータ交換形式です。この記事は、ABP 入門シリーズでの Json フォーマットの紹介に焦点を当てています。必要な方は参照してください。ページング関数について説明した後、このセクションでは新しい関数を急いで実装する必要はありません。 Abp での Json の使い方を簡単に紹介します。なぜこのセクションでそれについて説明するのでしょうか?もちろん、これは道を整えるためです。次の一連の記事では、Json を頻繁に扱います。

1. Json は何をしますか JSON (JavaScript Object Notation) は軽量のデータ交換フォーマットです。 人間にとって読み書きしやすい。機械による解析と生成も簡単です。 JSON は完全に言語に依存しないテキスト形式を採用していますが、

C 言語

ファミリ (C、C++、C#、Java、JavaScript、Perl、Python などを含む) と同様の習慣も使用します。 これらの特性により、JSON は理想的なデータ交換言語になります。 Json は通常、以下を表すために使用されます。

名前と値のペア:

{"firstName":"Brett","lastName":"McLaughlin","email":"aaaa"}

配列:

{ "people":[
  {"firstName":"Brett","lastName":"McLaughlin","email":"aaaa"},
  {"firstName":"Jason","lastName":"Hunter","email":"bbbb"},
  {"firstName":"Elliotte","lastName":"Harold","email":"cccc"}
 ]
}

two、Asp.net Mvc JsonResultAsp.net mvcがデフォルトで提供されますJson結果Json 形式のデータを返す必要がある状況を処理するために使用されます。

一般的には次のように使用できます:

public ActionResult Movies()
{
 var movies = new List<object>();
 movies.Add(new { Title = "Ghostbusters", Genre = "Comedy", ReleaseDate = new DateTime(2017,1,1) });
 movies.Add(new { Title = "Gone with Wind", Genre = "Drama", ReleaseDate = new DateTime(2017, 1, 3) });
 movies.Add(new { Title = "Star Wars", Genre = "Science Fiction", ReleaseDate = new DateTime(2017, 1, 23) });
 return Json(movies, JsonRequestBehavior.AllowGet);
}

ここで、Json() はコントローラーの基本クラスで提供される仮想メソッドです。

返された json 結果は次の形式になっています:

[
 {
 "Title": "Ghostbusters",
 "Genre": "Comedy",
 "ReleaseDate": "\/Date(1483200000000)\/"
 },
 {
 "Title": "Gone with Wind",
 "Genre": "Drama",
 "ReleaseDate": "\/Date(1483372800000)\/"
 },
 {
 "Title": "Star Wars",
 "Genre": "Science Fiction",
 "ReleaseDate": "\/Date(1485100800000)\/"
 }
]

返された json 結果を注意深く見ると、次の欠点があります:

返されたフィールドの大文字と小文字はコードと一致しています。これには、コード (item.Title、item.Genre、item.ReleaseDate) と同じ大文字と小文字をフロントエンドで使用する必要があります。

成功または失敗の情報は含まれていません: リクエストが成功したかどうかを判断したい場合は、JSON データ パケットの長さを手動で取得する必要があります。

返された日付はフォーマットされていないため、

フロントエンドで自分でフォーマットして出力する必要があります

。

3. Abp での Json のカプセル化そのため、Abp は AbpJsonResult

Inherits

を JsonResult からカプセル化し、主に次の 2 つの属性を追加します: CamelCase: 大きいキャメル ケースと小さいキャメル ケース (デフォルトは true、つまり小さいキャメル ケース) format )

Indented: インデントするかどうか (デフォルトは false、つまり書式設定されていません)

と、AbpController のコントローラーの Json() メソッドをオーバーロードし、返されるすべての Json 形式データを AbpJsonResult 型にするように強制します。 AbpJson() の仮想メソッドを提供しました。

/// <summary>
/// Json the specified data, contentType, contentEncoding and behavior.
/// </summary>
/// <param name="data">Data.</param>
/// <param name="contentType">Content type.</param>
/// <param name="contentEncoding">Content encoding.</param>
/// <param name="behavior">Behavior.</param>
protected override JsonResult Json(object data, string contentType, 
 Encoding contentEncoding, JsonRequestBehavior behavior)
{
 if (_wrapResultAttribute != null && !_wrapResultAttribute.WrapOnSuccess)
 {
  return base.Json(data, contentType, contentEncoding, behavior);
 }
 return AbpJson(data, contentType, contentEncoding, behavior);
}
protected virtual AbpJsonResult AbpJson(
 object data,
 string contentType = null,
 Encoding contentEncoding = null,
 JsonRequestBehavior behavior = JsonRequestBehavior.DenyGet,
 bool wrapResult = true,
 bool camelCase = true,
 bool indented = false)
{
 if (wrapResult)
 {
  if (data == null)
  {
   data = new AjaxResponse();
  }
  else if (!(data is AjaxResponseBase))
  {
   data = new AjaxResponse(data);
  }
 }
 return new AbpJsonResult
 {
  Data = data,
  ContentType = contentType,
  ContentEncoding = contentEncoding,
  JsonRequestBehavior = behavior,
  CamelCase = camelCase,
  Indented = indented
 };
}

ABP では、Controller を使用して AbpController から継承し、return Json() を直接使用し、返された Json 結果を次のようにフォーマットします。

{
 "result": [
 {
  "title": "Ghostbusters",
  "genre": "Comedy",
  "releaseDate": "2017-01-01T00:00:00"
 },
 {
  "title": "Gone with Wind",
  "genre": "Drama",
  "releaseDate": "2017-01-03T00:00:00"
 },
 {
  "title": "Star Wars",
  "genre": "Science Fiction",
  "releaseDate": "2017-01-23T00:00:00"
 }
 ],
 "targetUrl": null,
 "success": true,
 "error": null,
 "unAuthorizedRequest": false,
 "abp": true
}

ここで、 result はコードで指定された返されるデータです。認証、成功、エラー情報、ターゲット URL など、他のいくつかのキーと値のペアが ABP によってカプセル化されます。これらのパラメータは非常に甘いのでしょうか?

return AbpJson() を呼び出して、json 形式の出力のパラメーターを指定することもできます。

よく見ると、日付の形式がまだおかしいことがわかります。 2017-01-23T00:00:00、T がもう 1 つあります。 AbpJsonReult のソース コードを見ると、Newtonsoft.

Json シリアル化

コンポーネントの JsonConvert.SerializeObject(obj, settings); がシリアル化のために呼び出されていることがわかりました。

Newtonsoft.Json の公式 Web サイトの紹介を参照してください。日付の書式設定を出力するには、IsoDateTimeConverter の DateTimeFormat を指定する必要があります。

IsoDateTimeConverter timeFormat = new IsoDateTimeConverter();
   timeFormat.DateTimeFormat = "yyyy-MM-dd HH:mm:ss";
JsonConvert.SerializeObject(dt, Formatting.Indented, timeFormat)

では、Abp でこの DateTimeFormat を指定するにはどうすればよいでしょうか?

ABP で提供される AbpDateTimeConverter クラスは IsoDateTimeConverter を継承します。

しかし、ABP に統合された Json シリアル化拡張クラスを見てください:

public static class JsonExtensions
 {
 /// <summary>Converts given object to JSON string.</summary>
 /// <returns></returns>
 public static string ToJsonString(this object obj, bool camelCase = false, bool indented = false)
 {
  JsonSerializerSettings settings = new JsonSerializerSettings();
  if (camelCase)
  settings.ContractResolver = (IContractResolver) new CamelCasePropertyNamesContractResolver();
  if (indented)
  settings.Formatting = Formatting.Indented;
  settings.Converters.Insert(0, (JsonConverter) new AbpDateTimeConverter());
  return JsonConvert.SerializeObject(obj, settings);
 }
 }

明らかに DateTimeFormat が指定されていないため、自分で行う必要があります。具体的なコードについては、JSON を解決する 4 つの方法の 4 番目の方法を参照してください。日付形式の問題。

当有异常发生时，Abp返回的Json格式化输出以下结果：

{
 "targetUrl": null,
 "result": null,
 "success": false,
 "error": {
 "message": "An internal error occured during your request!",
 "details": "..."
 },
 "unAuthorizedRequest": false
}

当不需要abp对json进行封装包裹怎么办？

简单。只需要在方法上标记[DontWrapResult]特性即可。这个特性其实是一个快捷方式用来告诉ABP不要用AbpJsonResult包裹我，看源码就明白了：

namespace Abp.Web.Models
{
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)]
 public class DontWrapResultAttribute : WrapResultAttribute
 {
  /// <summary>
  /// Initializes a new instance of the <see cref="DontWrapResultAttribute"/> class.
  /// </summary>
  public DontWrapResultAttribute()
   : base(false, false)
  {
  }
 }
 /// <summary>
 /// Used to determine how ABP should wrap response on the web layer.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class | AttributeTargets.Interface | AttributeTargets.Method)]
 public class WrapResultAttribute : Attribute
 {
  /// <summary>
  /// Wrap result on success.
  /// </summary>
  public bool WrapOnSuccess { get; set; }
  /// <summary>
  /// Wrap result on error.
  /// </summary>
  public bool WrapOnError { get; set; }
  /// <summary>
  /// Log errors.
  /// Default: true.
  /// </summary>
  public bool LogError { get; set; }
  /// <summary>
  /// Initializes a new instance of the <see cref="WrapResultAttribute"/> class.
  /// </summary>
  /// <param name="wrapOnSuccess">Wrap result on success.</param>
  /// <param name="wrapOnError">Wrap result on error.</param>
  public WrapResultAttribute(bool wrapOnSuccess = true, bool wrapOnError = true)
  {
   WrapOnSuccess = wrapOnSuccess;
   WrapOnError = wrapOnError;
   LogError = true;
  }
 }
}

在AbpResultFilter和AbpExceptionFilter过滤器中会根据WrapResultAttribute、DontWrapResultAttribute特性进行相应的过滤。

四、Json日期格式化

第一种办法：前端JS转换：

 //格式化显示json日期格式
 function showDate(jsonDate) {
  var date = new Date(jsonDate);
  var formatDate = date.toDateString();
  return formatDate;
 }

第二种办法：在Abp的WepApiModule（模块）中指定JsonFormatter的时间序列化时间格式。

GlobalConfiguration.Configuration.Formatters.JsonFormatter.SerializerSettings.DateFormatString ="yyyy-MM-dd HH:mm:ss";

PS：这种方法仅对WebApi有效。

总结

本节主要讲解了以下几个问题：

Asp.net中JsonResult的实现。

ABP对JsonResult的再封装，支持指定大小驼峰及是否缩进进行Json格式化。

如何对DateTime类型对象进行格式化输出。

Web层通过拓展AbpJsonResult，指定时间格式。

前端，通过将Json日期转换为js的Date类型，再格式化输出。

WebApi，通过在Moduel中指定DateFormatString。

以上がABP 入門シリーズでの Json フォーマットの使用法についての紹介の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。