转自
开发者的天空
本文中我们来讨论在
NIO2中怎样
创建文件、读取文件和写文件。NIO2提供了多种创建
文件的方法,使得我们在创建文件的时候就可以指定文件的某些初始属性。例如在支持POSIX的文件系统上指定文件的所有者,访问权限等。关于文件的属性,
请看上一篇文章
Java SE 7新特性之文件操作(5) - 管理元数据
创建文件
可以调用createFile(FileAttribute<?>)方法创建一个空文件。该方法的参数就是文件的初始属性。下面的例子是怎样
在创建文件的时候赋予该文件某些权限的属性:
Path sourceFile = ;
Path newFile = ;
PosixFileAttributes attrs = Attributes.readPosixFileAttributes(sourceFile);
FileAttribute<Set<PosixFilePermission>> attr =
PosixFilePermissions.asFileAttribute(attrs.permissions());
try {
file.createFile(attr);
} catch (IOException x) {
//unable to create the file
}
如
果在调用该方法的时候没有传入任何参数,那么创建的文件将具有缺省的文件属性。下面的代码创建了一个具有缺省文件属性的文件:
Path file = ;
try {
file.createFile(); //Create the empty file with default permissions, etc.
} catch (FileAlreadyExists x) {
System.err.format("file named %s already exists%n", file);
} catch (IOException x) {
//Some other sort of failure, such as permissions.
System.err.format("createFile error: %s%n", x);
}
如
果要创建的文件已经存在,该方法会抛出异常。
注意在调用createFile方法时,检查文件是否存在和创建具有特定的属性的文件是在同一个原子操作中。
还可以使用newOutputSteam方法来创建文件,在本文的后面我们会讲到怎样使用newOutputStream方法来创建文件。
通过Stream I/O读文件
我们可以通过newInputStream(OpenOption...)方法打开和读取文件。这个方法返回一个unbuffered输入流(input
stream),我们可以用它来从文件中读取字节内容。
Path file = ;
InputStream in = null;
try {
in = file.newInputStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(in));
String line = null;
while ((line = reader.readLine()) != null) {
System.out.println(line);
}
} catch (IOException x) {
System.err.println(x);
} finally {
if (in != null) in.close();
}
注
意该方法接受可变个数的参数,参数类型为OpenOption,指定了文件怎样打开。如果不传入参数,则使用默认的READ方式打开。READ方式是所有
的实现都支持的方式。有一些实现也支持其他的打开方式。
如果传入的OpenOption或其组合不正确,会抛出异常。如果程序没有读权限或I/O错误,也会抛出异常。
Creating and Writing a File by Using Stream I/O
使用Stream I/O来创建和写文件
我们可以使用newOutputStream方法来创建文件、扩展文件或覆盖已有文件。这个方法为了写文件而打开或创建文件,该方法返回一个
unbuffered的输出流(output stream)。newOutputStream方法有两种形式:
- newOutputStream(OpenOption...)
- newOutputStream(Set<? extends OpenOption>,
FileAttribute<?>...)
这两种形式都接受一组OpenOption作为参数,第二种形式还允许指定初始的文件属性。这个方法支持的StandardOpenOption有:
- WRITE –为了写访问而打开该文件.
- APPEND – 将新数据扩展在文件的末尾。该选项和WRITE或CREATE选项一起使用。
- TRUNCATE_EXISTING – 将文件截断为0字节长. 该选项和WRITE选项一起使用来覆盖原有文件。
- CREATE_NEW – 创建一个新的文件。如果原来的文件存在这抛出异常。
- CREATE – 如果原文件存在这打开它,否则创建新的文件。
- DELETE_ON_CLOSE – 当Stream关闭时删除该文件。这个选项对临时文件比较有用。
- SPARSE – 表明新创建的文件是Sparse文件. 关于Sparse文件的具体信息请看http://space.itpub.net/8242091/viewspace-619756。
- SYNC – 保持该文件(包括内容和元数据)与底层存储设备同步。
- DSYNC – 保持文件内容与底层存储设备同步。
如果没有指定OpenOption,该方法的行为是:如果文件不存在,则创建新文件;如果文件存在,那么截断它。也就是说缺省的选择是CREATE和
TRUNCATE_EXISTING选项的组合。
下面的代码打开一个
日志文件,如果文件不存在,则创建一个新文件。如果文件
存在,这将新的内容扩展到文件尾部。
import static java.nio.file.StandardOpenOption.*;
Path logfile = ;
//Convert the string to a byte array.
String s = ;
byte data[] = s.getBytes();
OutputStream out = null;
try {
out = new BufferedOutputStream(logfile.newOutputStream(CREATE, APPEND));
out.write(data, 0, data.length);
} catch (IOException x) {
System.err.println(x);
} finally {
if (out != null) {
out.flush();
out.close();
}
}
使用Channel I/O来读写文件
Stream I/O每次读取一个字符,Channel
I/O每次读取一个缓冲块的数据。ByteChannel接口提供了基本的读写功能。SeekableByteChannel扩展了
ByteChannel并提供了维护一个channel中的位置并改变该位置的能力。SeekableByteChannel还支持截断文件和查询文件大
小的功能。
移动到文件中不同的位置,从该位置开始读或写的能力使我们可以
随机访问文件。有两种形式的
newByteChannel方法可以用来读或写文件,这两种形式和newOutputStream方法一样。
- newByteChannel(OpenOption...)
- newByteChannel(Set<? extends OpenOption>,
FileAttribute<?>...)
这两个方法都允许指定OpenOption,newOutputStream所支持的选择这里也支持,而且这里还支持另外一个选项READ,因为
SeekableByteChannel既支持读也支持写。
如果选项是READ,那么该channel就是为了读访问打开。如果选项是WRITE或APPEND,则该channel就是为了写访问打开。如果没有指
定,该channel默认是为了读打开。
下面的代码从文件中读取内容并输出到控制台上:
SeekableByteChannel sbc = null;
try {
sbc = file.newByteChannel(); //Defaults to READ
ByteBuffer buf = ByteBuffer.allocate(10);
//Read the bytes with the proper encoding for this platform.
//If you skip this step, you might see something that looks like Chinese
//characters when you expect Latin-style characters.
String encoding = System.getProperty("file.encoding");
while (sbc.read(buf) > 0) {
buf.rewind();
System.out.print(Charset.forName(encoding).decode(buf));
buf.flip();
}
} catch (IOException x) {
System.out.println("caught exception: " + x);
} finally {
if (sbc != null) sbc.close();
}
下
面的代码是为了UNIX或其他支持POSIX的文件系统编写的。这段代码创建一个新的日志文件或者扩展原有的日志文件,该日志文件创建时指定了访问权限
(所有者有读写权限,同组用户只有读权限,其他用户没有读权限)。
import static java.nio.file.StandardCopyOption.*;
//Create the set of options for appending to the file.
Set<OpenOptions> options = new HashSet<OpenOption>();
options.add(APPEND);
options.add(CREATE);
//Create the custom permissions attribute.
Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rw-r------");
FileAttribute<Set<PosixFilePermission>> attr = PosixFilePermissions.asFileAttribute(perms);
//Convert the string to a ByetBuffer.
String s = ;
byte data[] = s.getBytes();
ByteBuffer bb = ByteBuffer.wrap(data);
SeekableByteChannel sbc = null;
try {
sbc = file.newByteChannel(options, attr);
sbc.write(bb);
} catch (IOException x) {
System.out.println("exception thrown: " + x);
} finally {
if (sbc != null) sbc.close();
}
转自
开发者的天空
管理元数据(文件属性和文件存储属性)
在文件系统中,文件或者目录的元数据是和文件或者目录本身存储在一起的,而且元数据保存了很多的信息,例如:
对象是文件还是目录,抑或是符号链接。文件的大小、创建
时间、最后修改时间、文件的所有者、组、访问权限等。
java.nio.file.attribute包提供了访问和管理文件系统元数据(通常叫做文件属性)的功能。不同的文件系统提供的文件属性是不一样
的,所以我们按照这个将文件的属性划分成了不同的视图(View)。每个View对应一个文件系统的实现,如POSIX(Unix使用的文件系统)或
DOS;或者是所有文件系统共有的属性,如文件的所有权。当我们读取文件的属性的时候,是一次读取整个视图的属性的。
Java所支持的视图有:
BasicFileAttributeView – 所有的文件系统实现都必须提供的属性的视图。
DosFileAttributeView – 扩展了BasicFileAttributeView,添加了DOS文件系统能够支持的几种属性。
PosixFileAttributeView –
扩展了BasicFileAttributeView,添加了POSIX文件系统能够支持的几种属性。
FileOwnerAttributeView – 任何文件系统实现都会支持文件所有者的属性。这个View就包含这个属性。
AclFileAttributeView –
支持读取和更新文件的访问控制列表。支持NFSv4访问控制列表模型。所有定义了到NFSv4的映射的访问控制列表模型也同样支持,如Windows的访
问控制列表模型。
UserDefinedFileAttributeView –
支持用户自定义的元数据。这个View可以被映射到文件系统提供的扩展机制。例如在Solaris操作系统上,可以将这个View存储MIMEtype。
不同的文件系统可能支持不同的一个或几个view,也有可能含有上面所有的View都没有包含的文件属性。
Attributes类
大多数情况下,我们不需要直接使用FileAttributeView接口,Attributes类提供了转换的方法来读取和设置文件属性。
下面是Attributes类提供的一些方法:
读取或设置基本的文件属性:
readBasicFileAttributes(FileRef, LinkOption...)
setLastAccessTime(FileRef, FileTime)
setLastModifiedTime(FileRef, FileTime)
读取或设置POSIX文件属性
readPosixFileAttributes(FileRef, LinkOption...)
setPosixFilePermissions(FileRef, Set<PosixFilePermission>)
读取或设置文件的所有者
getOwner(FileRef)
setOwner(FileRef, UserPrincipal)
一次读取所有的文件属性
readAttributes(FileRef, String, LinkOption...)
读取或设定特定的文件属性
getAttribute(FileRef, String, LinkOption...)
setAttribute(FileRef, String, Object)
读取DOS文件属性
readDosFileAttributes(FileRef, LinkOption...)
读取或设置文件的访问控制列表。
getAcl(FileRef)
setAcl(FileRef, List<AclEntry>)
读取文件存储空间的属性,如总空间、有效空间、未分配空间等。
readFileStoreSpaceAttributes(FileStore)
每个read方法都返回一个对象,该对象会提供访问方法,我们通过这些访问方法能够很方便的获得特定的文件属性的值。
要想读取基本的文件信息,那么可以调用readBasicFileAttributes(FileRef,
LinkOption...)方法。这个方法支持的LinkOption就只有NOFOLLOW_LINKS。这个方法会一次性的读取所有的基本的文件属
性并返回一个BasicFileAttributes对象,我们可以访问该对象获取具体的文件属性。如果程序对文件没有访问权限,该方法会抛出
SecurityException异常。要注意的是,并不是所有文件系统的实现都支持创建时间、最后修改时间和最后访问时间这三个属性。如果某个属性不
被支持,则调用该属性的get方法时会返回null。下面就是一个读取文件的基本属性的例子:
Path file = ;
BasicFileAttributes attr = Attributes.readBasicFileAttributes(file);
if (attr.creationTime() != null) {
System.out.println("creationTime: " + attr.creationTime());
}
if (attr.lastAccessTime() != null) {
System.out.println("lastAccessTime: " + attr.lastAccessTime());
}
if (attr.lastModifiedTime() != null) {
System.out.println("lastModifiedTime: " + attr.lastModifiedTime());
}
System.out.println("isDirectory: " + attr.isDirectory());
System.out.println("isOther: " + attr.isOther());
System.out.println("isRegularFile: " + attr.isRegularFile());
System.out.println("isSymbolicLink: " + attr.isSymbolicLink());
System.out.println("size: " + attr.size());
下面的例子中,我们检查了对一个文件的访问权限,判断
该文件是常规的文件还是目录:
import static java.nio.file.AccessMode.*;
Path file = ;
boolean error=false;
try {
file.checkAccess(READ, EXECUTE);
if (!Attributes.readBasicFileAttributes(file).isRegularFile()) {
error = true;
}
} catch (IOException x) {
//Logic for error condition
error = true;
}
if (error) {
//Logic for failure
return;
}
//Logic for executable file
设置
时间戳
前面的文件基本属性的代码中演示了怎样获取文件的时间戳,Attributes类还提供了两个方法来设置时间戳:setLastAccessTime和
setLastModifiedTime,下面是这两个方法的示例:
Path file = ;
BasicFileAttributes attr = Attributes.readBasicFileAttributes(file);
long currentTime = System.currentTimeMillis();
if (attr.lastModifiedTime() != null) {
FileTime ft = FileTime.fromMillis(currentTime);
Attributes.setLastModifiedTime(file, ft);
} else {
System.err.println("lastModifiedTime time stamp not supported");
}
DOS的文件属性
要获取一个文件的DOS的文件属性,需要调用readDosFileAttributes方法。这个方法会返回一个DosFileAttributes对
象,该对象提供了获取DOS文件属性的方法,例如:
Path file = ;
try {
DosFileAttributes attr = Attributes.readDosFileAttributes(file);
System.out.println("isReadOnly is " + attr.isReadOnly());
System.out.println("isHidden is " + attr.isHidden());
System.out.println("isArchive is " + attr.isArchive());
System.out.println("isSystem is " + attr.isSystem());
} catch (IOException x) {
System.err.println("DOS file attributes not supported:" + x);
}
我
们可以使用setAttribute方法来设置DOS文件属性,如:
Path file = ;
Attributes.setAttribute(file, "dos:hidden", true);
要注意的是,不是只有DOS操作系统才支持DOS文
件属性,有些操作系统如Samba也支持DOS文件属性。
POSIX的文件属性
POSIX是Portable Operation System Interface for
UNIX的缩写,而且IEEE和ISO定义很多标准来保证不同的UNIX之间的户操作性,因此对于开发人员来说,针对POSIX编写的程序能够很容易的运
行在不同的兼容POSIX的文件系统上。
要读取POSIX文件属性,需要调用readPosixFileAttributes方法。除了文件所有者和所属组,POSIX还支持9种文件权限许可组
合:读、写、执行三种权限和文件所有者、同组的用户和其他用户三种角色的组合(3 × 3 = 9)。下面就是读取POSIX文件属性的简单的例子:
Path file = ;
PosixFileAttributes attr = Attributes.readPosixFileAttributes(file);
System.out.format("%s %s %s%n", attr.owner().getName, attr.group().getName(),
PosixFilePermissions.toString(attr.permissions()));
下面的代码读取了一个文件的属性,然后创建了一个新的
文件,将原有的文件的权限属性赋予新创建的文件:
Path sourceFile = ;
Path newFile = ;
PosixFileAttributes attrs = Attributes.readPosixFileAttributes(sourceFile);
FileAttribute<Set<PosixFilePermission>> attr =
PosixFilePermissions.asFileAttribute(attrs.permissions());
try {
file.createFile(attr);
} catch (IOException x) {
//unable to create the file
}
上
面的代码中我们使用了PosixFilePermission类,该类是一个帮助类,提供了一些方法来读取和生成文件权限,这里就不详细解释了。
如果想指定创建的文件的权限,可以使用下面的代码:
Path file = ;
Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rw-------");
FileAttribute<Set<PosixFilePermission>> attr = PosixFilePermissions.asFileAttribute(perms);
try {
Attributes.setPosixFilePermissions(file, perms);
} catch (IOException x) {
System.err.println(x);
}
文
件有所有者的属性和所属组的属性,在设置这些属性的时候,我们需要传入一个UserPrincipal对象作为参数,我们可以使用
UserPrincipalLookupService来根据用户名或组名来创建该对象。UserPrincipalLookupService实例可以
通过FileSystem.getUserPrincipalLookupService方法获得。下面就是设置所有者属性的例子:
Path file = ;
try {
UserPrincipal owner = file.GetFileSystem().getUserPrincipalLookupService()
.lookupPrincipalByName("sally");
Attributes.setOwner(file, owner);
} catch (IOException x) {
System.err.println(x);
}
Attributes
类没有提供设置所属组的方法,如果要设置所属组,需要调用POSIX文件属性视图来进行,下面是示例代码:
Path file = ;
try {
GroupPrincipal group = file.getFileSystem().getUserPrincipalLookupService()
.lookupPrincipalByGroupName("green");
file.getFileAttributeView(PosixFileAttributeView.class).setGroup(group);
} catch (IOException x) {
System.err.println(x);
}
用户定义的文件属性
如果文件系统支持的属性对你来说还不够用,你可以通过UserDefinedAttributeView来创建和跟踪自己的文件属性。
下面的例子中,我们将MIME类型作为一个用户自定义的属性:
Path file = ;
UserDefinedFileAttributeView view = file
.getFileAttributeView(UserDefinedFileAttributeView.class);
view.write("user.mimetype", Charset.defaultCharset().encode("text/html");
要读取MIME类型属性,要使用以下的代码:
Path file = ;
UserDefinedFileAttributeView view = file
.getFileAttributeView(UserDefinedFileAttributeView.class);
String name = "user.mimetype";
ByteBuffer buf = ByteBuffer.allocate(view.size(name));
view.read(name, buf);
buf.flip();
String value = Charset.defaultCharset().decode(buf).toString();
如果文件系统不支持扩展属性,那么会抛出一个
UnsupportedOperationException异常,你可以咨询系统管理员来确认系统是否支持文件的扩展属性并进行相应的配置。
文件存储属性
文件存储属性其实我们应该非常熟悉的属性,我们查看硬盘属性的时候,经常看到硬盘总的存储空间,使用了的存储空间,空闲的存储空间等就是文件存储属性。下
面是获取文件存储属性的代码:
Path file = ;
FileStore store = file.getFileStore();
FileStoreSpaceAttributes attr = Attributes.readFileStoreSpaceAttributes(store);
System.out.println("total: " + attr.totalSpace() );
System.out.println("used: " + (attr.totalSpace() - attr.unallocatedSpace()) );
System.out.println("avail: " + attr.usableSpace() );