使用 .NET Lambda Global CLI - AWS Lambda
必要條件使用 .NET CLI 建立 .NET 專案使用 .NET CLI 部署 .NET 專案透過 .NET CLI 使用 Lambda 層

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

使用 .NET Lambda Global CLI

透過 .NET CLI 和 .NET Lambda Global Tools 延伸模組 (Amazon.Lambda.Tools)，可以跨平台建立 .NET 式 Lambda 應用程式、封裝這些應用程式，然後部署到 Lambda。在本節中，您將學習如何使用 .NET CLI 和 Amazon Lambda 範本建立新的 Lambda .NET 專案，以及如何使用 Amazon.Lambda.Tools 封裝和部署這些專案。

必要條件

.NET 8 開發套件

如果您尚未這樣做，請安裝 .NET 8 SDK 和執行階段。

AWS 亞馬遜. Lambda. NET 專案範本

若要產生 Lambda 函數程式碼，請使用Amazon.Lambda.Templates NuGet 套件。若要安裝此範本套件，請執行下列命令：

dotnet new install Amazon.Lambda.Templates
AWS 亞馬遜工具. NET 全球 CLI 工具

若要建立 Lambda 函數，請使用 Amazon.Lambda.Tools .NET Core Global Tools 延伸模組。若要安裝 Amazon.Lambda.Tools，請執行下列命令：

dotnet tool install -g Amazon.Lambda.Tools

如需有關 Amazon.Lambda.Tools .NET CLI 延伸模組的詳細資訊，請參閱上的 .NET CLI 存放庫的AWS 擴充功能 GitHub。

使用 .NET CLI 建立 .NET 專案

在 .NET CLI 中，在命令列中使用 dotnet new 命令建立 .NET 專案。Lambda 提供使用Amazon.Lambda.Templates NuGet 套件的其他範本。

安裝此套件後，執行以下命令即可查看可用範本的清單。

dotnet new list

若要檢查範本的詳細資訊，請使用 help 選項。例如，若要查看有關 lambda.EmptyFunction 範本的詳細資訊，請執行以下命令。

dotnet new lambda.EmptyFunction --help

若要建立 .NET Lambda 函數的基本範本，請使用 lambda.EmptyFunction 範本。這會建立一個簡單的函數，此函數會接受字串作為輸入，並使用 ToUpper 方法轉換為大寫。此範本支援以下選項︰

  • --name - 函數的名稱。

  • --region— 要在其中建立函數的 AWS 區域。

  • --profile— AWS SDK for .NET 認證檔案中設定檔的名稱。若要深入了解 .NET 中的認AWS 證設定檔，請參閱. NET 開發人員指南中的「AWS 設定認證」。

在此範例中，我們建立myDotnetFunction使用預設描述檔和 AWS 區域 設定名稱的新空函式：

dotnet new lambda.EmptyFunction --name myDotnetFunction

此命令會在您的專案目錄中建立以下檔案和目錄。

└── myDotnetFunction
    ├── src
    │   └── myDotnetFunction
    │       ├── Function.cs
    │       ├── Readme.md
    │       ├── aws-lambda-tools-defaults.json
    │       └── myDotnetFunction.csproj
    └── test
        └── myDotnetFunction.Tests
            ├── FunctionTest.cs
            └── myDotnetFunction.Tests.csproj

在 src/myDotnetFunction 目錄下，檢查下列檔案：

  • aws-lambda-tools-defaults.json：您在部署 Lambda 函數時，在此檔案中指定命令列選項。例如：

      "profile" : "default",
  "region" : "us-east-2",
  "configuration" : "Release",
  "function-architecture": "x86_64",
  "function-runtime":"dotnet8",
  "function-memory-size" : 256,
  "function-timeout" : 30,
  "function-handler" : "myDotnetFunction::myDotnetFunction.Function::FunctionHandler"

  • Function.cs：您的 Lambda 處理常式函數程式碼。它是 C# 範本，包含了預設的 Amazon.Lambda.Core 程式庫和預設的 LambdaSerializer 屬性。如需關於序列化需求及選項的詳細資訊，請參閱Lambda 函數中的序列化。它也包含可編輯以套用 Lambda 函數程式碼的範例函數。

    using Amazon.Lambda.Core;

// Assembly attribute to enable the Lambda function's JSON input to be converted into a .NET class.
[assembly: LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))]

namespace myDotnetFunction;

public class Function
{

