API 开发策略

API 开发策略

React Router 是您应用程序的基础。我们希望确保升级到新的主要版本尽可能顺利,同时仍然允许我们随着 React 生态系统的发展调整和增强其行为和 API。

我们的策略和动机在我们的 未来标志 (Future Flags) 博客文章中有更详细的讨论。

未来标志 (Future Flags)

当 API 发生破坏性更改时,会通过未来标志引入。这允许您在新版本中成为默认设置之前,一次选择启用一个更改。

  • 不启用未来标志,您的应用程序不会有任何变化
  • 启用该标志会更改该功能的行为

所有当前的未来标志都在未来标志指南中有文档说明,以帮助您及时了解最新信息。

不稳定标志 (Unstable Flags)

不稳定标志是针对仍在设计和开发中,并提供给用户以帮助我们完善的功能。

不稳定标志不建议用于生产环境

  • 它们可能会在没有任何警告和升级路径的情况下更改
  • 它们会有错误
  • 它们没有文档说明
  • 它们可能会被完全放弃

当您选择启用不稳定标志时,您就成为了项目的贡献者,而不仅仅是用户。我们感谢您的帮助,但也请注意这个新的角色!

由于不稳定标志是实验性的,并且不保证会一直存在,我们在 SemVer 补丁版本中发布它们,因为它们不是新的稳定/文档化 API。当一个不稳定标志稳定下来成为一个 Future Flag 时,它将在 SemVer 小版本中发布,并会被妥善文档化并添加到Future Flags 指南中。

要了解当前的不稳定标志,请留意CHANGELOG

示例新功能流程

新功能的决策流程大致如下所示(请注意,此图与 Remix v1/v2 相关,但也适用于 React Router v6/v7)

Flowchart of the decision process for how to introduce a new feature

文档和示例 CC 4.0