StepFunctions-Local 项目教程

StepFunctions-Local 项目教程

stepfunctions-local Execute AWS Step Functions locally 项目地址: https://gitcode.com/gh_mirrors/st/stepfunctions-local

1、项目介绍

StepFunctions-Local 是一个用于在本地环境中执行 AWS Step Functions 的服务。该项目旨在替代 AWS Step Functions 在本地开发和测试中的使用，其 API 完全兼容 AWS 服务。通过使用 StepFunctions-Local，开发者可以在不将资源上传到 AWS 的情况下运行状态机，从而简化开发和测试流程。

2、项目快速启动

安装

首先，确保你已经安装了 AWS Command Line Interface (CLI) 和 Node.js 8 或更高版本。然后，你可以通过以下命令全局安装 StepFunctions-Local：

npm install -g stepfunctions-local

或者，你也可以通过 Docker 构建容器：

docker build -t stepfunctions-local .

启动服务器

使用命令行启动服务器：

stepfunctions-local start

你也可以通过 Docker 启动服务器：

docker run -it --rm -p 4584:4584 stepfunctions-local start

配置

在代码中启动服务器时，可以配置端口、区域、Lambda 和 ECS 的端点：

const stepfunctionsLocal = require('stepfunctions-local');
stepfunctionsLocal.start({
  port: 4584,
  region: 'local',
  lambdaRegion: 'local',
  lambdaEndpoint: 'http://localhost:4574',
  ecsRegion: 'local',
  ecsEndpoint: 'http://localhost:4600'
});

使用 AWS CLI 操作

启动服务器后，你可以使用 AWS CLI 进行操作，例如列出状态机：

aws stepfunctions --endpoint http://localhost:4584 list-state-machines

创建一个新的状态机：

aws stepfunctions --endpoint http://localhost:4584 create-state-machine --name my-state-machine --definition '{"Comment":"A Hello World example of the Amazon States Language using a Pass state","StartAt":"HelloWorld","States":{"HelloWorld":{"Type":"Pass","End":true}}}' --role-arn arn:aws:iam::0123456789:role/service-role/MyRole

启动状态机执行：

aws stepfunctions --endpoint http://localhost:4584 start-execution --state-machine-arn arn:aws:states:local:0123456789:stateMachine:my-state-machine --name my-execution --input '{"comment":"I am a great input"}'

3、应用案例和最佳实践

本地状态机与活动

如果你只想在本地运行一个带有活动的状态机，只需配置你的活动工作者使用 StepFunctions-Local 实例。例如，在 JavaScript 中：

AWS.config.stepfunctions = {
  region: 'local',
  endpoint: 'http://localhost:4584'
};

然后启动 StepFunctions-Local 服务器，你就可以执行对 StepFunctions API 的请求（如 GetActivityTask、SendTaskSuccess 等）。

本地状态机与远程 Lambda

要运行一个与远程 Lambda 函数结合的本地状态机，只需在启动服务器时配置 Lambda 端点和区域：

stepfunctions-local start --lambda-endpoint http://hostname.com:1337 --lambda-region my-region

StepFunctions-Local 将直接使用此配置查询 Lambda。

本地状态机与本地 Lambda

StepFunctions-Local 本身不模拟 Lambda，因此你需要一个符合 AWS API 的本地 Lambda 服务器。推荐使用 LocalStack 来实现这一点。

本地状态机与远程 ECS 任务

要运行一个与远程 ECS 任务结合的本地状态机，只需在启动服务器时配置 ECS 端点和区域：

stepfunctions-local start --ecs-endpoint http://hostname.com:1337 --ecs-region my-region

StepFunctions-Local 将直接使用此配置查询 ECS。

4、典型生态项目

LocalStack

LocalStack 是一个用于在本地模拟 AWS 服务的开源项目。它与 StepFunctions-Local 结合使用，可以完全在本地环境中模拟 AWS 生态系统，包括 Lambda、S3、DynamoDB 等服务。

AWS SAM CLI

AWS Serverless Application Model (SAM) CLI 是一个用于构建和测试无服务器应用程序的工具。结合 StepFunctions-Local，开发者可以在本地环境中测试和调试无服务器应用程序，而无需依赖 AWS 云环境。

Docker

Docker 是用于构建和运行容器的平台。通过使用 Docker，开发者可以将 StepFunctions-Local 打包成容器，并在任何支持 Docker 的环境中运行，从而实现跨平台的开发和测试。

stepfunctions-local Execute AWS Step Functions locally 项目地址: https://gitcode.com/gh_mirrors/st/stepfunctions-local