TypeScript单元测试：如何访问类的私有静态属性？

核心解决方案 #

方法1：绕过TypeScript私有属性检查（快速实现） #

TypeScript的私有静态属性编译为JavaScript后，本质仍是类的可访问属性，仅受TS编译器限制。可以通过类型断言绕过检查，直接获取并Stubchannel.ack方法：

import sinon, { createSandbox } from 'sinon';
import { expect } from 'chai';
import MyService from './path-to-MyService';
import infoService from '../infoService';
import type { ConsumeMessage } from 'amqplib';

const sandbox = createSandbox();

describe('MyService.consumeFunc1', () => {
  let channelAckStub: sinon.SinonStub;
  let getMeInfoStub: sinon.SinonStub;

  beforeEach(() => {
    // 绕过TS私有属性检查，获取静态channel
    const channel = (MyService as any).channel;
    // Stub ack方法
    channelAckStub = sandbox.stub(channel, 'ack');
    // Stub infoService.getMeInfo，让它返回真值触发ack逻辑
    getMeInfoStub = sandbox.stub(infoService, 'getMeInfo').resolves(true);
  });

  afterEach(() => {
    // 清理所有Stub，避免测试污染
    sandbox.restore();
  });

  it('should acknowledge message when infoService returns truthy result', async () => {
    // 构造符合格式的测试消息
    const testMsg: ConsumeMessage = {
      content: Buffer.from(JSON.stringify({ id: 'test-123' })),
      fields: {},
      properties: {}
    };

    await MyService.consumeFunc1(testMsg);
    // 等待.then()中的微任务执行完成
    await new Promise(process.nextTick);

    expect(channelAckStub.calledOnceWith(testMsg)).to.be.true;
    expect(getMeInfoStub.calledOnceWith(JSON.parse(testMsg.content.toString()))).to.be.true;
  });
});

方法2：Stub外部依赖初始化Channel（更优雅，推荐） #

不直接触碰私有属性，通过Stubamqplib库的方法，让MyService在init时自动使用预先准备的Stub Channel，完全符合测试隔离原则：

import sinon, { createSandbox } from 'sinon';
import { expect } from 'chai';
import amqp from 'amqplib';
import MyService from './path-to-MyService';
import infoService from '../infoService';
import type { ConsumeMessage } from 'amqplib';

const sandbox = createSandbox();

describe('MyService.consumeFunc1', () => {
  let channelStub: sinon.SinonStubbedInstance<amqp.Channel>;
  let getMeInfoStub: sinon.SinonStub;

  beforeEach(async () => {
    // 创建Stub Channel
    channelStub = sandbox.createStubInstance(amqp.Channel);
    // Stub AMQP连接，让createChannel返回我们的Stub Channel
    const connectionStub = sandbox.createStubInstance(amqp.Connection);
    connectionStub.createChannel.resolves(channelStub);
    sandbox.stub(amqp, 'connect').resolves(connectionStub);

    // 初始化MyService，使其内部channel指向Stub
    await MyService.init();

    // Stub infoService.getMeInfo
    getMeInfoStub = sandbox.stub(infoService, 'getMeInfo').resolves(true);
  });

  afterEach(() => {
    sandbox.restore();
  });

  it('should acknowledge message when infoService returns truthy result', async () => {
    const testMsg: ConsumeMessage = {
      content: Buffer.from(JSON.stringify({ id: 'test-123' })),
      fields: {},
      properties: {}
    };

    await MyService.consumeFunc1(testMsg);
    await new Promise(process.nextTick);

    expect(channelStub.ack.calledOnceWith(testMsg)).to.be.true;
  });
});

新手测试实践建议 #

• 严格处理异步逻辑：原代码中consumeFunc1用.then()链式调用而非await，直接await consumeFunc1()不会等待内部异步完成，必须通过await new Promise(process.nextTick)或Sinon假定时器等待微任务执行，否则断言会提前失败。
• 优先Stub外部依赖：直接访问私有属性会让测试和代码实现强耦合，一旦私有属性改名或结构变化，测试就会失效。通过Stub外部依赖（如amqplib、infoService）控制内部状态，是更健壮的测试方式。
• 用Sandbox管理Stub：每次测试后调用sandbox.restore()清理所有Stub，确保测试之间完全隔离，避免残留状态影响结果。
• 模拟真实数据结构：测试消息必须符合amqplib.ConsumeMessage的格式（比如content是Buffer类型），否则原代码中的JSON.parse会报错，无法覆盖真实业务逻辑。
• 覆盖全部分支：除了测试ack被调用的场景，还要测试以下分支：
  • infoService.getMeInfo返回假值（不触发ack）
  • infoService.getMeInfo抛出错误（验证日志输出，不触发ack）
  • 传入msg为null（不执行任何逻辑）

内容的提问来源于stack exchange，提问作者Sinan Bayar