AWS SDK for JavaScript v3 在 React Native 中的 ReadableStream 问题解析

问题背景

AWS SDK for JavaScript v3 是目前 AWS 官方推荐的 JavaScript SDK 版本。近期，许多 React Native 开发者在使用该 SDK 时遇到了一个棘手的问题：在 iOS 和 Android 平台上运行时出现 ReferenceError: Property 'ReadableStream' doesn't exist 错误，而同样的代码在 Web 环境下却能正常工作。

问题现象

开发者在使用 AWS SDK v3 的 S3、Cognito 等服务时，特别是在执行上传文件或身份验证等操作时，会遇到以下两种典型错误：

1. 未添加 polyfill 时：ReferenceError: Property 'ReadableStream' doesn't exist
2. 添加 web-streams-polyfill 后：TypeError: null is not a function

这些问题主要出现在 React Native 0.70 及以上版本中，因为这些版本默认启用了 Hermes JavaScript 引擎，而 Hermes 目前尚未实现 ReadableStream API。

技术分析

根本原因

1. Hermes 引擎限制：React Native 从 0.70 版本开始默认使用 Hermes 引擎，而 Hermes 目前没有实现 Web Streams API 中的 ReadableStream。

2. SDK 内部依赖：AWS SDK v3 在某些操作中会检查请求体是否为 ReadableStream 实例，这在没有 polyfill 的环境下会直接抛出错误。

3. 版本兼容性问题：从 v3.575.0 开始，SDK 内部对信号事件监听器的处理方式发生了变化，导致在 React Native 环境下会抛出 TypeError: null is not a function 错误。

影响范围

• 受影响的 SDK 版本：v3.575.0 及以上
• 受影响的 React Native 版本：0.70 及以上（使用 Hermes 引擎）
• 受影响的操作系统：iOS 和 Android

解决方案

临时解决方案

1. 降级 SDK 版本： 目前确认 v3.574.0 版本可以正常工作：

   npm install @aws-sdk/client-s3@3.574.0
   

2. 添加必要的 polyfill： 在应用的入口文件（通常是 index.js）中添加以下代码：

   import 'react-native-get-random-values';
   import 'react-native-url-polyfill/auto';
   import { ReadableStream } from 'web-streams-polyfill/ponyfill';
   globalThis.ReadableStream = ReadableStream;
   

3. 禁用 Hermes 引擎（不推荐）： 如果需要，可以按照 React Native 官方文档禁用 Hermes 引擎，但这会影响应用性能。

长期解决方案

AWS SDK 团队已经意识到这个问题，并正在考虑以下改进：

1. 在官方文档中明确 React Native 环境下的 polyfill 要求
2. 修复 SDK 中与信号事件监听器相关的兼容性问题
3. 与 React Native 团队合作，推动 Hermes 引擎对 Web Streams API 的支持

最佳实践建议

1. 保持 SDK 版本更新：关注 AWS SDK 的更新日志，特别是关于 React Native 兼容性的改进。

2. 测试策略：在 React Native 项目中，应该针对 iOS 和 Android 平台分别进行 AWS SDK 相关功能的测试。

3. 错误处理：在代码中添加适当的错误处理逻辑，捕获并处理可能的 ReadableStream 相关错误。

4. 性能考虑：polyfill 会增加包体积，应该评估其对应用性能的影响。

总结

AWS SDK for JavaScript v3 在 React Native 中的 ReadableStream 问题主要源于 Hermes 引擎的特性限制和 SDK 内部实现的变化。目前可以通过降级 SDK 版本或添加适当的 polyfill 来解决这个问题。开发者应该密切关注 AWS SDK 和 React Native 的更新，以便在官方提供更完善的解决方案后及时升级。

这个问题也提醒我们，在跨平台开发中使用原生 SDK 时，需要特别注意不同运行环境的差异和兼容性问题。通过合理的工程实践和持续集成测试，可以最大限度地减少这类问题对开发进度的影响。