单例模式的mock类注入单元测试与友元类解决方案

问题背景：单例模式的测试挑战

在单元测试中，我们经常需要对单例模式进行测试，特别是当单例类依赖其他组件时。传统的单例模式通过静态方法获取实例，这使得依赖注入 和mock替换变得困难。

核心困境

我们需要在测试时：

注入Mock对象替换真实依赖
访问私有构造函数来创建带有mock依赖的实例
避免影响生产代码的单例行为

这是一个很常见的单例模式测试问题。你需要使用前向声明 和友元声明的正确组合来解决。以下是具体的解决方案：

解决方案步骤

1. 在单例类中前向声明测试类并声明为友元

在你的单例类头文件中（比如 singleton.h）：

cpp 复制代码

// singleton.h
#pragma once

// 前向声明测试类
class SingletonTest;

class Singleton {
public:
    static Singleton& GetInstance();
    
    // 公有方法
    void SomePublicMethod();
    
private:
    // 私有构造函数
    Singleton();
    ~Singleton();
    
    // 声明测试类为友元
    friend class SingletonTest;
    
    // 私有方法（测试需要访问的）
    void SomePrivateMethod();
    
    // 禁用拷贝和赋值
    Singleton(const Singleton&) = delete;
    Singleton& operator=(const Singleton&) = delete;
    
    // 成员变量
    int some_data_;
};

2. 在测试文件中包含单例类头文件

在你的测试文件中（比如 singleton_test.cc）：

cpp 复制代码

// singleton_test.cc
#include "gtest/gtest.h"
#include "singleton.h"  // 必须包含单例类的完整定义

class SingletonTest : public ::testing::Test {
protected:
    void SetUp() override {
        // 测试设置
    }
    
    void TearDown() override {
        // 测试清理
    }
};

TEST_F(SingletonTest, TestPrivateMethod) {
    // 可以直接访问私有方法
    Singleton::GetInstance().SomePrivateMethod();
    
    // 或者通过其他方式测试
    // ...
}

TEST_F(SingletonTest, TestConstructor) {
    // 如果需要测试构造函数逻辑，可以这样
    // 注意：单例模式通常不需要直接测试构造函数
}

更复杂的场景：如果测试类在不同的命名空间中

如果测试类在不同的命名空间，友元声明需要更精确：

单例类中：

cpp 复制代码

// singleton.h
#pragma once

namespace mynamespace {
    // 前向声明带命名空间的测试类
    namespace test {
        class SingletonTest;
    }

    class Singleton {
    public:
        static Singleton& GetInstance();
        
    private:
        Singleton();
        ~Singleton();
        
        // 声明带命名空间的测试类为友元
        friend class test::SingletonTest;
        
        void SomePrivateMethod();
    };
}

测试类中：

cpp 复制代码

// singleton_test.cc
#include "gtest/gtest.h"
#include "singleton.h"

namespace mynamespace::test {

class SingletonTest : public ::testing::Test {
protected:
    void SetUp() override {}
    void TearDown() override {}
};

TEST_F(SingletonTest, TestPrivateAccess) {
    // 现在可以访问私有成员
    Singleton::GetInstance().SomePrivateMethod();
}

} // namespace mynamespace::test