TypeScript工具函数返回类型设置与参数类型校验必要性咨询

1. 入参运行时校验是否必要 #

TypeScript 的类型校验仅在编译阶段生效，运行时并不会做任何类型检查，是否需要加运行时校验完全取决于你工具函数的使用场景：

• 若工具函数仅在内部TS项目中使用，所有调用链路都有严格的类型约束，不存在使用any/unknown绕开类型校验、非TS模块调用的情况，这类校验属于冗余操作，可以直接删除。删除后也无需处理异常返回，代码更简洁，还能减少不必要的运行时开销。
• 若工具函数是导出给外部使用的公共方法，或是入参来源不可控（比如来自后端接口返回、本地存储读取、用户输入等），运行时校验属于防御性编程的良好实践，能避免非法入参导致的后续业务逻辑异常，是必须加的。

另外你给出的示例代码里存在一处逻辑错误：forEach循环中调用的是m.value，实际应该取当前遍历项的v.value，否则会执行报错。

2. 校验失败的处理方案 #

你当前选择返回null是合理的，除此之外可以根据场景选择不同的处理方式：

• 公共类库场景：更推荐抛出明确的类型错误。这样调用方传错参数时会直接暴露问题，避免静默失败导致的异常难以排查，也符合通用类库的设计习惯。
• 高容错业务场景：可以选择返回原始传入的模板字符串（若模板非法则返回预设的默认文案），保证业务功能不会直接中断。
• 上层调用方可以便捷处理空值的场景：保持返回null即可，调用方可通过??运算符快速设置fallback值，比如replaceStringsInTemplate(arr, str) ?? '默认文案'。

3. 返回类型设置建议 #

返回类型和你的校验逻辑完全对齐即可：

• 无运行时校验的内部场景：直接定义返回类型为string即可，入参的类型约束已经保证了不会出现非法输入，必然会返回合法字符串。
• 有运行时校验且返回null的场景：定义返回类型为string | null即可。
• 有运行时校验且抛出错误的场景：返回类型依然可以定义为string，抛出异常的分支不需要计入返回类型的统计。

优化后代码示例 #

纯内部TS项目使用版本

// TS类型规范建议首字母大写
interface ReplacementMap {
  key: string;
  value: string;
}

type TemplateString = string;

const replaceStringsInTemplate = (replacements: ReplacementMap[], template: TemplateString): string => {
  // 用reduce比forEach修改外部变量更符合函数式编程习惯
  return replacements.reduce((result, { key, value }) => {
    return result.split(key).join(value);
  }, template);
}

需要运行时校验的公共版本

interface ReplacementMap {
  key: string;
  value: string;
}

type TemplateString = string;

// 入参定义为unknown，适配不可控的输入场景
const replaceStringsInTemplate = (replacements: unknown, template: unknown): string => {
  if (typeof template !== 'string') {
    throw new TypeError('replaceStringsInTemplate 第二个入参必须是字符串类型');
  }
  if (!Array.isArray(replacements)) {
    throw new TypeError('replaceStringsInTemplate 第一个入参必须是数组类型');
  }
  // 可按需增加数组项的结构校验
  const isLegalReplacement = (item: unknown): item is ReplacementMap => {
    return typeof item === 'object' && item !== null && 'key' in item && 'value' in item && typeof item.key === 'string' && typeof item.value === 'string';
  };
  if (!replacements.every(isLegalReplacement)) {
    throw new TypeError('replaceStringsInTemplate 第一个入参数组的每一项必须包含key、value两个字符串属性');
  }

  return replacements.reduce((result, { key, value }) => {
    return result.split(key).join(value);
  }, template);
}

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