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

Question

我在想一个全局错误（也可以是成功消息）处理器的最佳实现方式是什么？让我用一个例子来解释一下：

1. 用户尝试删除记录
2. 删除失败并记录了一个错误
3. 用户重定向到另一个页面
4. 为用户显示错误消息（使用HtmlHelper或其他方法，不要让它成为特定的错误页面）

我只是想知道你们的想法。我一直在考虑TempData、ViewData和Session，但它们都有优点和缺点。

谢谢！

更新：

我会展示一个确切的例子，可能我的表述不够清晰。这是一个添加消息的方法，当用户删除一条记录时使用。如果用户成功，则会重定向到另一个页面。

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：

我已经创建了一个自定义的错误（消息）处理程序。如果您向下滚动，就可以看到代码。

- Kristoffer Lundberg

---

这有点奇怪。在大多数情况下，缺少错误消息表示成功。在大多数情况下，成功消息是多余的。如果出现错误，您将留在同一页上，所以我猜我仍然不明白您尝试做什么的逻辑。 - Erik Funkenbusch

我不同意，我认为告知用户操作成功非常重要，否则用户可能会感到困惑。但我也理解你的意思，当失败时通知用户更为重要。 - Kristoffer Lundberg

所有已经完成的可用性研究都不同意你的观点。这是一件非常紧张的事情。如果没有问题，用户不想被打扰。 - Erik Funkenbusch

Answer 1

仅为了好玩，我创建了自己的自定义错误处理程序（消息），它与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) %>

- Kristoffer Lundberg

Answer 2

我对以下步骤感到困惑：

• 删除失败并记录错误
• 用户被重定向到另一个页面

当出现错误时为什么要重定向用户？这没有任何意义，除非我误解了什么。

通常，我遵循以下准则：

• 表单提交错误（例如HTTP POST）：检查ModelState.IsValid，返回相同的视图，并使用@Html.ValidationSummary()渲染错误
• AJAX调用错误：返回JsonResult（如@Tomas所说），使用基本的客户端脚本来检查JSON并显示结果
• 领域/业务错误：抛出自定义异常，让控制器捕获它们并像上面那样添加到ModelState中

- RPM1984

---

我知道这听起来很奇怪，但假设您正在查看记录的详细信息。假设您删除该记录并希望将用户重定向到所有记录的列表视图，并向用户显示消息。当然，您可以使用TempData，但最好使用某种通用错误处理方式，即使涉及请求，也会记录所有消息。 - Kristoffer Lundberg

@Kristoffer - 我明白了，你并不是在谈论错误消息本身，而是自定义消息。TempData 是你唯一的选择。当非登录用户尝试保存某些数据时，我会使用这种方法。我将数据放入 TempData 中，将用户重定向到登录页面，然后再次重定向回来并预填表单。我通过自定义操作过滤器来实现这一点。 - RPM1984

确切地说，自定义消息是更好的定义。我知道如何从控制器和视图访问TempData，但是我可以从HtmlHelper访问它吗？ - Kristoffer Lundberg

@Kristoffer - 你绝对可以。HtmlHelper可以“看到”视图中的所有内容。 - RPM1984

Answer 3

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

由于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是动态的，因此两个匿名对象没有相同的属性也无关紧要。根据status的值，我只会查找实际存在的属性。

如果您创建自己的操作结果类并扩展JsonResult并自动添加状态属性，则可以更好地实现此目标。例如，您可以为失败的请求创建一个构造函数中带有异常的类，为成功的请求创建一个匿名对象。

- Tomas Aschan

---

是的，那是一种方法。当我使用JavaScript时，我经常倾向于使用这种技术，但在上面的场景中，这个例子不起作用(?)，因为涉及到HTTP请求。这就是为什么我对如何通过HTTP请求保持错误的实现方式感到好奇。 - Kristoffer Lundberg

@Max：我更喜欢使用HTTP状态码来处理那些我没有预料到的情况。我的JSON对象中的状态并不是“请求因为服务器错误而失败”，而更多的是“你尝试做的事情没有成功，但这并不是应用程序出错的原因。” - Tomas Aschan

@Kristoffer：我使用这段代码来响应由JavaScript创建的HTTP请求。 - Tomas Aschan

Answer 4

如果你只想要将用户重定向到另一个页面，那么你可以使用任何ActionMethod，并将其重定向到该页面。

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

如果您想捕获特定错误，则可以在相同的位置注册其他处理程序，并告诉系统该错误页面用于哪个错误。

- Erik Funkenbusch

---

嗨！我不确定那是否是我正在寻找的东西。我已经更新了我的帖子，并提供了更详细的示例。谢谢！ - Kristoffer Lundberg