C#でAWSLambda関数を作ってみた

この記事はOUCC Advent Calendar 2022の23日目の記事です。前回の記事は紅茶さんの「お気に入りの量産型・地雷系ファッションブランドについて語る」でした。

どうもこんにちは、3回のかきのたねです。
今知り合いとの忘年会を終えて酔いを冷ましながらこの記事を書いています。
エンジニアは孤独な職業と言いますが、最近人と遊んだり飲んだりするのが楽しくて仕方なくていよいよエンジニア失格かもしれませんね。。。
まあ、人付き合いも１種の立派な勉強と開き直っています。

さて先日AWSLambdaを触る機会があったので、備忘録として記事にしておこうと思います。

まずは準備

AWS Toolkit for Visual Studioのインストール

VisualStudio 2022 を開く。
上のメニューから拡張機能≫拡張機能を管理するを選択
AWS Toolkit for Visual Studioを選択してダウンロード。
VisualStudioをいったん閉じるとインストールが開始される。

AWSでアカウント登録を済ませておきましょう。

プロジェクト作成

VisualStudio2022を起動し新しいプロジェクトの作成画面を開くと、AWSLambdaプロジェクトのテンプレートが出てくるので、AWS Lambda Project (.Net Core -C#)を選択。
以下の画面が出てくるので空のプロジェクトを選択。

以下の構成でプロジェクトが作成されるはず。

.Project
 |---- Properties
 |   └ launchSettings.json
 |--- Function.cs
 |--- aws-lambda-tools-defaults.json
 --- readme.md

AWSアカウントとの連携

AWSのコンソールを開き、アカウント -> セキュリティ認証情報を選択。
セキュリティ認証情報画面で、新しいアクセスキーの作成を選択してアクセスキーを作成。キーファイルのダウンロードを選択してアクセスキーをダウンロードする。(このファイルは無くさないように大切に保管しておく。)
VisualStudioで表示 -> AWSExplorerを選択してウインドウを開き、アカウント追加ボタン(赤線部分)をクリックする。
アカウント作成画面が出るので、ダウンロードしたキーファイルの情報を入力。
プロフィール名は自由で、リージョンは一応東京を選択しておく。
OKを押して、正しく認証されれば以下のような画面になる。

サンプル関数をAWSLambdaに発行、テストする

入力文字列を受け取り、簡単なメッセージを返す以下のようなメソッドをLambdaに発行する。

    // -------------------------------------------------------------------------------
    #region +LambdaTestFunc：AWS用の簡単な関数
    // -------------------------------------------------------------------------------
    /// <summary>
    /// AWSLambdaで実行されるテスト用の関数です。
    /// ただ入力を受け取って簡単な文字列を返します。
    /// </summary>
    /// <param name="input">入力</param>
    /// <param name="context">関数とリクエストに関する情報を持つ[コンテキストオブジェクト](</param>
    /// <returns>返答メッセージ</returns>
   [LambdaSerializer(typeof(Amazon.Lambda.Serialization.SystemTextJson.DefaultLambdaJsonSerializer))]
    public string LambdaTestFunc(string input, ILambdaContext context)
    {
        return $"こんにちは: {input}さん";
    }
    #endregion (LambdaTestFunc)

ソリューションエクスプローラーでプロジェクトを右クリック, Publish to AWS Lambda...をクリック。
以下のように入力を行う。FunctionNameとDescriptionにはそれぞれLambda関数名と簡単な説明を入力する。
Lambda関数に与える権限とタイムアウト時間、メモリを設定する。
- 権限にはBasicExecutionRoleを設定した。ReadOnlyと違って,Console.WriteLineがメソッドでログをCloudWatchに出力できるようになるためである。

VisualStudioでのテスト

VisualStudio上でFunctionウィンドウからLambda上の関数を呼び出すことができる。
左側のテキストボックスが入力で、Invokeボタンで呼び出す。返答は右に表示される。

AWSでのテスト

AWSコンソール上でもLambdaでテストしたい関数を開くことでテストができる。

LambdaをAPIGateway経由で呼び出そう

今度は発行したLambda関数をAPIとして呼び出せるようにします

NugetからNewtonsoft.JsonとAmazon.Lambda.Serialization.Jsonを取得。

Lambda関数の戻り値をAPIGatewayに対応させるため、新しいクラスを作成する。
実際にはLambda関数はこのクラスを戻り値といて返しますが、Jsonに変換されてAPIGatewayに渡されます。

HttpStatusCodeやIsBase64Encoded, HeadersプロパティはAPIGatewayが参照する情報で、ユーザに渡したい値はBodyに文字列として渡します。クラスの情報を渡したい時はJson文字列にシリアライズして渡します。
JsonProperty属性はJsonに変換される際のキー名です。(指定しなかった場合プロパティ名がキーとなります。)
APIGatewayに合わせてキー名がキャメルケースになるようにしています

// ===================================================================================
#region LambdaResponse：Lambda関数の返答クラス
// ===================================================================================
/// <summary>
/// Lambda関数が戻り値として使用するクラスです。
/// 実際にはJsonにシリアライズされて返されます。
/// </summary>
public class LambdaResponse
{
    // ===============================================================================
    #region プロパティ
    // ===============================================================================
    /// <summary>Base64エンコードが行われているか</summary>
    [JsonProperty(PropertyName = "isBase64Encoded")]
    public bool IsBase64Encoded;

    /// <summary>HTTPのステータスコード</summary>
    [JsonProperty(PropertyName = "statusCode")]
    public HttpStatusCode StatusCode;
    /// <summary>HTTPのヘッダ情報</summary>
    [JsonProperty(PropertyName = "headers")]
    public Dictionary<string, string> Headers;
    /// <summary>本体メッセージ</summary>
    [JsonProperty(PropertyName = "body")]
    public string Body;
    #endregion (プロパティ)
}
#endregion (LambdaResponseクラス)

APIGatewayに対応した新しいメソッドをLambdaに発行する。

    // -------------------------------------------------------------------------------
    #region +APIGatewayGetTest：APIGatewayのGETメソッドテスト用の簡単な関数
    // -------------------------------------------------------------------------------
    /// <summary>
    /// APIGatewayのGETメソッドをテストするメソッドです。
    /// Lambdaに登録されAPIGatewayのGETメソッドを通して呼び出されます。
    /// </summary>
    /// <param name="input">入力</param>
    /// <param name="context">関数とリクエストに関する情報を持つ[コンテキストオブジェクト]</param>
    /// <returns></returns>
    public LambdaResponse APIGatewayGetTest(object input, ILambdaContext context)
    {
        return new LambdaResponse() {
            IsBase64Encoded = false,
            StatusCode = HttpStatusCode.OK,
            Headers = new Dictionary<string, string>()
                {
                    {"my_header", "my_value" }
                },
            Body = $"こんにちは!!",
        };
    }
    #endregion (APIGatewayGetTest)

発行したLambdaメソッドを呼び出したときの戻り値は以下のようにJsonになっています。

{
    "isBase64Encoded" : false,
    "statusCode"      : 200,
    "headers"         : {
        "my_header" : "my_value"
    },
    "body"            : "こんにちは!!"
}

注意点: 引数を取らないとき変数inputの型は必ずobject型にしてください。RESTAPIから呼び出したときに以下のエラーが出ます。

AWSコンソールからAPIGatewayを開き、APIの作成を選択。

APIのタイプにREST APIを選択。
設定画面は以下のように選択する。プロトコルでWebSocketを選択すると、WebSocketによりコネクションを作って通信するAPIとなるが、今回はRESTでいい。
アクション -> メソッドの作成を選択。
今回はGETメソッドを選択。
Lambdaに発行した関数をAPIから呼び出すように登録する。
作成したRESTAPIを呼び出すと、以下のようになる。
レスポンスの本文はBodyプロパティの文字列になっているのがわかる。

REST APIをデプロイ

AWSコンソールのAPIの画面に戻り、アクション -> APIのデプロイを選択。
デプロイされるステージに新しいステージを選択。ステージ名はURLにおけるパスになる。
以下のような設定画面が出るが、とりあえずデフォルトのままにして設定の保存を選択。
AWSLambdaの画面に戻ると、APIGatewayがLambda関数に登録されているのがわかる。

ここをクリックすると、エンドポイントのURLが表示される。
(念のため隠しておきます)

このURLからAPIGatewayを通じてLambda関数を呼び出すことができる。