@0xc/serverless-offline-aws-sqs 中文文档教程

Question

< img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT">

serverless-offline-sqs

这个无服务器离线插件在你的本地模拟 AWS λ 和 SQS 队列使用 ElasticMQ 的机器。 为此，它会侦听 SQS 队列并调用您的处理程序。

Installation

首先，将 @0xc/serverless-offline-aws-sqs 添加到您的项目中：

yarn add @0xc/serverless-offline-aws-sqs

然后在您项目的 serverless.yml 文件中，将以下条目添加到 serverless-offline（如果存在，则在 serverless-webpack 之后）：@0xc/serverless-offline-aws-sqs。

plugins:
  - serverless-webpack
  - "@0xc/serverless-offline-aws-sqs"
  - serverless-offline

Configure

Functions

该插件的功能配置遵循 serverless 文档。

functions:
  mySQSHandler:
    handler: handler.default
    events:
      - sqs:
          queueName: MyQueue
          arn:
            Fn::GetAtt:
              - MyQueue
              - Arn
resources:
  Resources:
    MyQueue:
      Type: AWS::SQS::Queue
      Properties:
        QueueName: MyQueue

在您的函数中，您可以使用包装器在本地和 (aws) 生产环境之间切换。

const AWS = require("aws-sdk");

let options = {};

// connect to local ElasticMQ if running offline
if (process.env.IS_OFFLINE) {
  options = {
    apiVersion: "2012-11-05",
    region: "localhost",
    endpoint: "http://0.0.0.0:9324",
    sslEnabled: false
  };
}

const client = new AWS.SQS(options);

export default client;

Local SQS (ElasticMQ)

aws.SQS客户端的配置 是通过使用您的特定配置在 serverless.yml 中定义一个 custom: serverless-offline-sqs 对象来完成的。

您可以使用具有以下配置的 ElasticMQ：

custom:
  "@0xc/serverless-offline-aws-sqs":
    apiVersion: "2012-11-05"
    endpoint: http://0.0.0.0:9324
    region: eu-west-1
    accessKeyId: root
    secretAccessKey: root
    skipCacheInvalidation: false

在启动无服务器功能之前，您需要运行 ElasticMQ。

docker run -it -p 9324:9324 s12v/elasticmq:latest

队列将自动创建。

Roadmap

• install ElasticMQ automatically or start docker automatically

请帮我完成这件事！ 欢迎每一个 PR。

Credits

这是来自 @meuschke/serverless-offline-aws-sqs 项目的自定义分支