TypeScript函数导出最佳实践及TDD场景下的封装性疑问

背景 #

本人是TypeScript新手，具备Java基础，认为导出函数会违背封装原则。

示例代码 #

// hello.ts
/** Below method will be called from outside **/
export const abcd = async () => {
  // some code
  dcb()
}

/** 
1. Below method (dcb) is not used outside this file, do I need to export?
2. Is it a best practise to export the method only for TDD development?
**/
export const dcb = async () => {
  // some code
}

提出的问题 #

1. 最佳实践中规定了函数何时该导出、何时不该导出吗？
2. 在TDD开发中，是否可以导出任意函数进行测试？这是否违背封装原则（我认为这并非良好实践）？

注：TypeScript支持无类函数，本问题与TypeScript类无关。

解答 #

1. 函数导出的最佳实践 #

核心原则非常清晰：只导出需要被外部模块调用的函数。

• 如果一个函数仅作为当前文件内部的辅助逻辑，没有被其他模块依赖的需求，完全不需要导出。这正是封装的核心——隐藏内部实现细节，只暴露必要的公共接口，既能减少模块间的耦合，也能避免外部误用内部逻辑。
• 只有当函数需要被其他文件导入使用时，才需要添加export关键字。

2. TDD中的函数导出与封装原则 #

不建议为了测试而导出原本不需要公开的函数，这确实违背了封装原则：

• 测试的核心是验证模块的公共行为，而非内部实现细节。如果测试必须依赖内部函数，往往说明模块设计存在问题——比如单个函数职责过重，或者公共接口的粒度不合理。
• 若确实需要验证内部逻辑，可以通过两种方式优化：
  • 重构代码，把需要测试的逻辑拆分成具备独立职责的子模块，合理导出这些子模块供测试调用。
  • 间接通过调用公共函数abcd来验证dcb的行为，确保公共接口的输出符合预期即可，内部实现的变动不应该影响测试用例的有效性。

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