マイナビニュースマイナビ

AWS Lambdaにおけるサーバレスエラーハンドリング(2)

【連載】

AWSで作るクラウドネイティブアプリケーションの応用

【第7回】AWS Lambdaにおけるサーバレスエラーハンドリング(2)

[2021/03/22 08:00]川畑光平 ブックマーク ブックマーク

本連載では、以下の図のようなAWS Lambdaを使ったサーバレス処理でのエラーハンドリング方法を解説しています。

イメージ

前回は、Lambdaファンクションのエラーハンドリングの特徴と代表的なパターン、エラーの概念/対処の考え方を説明しました。今回からはAPI GatewayとLambdaおよびSpringCloudFuntionを使って構築したLambdaを同期的に呼び出した場合に発生したエラーの取り扱い方や環境構築方法を解説します。

なお、Lambdaファンクションは以下のランタイム/ライブラリを使って実装してくものとします。

動作対象 バージョン
Java 11
Spring Boot 2.3.8.RELEASE
Spring Cloud Function 3.0.11.RELEASE
Spring Cloud AWS 2.2.5.RELEASE
AmazonSDK Lambda Java event 2.0.2
AmazonSDK Lambda Java core 1.1.0
AmazonSDK Java 1.11.923

AWS Lambdaの同期ビジネスエラー実装とライブラリ/パッケージの構成

まず最初のケースでは、AWS Lambdaで同期呼び出しのビジネスエラーについて考えます。同期型のビジネスエラーに関しては、Lambdaファンクション中で発生したエラーをユーザーに通知すれば良いので、以下のイメージの赤い矢印がスコープとなります。ここのLambdaファンクションの実装を進めていきます。

スコープ

これまでの連載(基本編第1回応用編第4回)でも、Spring Cloud Functionを使用したLambdaファンクションの実装について解説してきました。しかし、Spring Cloud Functionがバージョン3.1以降、フレームワークの使い方に少し大きめの修正があり、org.springframework.cloud.function.adapter.aws.FunctionInvokerを使う方法にシフトしています。

そこで、今回はこのFunctionInvokerを使ったプログラミングモデルによる同期エラー実装と、アプリケーションのパッケージ構成について、3.1よりも前のバージョンとの差分に触れながら解説を進めていきたいと思います。

なお、実際に作成したアプリケーションはGitHub上にコミットしています。以降のソースコードでは本質的でない記述を一部省略しているので、実行コードを作成する場合は、必要に応じて適宜GitHub上のソースコードも参照してください。

アプリケーションの実装に必要なライブラリ

アプリケーションの実装に必要なライブラリはこれまでと同様、以下の通りです。ただし、後の非同期での実装を含め、SQSやSystemsManager ParameterStoreへアクセスするので、Spring Cloud AWSとSDKのライブラリのライブラリを追加します。

また、Mattermostのようなチャットコミュニケーションツールのチャネルにメッセージを通知するためにWebClientを使用するので、spring-boot-starter-webfluxも追加しています。各マネージドサービスのエンドポイント情報などは、CloudFormationのスタック経由から取得しますが、スタックでエクスポートした名称を保持しておくためのプロパティクラスを使用するために、 spring-boot-configuration-processorを含めておいてください。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-function-context</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-function-adapter-aws</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-aws</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-aws-messaging</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-lambda-java-events</artifactId>
    <version>2.0.2</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-lambda-java-core</artifactId>
    <version>1.1.0</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-ssm</artifactId>
    <version>1.11.923</version>
</dependency>
<dependency>
    <groupId>com.amazonaws</groupId>
    <artifactId>aws-java-sdk-core</artifactId>
    <version>1.11.923</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

ファンクションクラスの実装

さて、Spring Cloud Functionの使用方法ですが、これまでリクエストをハンドリングするために使用してきたSpringBootRequestHandlerクラスは、バージョン3.1以降では非推奨です。そのため、ハンドラクラスを実装せずに、FunctionInvokerを使ってファンクションが実行されます。

