ASP.NET MVC HandleError

110

Jak przejść do [HandleError]filtru w asp.net MVC Preview 5?
Ustawiłem customErrors w moim pliku Web.config

<customErrors mode="On" defaultRedirect="Error.aspx">
  <error statusCode="403" redirect="NoAccess.htm"/>
  <error statusCode="404" redirect="FileNotFound.htm"/>
</customErrors>

i umieść [HandleError] nad moją klasą kontrolera w ten sposób:

[HandleError]
public class DSWebsiteController: Controller
{
    [snip]
    public ActionResult CrashTest()
    {
        throw new Exception("Oh Noes!");
    }
}

Następnie pozwoliłem moim kontrolerom dziedziczyć z tej klasy i wywołać na nich CrashTest (). Visual studio zatrzymuje się po wystąpieniu błędu i po naciśnięciu klawisza F5, aby kontynuować, następuje przekierowanie do Error.aspx? Aspxerrorpath = / sxi.mvc / CrashTest (gdzie sxi to nazwa używanego kontrolera. Oczywiście nie można znaleźć ścieżki i otrzymuję „Błąd serwera w aplikacji„ / ”.” 404.

Ta witryna została przeniesiona z wersji zapoznawczej 3 do 5. Wszystko działa (nie było dużo pracy do przeniesienia) z wyjątkiem obsługi błędów. Kiedy tworzę całkowicie nowy projekt, obsługa błędów wydaje się działać.

Pomysły?

--Uwaga -
Ponieważ to pytanie ma teraz ponad 3K wyświetleń, pomyślałem, że warto byłoby umieścić to, czego obecnie używam (ASP.NET MVC 1.0). W projekcie mvc contrib jest genialny atrybut o nazwie "RescueAttribute". Prawdopodobnie też powinieneś to sprawdzić;)

Boris Callens
źródło
Link do RescueAttributeźródła: mvccontrib.codeplex.com/SourceControl/changeset/view/…
Peter

Odpowiedzi:

158
[HandleError]

Jeśli podasz tylko atrybut HandleError do swojej klasy (lub do metody akcji w tym przypadku), wtedy gdy wystąpi nieobsługiwany wyjątek, MVC będzie szukał odpowiedniego widoku o nazwie „Błąd” najpierw w folderze widoku kontrolera. Jeśli nie może go tam znaleźć, przejdzie do folderu widoku współdzielonego (który domyślnie powinien zawierać plik Error.aspx)

[HandleError(ExceptionType = typeof(SqlException), View = "DatabaseError")]
[HandleError(ExceptionType = typeof(NullReferenceException), View = "LameErrorHandling")]

Możesz także zestawiać dodatkowe atrybuty z określonymi informacjami o typie wyjątku, którego szukasz. W tym momencie możesz skierować błąd do określonego widoku innego niż domyślny widok „Błąd”.

Aby uzyskać więcej informacji, zapoznaj się z wpisem na blogu Scotta Guthrie na ten temat.

Elijah Manor
źródło
1
Dzięki za rozszerzone informacje. Nie wiem, co zrobiłem źle, ale stworzyłem nowy projekt, przeportowałem w nim wszystkie istniejące widoki, kontrolery i modele i teraz działa. Nie wiedziałem jednak o selektywnych poglądach.
Boris Callens
Jeśli rejestrowanie tych wyjątków jest pożądane, czy byłoby to dopuszczalne miejsce na dodanie kodu za widokiem?
Peter J
6
Iconic, oto moja odpowiedź „lepiej późno niż wcale” na Twój komentarz: Zamiast tego możesz utworzyć podklasę HandleErrorAttribute i nadpisać jej metodę „OnException”: Następnie wstaw dowolne logowanie lub akcje niestandardowe, które chcesz. Następnie możesz albo w pełni obsłużyć wyjątek (ustawiając context.ExceptionHandled na true) lub odroczyć w tym celu do własnej metody OnException klasy bazowej. Oto doskonały artykuł, który może w tym pomóc: blog.dantup.me.uk/2009/04/…
Funka
Mam wiele kontrolerów więc mogę obsługiwać ten wnętrze global.asaxjak to pokazać wiadomość do użytkowników?
shaijut
@Co powiesz na używanie tej samej strony błędu co PartialView i renderowanie jej w modalnym oknie dialogowym po wystąpieniu wyjątku? Czy mógłbyś podać przykład w swojej odpowiedzi? To, co chcę osiągnąć, zostało wyjaśnione na temat obsługi błędów globalnych przy użyciu PartialView w MVC .
Jack
23

