Amazon S3でtry-with-resources文を使う

try-with-resources文とは何か？

Java7から追加された新しい記述法です。データベースアクセスやファイルアクセスのプログラムを書くとき、なんだかtry-catchを大量を書いてうんざりしていませんでしたか？try-with-resources文は、これを解決する方法です！

以下は、今まで通りの書き方となっています。tryブロックの途中で例外が発生する場合に備えて、finallyブロックでオブジェクトのクローズ処理を入れています。

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;

public class JdbcOld {

	public static void main(String[] args) {
		Connection conn = null;
		Statement stmt = null;
		ResultSet rs = null;
		String url = "jdbc:mysql://localhost/test?user=uuu&password=ppp";
		try {
			Class.forName("com.mysql.jdbc.Driver").newInstance();
			conn = DriverManager.getConnection(url);
			stmt = conn.createStatement();
			rs = stmt.executeQuery("SELECT foo FROM bar");
			
			while (rs.next()) {
				System.out.println(rs.getString(1));
			}
			
		} catch (ClassNotFoundException ex) {
			ex.printStackTrace();
		} catch (SQLException ex) {
			ex.printStackTrace();
		} catch (InstantiationException ex) {
			ex.printStackTrace();
		} catch (IllegalAccessException ex) {
			ex.printStackTrace();
		} finally {
			try {
				if (rs != null && !rs.isClosed()) {
					rs.close();
				}
				if (stmt != null && !stmt.isClosed()) {
					stmt.close();
				}
				if (conn != null && !conn.isClosed()) {
					conn.close();
				}
			} catch (SQLException ex) {
				ex.printStackTrace();
			}
		}
	}
}

次に、try-with-resources文を使った同じ目的のプログラムです。ポイントは、try宣言の後に自動でクローズしたい処理を実行しています。以前まではfinallyブロックでクローズ処理を書かないと外部リソースとの切断処理漏れとなってしまい、メモリリークなどが発生していましたが、自動対応になってくれたので記述が大幅に減りました。

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.Statement;

public class JdbcNew {

	public static void main(String[] args) {
		String url = "jdbc:mysql://localhost/test?user=uuu&password=ppp";
		try (
				Connection conn = DriverManager.getConnection(url); 
				Statement stmt = conn.createStatement(); 
				ResultSet rs = stmt.executeQuery("SELECT foo FROM bar")) {
			
			Class.forName("com.mysql.jdbc.Driver").newInstance();
			while (rs.next()) {
				System.out.println(rs.getString(1));
			}
			
		} catch (Exception ex) {
			System.out.println(ex);
		}
	}
}

Closeableインタフェース

Java6まではファイルアクセス関連のクラスにCloseableインタフェースが実装されていまして、自動的なクローズ処理ができるようになっていました。Java7からはこれを拡張し、AutoCloseableインタフェースを実装していればどんなクラスでも自動クローズ処理を行ってくれます！そして、AutoCloseableインタフェーズのサブインタフェースとして、Closeableインタフェースが定義されていますので、Closeableインタフェースを実装したクラスであれば、同じく自動クローズ処理を行ってくれるんですね。以下にクラス間の関係をUMLで表してみました。

S3Objectクラス

つい先日リリースされたAWS SDK for Java(1.4.8以上)では、Closeableインタフェースに対応したS3Objectクラスが出て来ました。今までの書き方とこれからの書き方を比較してみましょう。

以下はいままでの書き方です。

S3ObjectInputStream is = null;
try {
	S3Object object = s3.getObject(new GetObjectRequest(bucketName, key));
	is = object.getObjectContent();
} catch (AmazonClientException ex) {
	ex.printStackTrace();
} finally {
	if (is != null) {
		is.close();
	}
}

次に新しい書き方です。

try (S3Object object = s3.getObject(new GetObjectRequest(bucketName, key))) {
	S3ObjectInputStream is = object.getObjectContent();
} catch (AmazonClientException ex) {
	ex.printStackTrace();
}

少しだけすっきりしましたね。ストリームの閉じ忘れを心配する必要がなくなりました。

まとめ

Java7のtry-with-resources文とAutoCloseableインタフェースによって、生成したインスタンスオブジェクトの解放忘れを防ぐことができるようになりました。これは、java.io、java.nio、java.sqlなどの外部リソースに対してコネクションを張ってアクセスする場合において有効です。また、AWS SDKのように独自にAPIを開発する場合も、基底クラスで外部アクセスをしている場合、Closeableインタフェースを実装するようなクラス設計にすることで、SDK利用者のコードミスを減らし、高品質なアプリケーション開発を助けます。

参照資料

AWS Blogs - Java Development - Closeable S3Objects

JDK 7 - java.io - Interface - Closeable

JDK 6 - java.io - Interface - Closeable

com.amazonaws.services.s3.model - Class S3Object

Java 7’s Automatic Resource Management now covers JDBC

try-with-resources 文