简述什么是stub？举例说明

八股文_Node. js面试题 0 77

参考回答

Stub 是一种用于测试的工具或方法，用来替代真实的函数或模块，返回预定义的结果或行为。Stub 常用于隔离被测代码，使测试更专注于当前模块的逻辑，而不依赖外部依赖（如数据库、网络请求等）。

特点：

模拟依赖：Stub 会替代真实的依赖，例如函数、方法或模块。
控制输出：返回预定义的值，无需实际执行逻辑。
独立性测试：Stub 可以隔离测试，确保测试结果不受外部环境影响。

举例说明

场景：验证业务逻辑时，不想依赖外部服务

假设我们有一个函数 getUserData，它从数据库中获取用户数据。为了测试业务逻辑，我们不想连接真实的数据库，而是使用 Stub 来模拟。

示例代码

被测代码（userService.js）：

const db = require('./db');

const getUserData = async (userId) => {
    const user = await db.getUserById(userId); // 模拟从数据库获取数据
    if (!user) {
        throw new Error('User not found');
    }
    return user;
};

module.exports = { getUserData };

Stub 测试代码：

const sinon = require('sinon');
const { getUserData } = require('./userService');
const db = require('./db'); // 被 Stub 的模块
const { expect } = require('chai');

describe('getUserData', () => {
    it('should return user data when user exists', async () => {
        // 使用 sinon 创建 Stub
        const userStub = sinon.stub(db, 'getUserById').resolves({ id: 1, name: 'Alice' });

        const user = await getUserData(1);

        // 验证结果
        expect(user).to.deep.equal({ id: 1, name: 'Alice' });

        // 验证 Stub 是否被调用
        expect(userStub.calledOnce).to.be.true;

        // 恢复原始方法
        userStub.restore();
    });

    it('should throw an error when user does not exist', async () => {
        // Stub 模拟无数据返回
        const userStub = sinon.stub(db, 'getUserById').resolves(null);

        try {
            await getUserData(1);
        } catch (err) {
            expect(err.message).to.equal('User not found');
        }

        // 恢复原始方法
        userStub.restore();
    });
});

详细讲解与拓展

1. Stub 的用途

模拟外部依赖：如数据库、API 调用、文件操作等。
避免真实操作：防止实际的网络请求或数据写入。
控制测试结果：Stub 可以根据测试需求返回不同的结果（如成功、失败等）。

2. Stub 的实现方式

使用工具库：
- Sinon：专门用于创建 Stub、Mock、Spy 的测试工具。
- Jest：自带 jest.fn() 和 jest.spyOn()，支持创建 Stub。

手动实现：
在没有工具的情况下，可以手动替换方法：

const originalFunction = someObject.someMethod;

someObject.someMethod = () => 'stubbed result';

// 恢复原始方法
someObject.someMethod = originalFunction;

3. Stub 与 Mock 的区别

Stub：仅替代真实的依赖并返回预定义结果。
Mock：不仅替代依赖，还会记录依赖的调用情况（如调用次数、参数等）。

总结

Stub 是一种用于测试的模拟工具，主要用于替代外部依赖并返回预定义的结果。通过工具库（如 Sinon 或 Jest），可以方便地创建和管理 Stub，使测试更独立、可控。Stub 的使用可以帮助开发者专注于业务逻辑验证，而不依赖真实环境。