web-dev-qa-db-ja.com

ASP.NET MVCカスタムエラー処理Application_Error Global.asax?

MVCアプリケーションのエラーを特定するための基本的なコードがいくつかあります。現在、私のプロジェクトには、アクションメソッドHTTPError404()HTTPError500()、およびGeneral()を備えたErrorというコントローラーがあります。これらはすべて、文字列パラメーターerrorを受け入れます。以下のコードを使用または変更します。処理のためにデータをエラーコントローラに渡すための最良/適切な方法は何ですか?可能な限り堅牢なソリューションが必要です。

protected void Application_Error(object sender, EventArgs e)
{
    Exception exception = Server.GetLastError();
    Response.Clear();

    HttpException httpException = exception as HttpException;
    if (httpException != null)
    {
        RouteData routeData = new RouteData();
        routeData.Values.Add("controller", "Error");
        switch (httpException.GetHttpCode())
        {
            case 404:
                // page not found
                routeData.Values.Add("action", "HttpError404");
                break;
            case 500:
                // server error
                routeData.Values.Add("action", "HttpError500");
                break;
            default:
                routeData.Values.Add("action", "General");
                break;
        }
        routeData.Values.Add("error", exception);
        // clear error on server
        Server.ClearError();

        // at this point how to properly pass route data to error controller?
    }
}
101
aherrick

そのための新しいルートを作成する代わりに、コントローラー/アクションにリダイレクトし、クエリ文字列を介して情報を渡すことができます。例えば:

