【Java】java.nio.fileパッケージの使用例②(移動・コピー、削除)

当記事は、【Java】java.nio.fileパッケージの使用例①(ファイルの作成、存在チェック)の続きの記事であり、java.nio.fileパッケージを使った、Java上での以下のファイル操作について解説します。

• ファイル・ディレクトリの移動・コピー
• ファイル・ディレクトリの削除

当記事でのサンプルコードは、前記事で作成したディレクトリやファイルを元に記述しています。

java.nio.fileパッケージの概要について知りたい方は、以下の記事を参照して下さい。

【Java】Pathオブジェクトを生成する方法(java.nio.fileパッケージ)

また、ファイル名などのディレクトリに含まれ０るファイルの一覧の取得、ファイルの属性の取得といったファイル操作は以下の記事で解説します。

【Java】java.nio.fileパッケージの使用例①(ファイルの作成、存在チェック)

【Java】java.nio.fileパッケージの使用例③(ファイル属性の取得・変更)

FileChannelを使ったファイルのコピーは、以下の記事で解説します。

【Java】FileChannelを使って高速にファイル入出力を行ってみた

ファイル・ディレクトリの移動・コピー

ファイルやディレクトリの移動にはFIlesクラスのmoveメソッド、コピーにはFilesクラスのcopyメソッドを使います。

ファイル・ディレクトリの移動・コピーを行うメソッド

以下のメソッドの引数のうち、CopyOptionsは、移動・コピーを行う際のオプションを指定するための可変長引数です。

また、入力ストリームからコピー、出力ストリームへコピーを行うメソッドがあります。

入出力ストリームについては、以下の記事で解説しています。

【Java】入出力ストリーム(java.ioパッケージ)

CopyOptionで指定できるオプションは、主に以下のようなものがあります。これらはjava.nio.file.StandardCopyOptionクラスで用意されている列挙型の定数で、StandardCopyOption.定数名という書式で呼び出すことが出来ます。

moveメソッドの記述例

移動元と移動先のPathオブジェクトを以下の通りとします。

Path source = Paths.get("移動元のパス");
Path target = Paths.get("移動先のパス");

moveメソッドでファイルの移動を行います。この例では、オプションにATOMIC_MOVEを指定しています。

Files.move(source, target, StandardCopyOption.ATOMIC_MOVE);

copyメソッドの記述例

コピー元とコピー先のPathオブジェクトを以下の通りとします。

Path source = Paths.get("コピー元のパス");
Path target = Paths.get("コピー先のパス");

copyメソッドでファイルのコピーを行います。この例では、オプションにREPLACE_EXISTINGを指定しています。

Files.copy(source, target, StandardCopyOption.REPLACE_EXISTING);

FileInputStreamを使ってファイルをコピーします。

FileInputStream fis = new FileInputStream("コピー元のパス");
Files.copy(fis, target);

FileOutputStreamを使ってファイルをコピーします。

FileOutputStream fos = new FileOutputStream("コピー先のパス");
Files.copy(source, fos);

ファイルの移動を行うサンプルコード

以下のような【Java】java.nio.fileパッケージの使用例①(ファイルの作成、存在チェック)のサンプルコードを実行して生成したファイルおよびディレクトリを使います。

以下のサンプルコードでは、「sample.1.txt」というファイルを「aa」ディレクトリ直下に「sample2.txt」という名前に変更しながら移動させています。

public class moveCopySample {
	public static void main(String[] args) {
		//移動元のPathオブジェクトを作成します。
		Path sourcePath = Paths.get(".\\NIO\\sample1.txt");		
		//移動先のPathオブジェクトを生成します。
		Path targetPath = Paths.get(".\\NIO\\aa\\sample2.txt");		
		//移動元ファイルの存在チェックを行います。
		if (Files.exists(sourcePath)) {			
			//try節内でmoveメソッドを実行します。
			try {
				Files.move(sourcePath, targetPath);
			} catch (Exception e) {
				e.printStackTrace();
			}			
			//このメッセージが出れば、moveメソッドは正常に終了しています。
			System.out.println("ファイルの移動が正常に終了しました。");			
		}
		//移動元ファイルが存在しない場合は、メッセージを出します。
		else {
			System.out.println("移動元ファイルが存在しません。");
		}
	}
}

