Java NIOの深淵へ：java.nio.file.attributeパッケージ徹底解説

Java 7で導入されたNIO.2（New I/O 2）は、ファイルシステム操作に革命をもたらしました。その中核をなすのがjava.nio.fileパッケージであり、その中でも特に強力で柔軟な機能を提供するのがjava.nio.file.attributeパッケージです。

従来のjava.io.Fileクラスでは、ファイルの最終更新日時やサイズ、読み取り可能かといった基本的な属性しか扱えませんでした。しかし、現代のファイルシステムは、所有者情報、パーミッション、隠しファイル属性、さらにはカスタムメタデータまで、はるかに豊富な情報を持っています。

java.nio.file.attributeパッケージは、これらの多様なファイル属性に統一的かつ体系的にアクセスするための仕組みを提供します。これにより、開発者はOSやファイルシステムの種類を意識することなく、プラットフォームに依存しない形で高度なファイル操作を実装できるようになります。この記事では、この強力なパッケージを構成する主要なコンポーネントを詳細に解説し、具体的なコード例を通じてその使い方をマスターしていきます。

java.nio.file.attributeを理解する上で最も重要な概念が属性ビューです。属性ビューは、特定の視点（ビュー）から見たファイルの属性の集合体と考えることができます。

ファイルシステムには様々な種類があり（例：WindowsのNTFS、Linuxのext4、macOSのAPFS）、それぞれが管理する属性は異なります。属性ビューは、これらの違いを吸収し、特定の属性セット（例えば、すべてのファイルシステムに共通する基本属性、POSIX準拠システム向けの属性など）へのアクセスを提供します。

これにより、プログラムは特定のファイルシステムでサポートされている属性ビューを取得し、そのビューを介して属性を読み取ったり、更新したりすることができます。このアプローチにより、コードの可読性と保守性が向上します。

主要な属性ビューには以下のようなものがあります。

• BasicFileAttributeView: 基本的な属性（サイズ、作成日時など）のビュー。
• DosFileAttributeView: DOS/Windows系の属性（読み取り専用、隠しファイルなど）のビュー。
• PosixFileAttributeView: POSIX準拠システムの属性（パーミッション、所有者など）のビュー。
• FileOwnerAttributeView: ファイル所有者情報を扱うビュー。
• AclFileAttributeView: アクセス制御リスト（ACL）を扱うビュー。
• UserDefinedFileAttributeView: ユーザーが定義したカスタム属性を扱うビュー。

Files.getFileAttributeView(Path, Class) メソッドを使うことで、特定のパスに対して目的の属性ビューを取得できます。

BasicFileAttributesは、あらゆるファイルシステムで共通してサポートされるべき、最も基本的なファイル属性のセットを定義するインターフェースです。

このインターフェースを通じて、ファイルの作成日時、最終アクセス日時、最終更新日時、サイズ、そしてファイルの種類（通常のファイル、ディレクトリ、シンボリックリンク、その他）といった、必要不可欠な情報を取得できます。これらの属性は読み取り専用です。

BasicFileAttributesで取得できる主要な属性

使用例：ファイルの基本属性を読み取る

Files.readAttributes() メソッドを使用すると、指定した型の属性オブジェクトを一括で読み取ることができます。これは複数の属性にアクセスする場合に効率的です。

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.BasicFileAttributes;
import java.nio.file.attribute.FileTime;

