将上下文与 UI 应用程序中引发的异常关联起来的推荐方法是什么？

Question

我有一个 UI 应用程序，它访问数据库并且还必须能够对文件执行各种操作。不用说，在应用程序过程中可能会抛出各种/大量异常，例如：

• 数据库脱机。
• 找不到该文件（之前扫描到数据库中）。
• 该文件被另一个用户/进程锁定，无法访问。
• 文件的只读属性已设置且无法修改。
• 安全权限拒绝对文件的访问（读或写）。

在引发异常时，错误的精确细节是已知的。但是，有时您需要让异常在调用堆栈的更高层捕获，以包含异常的上下文，以便您可以创建并呈现用户友好的错误消息；例如，在文件复制、文件移动或文件删除操作期间可能会遇到被另一个进程锁定的文件。

出于讨论目的，假设我们有一个必须对文件执行各种操作的方法；它必须将文件读入内存，修改数据并将数据写回，如下例所示：

private void ProcessFile(string fileName)
{
    try
    {
        string fileData = ReadData(fileName);

        string modifiedData = ModifyData(fileData);

        WriteData(fileName, modifiedData);
    }
    catch (UnauthorizedAccessException ex)
    {
        // The caller does not have the required permission.
    }
    catch (PathTooLongException ex)
    {
        // The specified path, file name, or both exceed the system-defined maximum length.
        // For example, on Windows-based platforms, paths must be less than 248 characters
        // and file names must be less than 260 characters.
    }
    catch (ArgumentException ex)
    {
        // One or more paths are zero-length strings, contain only white space, or contain
        // one or more invalid characters as defined by InvalidPathChars.
        // Or path is prefixed with, or contains only a colon character (:).
    }
    catch (NotSupportedException ex)
    {
        // File name is in an invalid format.
        // E.g. path contains a colon character (:) that is not part of a drive label ("C:\").
    }
    catch (DirectoryNotFoundException ex)
    {
        // The path specified is invalid. For example, it is on an unmapped drive.
    }
    catch (FileNotFoundException ex)
    {
        // File was not found
    }
    catch (IOException ex)
    {
        // Various other IO errors, including network name is not known.
    }
    catch (Exception ex)
    {
        // Catch all for unknown/unexpected exceptions
    }
}

当记录错误消息并向用户显示错误消息时，我们希望尽可能描述出现问题的原因以及任何可能的建议这可能会导致解决。如果文件被锁定，我们应该能够通知用户，以便他可以在文件释放后重试。

在上面的示例中，使用所有异常 catch 子句，我们仍然不知道哪个操作（上下文）导致异常。打开和读取文件、修改数据或将更改写回文件系统时是否发生异常？

一种方法是将 try/catch 块移动到这些“操作”方法中的每一个中。这意味着将相同的异常处理逻辑复制/重复到所有三个方法中。当然，为了避免在多个方法中重复相同的逻辑，我们可以将异常处理封装到另一个通用方法中，该方法将调用捕获通用 System.Exception 并将其传递。

另一种方法是添加“枚举”或其他定义上下文的方法，以便我们知道异常发生的位置，如下所示：

public enum ActionPerformed
{
    Unknown,
    ReadData,
    ModifyData,
    WriteData,
    ...
}

private void ProcessFile(string fileName)
{
    ActionPerformed action;

    try
    {
        action = ActionPerformed.ReadData;
        string fileData = ReadData(fileName);

        action = ActionPerformed.ModifyData;
        string modifiedData = ModifyData(fileData);

        action = ActionPerformed.WriteData;
        WriteData(fileName, modifiedData);
    }
    catch (...)
    {
        ...
    }
}

现在，在每个 catch 子句中，我们将知道异常的上下文引发异常时执行的操作。

是否有推荐的方法来解决识别与异常相关的上下文的问题？这个问题的答案可能是主观的，但如果有一个设计模式或推荐的方法，我愿意遵循它。

Answer 1

创建异常时，请在抛出异常之前将其 Message 属性设置为描述性内容。然后，您可以在更高的位置向用户显示此消息。

Answer 2

我们通常记录异常（使用 log4net 或 nlog），然后抛出一个自定义异常，并带有用户可以理解的友好消息。

Answer 3

我的观点是，MS 本地化异常消息属性的方法是完全错误的。由于 .NET 框架有语言包，您可以从中文安装中得到神秘的（例如普通话）消息。作为一个非所部署产品语言的母语的开发人员，我应该如何调试它？
我会为面向技术开发人员的消息文本保留异常消息属性，并在其数据属性中添加用户消息。

