OHIF Viewer 开发中模块导入问题的分析与解决方案

问题背景

在使用 OHIF 医学影像查看器进行二次开发时，开发者在创建自定义模式时遇到了两个主要的 TypeScript 导入问题。这些问题会影响开发体验，特别是在使用 Visual Studio Code 或 WebStorm 等 IDE 时。

问题一：hotkeys 模块导出错误

当开发者尝试从 @ohif/core 导入 hotkeys 时，TypeScript 会报错提示该模块没有导出名为 'hotkeys' 的成员。

技术分析

这个问题源于 OHIF 版本升级导致的 API 变更。在较新版本中，hotkeys 相关的 API 可能已经进行了重构或重命名。根据错误提示，系统建议使用 'Hotkey' 替代，这表明模块导出结构可能已经发生了变化。

解决方案

1. 查阅当前使用版本的 OHIF 文档，确认 hotkeys 相关的正确导入方式
2. 根据错误提示尝试使用 'Hotkey' 替代 'hotkeys'
3. 如果确实需要使用 hotkeys，可以检查 @ohif/core 的源代码或类型定义文件，确认正确的导出名称

问题二：无法找到 @ohif/mode-longitudinal 模块

开发者尝试从 @ohif/mode-longitudinal 导入 initToolGroups 和 toolbarButtons 时，TypeScript 报错无法找到该模块。

技术分析

这个问题通常由以下几种情况导致：

1. 模块未正确安装或链接
2. TypeScript 类型声明文件缺失
3. 模块解析路径配置不正确

深入解决方案

1. 模块链接方案

对于本地开发环境，可以采用 yarn link 的方式解决模块解析问题：

# 在 OHIF 核心目录中
cd Viewers/platform/core
yarn link

# 在自定义扩展目录中
cd extensions/custom-extensions
yarn link @ohif/core

2. TypeScript 配置方案

更完善的解决方案是配置 TypeScript 的路径解析：

1. 首先在 OHIF 根目录生成类型声明文件：

tsc --declarationMap --outDir ../typings

2. 然后在自定义扩展中创建 tsconfig.json 文件：

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@ohif/ui": ["../../typings/platform/ui/src"],
      "@ohif/core": ["../../typings/platform/core/src"],
      "@ohif/extension-cornerstone": ["../../typings/extensions/cornerstone/src"]
    }
  }
}

3. 针对私有字段的编译问题

在 OHIF 3.9.1 版本中，MetadataProvider 类的私有字段会导致类型声明文件生成失败。可以通过修改源代码解决：

// 将 private 修饰符移除
class MetadataProvider {
  readonly studies: Map<string, any> = new Map();
  readonly imageURIToUIDs: Map<string, any> = new Map();
  readonly imageUIDsByImageId: Map<string, any> = new Map();
  readonly customMetadata: Map<string, any> = new Map();
  // ... 其他代码保持不变
}

最佳实践建议

1. 目录结构：建议将自定义模式和扩展放在 OHIF 项目目录内部（如 Viewers/custom-modes 和 Viewers/custom-extensions），这样可以简化模块解析。

2. 依赖管理：避免直接修改 peerDependencies 为 devDependencies，这可能导致运行时问题。优先使用 yarn link 或 TypeScript 路径配置方案。

3. 版本兼容性：在开发前仔细阅读所使用 OHIF 版本的迁移指南，了解 API 变更情况。

4. IDE 配置：确保 IDE 使用项目根目录的 TypeScript 版本和配置，避免使用全局 TypeScript。

总结

OHIF Viewer 开发中的模块导入问题主要源于模块解析路径和类型声明配置。通过合理配置 TypeScript 路径解析、使用 yarn link 技术以及适当调整源代码，可以有效地解决这些问题。对于团队开发，建议建立统一的开发环境配置规范，确保所有成员使用相同的模块解析策略。