用 PIMPL 模式来实现契约的前置条件、后置条件和不变式

用 PIMPL 模式来实现契约的前置条件、后置条件和不变式
黄国强 2009-10-16

    上文[1]说到用 NVI 模式[2]来实现契约的前置条件、后置条件和不变式。本文用相同的例子，用PIMPL模式重新实现了。


// 负责表示一个简单的栈
#include <boost/shared_ptr.hpp>

template<class T,class P>
class CSimpleStack
{
    boost::shared_ptr<P> m_pImpl;    

public:
    virtual ~CSimpleStack(void){}

    // 基本查询: 栈中元素数目
    int Count(void)const
    {
        return m_pImpl->Count();
    }

    // 基本查询: 逻辑位置为i的元素，栈顶逻辑位置是Count()-1
    T ItemAt(int i)const
    {
        ASSERT(i>=0 && i<Count()); // 前置条件
        T ret = m_pImpl->ItemAt(i);
        return ret;
    }

    // 派生查询: 栈是否为空
    bool IsEmpty(void)const
    {
        bool ret = m_pImpl->IsEmpty();
        ASSERT(ret == (Count()==0)); // 后置条件
        return ret;
    }

    // 派生查询: 查询栈顶元素
    T Item(void)
    {
        ASSERT(Count()>0); // 前置条件
        T ret = m_pImpl->Item();
        ASSERT(ret == ItemAt(Count()-1); // 后置条件
        return ret;
    }

    // 创建命令: 初始化
    void Init(void)
    {
        m_pImpl->Init();
        ASSERT(Count()==0); // 后置条件
    }

    // 其他命令: 将t压入栈顶
    void Put(T t)
    {
        int nOldCount = Count();
        m_pImpl->Put();
        ASSERT(Count()==nOldCount+1);   // 后置条件
        ASSERT(ItemAt(Count()-1) == t); // 后置条件
        ASSERT(Invariant());            // 不变式
    } 

    // 其他命令: 移除栈顶元素
    void Remove(void)
    {
        ASSERT(Count()>0);            // 前置条件
        int nOldCount = Count();
        m_pImpl->Remove();
        ASSERT(Count()==nOldCount-1); // 后置条件
        ASSERT(Invariant());          // 不变式
    }

    // 不变式
    bool Invariant(void)
    {
        return Count()>=0;
    }
};

      特别指出的是，上面的代码中使用boost库中的智能指针 shared_ptr。这样的设计好处是可以把 CSimpleStack 当作值对象或实体对象来使用，而用NVI模式只能把CSimpleStack 当作实体对象来使用。从实现的角度来看,选择NVI模式写起来要方便一些。所以，个人建议还是优先选择NVI模式。

[参考]
1 http://blog.csdn.net/acloudhuang/archive/2009/09/25/4593177.aspx
2 http://acloudblog.blog.sohu.com/129992469.html