FunctionInvokerにはLambdaのJava言語実装で必要になるhandleメソッドが実装されており、開発者はファンクションクラスを作成するだけで済みます。FunctionInvokerは、API Gatewayをはじめ、S3イベントやKinesis、SNSといった複数のAWSマネージドサービスからのリクエストをサポートしていますが、連載「AWSで実践!基盤・デプロイ自動化」の第41回で解説した CloudFormationのLambda-backedカスタムリソースのように、対応していないマネージドサービスのリクエストがいくつかあります。その場合は、FunctionInvokerを継承して、必要なリクエストハンドリング処理をオーバーライドして実装するようにしましょう。

FunctionInvokerから実行される、同期的なビジネスエラーハンリングを実装したファンクションクラスは以下の通りです。

package org.debugroom.mynavi.sample.aws.lambda.errorhandling.app.function;

import java.util.function.Function;

import org.springframework.messaging.Message;
import org.springframework.messaging.MessageHeaders;
import org.springframework.messaging.support.MessageBuilder;

import org.debugroom.mynavi.sample.aws.lambda.errorhandling.app.model.SampleResource;
import org.debugroom.mynavi.sample.aws.lambda.errorhandling.common.exception.BusinessException;
import org.debugroom.mynavi.sample.aws.lambda.errorhandling.domain.service.CheckParameterService;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class SyncExecuteBusinessErrorFunction implements Function<Map<String, Object>, Message<SampleResource>> {
                                                                                              // (1)

    @Autowired
    CheckParameterService checkParameterService; //(2)

    @Override
    public Message<SampleResource> apply(Map<String, Object> stringObjectMap) { //(3)

        log.info(this.getClass().getName() + " has started!");
        log.info("[Input]" + stringObjectMap.toString());

        Map<String, Object> queryStringParameters = (Map)stringObjectMap.get("queryStringParameters");
        try{
            checkParameterService.execute(queryStringParameters); //(4)
        }catch (BusinessException e){ //(5)
            Map<String, Object> headers = new HashMap<>();
            headers.put("statusCode", 400); //(6)
            MessageHeaders messageHeaders = new MessageHeaders(headers);
            return MessageBuilder.createMessage(
                 SampleResource.builder().message("No query string parameters.").build(), messageHeaders); //(7)
        }
        return MessageBuilder.withPayload(
             SampleResource.builder().message(queryStringParameters.toString()).build()).build(); //(8)
    }

}

各コードの詳細は以下の通りです。

項番 説明
1 java.util.Functionクラスを実装します。インプットデータの型としてMapクラスを、アウトプット型として、返却するクラスオブジェクトSampleResourceを型パラメータに指定したorg.springframework.messaging.Messageを指定します
2 ビジネス例外(アプリケーションのビジネスロジックとして想定される例外)が発生するサービスクラスとして、リクエストパラメータの有無をチェックし、ビジネス例外クラスをスローするCheckParameterServiceを使用します
3 FunctionInvokerクラスから、オーバーライドしたapply()メソッドがコールされます。リクエストパラメータおよびメタデータをMap型で受け取れます
4 インプットMapオブジェクトからクエリ文字列パラメータを取得し、チェックします。ここでは、クエリ文字列がないとビジネス例外をスローするようにしています(クエリ文字列があれば何もしません)
5 ビジネス例外が発生した場合、例外をキャッチして、呼び出し元のユーザーにエラー内容を通知する処理を実装します
6 SpringCloud Funtion3.1以降では、MessageHeaderに"statusCode"を設定して返却すると、API Gatewayから返却するレスポンスのステータスコードを指定することができます。ここでは、送信されたリクエストが不適切なことを示す400を設定しています
7 ビジネスエラー発生時、返却するメッセージのボディ部に設定するSampleResourceオブジェクトとして、メッセージを指定したMessageクラスを返却します
8 正常終了時、返却するメッセージのボディ部に設定するSampleResourceオブジェクトとして、メッセージを指定したMessageクラスを返却します

上記の実装を見てお気付きの方もいるかもしれませんが、ここではファンクションクラスの責務として「リクエストからパラメータを取り出し、ビジネス処理を実行して、エラーであればステータスコードを設定する」といった、Spring MVCのControllerクラスに相当する処理が実装されています。