Należy również zauważyć, że błędy, które nie ustawiają kodu błędu http na 500

(np. UnauthorizedAccessException)

nie będzie obsługiwana przez filtr HandleError.

Corin Blaikie
źródło
1
To prawda, ale sprawdź RescueAttribute w wkładzie MVC (link w OP)
Boris Callens
14

Rozwiązanie dla kodu błędu http do 500 jest to atrybut o nazwie [ERROR], który należy umieścić na akcji

public class Error: System.Web.Mvc.HandleErrorAttribute
{
    public override void OnException(System.Web.Mvc.ExceptionContext filterContext)
    {

            if (filterContext.HttpContext.IsCustomErrorEnabled)
            {
                filterContext.ExceptionHandled = true;

            }
            base.OnException(filterContext);
            //OVERRIDE THE 500 ERROR  
           filterContext.HttpContext.Response.StatusCode = 200;
    }

    private static void RaiseErrorSignal(Exception e)
    {
        var context = HttpContext.Current;
      // using.Elmah.ErrorSignal.FromContext(context).Raise(e, context);
    } 

}

//PRZYKŁAD:

[Error]
[HandleError]
[PopulateSiteMap(SiteMapName="Mifel1", ViewDataKey="Mifel1")]
public class ApplicationController : Controller
{
}
Raul
źródło
12

Atrybuty w MVC są bardzo przydatne w obsłudze błędów w metodzie get i post , śledzą również wywołania ajax .

Utwórz kontroler podstawowy w swojej aplikacji i odziedzicz go w kontrolerze głównym (EmployeeController).

public class EmployeeController: BaseController

Dodaj poniższy kod w kontrolerze podstawowym.

/// <summary>
/// Base Controller
/// </summary>
public class BaseController : Controller
{       
    protected override void OnException(ExceptionContext filterContext)
    {
        Exception ex = filterContext.Exception;

        //Save error log in file
        if (ConfigurationManager.AppSettings["SaveErrorLog"].ToString().Trim().ToUpper() == "TRUE")
        {
            SaveErrorLog(ex, filterContext);
        }

        // if the request is AJAX return JSON else view.
        if (IsAjax(filterContext))
        {
            //Because its a exception raised after ajax invocation
            //Lets return Json
            filterContext.Result = new JsonResult()
            {
                Data = Convert.ToString(filterContext.Exception),
                JsonRequestBehavior = JsonRequestBehavior.AllowGet
            };
        }
        else
        {
            filterContext.ExceptionHandled = true;
            filterContext.HttpContext.Response.Clear();

            filterContext.Result = new ViewResult()
            {
                //Error page to load
                ViewName = "Error",
                ViewData = new ViewDataDictionary()
            };

            base.OnException(filterContext);
        }
    }

    /// <summary>
    /// Determines whether the specified filter context is ajax.
    /// </summary>
    /// <param name="filterContext">The filter context.</param>
    private bool IsAjax(ExceptionContext filterContext)
    {
        return filterContext.HttpContext.Request.Headers["X-Requested-With"] == "XMLHttpRequest";
    }

