ASP.NET MVC - 全局错误处理方法?

时间:2011-08-17 21:50:01

标签: c# asp.net asp.net-mvc

我想知道什么是全局错误的最佳实现(不一定是错误,也可以是成功消息)处理程序会是什么?让我通过一个例子为你分解:

  1. 用户尝试删除记录
  2. 删除失败并记录错误
  3. 用户重定向到其他页面
  4. 显示用户的错误消息(使用HtmlHelper或其他内容,不希望它成为特定的错误页面)
  5. 我只是好奇你们的想法。我一直在考虑TempData,ViewData和Session,但它们各有利弊。

    TIA!

    更新

    我将举例说明我的意思,也许我不够清楚。 这是在用户删除记录时添加消息的方法示例。 如果用户成功,用户将重定向到另一个页面

    public ActionResult DeleteRecord(Record recordToDelete)
    {
        // If user succeeds deleting the record
        if (_service.DeleteRecord(recordToDelete) 
        {
            // Add success message
            MessageHandler.AddMessage(Status.SUCCESS, "A message to user");
    
            // And redirect to list view
            return RedirectToAction("RecordsList");
        }
        else 
        {
            // Else return records details view
            return View("RecordDetails", recordToDelete);
        }
    }
    

    在“RecordsList”视图中,在HtmlHelper中显示所有消息(包括错误和成功消息)会很酷。

    <%= Html.RenderAllMessages %>
    

    这可以通过多种方式实现,我只是好奇你们会做什么。

    更新2:

    我创建了一个自定义错误(消息)处理程序。如果向下滚动,可以看到代码。

4 个答案:

答案 0 :(得分:4)

为了好玩,我创建了自己的自定义错误(消息)处理程序,它几乎与TempData一样工作,但差别很小,这个处理程序可以在整个应用程序中访问。

我不打算解释代码的每一步,但总而言之,我使用IHttpModule为每个请求和Session发出一个方法来保存数据。以下是代码,随时可以编辑或提供改进建议。

Web.config (定义模块)

<httpModules>
  <add name="ErrorManagerModule" type="ErrorManagerNamespace.ErrorManager"/>
</httpModules>

<system.webServer>
  <modules runAllManagedModulesForAllRequests="true">
    <add name="ErrorManagerModule" type="ErrorManagerNamespace.ErrorManager"/>
  </modules>
</system.webServer>

ErrorManager.cs (错误管理器处理程序代码)

public class ErrorManager : IRequiresSessionState, IHttpModule
{
    private const string SessionKey = "ERROR_MANAGER_SESSION_KEY";

    public enum Type 
    {
        None,
        Warning,
        Success,
        Error
    }

    /*
     * 
     * Public methods
     * 
     */

    public void Dispose() 
    {
    }

    public void Init(HttpApplication context) 
    {
        context.AcquireRequestState += new EventHandler(Initiliaze);
    }

    public static IList<ErrorModel> GetErrors(ErrorManager.Type type = Type.None) 
    {
        // Get all errors from session
        var errors = GetErrorData();

        // Destroy Keep alive
        // Decrease all errors request count
        foreach (var error in errors.Where(o => type == ErrorManager.Type.None || o.ErrorType == type).ToList())
        {
            error.KeepAlive = false;
            error.IsRead = true;
        }

        // Save errors to session
        SaveErrorData(errors);

        //return errors;
        return errors.Where(o => type == ErrorManager.Type.None || o.ErrorType == type).ToList();
    }

    public static void Add(ErrorModel error) 
    {
        // Get all errors from session
        var errors = GetErrorData();
        var result = errors.Where(o => o.Key.Equals(error.Key, StringComparison.OrdinalIgnoreCase)).FirstOrDefault();

        // Add error to collection
        error.IsRead = false;

        // Error with key is already associated
        // Remove old error from collection
        if (result != null)
            errors.Remove(result);

        // Add new to collection
        // Save errors to session
        errors.Add(error);
        SaveErrorData(errors);
    }

    public static void Add(string key, object value, ErrorManager.Type type = Type.None, bool keepAlive = false) 
    {
        // Create new error
        Add(new ErrorModel()
        {
            IsRead = false,
            Key = key,
            Value = value,
            KeepAlive = keepAlive,
            ErrorType = type
        });
    }

    public static void Remove(string key) 
    {
        // Get all errors from session
        var errors = GetErrorData();
        var result = errors.Where(o => o.Key.Equals(key, StringComparison.OrdinalIgnoreCase)).FirstOrDefault();

        // Error with key is in collection
        // Remove old error
        if (result != null)
            errors.Remove(result);

        // Save errors to session
        SaveErrorData(errors);
    }

    public static void Clear() 
    {
        // Clear all errors
        HttpContext.Current.Session.Remove(SessionKey);
    }

    /*
     * 
     * Private methods
     * 
     */

    private void Initiliaze(object o, EventArgs e) 
    {
        // Get context
        var context = ((HttpApplication)o).Context;

        // If session is ready
        if (context.Handler is IRequiresSessionState || 
            context.Handler is IReadOnlySessionState)
        {
            // Load all errors from session
            LoadErrorData();
        }
    }

    private static void LoadErrorData() 
    {
        // Get all errors from session
        var errors = GetErrorData().Where(o => !o.IsRead).ToList();

        // If KeepAlive is set to false
        // Mark error as read
        foreach (var error in errors)
        {
            if (error.KeepAlive == false)
                error.IsRead = true;
        }

        // Save errors to session
        SaveErrorData(errors);
    }

    private static void SaveErrorData(IList<ErrorModel> errors) 
    {
        // Make sure to remove any old errors
        HttpContext.Current.Session.Remove(SessionKey);
        HttpContext.Current.Session.Add(SessionKey, errors);
    }

    private static IList<ErrorModel> GetErrorData() 
    {
        // Get all errors from session
        return HttpContext.Current.Session[SessionKey]
            as IList<ErrorModel> ??
            new List<ErrorModel>();
    }

    /*
     * 
     * Model
     * 
     */

    public class ErrorModel 
    {
        public string Key { get; set; }
        public object Value { get; set; }
        public bool KeepAlive { get; set; }
        internal bool IsRead { get; set; }
        public Type ErrorType { get; set; }
    }

HtmlHelperExtension.cs (用于呈现错误的扩展方法)

public static class HtmlHelperExtension
{
    public static string RenderMessages(this HtmlHelper obj, ErrorManager.Type type = ErrorManager.Type.None, object htmlAttributes = null) 
    {
        var builder = new TagBuilder("ul");
        var errors = ErrorManager.GetErrors(type);

        // If there are no errors
        // Return empty string
        if (errors.Count == 0)
            return string.Empty;

        // Merge html attributes
        builder.MergeAttributes(new RouteValueDictionary(htmlAttributes), true);

        // Loop all errors
        foreach (var error in errors)
        {
            builder.InnerHtml += String.Format("<li class=\"{0}\"><span>{1}</span></li>",
                error.ErrorType.ToString().ToLower(),
                error.Value as string);
        }

        return builder.ToString();
    }
}

创建错误的用法

// This will only be available for one request
ErrorManager.Add("Key", "An error message", ErrorManager.Type.Error);

// This will be available for multiple requests
// When error is read, it will be removed
ErrorManager.Add("Key", "An error message", ErrorManager.Type.Error, true);

// Remove an error
ErrorManager.Remove("AnotherKey");

// Clear all error
ErrorManager.Clear();

渲染错误的用法

// This will render all errors
<%= Html.RenderMessages() %>

// This will just render all errors with type "Error"
<%= Html.RenderMessages(ErrorManager.Type.Error) %>

答案 1 :(得分:2)

我对这些步骤感到困惑:

  • 删除失败并记录错误
  • 用户重定向到其他页面

发生错误时,为什么要重定向用户?这没有任何意义,除非我误解了什么。

通常,我遵循以下准则:

  • 表单提交时出错(例如HTTP POST):检查ModelState.IsValid并返回相同的视图并使用@Html.ValidationSummary()
  • 呈现错误
  • AJAX调用错误:return JsonResult(如@Tomas所说),并使用基本的客户端脚本来检查JSON并显示结果
  • 域/业务出错:抛出自定义异常并让控制器捕获它们并按上述方式添加到ModelState

答案 2 :(得分:1)

我更喜欢将我的服务器层编写为发出JSON的API - 在ASP.NET MVC中,这非常简单 - 您只需创建一堆嵌套的匿名对象,return Json(data);。然后客户端使用JSON对象,它由html,css和javascript组成(我经常使用jQuery,但你可能更喜欢其他工具)。

由于javascript是动态的,因此在数据对象上拥有属性status非常容易,客户端脚本可以根据需要解释该属性并显示状态或错误消息。

例如,请考虑以下操作方法:

public ActionResult ListStuff()
{
    var stuff = Repo.GetStuff();

    return Json(new { status = "OK", thestuff = stuff });
}

这将以下列格式返回JSON:

{ "status": "OK", "thestuf": [{ ... }, { ... }] }

其中...stuff属性的占位符。现在,如果我想要错误处理,我可以做到

try
{
    var stuff = Repo.GetStuff();
    return Json(new { status = "OK", thestuff = stuff});
}
catch (Exception ex)
{
    Log.Error(ex);
    return Json(new { status = "Fail", reason = ex.Message });
}

由于javascript是动态的,因此两个匿名对象没有相同的属性并不重要。根据{{​​1}}的值,我只会查找实际存在的属性。

如果您创建自己的操作结果类,扩展status并自动添加status属性,则可以更好地实现。例如,您可以为在构造函数中获取异常的失败请求创建一个,并为成功的请求创建一个而不是获取匿名对象。

答案 3 :(得分:0)

如果您要做的就是将用户重定向到另一个页面,那么您可以使用任何ActionMethod来执行此操作,只需重定向到该页面即可。

如果您想要一个全局错误,例如500或403或其他一些错误,那么MVC 3默认模板会为您创建一个_Error.cshtml页面,并在global.asax中注册错误处理程序。

如果要捕获特定错误,则可以在同一位置注册其他处理程序,并告诉系统该错误页面用于该错误。