将 GetLastError() 转换为异常

Question

我有一个 Visual Studio 2008 C++ 项目，在出现异常错误时使用 Win32Exception 类。 Win32Exception 类如下所示：

/// defines an exception based on Win32 error codes. The what() function will
/// return a formatted string returned from FormatMessage()
class Win32Exception : public std::runtime_error
{
public:
    Win32Exception() : std::runtime_error( ErrorMessage( &error_code_ ) )
    {
    };

    virtual ~Win32Exception() { };

    /// return the actual error code
    DWORD ErrorCode() const throw() { return error_code_; };

private:

    static std::string ErrorMessage( DWORD* error_code )
    {
        *error_code = ::GetLastError();

        std::string error_messageA;
        wchar_t* error_messageW = NULL;
        DWORD len = ::FormatMessageW( FORMAT_MESSAGE_FROM_SYSTEM | 
                                      FORMAT_MESSAGE_ALLOCATE_BUFFER |
                                      FORMAT_MESSAGE_IGNORE_INSERTS,
                                      NULL,
                                      *error_code,
                                      MAKELANGID( LANG_NEUTRAL, SUBLANG_DEFAULT ),
                                      reinterpret_cast< LPWSTR >( &error_messageW ),
                                      0,
                                      NULL );
        if( NULL != error_messageW )
        {
            // this may generate a C4244 warning. It is safe to ignore.
            std::copy( error_messageW, 
                       error_messageW + len, 
                       std::back_inserter( error_messageA ) );
            ::LocalFree( error_messageW );
        }
        return error_messageA;
    };

    /// error code returned by GetLastError()
    DWORD error_code_;

}; // class Win32Exception

该类在它所使用的情况下运行良好。我想知道是否有任何明显的情况会失败，我应该注意。欢迎任何其他问题、警告或一般性改进建议。

请注意，boost 库不是此代码的选项。

Answer 1

• 这已经被几个人做过了，包括你真正的
  • https://github.com/BillyONeal/Instalog/blob/ master/LogCommon/Win32Exception.hpp
  • https://github.com/BillyONeal/Instalog/blob/ master/LogCommon/Win32Exception.cpp

• 讽刺的是，您的代码不是异常安全的。

  if( NULL != error_messageW )
  {
      // 这可能会生成 C4244 警告。忽略它是安全的。
      std::copy( error_messageW, 
                 error_messageW + len, 
                 std::back_inserter( error_messageA ) );
      ::LocalFree( error_messageW );
  }
  

请注意，如果 back_inserter 导致抛出 std::bad_alloc，则 FormatMessage 内分配的内存将被泄漏。

Answer 2

• 真是巧合啊！我在所有项目中都使用类似的代码！这实际上是一个好主意。

• 这段代码有问题：

   // 这可能会生成 C4244 警告。忽略它是安全的。
      std::copy( error_messageW, 
                 error_messageW + len, 
                 std::back_inserter( error_messageA ) );
  

  它只是将 WCHAR 转换为字符。您可以显式使用 FormatMessageA 来获取当前代码页中的消息（好吧，您不能像您所说的那样），或者约定所有字符串均采用 UTF-8 编码。我选择了后者，请参阅这个原因。

• 错误消息本身可能没有用。捕获堆栈跟踪可能是个好主意。

Answer 3

意识到这已经过时了，但至少在 VC++ 2015 中，您可以抛出一个 system_error ，它将使用 system_category() 函数完成所有这些操作：

try
{
    throw system_error(E_ACCESSDENIED, system_category(), "Failed to write file");
}
catch (exception& ex)
{
    cout << ex.what();
}

这将打印：“无法写入文件：访问被拒绝”

Answer 4

• FormatMessage 本身可能会失败。对于这种情况，可能需要一些中性的“代码为 %d 的未知错误”。
• 有些错误代码并不是真正的错误（ERROR_ALREADY_EXISTS），具体取决于用户的期望。
• 某些系统函数返回其自己的错误代码（值得注意的示例是 SHFileOperation），您必须单独处理它们。如果您希望处理它们，那就是。
• 考虑在异常中包含附加信息：异常从哪里抛出（源文件和行），哪个系统函数导致异常，函数的参数是什么（至少是标识参数，如文件名、句柄值或一些此类参数） ）。堆栈跟踪也很好。

