使用 Serverless Framework 创建和部署

上一页
下一页

AWS Lambda 可以使用 Serverless Framework 创建和部署。它允许您创建 AWS Lambda 触发器，并通过创建所需的角色来部署它们。Serverless Framework 能够更轻松地处理大型项目。所需的事件和资源都编写在一个地方，只需几个命令即可将完整的功能部署到 AWS 控制台。

在本节中，您将详细了解如何开始使用 AWS Serverless Framework。

使用 npm install 安装 Serverless Framework

首先，您需要先安装 **Node.js**。您可以按照以下步骤检查 Node.js 是否已安装：

Install Server

您需要使用以下命令使用 npm 包安装 Serverless：

npm install -g serverless

Severless

npm 安装完成后，执行 serverless 命令，该命令将显示用于创建和部署 AWS Lambda 函数的命令列表。请观察下面的屏幕截图：

Framework Command

Framework Prompt

您也可以使用 sls 代替 serverless。**sls** 是 serverless 的简写命令。

Shorthand

如果您需要关于 **sls** 命令的帮助，可以使用以下命令：

sls create --help

Help

要创建 Serverless Framework，您需要按照以下步骤操作：

步骤 1

要开始使用 Serverless Framework，我们需要添加凭据。为此，您需要首先在 AWS 控制台中创建用户，如下所示：

Add User

步骤 2

单击 **下一步：权限** 按钮以添加权限。您需要为此用户附加现有策略或管理员访问权限。

Set Permission

Summary Review

步骤 3

单击 **创建用户** 以添加用户。它将显示访问密钥和密钥，我们需要使用它们来配置 Serverless Framework：

Create User

配置 AWS Serverless Framework

让我们看看如何配置 AWS Serverless Framework。您可以为此使用以下命令：

sls config credentials --provider aws --key accesskey --secret secretkey

Configure Framework

请注意，输入的凭据详细信息（即 **访问密钥** 和 **密钥**）存储在 **~/aws/credentials** 文件中。

首先，创建一个文件夹来存储您的项目文件。

Create Folder

接下来，我们将在 **aws-serverless** 文件夹中开始工作。

使用 Serverless Framework 创建 AWS Lambda

现在，让我们使用以下步骤使用 Serverless Framework 创建一个 Lambda 函数：

步骤 1

以下是 Serverless **create** 命令的详细信息：

Create Command

步骤 2

现在，我们需要分配模板，如下所示：

AWS-nodejs、aws-nodejs-typescript、aws-nodejs-ecma-script、aws-python、aws-python3、aws-groovy-gradle 等。

步骤 3

我们将使用 **aws-nodejs** 模板使用 Serverless Framework 创建我们的第一个项目。该命令如下所示：

sls create --template aws-nodejs

Nodejs

请注意，此命令会为 aws-nodejs 模板创建一个样板。

步骤 4

现在，在 IDE 中打开创建的文件夹。这里我们使用 Visual Studio Code，文件夹结构如下所示：

Visual Studio Framework

步骤 5

创建了 2 个文件：**handler.js** 和 **serverless.yml**

AWS Lambda 基本函数详细信息如下所示在 **handler.js** 中：

'use strict';

module.exports.hello = (event, context, callback) => {
   const response = {
      statusCode: 200,
      body: JSON.stringify({
         message: 'Go Serverless v1.0! Your function executed successfully!',
         input: event,
      }),
   };
   callback(null, response);

   // Use this code if you don't use the http event with the LAMBDA-PROXY integration
   // callback(null, { message: 'Go Serverless v1.0! Your function executed successfully!', event });
};

此文件 **serverless.yml** 包含 Serverless Framework 的配置详细信息，如下所示：

# Welcome to Serverless!
#
# This file is the main config file for your service.
# It's very minimal at this point and uses default values.
# You can always add more config options for more control.
# We've included some commented out config Examples here.
# Just uncomment any of them to get that config option.
#
# For full config options, check the docs:
#    docs.serverless.com
#
# Happy Coding!
service: aws-nodejs # NOTE: update this with your service name

# You can pin your service to only deploy with a specific Serverless version
# Check out our docs for more details
# frameworkVersion: "=X.X.X"

provider:
 name: aws
 runtime: nodejs6.10

# you can overwrite defaults here
#  stage: dev
#  region: us-east-1

# you can add statements to the Lambda function's IAM Role here
#  iamRoleStatements:
#    - Effect: "Allow"
#      Action:
#        - "s3:ListBucket"
#      Resource: { "Fn::Join" : ["", ["arn:aws:s3:::", { "Ref" : "ServerlessDeploymentBucket" } ] ]  }
#    - Effect: "Allow"
#      Action:
#        - "s3:PutObject"
#      Resource:
#        Fn::Join:
#          - ""
#          - - "arn:aws:s3:::"
#            - "Ref" : "ServerlessDeploymentBucket"
#            - "/*"

