如何使用 Sinon 正确存根(stub)类实例的属性

陌明君_9034

陌明君_9034

2026-08-15

223人浏览

原创

如何使用 Sinon 正确存根(stub)类实例的属性

Sinon 的 createStubInstance 不会执行构造函数,因此实例上未初始化的属性(包括构造函数中声明的 public readonly 参数)无法直接被 sinon.stub().value() 存根,需先手动赋值使其存在。

sinon 的 `createstubinstance` 不会执行构造函数,因此实例上未初始化的属性(包括构造函数中声明的 `public readonly` 参数)无法直接被 `sinon.stub().value()` 存根,需先手动赋值使其存在。

在使用 Sinon 进行单元测试时,sinon.createStubInstance(Class) 是一种快速生成“类形似对象”的常用方式——它会为类的所有方法创建 stub,并返回一个空壳实例。但需要注意:该实例不会调用构造函数,因此所有在构造函数中初始化的属性(如 public readonly myParameter: string)根本不会存在于实例上。这正是你遇到 TypeError: Cannot stub non-existent property myParameter 的根本原因。

为什么 myParameter 不存在?

TypeScript 中的 public constructor(public readonly myParameter: string) 实际编译为 JavaScript 后,等价于:

constructor(myParameter) {
  this.myParameter = myParameter; // 构造函数内赋值
}

而 createStubInstance 绕过了构造函数执行,导致 myClass.myParameter 属性从未被定义,自然无法被 Sinon 存根。

✅ 正确解决方案:先“占位”,再存根

你需要在调用 sinon.stub(...).value(...) 之前,确保目标属性已存在于实例上。由于 TypeScript 对 readonly 属性有严格检查,需通过类型断言绕过编译器限制:

describe("stubs", () => {
  it("should pass", () => {
    const myClass = sinon.createStubInstance(MyClass);

    // 关键步骤:手动设置属性(使属性存在),TS 中需 as any 绕过 readonly 限制
    (myClass as any).myParameter = undefined;

    // 此时属性已存在,可安全存根
    sinon.stub(myClass, "myParameter").value("a");

    expect(myClass.myParameter).toBe("a"); // ✅ 通过
  });
});

? 提示:赋值内容本身不重要(null、undefined 或任意占位值均可),关键是触发属性在 myClass 原型链上的“存在性”。

? 扩展场景:存根复杂类型属性

当属性是另一个类实例时,同样适用该模式:

// 假设 MyClass 有一个依赖属性
class MyClass {
  constructor(public readonly service: SomeService) {}
}

// 测试中:
const myClass = sinon.createStubInstance(MyClass);
(myClass as any).service = null; // 先占位
sinon.stub(myClass, "service").value(sinon.createStubInstance(SomeService));

// 现在可安全访问并验证嵌套行为
expect(myClass.service.doSomething).to.be.a("function");

⚠️ 注意事项与最佳实践

  • 不要滥用 as any:仅在明确需要绕过 TS 类型系统(如初始化只读属性)时使用,避免掩盖真实类型问题。
  • 考虑替代方案:若大量依赖属性存根,可能说明设计耦合度高;优先考虑依赖注入 + 真实实例 + sinon.replace 或 sinon.useFakeTimers 等更语义化的测试策略。
  • createStubInstance 的适用边界:它适合快速模拟“无状态”接口行为;对强依赖构造逻辑或属性初始化的类,建议改用 sinon.stub(new MyClass(...)) 或手动构造 + 方法级 stub。
  • Sinon v15+ 变化:新版 Sinon 对属性 stub 支持更严格,此方案在 v14–v17 均有效,无需额外 polyfill。

总之,理解 createStubInstance 的“零初始化”本质,是解决此类问题的关键。先让属性落地,再赋予行为——这是 Sinon 属性 stub 的可靠范式。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4566

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1129

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4484

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1796

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4233

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2760

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习