    /// <summary>
    /// Saves the error log.
    /// </summary>
    /// <param name="ex">The ex.</param>
    /// <param name="filterContext">The filter context.</param>
    void SaveErrorLog(Exception ex, ExceptionContext filterContext)
    {
        string logMessage = ex.ToString();

        string logDirectory = Server.MapPath(Url.Content("~/ErrorLog/"));

        DateTime currentDateTime = DateTime.Now;
        string currentDateTimeString = currentDateTime.ToString();
        CheckCreateLogDirectory(logDirectory);
        string logLine = BuildLogLine(currentDateTime, logMessage, filterContext);
        logDirectory = (logDirectory + "\\Log_" + LogFileName(DateTime.Now) + ".txt");

        StreamWriter streamWriter = null;
        try
        {
            streamWriter = new StreamWriter(logDirectory, true);
            streamWriter.WriteLine(logLine);
        }
        catch
        {
        }
        finally
        {
            if (streamWriter != null)
            {
                streamWriter.Close();
            }
        }
    }

    /// <summary>
    /// Checks the create log directory.
    /// </summary>
    /// <param name="logPath">The log path.</param>
    bool CheckCreateLogDirectory(string logPath)
    {
        bool loggingDirectoryExists = false;
        DirectoryInfo directoryInfo = new DirectoryInfo(logPath);
        if (directoryInfo.Exists)
        {
            loggingDirectoryExists = true;
        }
        else
        {
            try
            {
                Directory.CreateDirectory(logPath);
                loggingDirectoryExists = true;
            }
            catch
            {
            }
        }

        return loggingDirectoryExists;
    }

    /// <summary>
    /// Builds the log line.
    /// </summary>
    /// <param name="currentDateTime">The current date time.</param>
    /// <param name="logMessage">The log message.</param>
    /// <param name="filterContext">The filter context.</param>       
    string BuildLogLine(DateTime currentDateTime, string logMessage, ExceptionContext filterContext)
    {
        string controllerName = filterContext.RouteData.Values["Controller"].ToString();
        string actionName = filterContext.RouteData.Values["Action"].ToString();

        RouteValueDictionary paramList = ((System.Web.Routing.Route)(filterContext.RouteData.Route)).Defaults;
        if (paramList != null)
        {
            paramList.Remove("Controller");
            paramList.Remove("Action");
        }

        StringBuilder loglineStringBuilder = new StringBuilder();

        loglineStringBuilder.Append("Log Time : ");
        loglineStringBuilder.Append(LogFileEntryDateTime(currentDateTime));
        loglineStringBuilder.Append(System.Environment.NewLine);

        loglineStringBuilder.Append("Username : ");
        loglineStringBuilder.Append(Session["LogedInUserName"]);
        loglineStringBuilder.Append(System.Environment.NewLine);

        loglineStringBuilder.Append("ControllerName : ");
        loglineStringBuilder.Append(controllerName);
        loglineStringBuilder.Append(System.Environment.NewLine);

        loglineStringBuilder.Append("ActionName : ");
        loglineStringBuilder.Append(actionName);
        loglineStringBuilder.Append(System.Environment.NewLine);

        loglineStringBuilder.Append("----------------------------------------------------------------------------------------------------------");
        loglineStringBuilder.Append(System.Environment.NewLine);

        loglineStringBuilder.Append(logMessage);
        loglineStringBuilder.Append(System.Environment.NewLine);
        loglineStringBuilder.Append("==========================================================================================================");

        return loglineStringBuilder.ToString();
    }

    /// <summary>
    /// Logs the file entry date time.
    /// </summary>
    /// <param name="currentDateTime">The current date time.</param>
    string LogFileEntryDateTime(DateTime currentDateTime)
    {
        return currentDateTime.ToString("dd-MMM-yyyy HH:mm:ss");
    }

    /// <summary>
    /// Logs the name of the file.
    /// </summary>
    /// <param name="currentDateTime">The current date time.</param>
    string LogFileName(DateTime currentDateTime)
    {
        return currentDateTime.ToString("dd_MMM_yyyy");
    }

}

================================================