# you can define service wide environment variables here
#  environment:
#    variable1: value1

# you can add packaging information here
#package:
#  include:
#    - include-me.js
#    - include-me-dir/**
#  exclude:
#    - exclude-me.js
#    - exclude-me-dir/**

functions:
 hello:
   handler: handler.hello

#    The following are a few example events you can configure
#    NOTE: Please make sure to change your handler code to work with those events
#    Check the event documentation for details
#    events:
#      - http:
#          path: users/create
#          method: get
#      - s3: ${env:BUCKET}
#      - schedule: rate(10 minutes)
#      - sns: greeter-topic
#      - stream: arn:aws:dynamodb:region:XXXXXX:table/foo/stream/1970-01-01T00:00:00.000
#      - alexaSkill: amzn1.ask.skill.xx-xx-xx-xx
#      - alexaSmartHome: amzn1.ask.skill.xx-xx-xx-xx
#      - iot:
#          sql: "SELECT * FROM 'some_topic'"
#      - cloudwatchEvent:
#          event:
#            Example:
#              - "aws.ec2"
#            detail-type:
#              - "EC2 Instance State-change Notification"
#            detail:
#              state:
#                - pending
#      - cloudwatchLog: '/aws/lambda/hello'
#      - cognitoUserPool:
#          pool: MyUserPool
#          trigger: PreSignUp

#    Define function environment variables here
#    environment:
#      variable2: value2

# you can add CloudFormation resource templates here
#resources:
#  resources:
#    NewResource:
#      Type: AWS::S3::Bucket
#      Properties:
#        BucketName: my-new-bucket
#  Outputs:
#     NewOutput:
#       Description: "Description for the output"
#       Value: "Some output value"

现在，我们需要根据我们的需求更改 serverless.yml 文件。您可以使用以下命令：

您可以使用以下命令指定 **服务名称**：

service: aws-nodejs # NOTE: update this with your service name

现在，在此处更改服务名称，并添加我们文件夹的名称，如下所示：

service: aws-serverless # NOTE: update this with your service name

提供程序详细信息如下所示：

provider:
   name: aws
   runtime: nodejs6.10

提供程序为 **aws**，运行时为 **nodejs6.10**。我们需要添加我们将要工作的 **区域** 和 **阶段**，即项目的 **dev 或 prod** 环境。以下是提供程序的更新详细信息：

name: aws
runtime: nodejs6.10
# you can overwrite defaults here
stage: prod
region: us-east-1

IAM 角色

**iam 角色**，即与 Lambda 协同工作的权限代码，在此处在 **.yml** 文件中显示：

#  iamRoleStatements:
#    - Effect: "Allow"
#      Action:
#        - "s3:ListBucket"
#      Resource: { "Fn::Join" : ["", ["arn:aws:s3:::", { "Ref" : "ServerlessDeploymentBucket" } ] ]  }
#    - Effect: "Allow"
#      Action:
#        - "s3:PutObject"
#      Resource:
#        Fn::Join:
#          - ""
#          - - "arn:aws:s3:::"
#            - "Ref" : "ServerlessDeploymentBucket"
#            - "/*"

请注意，我们需要在上述部分中提供角色的详细信息，即与其他 AWS 服务所需的权限。

AWS Lambda 处理程序详细信息

**handler.js** 中导出的函数名称为 hello。因此，处理程序是文件名后跟导出名称。

functions:
   hello:
      handler: handler.hello

此处显示添加的关于 s3 服务的资源详细信息：

# you can add CloudFormation resource templates here
#resources:
#  resources:
#    NewResource:
#      Type: AWS::S3::Bucket
#      Properties:
#        BucketName: my-new-bucket
#  Outputs:
#     NewOutput:
#       Description: "Description for the output"
#       Value: "Some output value"

使用 Serverless Framework 部署 AWS Lambda

让我们将上述 Lambda 函数部署到 AWS 控制台。您可以为此使用以下步骤：

步骤 1

首先，您需要使用以下命令：

 sls deploy

Deploy

步骤 2

现在，您应该可以在 AWS 控制台中看到该函数，如下图所示。Serverless AWS 的详细信息记录在 AWS CloudFormation 中。为此，请转到 AWS 服务并选择 **CloudFormation**。AWS Lambda 的详细信息如下所示：

Cloud Framework

请注意，给定的名称是项目名称后跟使用的阶段。

Stage Used

步骤 3

它创建 AWS Lambda 的 iam 角色和 AWS CloudWatch 的日志组。创建存储代码详细信息和配置详细信息的 S3 存储桶。

这是由命令 **sls deploy** 创建的。您无需指定 iam 角色，而是在 **deploy** 阶段默认创建。

Serverless Prod

步骤 4

事件的详细流程如下所示在 CloudFormation 服务中。

