【第3回】サーバレス開発(3)AWS API Gatewayの利用¶
クラウド時代が到来し、ますます広がりを見せつつあるサーバレス開発。初回はAWS LambdaとAPI Gatewayを使ったサーバレス環境下でSpringアプリケーションを構築する方法を解説します。
前回の記事「 【第2回】サーバレス開発(2)Amazon Lambdaの利用 」ではサーバレスアプリケーションをAWS Lambdaへ登録しました。 今回は、Amazon API Gatewayを設定して、登録したLambda関数を呼び出してみましょう。
Amazon API Gatewayの設定¶
リクエストを受け付けて、設定したAWS Lambdaを実行するためのAPI Gatewayの設定を行います。AWSコンソールの API Gatewayサービスメニューから、以下を入力して、「APIの作成」を押下してください。
- Protocol : REST
- 新しいAPIの作成：新しいAPI
- API名：任意の名前を入力
- エンドポイントタイプ：リージョン
API作成後、「アクション」ボタンから「リソースの作成」を選択します。
リソース名とリソースパスを設定し、「リソースの作成」ボタンを押下します。
作成したリソースを選択し、再び「アクション」メニューからメソッドの作成を選択し、POSTメソッドを選択、チェックボタンを押下します。
警告
GETメソッドを指定すると、SpringBootApiGatewayRequestHandlerでは、JSONリクエストボディがなくなるため、エラーになります。2019.1月現在、この問題は ISSUE として起票されています
以下の設定内容に従って、POSTメソッドのセットアップを行い、「保存」ボタンを押下します。
- 統合タイプ：Lambda関数
- Lambdaプロキシ統合の使用：チェックする
- Lambdaリージョン：Lambdaを作成したリージョン
- Lamnda関数：前節で作成したLambda関数名を選択する。
- デフォルトタイムアウトの使用：チェックする
警告
Lambdaプロキシ統合をチェックしないと、Lambdaファンション側にSpring Cloud Functionが期待するデータが来ないのでエラーとなります。忘れないようにチェックしておきましょう。なお、Lambdaプロキシ統合をチェックしないとエラーになる理由は、今回ハンドラクラスで継承したSpringBootApiGatewayRequestHandlerが、型パラメータとしてcom.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEventを指定しているためです。Lambdaプロキシ統合でなければ、上記の型パラメータクラスに必要な情報が渡って来ないため、NullPointerExceptionでエラーになります。
設定したLambda関数が正しく動くか動作テストを実施します。「テスト」リンクを押下します。
以下の項目を入力し、「テスト」ボタンを押下します。レスポンス本文に「Complete!」と表示されればアップロードしたサーバレスアプリケーションが正常に実行された結果です。
- リクエスト本文：{"test":"TestMessage"}
Lambda関数が正常に実行できることは確認できましたが、外からAPIをコールするためには、APIをデプロイすることが必要です。「アクション」メニューから「APIのデプロイ」を選択します。
デプロイされるステージとして、「新しいステージ」を選択し、任意の名前を入力し、「デプロイ」ボタンを押下します。ステージ名はエンドポイントURLにも反映されるため、「prod」や「dev」などにするのが一般的です。
APIがデプロイされると、エンドポイントのURLが表示されます。このURLにリソース名を加えたものがリソースURLになります。
設定が終わったら、実際に外部のローカルクライアントから、curlコマンドなどでリクエストを送信し、実行結果を確認してみましょう。エンドポイントURLの最後にリソース名を付与するのを忘れないでください。
curl -d '{"test":"TestMessage"}' https://xxxxxxxx.execute-api.ap-northeast-1.amazonaws.com/dev/sample
コマンドを実行した結果、"Complete!"というメッセージが返却されるのに加えて、CloudWatch Logsには、実行したLambda関数の結果が表示されます。
注釈
Lambda関数の初回起動時はSpringFrameworkの起動でAPIリクエストを送信してから実行までに少々時間がかかります。２回目以降は実行環境が再利用されるので、即時処理されますが、実行環境は一定時間経つと破棄されるので、そうした制約を考慮しておきましょう。
まとめ¶
AWS LambdaやAmazon API Gateway、Spring Cloud Functionを利用することにより、ごくごく少量のコーディングで、サーバレスアプリケーションを実行することができます。 このサーバレス開発のスタックはとても簡易で、かつ拡張性も高く、エンタープライズ開発でも十分有用です。