    /// <summary>
    /// A simple function that takes a string and does a ToUpper
    /// </summary≫
    /// <param name="input"></param>
    /// <param name="context"></param>
    /// <returns></returns>
    public string FunctionHandler(string input, ILambdaContext context)
    {
        return input.ToUpper();
    }
}

  • 我的 DotnetFunction .csproj：一個 MSBuild 文件，列出了構成您的應用程序的文件和程序集。

    <Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
    <GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
    <AWSProjectType>Lambda</AWSProjectType>
    <!-- This property makes the build directory similar to a publish directory and helps the AWS .NET Lambda Mock Test Tool find project dependencies. -->
    <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
    <!-- Generate ready to run images during publishing to improve cold start time. -->
    <PublishReadyToRun>true</PublishReadyToRun>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0" />
    <PackageReference Include="Amazon.Lambda.Serialization.SystemTextJson" Version="2.4.0" />
  </ItemGroup>
</Project>

  • Readme：使用此檔案來記錄您的 Lambda 函數。

在 myfunction/test 目錄下，檢查下列檔案：

  • 我的 DotnetFunction .tests.csproj：如前所述，這是一個 MSBuild 文件，列出了組成測試項目的文件和程序集。也請注意，它包含 Amazon.Lambda.Core 程式庫，以便您順利整合測試函數時所需要的任何 Lambda 範本。

    <Project Sdk="Microsoft.NET.Sdk">
   ... 

    <PackageReference Include="Amazon.Lambda.Core" Version="2.2.0 " />
   ...

  • FunctionTest.cs：它包含在src目錄中的相同 C＃ 代碼模板文件。編輯此檔案以鏡像您的函數的生產程式碼，並在上傳 Lambda 函數至生產環境之前進行測試。

    using Xunit;
using Amazon.Lambda.Core;
using Amazon.Lambda.TestUtilities;

using MyFunction;

namespace MyFunction.Tests
{
    public class FunctionTest
    {
        [Fact]
        public void TestToUpperFunction()
        {

            // Invoke the lambda function and confirm the string was upper cased.
            var function = new Function();
            var context = new TestLambdaContext();
            var upperCase = function.FunctionHandler("hello world", context);

            Assert.Equal("HELLO WORLD", upperCase);
        }
    }
}

使用 .NET CLI 部署 .NET 專案

若要建置部署套件並部署到 Lambda，請使用 Amazon.Lambda.Tools CLI 工具。若要從先前步驟中建立的檔案部署函數，請先瀏覽至包含函數 .csproj 檔案的資料夾。

cd myDotnetFunction/src/myDotnetFunction

若要將程式碼以 .zip 部署套件形式部署至 Lambda，請執行下列命令。選擇您的函數名稱。

dotnet lambda deploy-function myDotnetFunction

在部署期間，精靈會要求您選取使用執行角色定義 Lambda 函數許可. 在此範例中，請選取 lambda_basic_role。

部署函數後，您可以使用 dotnet lambda invoke-function 命令在雲端進行測試。在 lambda.EmptyFunction 範本的程式碼範例中，您可以使用 --payload 選項傳入字串來測試函數。

dotnet lambda invoke-function myDotnetFunction --payload "Just checking if everything is OK"

如果函數部署成功，您應該會看到類似以下內容的輸出。

dotnet lambda invoke-function myDotnetFunction --payload "Just checking if everything is OK"
Amazon Lambda Tools for .NET Core applications (5.8.0)
Project Home: https://github.com/aws/aws-extensions-for-dotnet-cli, https://github.com/aws/aws-lambda-dotnet

Payload:
"JUST CHECKING IF EVERYTHING IS OK"

Log Tail:
START RequestId: id Version: $LATEST
END RequestId: id
REPORT RequestId: id  Duration: 0.99 ms       Billed Duration: 1 ms         Memory Size: 256 MB     Max Memory Used: 12 MB

透過 .NET CLI 使用 Lambda 層

注意

搭配 C# 等編譯語言函數使用層，可能不會具有與使用 Python 等轉譯語言一樣多的好處。由於 C# 是編譯語言，因此您的函數仍須在 init 階段，將所有共用組件手動載入記憶體中，這可能會增加冷啟動時間。相反地，建議您在編譯時加入任何共用程式碼，利用任何內建的編譯器最佳化功能。

.NET CLI 支援命令，協助您發布層及部署使用層的 C# 函數。若要將層發布至指定的 Amazon S3 儲存貯體，請在與 .csproj 檔案相同的目錄中執行以下命令：

dotnet lambda publish-layer <layer_name> --layer-type runtime-package-store --s3-bucket <s3_bucket_name>

接著使用 .NET CLI 部署函數時，請在以下命令中指定要使用的層 ARN：

dotnet lambda deploy-function <function_name> --function-layers arn:aws:lambda:us-east-1:123456789012:layer:layer-name:1

如需 Hello World 函式的完整範例，請參閱 blank-csharp-with-layer範例。