web-dev-qa-db-ja.com

ASP.NET MVC Ajaxエラー処理

Jquery ajaxがアクションを呼び出すときにコントローラーでスローされた例外を処理するにはどうすればよいですか?

たとえば、デバッグモードまたは通常のエラーメッセージの場合に例外メッセージを表示するajax呼び出し中に、あらゆる種類のサーバー例外で実行されるグローバルJavaScriptコードが必要です。

クライアント側では、ajaxエラーで関数を呼び出します。

サーバー側では、カスタムアクションフィルターを記述する必要がありますか?

114
Shawn Mclean

サーバーが200以外のステータスコードを送信すると、エラーコールバックが実行されます。

$.ajax({
    url: '/foo',
    success: function(result) {
        alert('yeap');
    },
    error: function(XMLHttpRequest, textStatus, errorThrown) {
        alert('oops, something bad happened');
    }
});

また、グローバルエラーハンドラを登録するには、 $.ajaxSetup() メソッドを使用できます。

$.ajaxSetup({
    error: function(XMLHttpRequest, textStatus, errorThrown) {
        alert('oops, something bad happened');
    }
});

別の方法は、JSONを使用することです。そのため、例外をキャッチしてJSON応答に変換するカスタムアクションフィルターをサーバーで作成できます。

public class MyErrorHandlerAttribute : FilterAttribute, IExceptionFilter
{
    public void OnException(ExceptionContext filterContext)
    {
        filterContext.ExceptionHandled = true;
        filterContext.Result = new JsonResult
        {
            Data = new { success = false, error = filterContext.Exception.ToString() },
            JsonRequestBehavior = JsonRequestBehavior.AllowGet
        };
    }
}

そして、コントローラーのアクションを次の属性で装飾します。

[MyErrorHandler]
public ActionResult Foo(string id)
{
    if (string.IsNullOrEmpty(id))
    {
        throw new Exception("oh no");
    }
    return Json(new { success = true });
}

そして最後にそれを呼び出します:

$.getJSON('/home/foo', { id: null }, function (result) {
    if (!result.success) {
        alert(result.error);
    } else {
        // handle the success
    }
});
160
Darin Dimitrov

グーグルの後、MVCアクションフィルターに基づいて簡単な例外処理を記述します。

public class HandleExceptionAttribute : HandleErrorAttribute
{
    public override void OnException(ExceptionContext filterContext)
    {
        if (filterContext.HttpContext.Request.IsAjaxRequest() && filterContext.Exception != null)
        {
            filterContext.HttpContext.Response.StatusCode = (int)HttpStatusCode.InternalServerError;
            filterContext.Result = new JsonResult
            {
                JsonRequestBehavior = JsonRequestBehavior.AllowGet,
                Data = new
                {
                    filterContext.Exception.Message,
                    filterContext.Exception.StackTrace
                }
            };
            filterContext.ExceptionHandled = true;
        }
        else
        {
            base.OnException(filterContext);
        }
    }
}

global.ascxに書き込みます。

 public static void RegisterGlobalFilters(GlobalFilterCollection filters)
 {
      filters.Add(new HandleExceptionAttribute());
 }

次に、レイアウトまたはマスターページに次のスクリプトを記述します。

<script type="text/javascript">
      $(document).ajaxError(function (e, jqxhr, settings, exception) {
                       e.stopPropagation();
                       if (jqxhr != null)
                           alert(jqxhr.responseText);
                     });
</script>

最後に、カスタムエラーをオンにする必要があります。そしてそれをお楽しみください:)

72
Arash Karami

残念ながら、どちらの答えも私にとって良いものではありません。驚くべきことに、解決策ははるかに簡単です。コントローラーから戻る:

return new HttpStatusCodeResult(HttpStatusCode.BadRequest, e.Response.ReasonPhrase);

そして、クライアントで標準のHTTPエラーとして処理します。

9
alehro

Alehoの回答と一致して、ここに完全な例があります。それは魅力のように機能し、非常にシンプルです。

コントローラーコード

[HttpGet]
public async Task<ActionResult> ChildItems()
{
    var client = TranslationDataHttpClient.GetClient();
    HttpResponseMessage response = await client.GetAsync("childItems);

    if (response.IsSuccessStatusCode)
        {
            string content = response.Content.ReadAsStringAsync().Result;
            List<WorkflowItem> parameters = JsonConvert.DeserializeObject<List<WorkflowItem>>(content);
            return Json(content, JsonRequestBehavior.AllowGet);
        }
        else
        {
            return new HttpStatusCodeResult(response.StatusCode, response.ReasonPhrase);
        }
    }
}

ビュー内のJavascriptコード

var url = '@Html.Raw(@Url.Action("ChildItems", "WorkflowItemModal")';

$.ajax({
    type: "GET",
    dataType: "json",
    url: url,
    contentType: "application/json; charset=utf-8",
    success: function (data) {
        // Do something with the returned data
    },
    error: function (xhr, status, error) {
        // Handle the error.
    }
});

これが他の人の助けになることを願っています!

4
Rymnel

時間が足りなかったので、すぐに解決しましたが、うまくいきました。私はより良いオプションは例外フィルターを使用することだと思いますが、私のソリューションは簡単なソリューションが必要な場合に役立つかもしれません。

私は次のことをしました。コントローラーメソッドでは、データ内にプロパティ「Success」を持つJsonResultを返しました。

    [HttpPut]
    public JsonResult UpdateEmployeeConfig(EmployeConfig employeToSave) 
    {
        if (!ModelState.IsValid)
        {
            return new JsonResult
            {
                Data = new { ErrorMessage = "Model is not valid", Success = false },
                ContentEncoding = System.Text.Encoding.UTF8,
                JsonRequestBehavior = JsonRequestBehavior.DenyGet
            };
        }
        try
        {
            MyDbContext db = new MyDbContext();

            db.Entry(employeToSave).State = EntityState.Modified;
            db.SaveChanges();

            DTO.EmployeConfig user = (DTO.EmployeConfig)Session["EmployeLoggin"];

            if (employeToSave.Id == user.Id)
            {
                user.Company = employeToSave.Company;
                user.Language = employeToSave.Language;
                user.Money = employeToSave.Money;
                user.CostCenter = employeToSave.CostCenter;

                Session["EmployeLoggin"] = user;
            }
        }
        catch (Exception ex) 
        {
            return new JsonResult
            {
                Data = new { ErrorMessage = ex.Message, Success = false },
                ContentEncoding = System.Text.Encoding.UTF8,
                JsonRequestBehavior = JsonRequestBehavior.DenyGet
            };
        }

        return new JsonResult() { Data = new { Success = true }, };
    }

Ajax呼び出しの後半で、例外が発生したかどうかを知るためにこのプロパティを要求しました。

$.ajax({
    url: 'UpdateEmployeeConfig',
    type: 'PUT',
    data: JSON.stringify(EmployeConfig),
    contentType: "application/json;charset=utf-8",
    success: function (data) {
        if (data.Success) {
            //This is for the example. Please do something prettier for the user, :)
            alert('All was really ok');                                           
        }
        else {
            alert('Oups.. we had errors: ' + data.ErrorMessage);
        }
    },
    error: function (request, status, error) {
       alert('oh, errors here. The call to the server is not working.')
    }
});

お役に立てれば。幸せなコード! :P

4
Daniel Silva

クライアント側でajax呼び出しからのエラーを処理するには、関数をajax呼び出しのerrorオプションに割り当てます。

デフォルトをグローバルに設定するには、ここで説明されている関数 http://api.jquery.com/jQuery.ajaxSetup を使用できます。

0
Brian Ball