Ajaxで取得した内容に応じてtoastrの種別を分けたい

Question

現在AjaxでリモートAPIのデータを取得し、その結果データの内容に応じてJquery Toastのステータスを変更しようと考えています。

Dataの中身は通常のテキストメッセージが返却されるため、エラーなのか正常なのかを現時点では判断ができないため、識別できるように値とメッセージを入れて返却するように修正しようと思っているのですが、その値の特定の部分の中身をみて、toastrに渡す方法がよくわかりません。

$.ajax({
type: "POST",
url: "/api",
data: data,

success: function(data, dataType)
{
	toastr.success(data)
},
error: function(XMLHttpRequest, textStatus, errorThrown)
{
	toastr.danger('Error : ' + errorThrown);
}
});

例えば、DATAの値に以下の様な文字列を返却できるようにし、先頭のステータス文字を、toastr実行時の値として利用するようなことを考えています。

success:正常に完了しました。
danger:エラーが発生しました。

toastr.$status(data)
※$statusの中にsuccessやdangerを入れる等。

もう少しシンプルな実装方法やベストなナレッジがあればアドバイス頂けると助かります。

宜しくお願いします。

Answer 1

$.ajaxのerrorはajax(xhr)自体にエラーが発生した場合に呼ばれますので気を付けてください。

APIは大抵の場合JSONでレスポンスを返すように実装されています。
そして、サーバー側の処理でエラーが発生した場合は、JSON内にerrorといったキーをつけて、その値にメッセージやステータスコード、もしくはエラーに関する情報をまとめたオブジェクトにして返すのが一般的かと。

$.ajax({
  type: 'POST',
  url: '/api',
  dataType: 'json',
  success: function(data) {
    if(data.error) {
      toastr.danger('Error : ' + data.error);
    } else if(data.success) {
      toastr.success('Success : ' + data.success);
    }
  },
  error: function(XMLHttpRequest, textStatus, errorThrown)
  {
    toastr.danger('Ajax Error : ' + errorThrown);
  }
}

Comments

[ashly]

ありがとうございます。こちらのコードも大変参考になりました。

Answer 2

API側を自由に修正できるのでしたら、返却するのは文字列ではなく、JSON形式などオブジェクトを持てる形式で返却する形にした方がよいと思います。
API側からは、code,message等を持たせたオブジェクトデータを返却してあげて、文字列判定ではなくオブジェクトのそれぞれの値をクライアント側で判定してあげた方があとあと幸せになれると思います。

なお、jQueryの$.ajaxのerrorコールバックに入るのはあくまで通信に失敗した場合などに発生するクライアント起因のエラーのみですので、API側で発生したいわゆるアプリケーションエラーは拾えません。

$.ajax({
  type: "POST",
  url: "/api",
  data: data,
  success: function(data, dataType) {
    var json = JSON.parse(data);
    if (json.code == 0) { // code=0の場合はエラーなし
      toastr.success(json.message);
    } else {
      toastr.danger('APIエラー : ' + json.message);
    }
  },
  error: function(XMLHttpRequest, textStatus, errorThrown) {
    toastr.danger('Error : ' + errorThrown);
  }
});

サーバーサイド（イメージ）

<?php
if (no_error) {
  // 正常時
  echo json_encode(array('code' => 0, 'message' => '正常です'));
} else {
  // エラー時
  echo json_encode(array('code' => 1, 'message' => 'エラーです'));
}

Comments

[ashly]

ありがとうございます。API側で返却するものをJSON形式にして、CODEの部分をパースして判定するようにしたところ、無事にうまくいきました！
サンプルコードも頂き大変助かりました。