# Java の Lambda 関数ハンドラーの定義
Lambda 関数*ハンドラー*は、イベントを処理する関数コード内のメソッドです。関数が呼び出されると、Lambda はハンドラーメソッドを実行します。関数は、ハンドラーが応答を返すか、終了するか、タイムアウトするまで実行されます。
このページでは、プロジェクトのセットアップオプション、命名規則、ベストプラクティスなど、Java で Lambda 関数ハンドラーを使用する方法について説明します。このページには、注文に関する情報を取得し、テキストファイル受信を生成し、このファイルを Amazon Simple Storage Service (Amazon S3) バケットに配置する Java Lambda 関数の例も含まれています。関数を書き込んだ後にデプロイする方法については、「[.zip または JAR ファイルアーカイブで Java Lambda 関数をデプロイする](java-package.md)」または「[コンテナイメージを使用した Java Lambda 関数のデプロイ](java-image.md)」を参照してください。
**Topics**
+ [
## Java ハンドラープロジェクトのセットアップ
](#java-handler-setup)
+ [
## Java Lambda 関数のコードの例
](#java-example-code)
+ [
## Java ハンドラーの有効なクラス定義
](#java-handler-signatures)
+ [
## ハンドラーの命名規則
](#java-example-naming)
+ [
## 入力イベントオブジェクトの定義とアクセス
](#java-handler-input)
+ [
## Lambda コンテキストオブジェクトへのアクセスと使用
](#java-example-context)
+ [
## ハンドラーでの AWS SDK for Java v2 の使用
](#java-example-sdk-usage)
+ [
## 環境変数にアクセスする
](#java-example-envvars)
+ [
## グローバルな状態を使用する
](#java-handler-state)
+ [
## Java Lambda 関数のコードのベストプラクティス
](#java-best-practices)
## Java ハンドラープロジェクトのセットアップ
Java で Lambda 関数を使用する場合、このプロセスにはコードの記述、コンパイル、コンパイルされたアーティファクトの Lambda へのデプロイが含まれます。Java Lambda プロジェクトはさまざまな方法で初期化できます。例えば、[Lambda 関数の Maven Archetype](https://github.com/aws/aws-sdk-java-v2/tree/master/archetypes/archetype-lambda)、AWS SAM CLI [sam init コマンド](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-init.html)、または IntelliJ IDEA や Visual Studio Code といった任意の IDE での標準 Java プロジェクト設定などのツールを使用できます。または、必要なファイル構造を手動で作成することもできます。
一般的な Java Lambda 関数プロジェクトは、次の一般的な構造に従います。
```
/project-root
└ src
└ main
└ java
└ example
└ OrderHandler.java (contains main handler)
└
└ build.gradle OR pom.xml
```
Maven または Gradle を使用してプロジェクトを構築し、依存関係を管理できます。
関数のメインハンドラーロジックは、`src/main/java/example` ディレクトリの Java ファイルにあります。このページの例では、このファイルに `OrderHandler.java` という名前を付けます。このファイルとは別に、必要に応じて追加の Java クラスを含めることができます。関数を Lambda にデプロイする際は、呼び出し中に Lambda が呼び出すメインハンドラーメソッドを含む Java クラスを必ず指定してください。
## Java Lambda 関数のコードの例
以下の Java 21 Lambda 関数コードの例では、注文に関する情報を取得し、テキストファイル受信を生成し、このファイルを Amazon S3 バケットに配置します。
**Example `OrderHandler.java` Lambda 関数**
```
package example;
import com.amazonaws.services.lambda.runtime.Context;
import com.amazonaws.services.lambda.runtime.RequestHandler;
import software.amazon.awssdk.core.sync.RequestBody;
import software.amazon.awssdk.services.s3.S3Client;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.s3.model.S3Exception;
import java.nio.charset.StandardCharsets;
/**
* Lambda handler for processing orders and storing receipts in S3.
*/
public class OrderHandler implements RequestHandler {
private static final S3Client S3_CLIENT = S3Client.builder().build();
/**
* Record to model the input event.
*/
public record Order(String orderId, double amount, String item) {}
@Override
public String handleRequest(Order event, Context context) {
try {
// Access environment variables
String bucketName = System.getenv("RECEIPT_BUCKET");
if (bucketName == null || bucketName.isEmpty()) {
throw new IllegalArgumentException("RECEIPT_BUCKET environment variable is not set");
}
// Create the receipt content and key destination
String receiptContent = String.format("OrderID: %s\nAmount: $%.2f\nItem: %s",
event.orderId(), event.amount(), event.item());
String key = "receipts/" + event.orderId() + ".txt";
// Upload the receipt to S3
uploadReceiptToS3(bucketName, key, receiptContent);
context.getLogger().log("Successfully processed order " + event.orderId() +
" and stored receipt in S3 bucket " + bucketName);
return "Success";
} catch (Exception e) {
context.getLogger().log("Failed to process order: " + e.getMessage());
throw new RuntimeException(e);
}
}
private void uploadReceiptToS3(String bucketName, String key, String receiptContent) {
try {
PutObjectRequest putObjectRequest = PutObjectRequest.builder()
.bucket(bucketName)
.key(key)
.build();
// Convert the receipt content to bytes and upload to S3
S3_CLIENT.putObject(putObjectRequest, RequestBody.fromBytes(receiptContent.getBytes(StandardCharsets.UTF_8)));
} catch (S3Exception e) {
throw new RuntimeException("Failed to upload receipt to S3: " + e.awsErrorDetails().errorMessage(), e);
}
}
}
```
この `OrderHandler.java` ファイルには以下のコードのセクションが含まれます:
+ `package example`: Java では、これは任意のものにできますが、プロジェクトのディレクトリ構造と一致する必要があります。ここでは、ディレクトリ構造が `src/main/java/example` であるため、`package example` を使用します。
+ `import` ステートメント: これらを使用して、Lambda 関数に必要な Java クラスをインポートします。
+ `public class OrderHandler ...`: これは Java クラスを定義します。また、[有効なクラス定義](#java-handler-signatures)である必要があります。
+ `private static final S3Client S3_CLIENT ...`: これにより、クラスのメソッドの外部で S3 クライアントが初期化されます。これにより、Lambda は[初期化フェーズ](lambda-runtime-environment.md#runtimes-lifecycle-ib)中にこのコードを実行します。
+ `public record Order ...`: このカスタム Java [レコード](https://openjdk.org/jeps/395)で予想される入力イベントの形状を定義します。
+ `public String handleRequest(Order event, Context context)`: これは**メインハンドラーメソッド**で、メインアプリケーションロジックが含まれています。
+ `private void uploadReceiptToS3(...) {}`: これは、メイン `handleRequest` ハンドラーメソッドによって参照されるヘルパーメソッドです。
### build.gradle および pom.xml ファイルのサンプル
次の `build.gradle` または `pom.xml` ファイルは、この関数に付随します。
------
#### [ build.gradle ]
```
plugins {
id 'java'
}
repositories {
mavenCentral()
}
dependencies {
implementation 'com.amazonaws:aws-lambda-java-core:1.2.3'
implementation 'software.amazon.awssdk:s3:2.28.29'
implementation 'org.slf4j:slf4j-nop:2.0.16'
}
task buildZip(type: Zip) {
from compileJava
from processResources
into('lib') {
from configurations.runtimeClasspath
}
}
java {
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
}
build.dependsOn buildZip
```
------
#### [ pom.xml ]
```
4.0.0
com.example
example-java
jar
1.0-SNAPSHOT
example-java-function
UTF-8
21
21
com.amazonaws
aws-lambda-java-core
1.2.3
software.amazon.awssdk
s3
2.28.29
org.slf4j
slf4j-nop
2.0.16
maven-surefire-plugin
3.5.2
org.apache.maven.plugins
maven-shade-plugin
3.4.1
false
*:*
META-INF/*
META-INF/versions/**
package
shade
org.apache.maven.plugins
maven-compiler-plugin
3.13.0
21
```
------
この関数が正しく機能するには、[実行ロール](lambda-intro-execution-role.md)で `s3:PutObject` アクションを許可する必要があります。また、必ず `RECEIPT_BUCKET` 環境変数を定義してください。呼び出しに成功したら、Amazon S3 バケットに受信ファイルが含まれているはずです。
**注記**
この関数がタイムアウトすることなく正常に実行されるには、追加の構成設定が必要になる場合があります。メモリを 256 MB、タイムアウトを 10 秒に設定することをお勧めします。[コールドスタート](lambda-runtime-environment.md#cold-start-latency)により、最初の呼び出しにさらに時間がかかる場合があります。実行環境が再利用されるため、それ以降の呼び出しはより高速に実行されます。
## Java ハンドラーの有効なクラス定義
クラスを定義するために、[aws-lambda-java-core](https://github.com/aws/aws-lambda-java-libs/tree/master/aws-lambda-java-core) ライブラリは、ハンドラーメソッドの 2 つのインターフェイスを定義します。用意されているインターフェイスを使用して、ハンドラー設定をシンプルにし、コンパイル時にメソッドシグネチャを検証します。
+ [com.amazonaws.services.lambda.runtime.RequestHandler](https://github.com/aws/aws-lambda-java-libs/blob/master/aws-lambda-java-core/src/main/java/com/amazonaws/services/lambda/runtime/RequestHandler.java)
+ [com.amazonaws.services.lambda.runtime.RequestStreamHandler](https://github.com/aws/aws-lambda-java-libs/blob/master/aws-lambda-java-core/src/main/java/com/amazonaws/services/lambda/runtime/RequestStreamHandler.java)
`RequestHandler` インターフェイスは、入力タイプと出力タイプの 2 つのパラメータを受け取る汎用タイプです。どちらのタイプもオブジェクトであることが必要です。この例では、`OrderHandler` クラスは `RequestHandler` を実装します。入力タイプはクラス内で定義する `Order` レコードで、出力タイプは `String` です。
```
public class OrderHandler implements RequestHandler {
...
}
```
このインターフェイスを使用すると、Java ランタイムはイベントを入力タイプのオブジェクトに逆シリアル化し、出力をテキストにシリアル化します。組み込みのシリアル化が入力タイプと出力タイプで機能する場合は、このインターフェイスを使用します。
独自のシリアル化を使用するために、`RequestStreamHandler` インターフェイスを実装できます。このインターフェイスでは、Lambda はハンドラーに入力ストリームと出力ストリームを渡します。ハンドラーは、入力ストリームからバイトを読み取り、出力ストリームに書き込み、void を返します。Java 21 ランタイムを使用したこの例については、「[HandlerStream.java](https://github.com/awsdocs/aws-lambda-developer-guide/tree/main/sample-apps/java-basic/src/main/java/example/HandlerStream.java)」を参照してください。
Java 関数で基本型と汎用型 (`String`、`Integer`、`List` または `Map`) のみを使用している場合は、インターフェイスを実装する必要はありません。例えば、関数が `Map` 入力を受け取り、`String` を返す場合、クラス定義とハンドラー署名は次のようになります。
```
public class ExampleHandler {
public String handleRequest(Map input, Context context) {
...
}
}
```
さらに、インターフェイスを実装しない場合、[コンテキスト](java-context.md)オブジェクトはオプションです。例えば、クラス定義とハンドラー署名は次のようになります。
```
public class NoContextHandler {
public String handleRequest(Map input) {
...
}
}
```
## ハンドラーの命名規則
Java の Lambda 関数では、`RequestHandler` または `RequestStreamHandler` インターフェイスを実装する場合、メインハンドラーメソッドの名前は `handleRequest` である必要があります。また、`handleRequest` メソッドの上に `@Override` タグを含めます。関数を Lambda にデプロイするときは、関数の設定でメインハンドラーを次の形式で指定します。
+ **.** – 例: `example.OrderHandler`。
`RequestHandler` または `RequestStreamHandler` インターフェイスを実装しない Java の Lambda 関数の場合、ハンドラーには任意の名前を使用できます。関数を Lambda にデプロイするときは、関数の設定でメインハンドラーを次の形式で指定します。
+ **.**::** – 例: `example.Handler::mainHandler`。
## 入力イベントオブジェクトの定義とアクセス
JSON は Lambda 関数の最も一般的な標準入力形式です。この例では、関数は以下のような入力を想定しています:
```
{
"orderId": "12345",
"amount": 199.99,
"item": "Wireless Headphones"
}
```
Java 17 以降で Lambda 関数を使用する場合、予想される入力イベントの形状を Java レコードとして定義できます。この例では、`Order` オブジェクトを表すレコードを `OrderHandler` クラス内で定義します。
```
public record Order(String orderId, double amount, String item) {}
```
このレコードは、予想される入力形状と一致します。レコードを定義したら、レコード定義に準拠する JSON 入力を取り込むハンドラー署名を記述できます。Java ランタイムは、この JSON を Java オブジェクトに自動的に逆シリアル化します。その後、オブジェクトのフィールドにアクセスできます。例えば、`event.orderId` は元の入力から `orderId` の値を取得します。
**注記**
Java レコードは、Java 17 ランタイム以降の機能です。すべての Java ランタイムで、クラスを使用してイベントデータを表すことができます。このような場合は、[jackson](https://github.com/FasterXML/jackson) などのライブラリを使用して JSON 入力を逆シリアル化できます。
### その他の入力イベントタイプ
Java の Lambda 関数には、多くの入力イベントが考えられます。
+ `Integer``Long` 、`Double`、など － イベントは、追加の形式のない数値です (`3.5` など)。Java ランタイムは、値を指定されたタイプのオブジェクトに変換します。
+ `String` － イベントは、引用符を含む JSON 文字列です ( など)`“My string”`。ランタイムは、値を引用符なしの `String` オブジェクトに変換します。
+ `List``List` 、`List