Detailed Flow

Hello

AWS Lambda 代码

AWS Lambda 代码及其执行设置如下面的屏幕截图所示：

Lambda Code

当您测试 Lambda 函数时，您可以找到以下输出：

Lambda framework

Execution Framework

上面函数的日志输出如下所示：

Framework Output

我们也可以使用 serverless 命令测试 AWS Lambda 函数，如下所示：

sls invoke --function hello

Serverless Framework

invoke 命令的语法如下所示：

sls invoke --function hello

此 invoke 命令会触发 AWS Lambda 函数，并在命令提示符中显示输出，如下所示：

Command Trigger

您还可以在部署前测试 Lambda 函数，可以使用以下命令：

sls invoke local --function hello

请注意，并不总是可以在本地进行测试，因为 S3 和 DynamoDB 等资源无法在本地环境中模拟。只有基本的函数调用可以在本地测试。

Invoke Local

使用 API Gateway 和 Serverless Framework 与 AWS Lambda 结合使用

让我们看看如何创建一个新项目来使用 Lambda 和 API Gateway。您可以为此使用以下命令：

sls create --template aws-nodejs

Api Gateway Framework

现在，在 Visual Studio Code 中打开 **aws-api** 项目。您可以看到已创建 **handler.js** 和 **serverless.yml** 文件。让我们对其进行更改以添加 API Gateway。

Handler Open

您需要在 **serverless.yml** 中进行以下更改：

Changes

现在，为使用 AWS Lambda 激活 API Gateway 添加了事件详细信息：

Event Details

这里添加了一个新内容，称为 **events**。我们已将事件指定为 **http**，以及其路径和方法。

路径是我们创建 API Gateway 路径时将使用的端点，使用的方法为 GET。

请注意，处理程序是 **handler.hello**，hello 是 handler.js 中的导出名称。

Observe Handler

请注意，您无需在此处部署 API Gateway，因为 Serverless Framework 将执行此操作。

现在，我们将运行 **sls deploy** 命令来创建将 **API Gateway** 作为触发器的 AWS Lambda 函数。

sls deploy

Sls Deploy

请注意，部署详细信息列在上面。它提供了带有端点作为路径详细信息的 **Get** URL。阶段为 **prod**，因此在 URL 中使用相同的阶段。函数的名称为 **aws-api-prod-hello**。

让我们访问 URL 并查看输出。您可以看到我们从 API Gateway GET URL 获取的响应如下：