Answer 5

我想知道是否有
是否有任何明显的情况会导致
失败是我应该意识到的。任何
其他陷阱、警告或一般情况
改进建议是
欢迎。

我在此类消息检索方面遇到的主要问题是ERROR_SUCCESS。当某些操作失败并伴有“操作成功”的错误消息时，这是相当令人困惑的。人们不会认为这种情况会发生，但它确实发生了。

我想这是辩证法所指出的一个特例，即“某些错误代码并不是真正的错误”，但对于大多数代码来说，至少该消息通常是可以接受的。

第二个问题是大多数Windows系统错误信息末尾都有回车+换行。将消息插入其他文本是有问题的，并且它打破了 C++ 异常消息的约定。所以，删除这些字符是个好主意。

现在，不再重复其他人已经注意到的所有内容，而是介绍一下设计。

如果将 ErrorMessage 函数公开或移出类，并按值获取错误代码，而不是获取指针参数，则该函数会更有用。这就是职责分开的原则。促进重用。

如果使用析构函数来释放内存，ErrorMessage 中的代码会更加清晰、安全和高效。然后，您也可以直接在 return 语句中构造字符串，而不是使用带有后插入器的复制循环。

干杯&呵呵，

Answer 6

我最近正在研究一个非常相似的类，在阅读此线程后尝试使复制部分异常安全。我引入了一个小帮助器类，它除了保存指向 ::FormatMessage 返回的字符串的指针并在其析构函数中使用 ::LocalFree 释放它之外什么也不做。不允许复制、分配和移动，因此不会惹上麻烦。

以下是我的总体想法：

class windows_error {
public:
    windows_error(wchar_t const* what);

    // Getter functions
    unsigned long errorCode() const { return _code; }
    wchar_t const* description() const { return _what; }
    std::wstring errorMessage() const { return _sys_err_msg; }
private:
    unsigned long _code;
    wchar_t const* _what;
    std::wstring _sys_err_msg;
};

// This class outsources the problem of managing the string which
// was allocated with ::LocalAlloc by the ::FormatMessage function.
// This is necessary to make the constructor of windows_error exception-safe.
class LocalAllocHelper {
public:
    LocalAllocHelper(wchar_t* string) : _string(string) { }
    ~LocalAllocHelper() {
        ::LocalFree(_string);
    }

    LocalAllocHelper(LocalAllocHelper const& other) = delete;
    LocalAllocHelper(LocalAllocHelper && other) = delete;
    LocalAllocHelper& operator=(LocalAllocHelper const& other) = delete;
    LocalAllocHelper& operator=(LocalAllocHelper && other) = delete;

private:
    wchar_t* _string;
};

windows_error::windows_error(wchar_t const* what)
    : _code(::GetLastError()),
      _what(what) {
    // Create a temporary pointer to a wide string for the error message
    LPWSTR _temp_msg = 0;
    // Retrieve error message from error code and save the length
    // of the buffer which is being returned. This is needed to 
    // implement the copy and assignment constructor.
    DWORD _buffer_size = ::FormatMessageW(FORMAT_MESSAGE_ALLOCATE_BUFFER | 
                                          FORMAT_MESSAGE_FROM_SYSTEM |
                                          FORMAT_MESSAGE_IGNORE_INSERTS, 
                                          NULL, _code, 0, _temp_msg, 0, NULL);

    if(_buffer_size) {
        // When calling _sys_err_msg.resize an exception could be thrown therefore
        // the _temp_msg needs to be a managed resource.
        LocalAllocHelper helper(_temp_msg);
        _sys_err_msg.resize(_buffer_size + 1);
        std::copy(_temp_msg, _temp_msg + _buffer_size, _sys_err_msg.begin());
    }
    else {
        _sys_err_msg = std::wstring(L"Unknown error. (FormatMessage failed)");
    }
}

也许这对你们中的一些人有用。