在JavaScript开发中,函数契约编程是指为函数定义明确的前置条件、后置条件和不变式,确保函数在符合预期的场景下执行。类型约束和断言验证是实现函数契约的核心手段,能够有效提前拦截不符合要求的参数,降低线上故障概率。

什么是函数契约编程
函数契约本质是函数与调用方之间的约定,明确函数接收什么类型的参数、需要满足什么条件,以及返回什么结果。当调用方违反约定时,函数会主动抛出错误,而不是在后续逻辑中引发难以排查的异常。
类型约束的实现方式
JavaScript本身是弱类型语言,我们可以通过多种方式实现类型约束,分为运行时约束和静态类型约束两类。
运行时类型检查
在函数入口处手动校验参数类型,不符合要求时抛出错误,这是最基础的类型约束方式。
function add(a, b) {
// 校验参数类型
if (typeof a !== 'number') {
throw new TypeError('参数a必须是数字类型');
}
if (typeof b !== 'number') {
throw new TypeError('参数b必须是数字类型');
}
return a + b;
}
// 正确调用
console.log(add(1, 2)); // 输出3
// 错误调用
add('1', 2); // 抛出TypeError: 参数a必须是数字类型
使用静态类型工具
TypeScript是JavaScript的超集,通过静态类型定义可以在编译阶段就发现类型错误,是目前主流的类型约束方案。
// 定义函数参数和返回值的类型契约
function multiply(a: number, b: number): number {
return a * b;
}
// 编译阶段就会报错,无需等到运行时
multiply('3', 4);
断言验证函数前提条件
除了基础的类型约束,我们还需要验证参数的取值范围、格式等更复杂的约束条件,这时候可以使用断言来实现。
自定义断言函数
封装通用的断言函数,在函数入口处校验参数的前提条件,不满足条件时抛出明确的错误信息。
// 自定义断言函数
function assert(condition, message) {
if (!condition) {
throw new Error(message);
}
}
// 计算平方根的函数,要求参数必须是非负数
function sqrt(num) {
// 验证前提条件:参数是数字且大于等于0
assert(typeof num === 'number', '参数必须是数字类型');
assert(num >= 0, '参数必须是非负数');
return Math.sqrt(num);
}
// 正确调用
console.log(sqrt(4)); // 输出2
// 错误调用
sqrt(-1); // 抛出Error: 参数必须是非负数
使用第三方断言库
实际项目中可以使用成熟的断言库,比如chai的assert模块,减少重复代码编写。
// 假设已引入chai的assert模块
const { assert } = require('chai');
function divide(a, b) {
// 验证除数不能为0的前提条件
assert.isNumber(a, '被除数必须是数字');
assert.isNumber(b, '除数必须是数字');
assert.notStrictEqual(b, 0, '除数不能为0');
return a / b;
}
divide(10, 2); // 返回5
divide(10, 0); // 抛出AssertionError: 除数不能为0
函数契约的最佳实践
在实际开发中,我们可以结合类型约束和断言验证,形成完整的函数契约:
- 优先使用TypeScript定义静态类型契约,在编译阶段拦截类型错误
- 对于复杂的业务约束,使用断言在函数入口处校验前提条件
- 错误信息要明确,让调用方能够快速定位问题
- 不要在函数内部处理不符合契约的参数,应该直接抛出错误
总结
通过类型约束和断言验证实现函数契约编程,能够让我们的JavaScript代码更健壮、更易维护。类型约束解决参数类型不符合预期的问题,断言验证解决参数取值范围、业务规则等前提条件的问题,两者结合可以有效减少运行时错误,提升代码质量。