【IO】File

前言

Github：https://github.com/yihonglei/jdk-source-code-reading（java-io）

一 File 概述

存储在变量、数组和对象中的数据是暂时的，当程序终止时他们就会丢失，为了能够永久的保存程序中创建的数据，

需要将他们存储到硬盘或光盘的文件中。而 File 类关心的是在磁盘上文件的存储，File类描述的是一个文件或文件夹。

File 类的出现是对文件系统的中的文件以及文件夹进行对象的封装。可以通过对象的思想来操作文件以及文件夹，

用面向对象的方式处理问题，通过该对象的方法，可以得到文件或文件夹的信息方便了对文件与文件夹的属性信息进行操作。

Java IO API中的File类可以让你访问底层文件系统，主要有以下功能点：

• 检测文件是否存在
• 读取文件长度
• 重命名或移动文件
• 删除文件
• 检测某个路径是文件还是目录
• 读取目录中的文件列表

注意:

File只能访问文件以及文件系统的元数据。如果想读写文件内容，

需要使用字节流形式的FileInputStream、FileOutputStream或者RandomAccessFile，或字符流形式的FileReader，FileWriter。

如果你正在使用Java NIO，并且想使用完整的NIO解决方案你会使用到java.nio.FileChannel(否则你也可以使用File)。

二 文件路径分割符

上下级文件夹之间使用分隔符分开：在Windows中分隔符为'\'，在Unix/Linux中分隔符为'/'。

跨平台的目录分隔符更专业的做法是使用File.separatorChar，这个值就会根据系统得到的相应的分割符。

例：new File("C:" + File.separatorChar + "test.txt");

注意，如果是使用"\"，则需要进行转义，写为"\\"才可以，如果是两个"\"，则写为"\\\\"。

三 绝对路径与相对路径

对于UNIX平台，绝对路径名的前缀是"/"。相对路径名没有前缀。对于Windows平台，绝对路径名的前缀由驱动器号和一个":"组成，

例"c:\\..."。相对路径没有盘符前缀。

相对路径：

相对路径是指相对于某位置的路径，是指相对于当前目录。

在执行Java程序时，相对路径为执行java命令时当前所在的目录。

eg：

在不同的路径下执行java命令运行以下程序，并观察输出结果。

File file = new File("a.txt");

System.out.println(file.getAbsolutePath());

一般在使用时，建议用绝对路径，因为相对路径容易出问题，不好确定到底在什么地方。

// 相对路径

// File file = new File("src/a.txt");

四 File 类中常用构造器和方法分析

File中的方法很多，大概分可以按以下几类去分析。

1、构造器

public File(String pathname);

通过将给定路径来创建一个新File实例。

public File(String parent, String child);

根据parent路径名字符串和child路径名创建一个新File实例。

parent是指上级目录的路径，完整的路径为parent+child。

public File(File parent, String child);

根据parent抽象路径名和child路径名创建一个新File实例。

parent是指上级目录的路径，完整的路径为parent.getPath()+child。

public File(URI uri);

通过将给定的文件创建一个新文件实例：URI到一个抽象路径名,

URI是依赖于系统的，因此这个构造函数执行的转换也是依赖于系统的。

2、创建

createNewFile()

在指定位置创建一个空文件，成功就返回true，如果已存在就不创建然后返回false。

mkdir()

在指定位置创建目录，这只会创建最后一级目录，如果上级目录不存在就抛异常。

mkdirs()

在指定位置创建目录，这会创建路径中所有不存在的目录。

renameTo(File dest)

重命名文件或文件夹，也可以操作非空的文件夹，文件不同时相当于文件的剪切,

剪切时候不能操作非空的文件夹。移动/重命名成功则返回true，失败则返回false。

3、删除

delete()

删除文件或一个空文件夹，如果是文件夹且不为空，则不能删除，成功返回true，失败返回false。

deleteOnExit()

在虚拟机终止时，请求删除此抽象路径名表示的文件或目录，保证程序异常时创建的临时文件也可以被删。

4、判断

exists()

文件或文件夹是否存在。

isFile()

是否是一个文件，如果不存在，则始终为false。

isDirectory()

是否是一个目录，如果不存在，则始终为false。

isHidden()

是否是一个隐藏的文件或是否是隐藏的目录。

isAbsolute()

测试此抽象路径名是否为绝对路径名。

5、获取

getName()

获取文件或文件夹的名称，不包含上级路径。

getPath()

返回绝对路径，可以是相对路径，但是目录要指定。

getAbsolutePath()

获取文件的绝对路径，与文件是否存在没关系。

length()

获取文件的大小（字节数），如果文件不存在则返回0L，如果是文件夹也返回0L。

getParent()

返回此抽象路径名父目录的路径名字符串；如果此路径名没有指定父目录，则返回null。

lastModified()

获取最后一次被修改的时间。

6、文件夹相关

staic File[] listRoots()

列出所有的根目录（Window中就是所有系统的盘符）。

list()

返回目录下的文件或者目录名，包含隐藏文件。对于文件这样操作会返回null。

list(FilenameFilter filter)

返回指定当前目录中符合过滤条件的子文件或子目录。对于文件这样操作会返回null。

listFiles()

返回目录下的文件或者目录对象（File类实例），包含隐藏文件。对于文件这样操作会返回null。

listFiles(FilenameFilter filter)

返回指定当前目录中符合过滤条件的子文件或子目录。对于文件这样操作会返回null。

从上面可以知道File中方法很多，但是大概功能点在概述中有所描述，

下面正对每类重要功能点进行分析和代码演示。

1）实例化一个java.io.File对象