protected void Application_Error(object sender, EventArgs e) {
  Exception exception = Server.GetLastError();
  Response.Clear();

  HttpException httpException = exception as HttpException;

  if (httpException != null) {
    string action;

    switch (httpException.GetHttpCode()) {
      case 404:
        // page not found
        action = "HttpError404";
        break;
      case 500:
        // server error
        action = "HttpError500";
        break;
      default:
        action = "General";
        break;
      }

      // clear error on server
      Server.ClearError();

      Response.Redirect(String.Format("~/Error/{0}/?message={1}", action, exception.Message));
    }

その後、コントローラーは必要なものを受け取ります。

// GET: /Error/HttpError404
public ActionResult HttpError404(string message) {
   return View("SomeView", message);
}

アプローチにはいくつかのトレードオフがあります。この種のエラー処理では、ループに非常に注意してください。もう1つは、asp.netパイプラインを介して404を処理するため、これらすべてのヒットに対してセッションオブジェクトを作成するということです。これは、頻繁に使用されるシステムの問題(パフォーマンス)になる可能性があります。

99
andrecarlucci

最初の質問「ルートコントローラーをエラーコントローラーに正しく渡す方法」に答えるには:

IController errorController = new ErrorController();
errorController.Execute(new RequestContext(new HttpContextWrapper(Context), routeData));

次に、ErrorControllerクラスで、次のような関数を実装します。

[AcceptVerbs(HttpVerbs.Get)]
public ViewResult Error(Exception exception)
{
    return View("Error", exception);
}

これにより、例外がビューにプッシュされます。ビューページは次のように宣言する必要があります。

<%@ Page Language="C#" Inherits="System.Web.Mvc.ViewPage<System.Exception>" %>

そして、エラーを表示するコード:

<% if(Model != null) { %>  <p><b>Detailed error:</b><br />  <span class="error"><%= Helpers.General.GetErrorMessage((Exception)Model, false) %></span></p> <% } %>

例外ツリーからすべての例外メッセージを収集する関数は次のとおりです。

    public static string GetErrorMessage(Exception ex, bool includeStackTrace)
    {
        StringBuilder msg = new StringBuilder();
        BuildErrorMessage(ex, ref msg);
        if (includeStackTrace)
        {
            msg.Append("\n");
            msg.Append(ex.StackTrace);
        }
        return msg.ToString();
    }

    private static void BuildErrorMessage(Exception ex, ref StringBuilder msg)
    {
        if (ex != null)
        {
            msg.Append(ex.Message);
            msg.Append("\n");
            if (ex.InnerException != null)
            {
                BuildErrorMessage(ex.InnerException, ref msg);
            }
        }
    }
27
user248913

Lion_clが指摘したajax問題の解決策を見つけました。

global.asax:

protected void Application_Error()
    {           
        if (HttpContext.Current.Request.IsAjaxRequest())
        {
            HttpContext ctx = HttpContext.Current;
            ctx.Response.Clear();
            RequestContext rc = ((MvcHandler)ctx.CurrentHandler).RequestContext;
            rc.RouteData.Values["action"] = "AjaxGlobalError";

            // TODO: distinguish between 404 and other errors if needed
            rc.RouteData.Values["newActionName"] = "WrongRequest";

            rc.RouteData.Values["controller"] = "ErrorPages";
            IControllerFactory factory = ControllerBuilder.Current.GetControllerFactory();
            IController controller = factory.CreateController(rc, "ErrorPages");
            controller.Execute(rc);
            ctx.Server.ClearError();
        }
    }

ErrorPagesController

public ActionResult AjaxGlobalError(string newActionName)
    {
        return new AjaxRedirectResult(Url.Action(newActionName), this.ControllerContext);
    }

AjaxRedirectResult

public class AjaxRedirectResult : RedirectResult
{
    public AjaxRedirectResult(string url, ControllerContext controllerContext)
        : base(url)
    {
        ExecuteResult(controllerContext);
    }

    public override void ExecuteResult(ControllerContext context)
    {
        if (context.RequestContext.HttpContext.Request.IsAjaxRequest())
        {
            JavaScriptResult result = new JavaScriptResult()
            {
                Script = "try{history.pushState(null,null,window.location.href);}catch(err){}window.location.replace('" + UrlHelper.GenerateContentUrl(this.Url, context.HttpContext) + "');"
            };

            result.ExecuteResult(context);
        }
        else
        {
            base.ExecuteResult(context);
        }
    }
}

AjaxRequestExtension

public static class AjaxRequestExtension
{
    public static bool IsAjaxRequest(this HttpRequest request)
    {
        return (request.Headers["X-Requested-With"] != null && request.Headers["X-Requested-With"] == "XMLHttpRequest");
    }
}
9

以前、MVCアプリでグローバルエラー処理ルーチンを集中化するというアイデアに苦労しました。 ASP.NETフォーラムに投稿 があります。

基本的に、エラーコントローラー、[HandlerError]属性で装飾したり、web.configでcustomErrorsノードをいじったりすることなく、global.asaxですべてのアプリケーションエラーを処理します。

9
Jack Hsu

おそらく、MVCでエラーを処理するより良い方法は、コントローラーまたはアクションにHandleError属性を適用し、Shared/Error.aspxファイルを更新して必要な処理を行うことです。そのページのModelオブジェクトには、ControllerNameとActionNameに加えて、Exceptionプロパティが含まれています。

6
Brian

Ajaxリクエストに問題があるApplication_Error。 Ajaxによって呼び出されたActionでエラーが処理された場合、結果のコンテナー内にエラービューが表示されます。

4

これはMVCに最適な方法ではないかもしれません( https://stackoverflow.com/a/9461386/5869805

以下は、Application_Errorでビューをレンダリングし、http応答に書き込む方法です。リダイレクトを使用する必要はありません。これにより、サーバーへの2番目の要求が防止されるため、ブラウザーのアドレスバーのリンクは同じままになります。これは良いことも悪いこともありますが、それはあなたが望むものに依存します。

Global.asax.cs

protected void Application_Error()
{
    var exception = Server.GetLastError();
    // TODO do whatever you want with exception, such as logging, set errorMessage, etc.
    var errorMessage = "SOME FRIENDLY MESSAGE";

    // TODO: UPDATE BELOW FOUR PARAMETERS ACCORDING TO YOUR ERROR HANDLING ACTION
    var errorArea = "AREA";
    var errorController = "CONTROLLER";
    var errorAction = "ACTION";
    var pathToViewFile = $"~/Areas/{errorArea}/Views/{errorController}/{errorAction}.cshtml"; // THIS SHOULD BE THE PATH IN FILESYSTEM RELATIVE TO WHERE YOUR CSPROJ FILE IS!

    var requestControllerName = Convert.ToString(HttpContext.Current.Request.RequestContext?.RouteData?.Values["controller"]);
    var requestActionName = Convert.ToString(HttpContext.Current.Request.RequestContext?.RouteData?.Values["action"]);

    var controller = new BaseController(); // REPLACE THIS WITH YOUR BASE CONTROLLER CLASS
    var routeData = new RouteData { DataTokens = { { "area", errorArea } }, Values = { { "controller", errorController }, {"action", errorAction} } };
    var controllerContext = new ControllerContext(new HttpContextWrapper(HttpContext.Current), routeData, controller);
    controller.ControllerContext = controllerContext;

    var sw = new StringWriter();
    var razorView = new RazorView(controller.ControllerContext, pathToViewFile, "", false, null);
    var model = new ViewDataDictionary(new HandleErrorInfo(exception, requestControllerName, requestActionName));
    var viewContext = new ViewContext(controller.ControllerContext, razorView, model, new TempDataDictionary(), sw);
    viewContext.ViewBag.ErrorMessage = errorMessage;
    //TODO: add to ViewBag what you need
    razorView.Render(viewContext, sw);
    HttpContext.Current.Response.Write(sw);
    Server.ClearError();
    HttpContext.Current.Response.End(); // No more processing needed (ex: by default controller/action routing), flush the response out and raise EndRequest event.
}

表示

@model HandleErrorInfo
@{
    ViewBag.Title = "Error";
    // TODO: SET YOUR LAYOUT
}
<div class="">
    ViewBag.ErrorMessage
</div>
@if(Model != null && HttpContext.Current.IsDebuggingEnabled)
{
    <div class="" style="background:Khaki">
        <p>
            <b>Exception:</b> @Model.Exception.Message <br/>
            <b>Controller:</b> @Model.ControllerName <br/>
            <b>Action:</b> @Model.ActionName <br/>
        </p>
        <div>
            <pre>
                @Model.Exception.StackTrace
            </pre>
        </div>
    </div>
}
3
burkay

ブライアン、このアプローチはAjax以外のリクエストには最適ですが、Lion_clが述べたように、Ajaxの呼び出し中にエラーが発生した場合、Share/Error.aspxビュー(またはカスタムエラーページビュー)がAjax呼び出し元に返されます。 -ユーザーはエラーページにリダイレクトされません。

3
undeniablyrob

ルートページでリダイレクトするには、次のコードを使用します。 exceptionの代わりにexception.Messageを使用します。 Coz例外クエリ文字列は、クエリ文字列の長さを延長するとエラーになります。

routeData.Values.Add("error", exception.Message);
// clear error on server
Server.ClearError();
Response.RedirectToRoute(routeData.Values);
0
Swapnil Malap