关于文档

Doubao 中英对照 About the Documentation

目录

• 1. 最新版本与版权声明
• 2. 为文档做贡献
• 3. 获取帮助
• 4. 接下来去哪里

Stephane Maldini <@smaldini>；Simon Baslé <@simonbasle> 版本 3.8.2

本节简要介绍 Reactor 参考文档。您无需按顺序阅读本指南。每个部分都可独立成章，不过它们常常会引用其他部分。

1. 最新版本与版权声明

Reactor 参考指南以 HTML 文档形式提供。最新版本可在 projectreactor.io/docs/core/release/reference/index.html 获取。

您可以为自己使用而复制本文档，也可以分发给他人，但前提是您不得对此类副本收取任何费用，并且每份副本（无论以印刷形式还是电子形式分发）都必须包含本版权声明。

2. 为文档做贡献

本参考指南使用 Antora 以 Asciidoc 编写，您可以在 github.com/reactor/reactor-core/tree/main/docs/ 找到其源文件。

如果您有改进意见或建议，我们非常欢迎您提交 pull request！

建议您检出仓库的本地副本，这样就可以通过运行 asciidoctor gradle 任务来生成文档并检查渲染效果。有些部分依赖于被包含的文件，因此 GitHub 的渲染并不总是完整的。

提示

为便于编辑文档，您可以通过右上角边栏中的 Edit this Page 链接编辑当前页面。该链接会直接在 GitHub 上打开当前页面主源文件的编辑 UI。这些链接仅出现在本参考指南的 HTML5 版本中。它们类似于以下链接：Edit this Page，用于修改关于文档页面。

3. 获取帮助

您可以通过以下几种方式获取 Reactor 相关帮助：

• 在 Gitter 上与社区交流。

• 在 stackoverflow.com 的 project-reactor 标签下提问。

• 在 Github issues 中报告 bug。我们密切关注以下仓库：reactor-core（涵盖核心特性）和 reactor-addons（涵盖 reactor-test 与适配器相关问题）。

备注

Reactor 的全部内容都是开源的，本文档也是如此。如果您发现文档存在问题，或者想改进文档，欢迎参与贡献。

4. 接下来去哪里

• 如果您想直接动手写代码，请前往快速上手。

• 不过，如果您刚接触响应式编程，或许应该从响应式编程简介开始。

• 如果您已经熟悉 Reactor 的概念，只是想为手头的工作找合适的工具，却想不起相关操作符，可以试试附录我需要哪个操作符？。

• 为了更深入地了解 Reactor 的核心特性，请前往Reactor Core 特性了解：

  • 在Flux，0-N 个元素的异步序列与Mono，0-1 个结果的异步处理两节中进一步了解 Reactor 的响应式类型。

  • 如何使用调度器切换线程上下文。

  • 如何在错误处理一节中处理错误。

• 单元测试？借助 reactor-test 项目，这完全可行！请参阅测试。

• 以编程方式创建序列提供了一种更高级的创建响应式源的方式。

• 其他高级主题在高级特性与概念中介绍。