应用程序的每一层都可以从自己的角度向当前抛出的异常添加用户消息。
如果您假设第一个异常确切地知道出了什么问题以及如何修复它，您应该向用户显示第一个添加的用户消息。上面的所有架构层对来自较低层的特定错误的上下文和了解都较少。这将导致对用户来说不太有用的错误消息。因此，最好在仍然有足够上下文的层中创建用户消息，以便能够告诉用户出了什么问题以及是否可以修复以及如何修复。

为了说明这一点，假设有一个软件，其中有登录表单、Web 服务、后端和存储用户凭据的数据库。当检测到数据库问题时，您将在哪里创建用户消息？

1. 登录表单
2. Web服务
3. 后端

4. 数据库访问层

   1. IResult res = WebService.LoginUser("user", "pwd");
   2. IResult res = RemoteObject.LoginUser("user","pwd");
   3. 字符串 pwd = QueryPasswordForUser("用户");
   4. 用户 user = NHibernate.Session.Get("user"); -> 抛出 SQLException

数据库抛出 SQLException，因为数据库处于维护模式。

在这种情况下，后端 (3) 仍然有足够的上下文来处理数据库问题，但它也知道用户尝试登录。UI

将通过 Web 服务获取不同的异常对象，因为无法保留类型标识跨越应用程序域/进程边界。更深层次的原因是远程客户端没有安装NHibernate和SQL Server，导致无法通过序列化传输异常堆栈。

您必须将异常堆栈转换为更通用的异常，该异常是 Web 服务数据契约的一部分，这会导致 Web 服务边界处的信息丢失。

如果您尝试在最高级别（UI）上尝试将所有可能的系统错误映射到有意义的用户消息，则将 UI 逻辑绑定到后端的内部工作原理。这不仅是一种不好的做法，而且也很难做到，因为您将丢失有用的用户消息所需的上下文。

 catch(SqlException ex)  
 {
    if( ex.ErrorCode == DB.IsInMaintananceMode ) 
       Display("Database ??? on server ??? is beeing maintained. Please wait a little longer or contact your administrator for server ????");
    ....

由于 Web 服务边界，它实际上更像是

 catch(Exception ex)
 {
       Excepton first = GetFirstException(ex);
       RemoteExcepton rex = first as RemoteExcepton;
       if( rex.OriginalType == "SQLException" )
       {
           if( rex.Properties["Data"] == "DB.IsMaintainanceMode" )
           {
              Display("Database ??? on server ??? is beeing maintained. Please wait a little longer or contact your administrator for server ????");

因为异常将被来自其他层的其他异常所包装，因此您在 UI 层中针对后端的内部进行编码。

另一方面，如果您在后端层执行此操作，您就知道您的主机名是什么，您就知道您尝试访问哪个数据库。当你做得正确时，事情会变得容易得多。

   catch(SQLException ex)
   {
       ex.Data["UserMessage"] = MapSqlErrorToString(ex.ErrorCode, CurrentHostName, Session.Database)'
       throw;
   }

作为一般规则，您应该将用户消息添加到最深层的异常中，您仍然知道用户尝试执行的操作。

你的，
阿洛伊斯·克劳斯

Answer 4

如果可能的话，您应该从每个可以抛出异常类型的方法中抛出不同的异常类型。例如，如果您担心 .NET 异常冲突，ModifyData 方法可以在内部捕获共享异常类型并重新抛出它们。

Answer 5

您可以创建自己的异常类，并将其从 catch 块中返回给用户，并将消息放入新的异常类中。

catch (NotSupportedException ex)
    {
        YourCustomExceptionClass exception = new YourCustomExceptionClass(ex.message);
        throw exception;
    }

您可以将尽可能多的信息保存到异常类中，这样用户就可以获得所有信息，并且只有您希望他们拥有的信息。

编辑：

事实上，您可以在自定义异常类中创建一个异常成员并执行此操作。

catch (NotSupportedException ex)
{  
    YourCustomExceptionClass exception = new YourCustomExceptionClass(ex.message);
    exception.yourExceptionMemberofTypeException = ex;
    throw exception;
}

这样，您可以给用户一个好的消息，同时也给他们底层的内部异常。 .NET 一直通过 InnerException 来执行此操作。