public class BasicAttributesExample {
    public static void main(String[] args) {
        // 確認したいファイルのパスを生成
        Path path = Paths.get("example.txt");

        try {
            // ファイルが存在しない場合に備えて作成
            if (!Files.exists(path)) {
                Files.createFile(path);
                System.out.println("'" + path.getFileName() + "' を作成しました。");
            }

            // BasicFileAttributes を一括で読み取る
            BasicFileAttributes attrs = Files.readAttributes(path, BasicFileAttributes.class);

            System.out.println("ファイル: " + path.getFileName());
            System.out.println("------------------------------------");

            // 各属性を出力
            System.out.println("サイズ: " + attrs.size() + " バイト");
            System.out.println("作成日時: " + attrs.creationTime());
            System.out.println("最終アクセス日時: " + attrs.lastAccessTime());
            System.out.println("最終更新日時: " + attrs.lastModifiedTime());

            System.out.println("ディレクトリか？: " + attrs.isDirectory());
            System.out.println("通常ファイルか？: " + attrs.isRegularFile());
            System.out.println("シンボリックリンクか？: " + attrs.isSymbolicLink());
            System.out.println("その他か？: " + attrs.isOther());
            System.out.println("ファイルキー: " + attrs.fileKey());

            // 属性の更新 (BasicFileAttributeView を使用)
            BasicFileAttributeView view = Files.getFileAttributeView(path, BasicFileAttributeView.class);
            FileTime newTime = FileTime.fromMillis(System.currentTimeMillis());
            view.setTimes(newTime, null, null); // 最終更新日時のみ更新

            // 更新後の属性を再読み込みして確認
            attrs = view.readAttributes();
            System.out.println("更新後の最終更新日時: " + attrs.lastModifiedTime());

        } catch (IOException e) {
            System.err.println("ファイル属性の読み取り中にエラーが発生しました: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

BasicFileAttributes自体は読み取り専用ですが、属性を変更したい場合は、対応するビューであるBasicFileAttributeViewを取得し、そのsetTimes()メソッドを使用します。

PosixFileAttributesは、LinuxやmacOS、その他のUNIXライクなオペレーティングシステムで標準的に使用されるPOSIX（Portable Operating System Interface）属性を扱うためのインターフェースです。

これはBasicFileAttributesを継承しており、基本的な属性に加えて、ファイル所有者、グループ所有者、そしてアクセスパーミッションという、UNIX系システムにおけるセキュリティの根幹をなす3つの重要な属性を提供します。

PosixFileAttributesで追加される主要な属性

使用例：パーミッションの読み取りと設定

POSIXパーミッションは、所有者・グループ・その他の3つのカテゴリに対して、読み取り（READ）、書き込み（WRITE）、実行（EXECUTE）の権限を個別に設定します。PosixFilePermissionsユーティリティクラスを使うと、”rwxr-x—“のような文字列表現からパーミッションのセットを簡単に生成できます。

import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.PosixFileAttributeView;
import java.nio.file.attribute.PosixFileAttributes;
import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Set;

public class PosixAttributesExample {
    public static void main(String[] args) {
        Path path = Paths.get("posix_example.sh");
        
        // 実行環境がPOSIX属性をサポートしているか確認
        if (!FileSystems.getDefault().supportedFileAttributeViews().contains("posix")) {
            System.out.println("お使いのファイルシステムはPOSIX属性をサポートしていません。");
            return;
        }

        try {
            if (!Files.exists(path)) {
                Files.createFile(path);
            }
            
            // PosixFileAttributeView を取得
            PosixFileAttributeView view = Files.getFileAttributeView(path, PosixFileAttributeView.class);
            PosixFileAttributes attrs = view.readAttributes();

            System.out.println("ファイル: " + path.getFileName());
            System.out.println("------------------------------------");
            System.out.println("所有者: " + attrs.owner().getName());
            System.out.println("グループ: " + attrs.group().getName());
            
            // 現在のパーミッションを文字列表現で取得
            String currentPermissions = PosixFilePermissions.toString(attrs.permissions());
            System.out.println("現在のパーミッション: " + currentPermissions);

            // 新しいパーミッションを設定 (rwxr-x---)
            System.out.println("\nパーミッションを 'rwxr-x---' に変更します...");
            Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rwxr-x---");
            view.setPermissions(perms);

            // 変更後のパーミッションを再読み込みして確認
            attrs = view.readAttributes();
            System.out.println("変更後のパーミッション: " + PosixFilePermissions.toString(attrs.permissions()));
            
        } catch (IOException | UnsupportedOperationException e) {
            System.err.println("POSIX属性の操作中にエラーが発生しました: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

DosFileAttributesは、MS-DOS時代から続く、Windowsファイルシステムで利用可能な伝統的な属性セットを扱います。これもBasicFileAttributesを継承しています。

これらの属性は、ファイルの動作や表示を制御するためのシンプルなフラグとして機能します。例えば、ファイルをユーザーから隠したり、誤って変更されないように読み取り専用にしたりできます。

DosFileAttributesで追加される主要な属性

使用例：隠しファイル属性の確認と設定

DOS属性の変更は、Files.setAttribute() メソッドを使って個別に設定するのが一般的です。ビュー名（"dos"）と属性名（例："hidden"）、そして設定したい値（trueまたはfalse）を指定します。

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.DosFileAttributes;

public class DosAttributesExample {
    public static void main(String[] args) {
        Path path = Paths.get("dos_example.txt");

        try {
            if (!Files.exists(path)) {
                Files.createFile(path);
            }
            
            // DosFileAttributes を読み取る
            DosFileAttributes attrs = Files.readAttributes(path, DosFileAttributes.class);
            System.out.println("ファイル: " + path.getFileName());
            System.out.println("------------------------------------");
            System.out.println("隠しファイルか？: " + attrs.isHidden());
            System.out.println("読み取り専用か？: " + attrs.isReadOnly());

            // 隠しファイル属性を現在の状態から反転させる
            boolean currentHiddenState = attrs.isHidden();
            System.out.println("\n隠しファイル属性を " + !currentHiddenState + " に変更します...");
            Files.setAttribute(path, "dos:hidden", !currentHiddenState);

            // 変更後の属性を再読み込みして確認
            attrs = Files.readAttributes(path, DosFileAttributes.class);
            System.out.println("変更後の隠しファイルか？: " + attrs.isHidden());
            
        } catch (IOException | UnsupportedOperationException | IllegalArgumentException e) {
            System.err.println("DOS属性の操作中にエラーが発生しました: " + e.getMessage());
            System.err.println("このファイルシステムはDOS属性をサポートしていない可能性があります。");
            e.printStackTrace();
        }
    }
}

基本的な属性の他に、java.nio.file.attributeパッケージは、より専門的で高度なファイル属性を操作するためのビューも提供しています。

ユーザー定義属性 (UserDefinedFileAttributeView)

UserDefinedFileAttributeView を使用すると、ファイルに任意のメタデータを「キーと値のペア」として関連付けることができます。これは、ファイルシステム自体は解釈しない、アプリケーション固有の情報を保存するのに非常に便利です。例えば、画像ファイルの文字エンコーディングや、ドキュメントのバージョン情報などを埋め込むことができます。

値はByteBufferとして扱われるため、文字列やその他のデータをバイトに変換して書き込む必要があります。

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.UserDefinedFileAttributeView;

public class UserDefinedAttributeExample {
    public static void main(String[] args) {
        Path path = Paths.get("user_defined_example.txt");
        try {
            if (!Files.exists(path)) { Files.createFile(path); }

            UserDefinedFileAttributeView view = Files.getFileAttributeView(path, UserDefinedFileAttributeView.class);
            
            if (view == null) {
                System.out.println("このファイルシステムはユーザー定義属性をサポートしていません。");
                return;
            }

            // ユーザー定義属性を書き込む
            String key = "myapp.metadata.version";
            String value = "v2.1.0-beta";
            byte[] bytes = value.getBytes(StandardCharsets.UTF_8);
            view.write(key, ByteBuffer.wrap(bytes));
            System.out.println("属性 '" + key + "' に値 '" + value + "' を書き込みました。");

            // ユーザー定義属性を読み込む
            ByteBuffer buffer = ByteBuffer.allocate(view.size(key));
            view.read(key, buffer);
            buffer.flip();
            String readValue = StandardCharsets.UTF_8.decode(buffer).toString();
            System.out.println("属性 '" + key + "' から値 '" + readValue + "' を読み込みました。");

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

アクセス制御リスト (AclFileAttributeView)

AclFileAttributeViewは、ファイルへのアクセス権をより細かく制御するためのアクセス制御リスト（ACL）を操作します。POSIXの基本的なパーミッション（所有者・グループ・その他）よりもはるかに柔軟で、特定のユーザーやグループに対して個別の権限（許可または拒否）を設定できます。

ACLの操作は複雑で、AclEntryオブジェクトを構築してリストとして設定する必要があります。これはNFSv4のACLモデルに基づいており、サポートしているファイルシステム（例: ZFSやNTFSの一部機能）は限られています。

以下は概念的なコード例です。実際に動作させるには、適切なユーザープリンシパルを取得し、ファイルシステムがACLをサポートしている必要があります。

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.*;
import java.util.List;

public class AclExample {
    public static void main(String[] args) {
        Path path = Paths.get("acl_example.txt");
        try {
            if (!Files.exists(path)) { Files.createFile(path); }

            AclFileAttributeView view = Files.getFileAttributeView(path, AclFileAttributeView.class);
            if (view == null) {
                System.out.println("このファイルシステムはACLをサポートしていません。");
                return;
            }

            // 特定のユーザー（例：'guest'）を取得
            UserPrincipal guest = path.getFileSystem().getUserPrincipalLookupService().lookupPrincipalByName("guest");

            // 'guest'に読み取りを許可するACLエントリーを作成
            AclEntry entry = AclEntry.newBuilder()
                    .setType(AclEntryType.ALLOW)
                    .setPrincipal(guest)
                    .setPermissions(AclEntryPermission.READ_DATA, AclEntryPermission.READ_ATTRIBUTES)
                    .build();
            
            // 現在のACLリストを取得し、新しいエントリーを追加
            List<AclEntry> acl = view.getAcl();
            acl.add(0, entry); // リストの先頭に追加
            
            // 更新したACLを設定
            view.setAcl(acl);
            System.out.println("'guest' ユーザーに読み取り権限を追加しました。");

        } catch (IOException | UserPrincipalNotFoundException e) {
            System.err.println("ACLの操作に失敗しました: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

セキュリティ上、ファイルを作成してからパーミッションを設定するまでのわずかな時間に、意図しないアクセスが発生する可能性があります。これを避けるため、NIO.2ではFiles.createFile()やFiles.createDirectory()の呼び出し時に、属性をアトミックに（不可分な操作として）設定することができます。

これにはFileAttributeインターフェースの実装を使用します。PosixFilePermissions.asFileAttribute()は、パーミッションセットから直接FileAttributeオブジェクトを生成する便利なヘルパーメソッドです。

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.attribute.FileAttribute;
import java.nio.file.attribute.PosixFilePermission;
import java.nio.file.attribute.PosixFilePermissions;
import java.util.Set;

public class CreateWithAttributesExample {
    public static void main(String[] args) {
        Path path = Paths.get("secure_file.dat");
        
        // 所有者のみ読み書き可能なパーミッション (rw-------)
        Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rw-------");
        FileAttribute<Set<PosixFilePermission>> attr = PosixFilePermissions.asFileAttribute(perms);

        try {
            // ファイルを作成すると同時にパーミッションを設定
            Files.createFile(path, attr);
            System.out.println("ファイル '" + path.getFileName() + "' をパーミッション " + PosixFilePermissions.toString(perms) + " で作成しました。");

            // 確認
            Set<PosixFilePermission> actualPerms = Files.getPosixFilePermissions(path);
            System.out.println("実際のパーミッション: " + PosixFilePermissions.toString(actualPerms));

        } catch (IOException | UnsupportedOperationException e) {
            System.err.println("属性付きのファイル作成に失敗しました: " + e.getMessage());
            e.printStackTrace();
        }
    }
}