实例化一个File对象，就是调用File的构造方法，传入对应参数创建File对象。

如果指定的路径不存在，不会抛异常，这时file.exists()返回false。

在使用File之前，必须通过构造器创建File对象，代码如下：

File file = new File("C:\\mycode\\hello.txt");

2）检测文件是否存在

当你获得一个File对象之后，可以检测相应的文件是否存在。当文件不存在的时候，构造函数并不会执行失败。

通过调用exists()方法，可以检测文件是否存在，代码如下：

File file = new File("C:\\mycode\\hello.txt");

boolean fileExists = file.exists();
3）文件长度

通过调用length()可以获得文件的字节长度，代码如下：

File file = new File("C:\\mycode\\hello.txt");

long length = file.length();
4）重命名或移动文件

通过调用File类中的renameTo()方法可以重命名(或者移动)文件，代码如下：

File file = new File("C:\\mycode\\hello.txt");

boolean success = file.renameTo(new File("C:\\mycode\\hello-rename.txt"));

5）删除文件

通过调用delete()方法可以删除文件，代码如下：

File file = new File("C:\\mycode\\hello.txt");

boolean success = file.delete();

delete()方法与rename()方法一样，返回布尔值表明是否成功删除文件，

同样也会有相同的操作失败原因。

6）检测某个路径是文件还是目录

File对象既可以指向一个文件，也可以指向一个目录。可以通过调用isDirectory()方法，

可以判断当前File对象指向的是文件还是目录。当方法返回值是true时，File指向的是目录，否则指向的是文件，代码如下：

File file = new File("C:\\mycode");

boolean isDirectory = file.isDirectory();

7）读取目录中的文件列表

通过调用list()或者listFiles()方法获取一个目录中的所有文件列表。

list()方法返回当前File对象指向的目录中所有文件与子目录的字符串名称

(不会返回子目录下的文件及其子目录名称)。

listFiles()方法返回当前File对象指向的目录中所有文件与子目录

相关联的File对象(与list()方法类似，不会返回子目录下的文件及其子目录)。

代码如下：

File file = new File("C:\\mycode");

String[] fileNames = file.list();

File[] files = file.listFiles();

因为方法比较多，举一部分简单实例，体验File的使用:

创建文件

package com.jpeony.io.file;

import java.io.File;
import java.io.IOException;

/**
 * 在指定位置创建一个空文件，成功就返回true，如果已存在就不创建然后返回false。
 *
 * @author yihonglei
 */
public class CreateNewFileSimple {

    public static void main(String[] args) {
        // 1.指定文件路径
        File file = new File("C:\\mycode\\test-createNewFile.txt");
        try {
            // 2.调用创建方法创建
            boolean b = file.createNewFile();
            // 3. 创建文件结果
            System.out.println("createNewFile创建文件结果:" + b);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

删除文件或空文件夹

package com.jpeony.io.file;

import java.io.File;

/**
 * delete()
 * 删除文件或一个空文件夹，如果是文件夹且不为空，则不能删除，成功返回true，失败返回false。
 *
 * @author yihonglei
 */
public class DeleteFileSimple {

    public static void main(String[] args) {
        // 指定删除文件目录构建File对象
        File file = new File("C:\\mycode\\test-mkdir");
        // 调用delete()方法
        boolean b = file.delete();
        // 删除结果
        System.out.println("删除结果:" + b);
    }
}

创建目录(mkdir)

package com.jpeony.io.file;

import java.io.File;

/**
 * mkdir():
 * 在指定位置创建目录，这只会创建最后一级目录，如果上级目录不存在就抛异常。
 * 创建成功返回true,否则返回false。
 *
 * @author yihonglei
 */
public class MkdirSimple {

    public static void main(String[] args) {
        // 指定创建目录位置
        File file = new File("C:\\mycode\\test-mkdir");
        // 调用mkdir()在指定位置创建目录
        boolean b = file.mkdir();
        // 打印创建结果
        System.out.println("创建文件目录结果:" + b);
    }

}

创建完整目录(mkdirs)

package com.jpeony.io.file;

import java.io.File;

/**
 * mkdirs()
 * 在指定位置创建目录，这会创建路径中所有不存在的目录。
 *
 * @author yihonglei
 */
public class MkdirsSimple {

    public static void main(String[] args) {
        // 指定文件目录
        File file = new File("C:\\mycode\\test\\mkdirs\\hello-file");
        // 调用mkdirs
        boolean b = file.mkdirs();
        // 创建结果
        System.out.println("创建结果:" + b);
    }

}

文件或列表(list, listFiles)

package com.jpeony.io.file;

import java.io.File;

/**
 *  列出指定目录中所有包含的子文件与子目录
 *
 * @author yihonglei
 */
public class ListFilesDirsSimple {

    public static void main(String[] args) {
        // 1. 根据File相应构造器，创建File对象
        File file = new File("C:\\mycode");
        // 2. 通过list方法得到所包含的所有子目录与子文件名称
        String[] names = file.list();
        // 3. 显示这些名称
        for (int i = 0; i < names.length; i++) {
            System.out.println("文件名称:" + names[i]);
        }
        /*
         * listFiles:
         * 方法返回当前File对象指向的目录中所有文件与子目录
         */
        // 4. 分别显示文件名与文件夹名
        File[] files = file.listFiles();
        for (int i = 0; i < files.length; i++) {
            File myFile = files[i];
            if (myFile.isFile()) {
                System.out.println("子文件名称:" + myFile.getName());
            } else if (myFile.isDirectory()){
                System.out.println("子目录名称:" + myFile.getName());
            }
        }

    }

}