ファイルの移動を行うサンプルコードの実行結果

コンソールに以下のように出力されます。

ファイルの移動が正常に終了しました。

また、「NIO」ディレクトリ直下の「sample2.txt」ファイルが、「aa」ディレクトリ直下に「sample2.txt」という名前のファイルとして移動したことが確認できます。

ディレクトリのコピーを行うサンプルコード

上記のディレクトリ構成を前提にディレクトリの移動を行います。

public class moveDirectorySample {
	public static void main(String[] args) {
		//移動元のディレクトリを表すPathオブジェクトを作成します。
		Path sourceDirectory = Paths.get(".\\NIO\\aa");
		//移動先を表すPathオブジェクトを生成します。
		Path targetDirectory = Paths.get(".\\NIO\\bb\\dd");
		//try節中で、copyメソッドを実行します。
		//オプションにATOMIC_MOVEを渡してアトミックな移動操作を行うように指定します。
		try {
			Files.move(sourceDirectory, targetDirectory, StandardCopyOption.ATOMIC_MOVE);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

ディレクトリの移動を行うサンプルコードの実行結果

「NIO」ディレクトリ直下にあった「aa」ディレクトリが、「bb」ディレクトリ直下に、「dd」ディレクトリとして移動していることが確認できます。

また、「aa」ディレクトリ直下の「sample2.txt」ファイルも、ディレクトリと一緒にコピーされていることが確認できます。

ファイル・ディレクトリのコピーを行うサンプルコード

先ほどのファイル・ディレクトリの移動を行うサンプルコードで生成したファイルおよびディレクトリを使います。

public class copySample {
	public static void main(String[] args) {
		//コピー元のファイルを表すPathオブジェクトを作成します。
		Path sourceFilePath = Paths.get(".\\NIO\\bb\\dd\\sample2.txt");
		//コピー先を表すPathオブジェクトを作成します。
		Path targetFilePath = Paths.get(".\\NIO\\bb\\cc\\sample3.txt");		
		//コピー元のディレクトリを表すPathオブジェクトを作成します。
		Path sourceDirectoryPath = Paths.get(".\\NIO\\bb\\dd");	
		//コピー先を表すPathオブジェクトを作成します。
		Path targetDirectoryPath = Paths.get(".\\NIO\\ee");	
		//try節中で、copyメソッドを実行します。
		try {
			//ファイルのコピーを行います。
			//オプションにREPLACE_EXISTINGを渡してファイルを上書きを行うオプションを指定しています。
			Files.copy(sourceFilePath, targetFilePath, StandardCopyOption.REPLACE_EXISTING);		
			//ディレクトリのコピーを行います。
			Files.copy(sourceDirectoryPath, targetDirectoryPath);
		} catch (Exception e) {
			e.printStackTrace();
		}	
		//InputStreamを使ったコピーのコピー先、およびOutputStreamを使ったコピーのコピー元のPathファイルを生成します。
		Path path = Paths.get(".\\NIO\\bb\\sample4.txt");	
		//InputStreamを使ってコピーを行います。
		try (FileInputStream fis = new FileInputStream(".\\NIO\\bb\\cc\\sample3.txt")) {
			Files.copy(fis, path);
		} catch (Exception e) {
			e.printStackTrace();
		}	
		//OutputStreamを使ってコピーを行います。
		try (FileOutputStream fos = new FileOutputStream(".\\NIO\\sample5.txt")) {
			Files.copy(path, fos);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

ファイル・ディレクトリのコピーを行うサンプルコードの実行結果

上記のサンプルコードを実行すると、ディレクトリは以下のような構成になります。

サンプルコードでは、「\NIO\bb\dd」ディレクトリを「\NIO\ee」ディレクトリにコピーしていますが、コピーした「ee」ディレクトリの中身は空になります。

copyメソッドでは、ディレクトリ内のファイルはコピーしませんので注意してください。

ファイル・ディレクトリの削除

ファイルやディレクトリの削除にはFIlesクラスのdeleteメソッド、またはdeleteIfExistsメソッドを使います。

ファイル・ディレクトリの削除を行うメソッド

もし空でないディレクトリを削除しようとした場合は、例外DirectoryNotEmptyExceptionがスローされます。

deleteメソッド、deleteIfExistsメソッドの記述例

Pathオブジェクトで指定したファイルまたはディレクトリを削除します。

Path path = Paths.get("削除するファイルまたはディレクトリのパス");
Files.delete(path);

Pathオブジェクトで指定したファイルまたはディレクトリが、もし存在するなら削除します。

Path path = Paths.get("削除するファイルまたはディレクトリのパス");
Files.deleteIfExists(path);

ファイル・ディレクトリの削除を行うサンプルコード

先ほどのファイル・ディレクトリのコピーを行うサンプルコードで生成したファイルおよびディレクトリを使います。

public class deleteSample {
	public static void main(String[] args) {
		//削除したいファイルを指定
		Path filePath = Paths.get(".\\NIO\\sample5.txt");

		//削除したいディレクトリを指定
		Path dirPath1 = Paths.get(".\\NIO\\ee");

		//存在しないディレクトリを指定
		Path dirPath2 = Paths.get(".\\NIO\\ff");

		try {
			//deleteメソッドでファイルを削除
			Files.delete(filePath);

			//deleteIfexistsメソッドで、存在する空のディレクトリを指定して削除を行う
			if (Files.deleteIfExists(dirPath1)) {
				System.out.println(dirPath1 + "を削除しました。");
			} else {
				System.out.println(dirPath1 + "は存在しないファイルまたはディレクトリです。");
			}

			//deleteIfexistsメソッドで、存在しないディレクトリを指定して削除を行う
			if (Files.deleteIfExists(dirPath2)) {
				System.out.println(dirPath2 + "を削除しました。");
			} else {
				System.out.println(dirPath2 + "は存在しないファイルまたはディレクトリです。");
			}

		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

ファイル・ディレクトリのコピーを行うサンプルコードの実行結果

上記のサンプルコードを実行すると、コンソールに以下のように出力されます。

.\NIO\eeを削除しました。
.\NIO\ffは存在しないファイルまたはディレクトリです。

また、ディレクトリは以下のような構成になります。

「sample5.txt」ファイルおよび「ee」ディレクトリが削除されたことが確認できると思います。

「bb」ディレクトリ以下はサンプルコードで操作を行っていないので、ディレクトリ構成に変更はありません。

まとめ

当記事では、ファイル・ディレクトリの削除およびコピーについて解説しました。

java.nio.fileパッケージがjava.io.Fileクラスより高機能だと書きましたが、例えばFiles.deleteIfExistsメソッドのファイルの存在を確認してから削除するというメソッドは、java.io.Fileクラスにはなく、ファイルの存在チェックをしてから削除する必要があり、コードの記述が長くなります。

java.nio.fileパッケージを使いこなして簡潔に短くコードを書くことが出来れば、単にコーディングの時間が短くなるだけではなく、読みやすいので、デバッグや保守の際にも役に立ちますので、身に着けておくと何かと役に立ちます。

関連記事：

【Java】java.nio.fileパッケージ(NIO.2)

【Java】Pathオブジェクトを生成する方法(java.nio.fileパッケージ)

【Java】java.nio.fileパッケージの使用例①(ファイルの作成、存在チェック)

【Java】java.nio.file