Znajduje katalog: Root / App_Start / FilterConfig.cs

Dodaj poniższy kod:

/// <summary>
/// Filter Config
/// </summary>
public class FilterConfig
{
    /// <summary>
    /// Registers the global filters.
    /// </summary>
    /// <param name="filters">The filters.</param>
    public static void RegisterGlobalFilters(GlobalFilterCollection filters)
    {
        filters.Add(new HandleErrorAttribute());
    }
}

Śledź błąd AJAX:

Wywołaj funkcję CheckAJAXError podczas ładowania strony układu.

function CheckAJAXError() {
    $(document).ajaxError(function (event, jqXHR, ajaxSettings, thrownError) {

        var ex;
        if (String(thrownError).toUpperCase() == "LOGIN") {
            var url = '@Url.Action("Login", "Login")';
            window.location = url;
        }
        else if (String(jqXHR.responseText).toUpperCase().indexOf("THE DELETE STATEMENT CONFLICTED WITH THE REFERENCE CONSTRAINT") >= 0) {

            toastr.error('ReferanceExistMessage');
        }
        else if (String(thrownError).toUpperCase() == "INTERNAL SERVER ERROR") {
            ex = ajaxSettings.url;
            //var url = '@Url.Action("ErrorLog", "Home")?exurl=' + ex;
            var url = '@Url.Action("ErrorLog", "Home")';
            window.location = url;
        }
    });
};
Sandip - Full Stack Developer
źródło
Wyciekasz szczegóły wyjątków w żądaniach AJAX, nie zawsze tego chcesz. Twój kod logowania nie jest bezpieczny dla wątków. Zakładasz, że istnieje widok błędu i zwracasz go bez zmiany kodu odpowiedzi. Następnie sprawdzasz, czy w JavaScript nie ma określonych ciągów błędów (a co z lokalizacją?). Zasadniczo powtarzasz to, co już mówi istniejąca odpowiedź: „Zastąp, OnExceptionaby obsłużyć wyjątki” , ale pokazujesz dość złą implementację.
CodeCaster
Co to jest parametr @ School.Resource.Messages.ReferanceExist?
Jack
@CodeCaster Czy znasz lepszy sposób na użycie tego rodzaju metody obsługi błędów z AJAX w ASP.NET MVC? Proszę o pomoc?
Jack
Zwróć 400 lub 500, zgodnie z zamierzeniami HTTP. Nie szukaj określonych ciągów w treści odpowiedzi.
CodeCaster
@CodeCaster Czy mógłbyś rzucić okiem na obsługę globalnych błędów przy użyciu PartialView w MVC w odniesieniu do tego problemu?
Jack
4

Brakuje Error.aspx :) W wersji zapoznawczej 5 znajduje się on w Twoim folderze Widoki / Udostępniony. Po prostu skopiuj go z nowego projektu Preview 5.

Ricky
źródło
Dziękuję za odpowiedź, ale już skopiowałem stronę Error.aspx. Rzeczywiście mogło to być coś, o czym normalnie bym zapomniał, ale nie tym razem. : P
Boris Callens
-1
    [HandleError]
    public class ErrorController : Controller
    {        
        [AcceptVerbs(HttpVerbs.Get)]
        public ViewResult NotAuthorized()
        {
            //401
            Response.StatusCode = (int)HttpStatusCode.Unauthorized;

        return View();
    }

    [AcceptVerbs(HttpVerbs.Get)]
    public ViewResult Forbidden()
    {
        //403
        Response.StatusCode = (int)HttpStatusCode.Forbidden;

        return View();
    }

    [AcceptVerbs(HttpVerbs.Get)]
    public ViewResult NotFound()
    {
        //404
        Response.StatusCode = (int)HttpStatusCode.NotFound;
        return View();
    }

    public ViewResult ServerError()
    {
        //500
        Response.StatusCode = (int)HttpStatusCode.NotFound;
        return View();
    }

}

Jacek
źródło