实战经验：时刻关注类对象内部数据成员状态

今天在追踪一个复杂逻辑错误导致的Bug时，花费了很多时间，最后发现是线程句柄重复Close导致的。

首先，我们考察以下类定义：

class CTest
{
public:
    CTest();
    ~CTest();
private:
    void Init();
    void Destroy();
private:
    HANDLE m_hThread;
};
void CTest::Init()
{
    m_hThread = AfxBeginThread(...);
}
void CTest::Destroy()
{
    WaitForSingleObject(m_hThread);
    CloseHandle(m_hThread);
}
CTest::~CTest()
{
    CloseHandle(m_hThread);
}

类客户代码示例如下：

int main()
{
    CTest obj;
    obj.Init();
    obj.Destroy();
    return 0;
}

在以上类定义中，我们可以明显看到CloseHandle被重复调用了两次，分别是在类成员函数Destory和类析构函数中。尝试对一个句柄重复调用CloseHandle，结果是未定义的，一般情况下，在调试模式下，程序会崩溃并提示：invalid handle。在复杂的大型程序中，我们可能不太容易发现这种重复调用导致的Bug。所以，需要有一种方法能抵御这种类型的错误。

以下是修改之后的类定义：

class CTest
{
public:
    CTest();
    ~CTest();
private:
    void Init();
    void Destroy();
private:
    HANDLE m_hThread;
};
CTest::CTest()
: m_hThread(NULL)
{
    
}
void CTest::Init()
{
    if (m_hThread == NULL)
    {
        m_hThread = AfxBeginThread(...);
    }
    else
    {
        // m_hThread should be NULL here but it is not, check program logic.
    }
}
void CTest::Destroy()
{
    if (m_hThread != NULL)
    {
        WaitForSingleObject(m_hThread);
        CloseHandle(m_hThread);
        m_hThread = NULL;
    }
}
CTest::~CTest()
{
    if (m_hThread != NULL)
    {
        CloseHandle(m_hThread);
        m_hThread = NULL;
    }
}

以上修改后的类定义，在各个方法实现上，添加了对类内部数据成员m_hThread的状态判定：
1) 类构造函数首先在类对象实例化时，立即对类的内部数据成员做初始化，并将合理的初始值设置到数据成员。
2) Init实现上，首先检查数据成员，仅当数据成员符合一定的逻辑条件时才做出动作，否则提示系统内部逻辑错误。
3) Destroy实现同Init，在确保数据成员有效的情况下才继续做下一步动作，并且，在动作执行完毕后，立即将数据成员重置为初始值NULL。
4) 类析构函数也在具体的资源释放动作进行之前，对类的数据成员做了一次判定，如果之前Destroy调用成功，则此处的m_hThread为空，就避免了对句柄做出重复的CloseHandle调用。

有时候，我们在编写小程序时，往往会贪图简单，将类的数据成员的逻辑状态的合理检测给省略掉了，因为此时程序还小，我们可以一眼就看出错误出在哪里。但随着系统内部逻辑越来越复杂，程序规模越来越大，我们就很难追踪程序内部的逻辑混乱导致的崩溃问题。
所以，正如本文标题所言：时刻关注类对象内部数据成员状态。