ファンクションクラス自体にビジネス処理を実装するのもシンプル化の観点から悪くない方法です。ただし、例外ハンドリングの実装が複雑化することや単体テストの観点からは、ファンクションクラスはコントローラが持つ単一責務を負うものとして実装したほうがコードの見通しがすっきりします。

そこで、本連載では、連載「AWSで実践!基盤・デプロイ自動化」の第4回で解説したパッケージ構成に倣い、以下のようにLambdaファンクションのパッケージを構成します。

パッケージ構成

また、アプリケーションの設定ファイルを以下の通り設定しておきます。

cloud:
  aws:
    credentials:
      profileName:
      instanceProfile: false
    stack:
      auto: false
    region:
      auto: false
      static: ap-northeast-1                                                 #(A)
spring:
  main:
    web-application-type: none                                               #(B)
  cloud:
    function:
      scan:
        packages: org.debugroom.mynavi.sample.aws.lambda.errorhandling.app.function
                                                                             #(C)
logging:
  level:
    com:
      amazonaws:
        util:
          EC2MetadataUtils : error                                           #(D)
service:
  systems-manager-parameter-store:
    mattermost:
      in-comming-webhook: sample-aws-lambda-errorhandling-mattermost-webhook-url
                                                                             #(E)
項番 説明
A Spring Cloud AWSで起動時に実行されるインスタンスプロファイル、実行リージョン、スタック情報の自動取得をオフにしておきます
B WebClientの利用で追加したspring-boot-starter-webfluxがデフォルトだとファンクション実行時に組み込みアプリケーションサーバを起動してしまうため、設定をオフにしておきます。
C ファンクションクラスがあるパッケージを指定します
D Lambdaで実行されるものの、Spring Cloud AWSがファンクション起動時にEC2インスタンスメタデータを取得しようとして失敗するため、エラーが出力されても問題なように設定しておきます
E SystemsManager ParameterStoreからMattermostのWebhookURLを取得するためのキー名を指定します。MattermostのWebhookについては次回以降改めて説明します

* * *

今回はSpring Cloud Function 3.1以降のLambdaファンクションの実装方法やパッケージ構成を解説しました。次回は、API GatewayとLambdaをCloudFormationを使って構築し、Lambdaを同期的に呼び出す環境構築方法を解説します。

著者紹介


川畑 光平(KAWABATA Kohei) - NTTデータ
エグゼクティブ ITスペシャリスト ソフトウェアアーキテクト・デジタルテクノロジーストラテジスト(クラウド)

金融機関システム業務アプリケーション開発・システム基盤担当、ソフトウェア開発自動化関連の研究開発を経て、デジタル技術関連の研究開発・推進に従事。

Red Hat Certified Engineer、Pivotal Certified Spring Professional、AWS Certified Solutions Architect Professional等の資格を持ち、アプリケーション基盤・クラウドなど様々な開発プロジェクト支援にも携わる。AWS Top Engineers & Ambassadors選出。

本連載の内容に対するご意見・ご質問は Facebook まで。

※ 本記事は掲載時点の情報であり、最新のものとは異なる場合がございます。予めご了承ください。

一覧はこちら

連載目次

関連リンク

この記事に興味を持ったら"いいね!"を Click
Facebook で TECH+ の人気記事をお届けします
注目の特集/連載
[解説動画] Googleアナリティクス分析&活用講座 - Webサイト改善の正しい考え方
Slackで始める新しいオフィス様式
Google Workspaceをビジネスで活用する
ニューノーマル時代のオウンドメディア戦略
ミッションステートメント
次世代YouTubeクリエイターの成長戦略
IoTでできることを見つけるための発想トレーニング
教えてカナコさん! これならわかるAI入門
AWSではじめる機械学習 ~サービスを知り、実装を学ぶ~
Kubernetes入門
SAFeでつくる「DXに強い組織」~企業の課題を解決する13のアプローチ~
マイクロサービス時代に活きるフレームワーク Spring WebFlux入門
AWSで作るマイクロサービス
マイナビニュース スペシャルセミナー 講演レポート/当日講演資料 まとめ
セキュリティアワード特設ページ

一覧はこちら

今注目のIT用語の意味を事典でチェック!

一覧はこちら

会員登録(無料)

ページの先頭に戻る