Restate - 轻松构建高韧性应用！

Restate 是构建高韧性应用最简单的方式。

Restate 提供了您日常构建模块的分布式持久化版本，让您能够构建各种用例：

• 持久化 AI 代理
• 代码即工作流
• 微服务编排
• 事件处理
• 异步任务
• 代理、有状态 Actor、状态机以及更多

开始使用 Restate

1. 🏎 跟随快速入门指南 在 2 分钟内让 Restate 运行起来！
2. 💡 Restate 之旅 带您了解 Restate 最重要的功能。

软件开发工具包 (SDK)

Restate 支持以下 SDK：

• TypeScript
• Java 和 Kotlin
• Python
• Go
• Rust

安装

我们提供适用于 MacOS 和 Linux 的 CLI (命令行界面) 和服务器的预编译二进制文件。

请查看 快速入门 或 文档中的安装说明。

安装服务器

通过 Homebrew 安装：

brew install restatedev/tap/restate-server

通过 npx 运行：

npx @restatedev/restate-server

通过 Docker 运行：

docker run --rm -p 8080:8080 -p 9070:9070 -p 9071:9071 \
    --add-host=host.docker.internal:host-gateway docker.restate.dev/restatedev/restate:latest

安装 CLI

通过 Homebrew 安装：

brew install restatedev/tap/restate

通过 npm 安装：

npm install --global @restatedev/restate

通过 npx 运行：

npx @restatedev/restate

您也可以从 发布页面 或我们的 下载页面 下载二进制文件。

社区

• 🤗️ 加入我们在 Discord 或 Slack 上的在线社区，获取帮助、分享反馈并与社区交流。
• 📖 查看我们的文档 以快速上手！
• 📣 在 Twitter 上关注我们 以保持最新动态。
• 🙋 创建 GitHub Issue 以请求新功能或报告问题。
• 🏠 访问我们的 GitHub 组织 以探索其他仓库。

核心原语

Restate 为简化应用开发所提供的核心原语如下：

• 可靠执行：Restate 保证代码运行完成。失败会导致重试，并使用 持久化执行机制 (Durable Execution) 来恢复部分进度并防止重新执行已完成的步骤。
• 可靠通信：服务之间进行通信时采用精确一次语义：无论是 请求 - 响应、单向消息还是定时任务。Restate 可靠地传递消息，并使用持久化执行来确保不会发生丢失或重复。
• 持久化 Promise 和定时器：在 Restate 中注册 Promise/Future 和定时器，使其对故障具有弹性（例如睡眠、Webhook、定时器）。Restate 可以在故障、进程和时间跨度过后恢复它们。
• 一致状态：实现 有状态实体，每个实体拥有隔离的键值 (K/V) 状态。Restate 将 K/V 状态更新与执行进度一起持久化，以确保状态一致。Restate 在调用时将 K/V 状态附加到请求上，并在完成后写回。这对于 FaaS (函数即服务) 部署特别高效（有状态无服务器，太棒了！）。
• 挂起用户代码：长时间运行的代码在等待 Promise/Future 时会挂起，并在该 Promise 解析时恢复。这与无服务器部署结合使用时特别有用。
• 可观测性与自省：Restate 包含一个 UI 和 CLI，用于检查跨服务和调用的 应用程序状态。Restate 自动为处理器之间的交互生成 OpenTelemetry 跟踪。

贡献

如果您加入 Restate 社区并开始贡献，我们将非常兴奋！ 无论是功能请求、错误报告、想法与反馈还是拉取请求 (PR)，我们都感激任何及所有贡献。 我们知道您的时间宝贵，因此我们非常重视任何贡献的努力！

请查看我们的 开发指南 和 本地开发技巧 以开始上手。

版本

Restate 遵循 语义化版本控制 (Semantic Versioning)。

您可以安全地从 Restate x.y 升级到 x.(y+1) 版本，而无需执行任何手动数据迁移，因为 Restate 会为您执行自动数据迁移。

关于 SDK 兼容性，请参考各自 README 中的支持版本矩阵：

• Restate Java/Kotlin SDK
• Restate TypeScript SDK
• Restate Go SDK
• Restate Python SDK
• Restate Rust SDK

在本地构建 Restate

若要在本地构建 Restate，请 遵循构建说明。

Restate 快速上手指南

Restate 是一个构建高可用应用的分布式框架，提供持久化执行、可靠通信和状态管理等功能。以下是快速开始指南。

1. 环境准备

• 操作系统：推荐使用 macOS 或 Linux（Windows 用户建议使用 WSL 或 Docker）。
• 依赖工具：
  • 若使用 Docker 方式：需安装 Docker Engine。
  • 若使用 Homebrew 方式：需安装 Homebrew。
  • 若使用 npm 方式：需安装 Node.js 及 npm。
• 网络要求：确保能访问 GitHub 及 Docker Hub 相关地址。

2. 安装步骤

Restate 提供多种安装方式，您可根据偏好选择其一。

方式一：Docker（推荐）

直接运行容器，无需本地安装二进制文件。

docker run --rm -p 8080:8080 -p 9070:9070 -p 9071:9071 \
    --add-host=host.docker.internal:host-gateway docker.restate.dev/restatedev/restate:latest

方式二：Homebrew（macOS/Linux）

安装 Restate 服务器和 CLI 工具。

brew install restatedev/tap/restate-server
brew install restatedev/tap/restate

方式三：NPM / npx

适用于 Node.js 环境。

# 安装 CLI
npm install --global @restatedev/restate

# 运行服务器
npx @restatedev/restate-server

# 运行 CLI
npx @restatedev/restate

3. 基本使用

安装完成后，即可启动服务并开始开发。

1. 启动服务： 根据上述安装方式运行 Restate 服务器。默认监听端口为 8080（HTTP）、9070 和 9071。

2. 验证运行： 访问 http://localhost:8080 可进入 Restate 的 Web UI，查看应用状态。

3. 编写代码： Restate 支持多种 SDK，请根据您的技术栈选择并参考官方示例：

   • TypeScript
   • Java/Kotlin
   • Python
   • Go
   • Rust

4. 快速入门： 建议直接跟随官方 Quickstart 教程，在 2 分钟内完成第一个 Resilient Application 的构建。