Response 
{"message":"Go Serverless v1.0! Your function executed 
successfully!","input":{"resource":"/first-api","path":"/first-api","httpMethod":
"GET","headers":{"Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,
image/webp,image/apng,*/*;q=0.8","Accept-Encoding":"gzip, deflate, br","Accept-Language":"en-US,en;q=0.9","CloudFront-Forwarded-Proto":
"https","CloudFront-Is-Desktop-Viewer":"true","CloudFront-Is-Mobile-Viewer":
"false","CloudFront-Is-SmartTV-Viewer":"false","CloudFront-Is-Tablet-Viewer":
"false","CloudFront-Viewer-Country":"IN","Host":"nvbhfdojfg.execute-api.us-east-1.
amazonaws.com","upgrade-insecure-requests":"1","User-Agent":"Mozilla/5.0 
(Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)
 Chrome/66.0.3359.181 Safari/537.36","Via":"2.0 707912794802dbb4825c79b7d8626a5d.cloudfront.net (CloudFront)","X-Amz-Cf-Id":"j70MMqkWFp6kmvuauzp_nvTbI-WwKIQmm2Jl5hzSoN6gkdvX11hh-g==",
 "X-Amzn-Trace-Id":"Root=1-5b13f9ef-5b012e36b7f40b5013a326fc","X-Forwarded-For":"157.33.133.217, 54.182.242.73","X-Forwarded-Port":"443","X-Forwarded-Proto":"https"},
 "queryStringParameters":null,"pathParameters":null,"stageVariables":null,
 "requestContext":{"resourceId":"pes5sy","resourcePath":"/first-api","httpMethod":
 "GET","extendedRequestId":"H6P9fE-MoAMFdIg=","requestTime":"03/Jun/2018:14:23:
 43 +0000","path":"/prod/first-api","accountId":"625297745038","protocol":"HTTP/1.1",
 "stage":"prod","requestTimeEpoch":1528035823928,"requestId":"b865dbd6-6739-11e8-b135
 -a30269a8ec58","identity":{"cognitoIdentityPoolId":null,"accountId":null,
 "cognitoIdentityId":null,"caller":null,"SourceIp":"157.33.133.217","accessKey":null,
 "cognitoAuthenticationType":null,"cognitoAuthenticationProvider":null,"userArn":null,
 "userAgent":"Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like
 Gecko) Chrome/66.0.3359.181 Safari/537.36","user":null},"apiId":"nvbhfdojfg"},"body":null,
 "isBase64Encoded":false}}

当您访问 URL 时，事件详细信息也包含在输出中。httpMethod 为 GET，queryStringParameters 为 null，因为查询字符串中没有任何内容。事件详细信息提供给我们在 AWS Lambda 处理程序中指定的 **input**：

Input

我们从 API Gateway 获取的输出只是 **body** 详细信息，例如 **message** 和 **input**。响应完全由 API Gateway 控制以及如何将其显示为输出。

现在，让我们将输入传递到查询字符串中的 GET URL 并查看显示：

Get Url

然后您可以看到查询字符串的输出，如下所示：

{"message":"Go Serverless v1.0! Your function executed 
successfully!","input":{"resource":"/first-api","path":"/first-api","httpMethod":
"GET","headers":{"Accept":"text/html,application/xhtml+xml,application/xml;q=0.9,
image/webp,image/apng,*/*;q=0.8","Accept-Encoding":"gzip, deflate, 
br","Accept-Language":"en-US,en;q=0.9","CloudFront-Forwarded-Proto":"https",
"CloudFront-Is-Desktop-Viewer":"true","CloudFront-Is-Mobile-Viewer":"false",
"CloudFront-Is-SmartTV-Viewer":"false","CloudFront-Is-Tablet-Viewer":"false",
"CloudFront-Viewer-Country":"IN","Host":"nvbhfdojfg.execute-api.us-east-1.amazonaws.com",
"upgrade-insecure-requests":"1","User-Agent":"Mozilla/5.0 (Windows NT 6.3; Win64; x64)
 AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.181 Safari/537.36","Via":"2.0 
 8b1d3263c2fbd0a2c270b174d7aa3d61.cloudfront.net (CloudFront)","X-Amz-Cf-Id":"JIBZw3I-blKbnpHP8LYXPVolCgdW5KmEukZS4at9mi4vrWBMI-UKNw==",
 "X-Amzn-Trace-Id":"Root=1-5b13ff90-7d6e38d4c0e4a5d4e6184f30","X-Forwarded-For":
 "157.33.133.217, 54.182.242.127","X-Forwarded-Port":"443","X-Forwarded-Proto":"https"},"queryString
 Parameters":{"displaymessage":"Hello"},"pathParameters":null,"stageVariables":null,
 "requestContext":{"resourceId":"pes5sy","resourcePath":"/first-api","httpMethod":
 "GET","extendedRequestId":"H6TeiG34oAMFguA=","requestTime":"03/Jun/2018:14:47:44 +0000","path":"/prod/first-api","accountId":"625297745038","protocol":"HTTP/1.1",
"stage":"prod","requestTimeEpoch":1528037264252,"requestId":"12e5dca3-
673d-11e8-8966-69fcf43bd4db","identity":{"cognitoIdentityPoolId":null,"accountId":null,
"cognitoIdentityId":null,"caller":null,"exmpleIp":"157.33.133.217","accessKey":null,
"cognitoAuthenticationType":null,"cognitoAuthenticationProvider":null,"userArn":null,
"userAgent":"Mozilla/5.0 (Windows NT 6.3; Win64; x64) AppleWebKit/537.36 (KHTML, like
 Gecko) Chrome/66.0.3359.181 Safari/537.36","user":null},"apiId":"nvbhfdojfg"},"body":
 null,"isBase64Encoded":false}}

让我们更改 AWS Lambda 函数以仅显示查询字符串详细信息，如下所示：

'use strict';
module.exports.hello = (event, context, callback) => {
   const response = {
      statusCode: 200,
      body: JSON.stringify({
         message:(event.queryStringParameters &&     event.queryStringParameters.displaymessage!="") ? event.queryStringParameters.displaymessage : 'Go Serverless v1.0! Your function executed successfully!'
      }),
   };
   callback(null, response);
   // Use this code if you don't use the http event with the LAMBDA-PROXY integration
   // callback(null, { message: 'Go Serverless v1.0! Your function executed successfully!', event });
};

请注意，我们已根据查询字符串 **display message** 更改了消息。这将再次部署函数并检查输出。它将显示查询字符串变量 display message 中的详细信息，如下所示。

Display Message

现在，让我们将 **post** 方法添加到创建的事件中，如下所示：

Post Method

现在，部署所做的更改，您可以从 deploy 命令中看到以下输出：

Deploy Command

请注意，直接在浏览器中测试 post URL 将不会提供详细信息。您应该在 **Postman** 中测试 post URL。

要获取 Postman，请访问 https://www.getpostman.com/apps。根据您的操作系统下载应用程序。安装后，您应该能够测试您的 post URL，如下所示：

Post Url

这将显示我们在 Lambda 函数中添加的消息。

打印页面
上一页
下一页
广告