Java中File类，你知道有哪些api方法吗？

逃离我推掉我的手 2021-09-24 09:02 353阅读 0赞

> `创作不易，如果觉得这篇文章对你有帮助，欢迎各位老铁点个赞呗，您的支持是我创作的最大动力！`

### 文章目录 ###

*  1 前言
 *  2 File类
 *  3 创建一个File对象
 *  4 File对象中常用的方法
 *  5 File使用实例
 *   *  5.1 File基础使用
     *  5.2 获取maven仓库中，失败的依赖
     *  5.3 文件和目录的拷贝
     *   *  5.3.1 文件拷贝工具类
         *  5.3.2 拷贝文件的功能
         *  5.3.3 拷贝文件目录的功能
     *  5.4 拷贝jar资源到目标目录
 *  6 总结

# 1 前言 #

Java中的File类，在实际开发中用的还是比较多的，比如说读取资源时，文件上传下载时等场景，这里做一下总结，以后使用的时候，可以很方便的查询api。

# 2 File类 #

Java文件类以抽象的方式代表文件名和目录路径名。该类主要用于`文件和目录的创建`、`文件的查找`和`文件的删除`等。

`File`对象代表磁盘中实际存在的文件和目录。

# 3 创建一个File对象 #

**可以通过以下四种构造方法其中一个，来创建一个File对象：**

通过给定的父抽象路径名和子路径名字符串创建一个新的File实例  
`File(File parent, String child)`

通过将给定路径名字符串转换成抽象路径名来创建一个新 File 实例  
`File(String pathname)`

根据 parent 路径名字符串和 child 路径名字符串创建一个新 File 实例  
`File(String parent, String child)`

通过将给定的 file: URI 转换成一个抽象路径名来创建一个新的 File 实例  
`File(URI uri)`

# 4 File对象中常用的方法 #

创建File对象成功后，可以使用以下表格中的方法来操作文件：

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th align="left">方法名称</th> 
   <th align="left">方法描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td align="left"><code>public String getName()</code></td> 
   <td align="left">返回由此抽象路径名表示的文件或目录的名称</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td align="left">public String getParent()</td> 
   <td align="left">返回此抽象路径名的父路径名的路径名字符串，如果此路径名没有指定父目录，则返回 null</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td align="left"><code>public File getParentFile()</code></td> 
   <td align="left">返回此抽象路径名的父路径名的抽象路径名，如果此路径名没有指定父目录，则返回 null</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td align="left">public String getPath()</td> 
   <td align="left">将此抽象路径名转换为一个路径名字符串</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td align="left">public boolean isAbsolute()</td> 
   <td align="left">判断此抽象路径名是否为绝对路径名</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td align="left"><code>public String getAbsolutePath()</code></td> 
   <td align="left">返回抽象路径名的绝对路径名字符串</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td align="left">public boolean canRead()</td> 
   <td align="left">判断应用程序是否可以读取此抽象路径名表示的文件</td> 
  </tr> 
  <tr> 
   <td>8</td> 
   <td align="left">public boolean canWrite()</td> 
   <td align="left">判断应用程序是否可以修改此抽象路径名表示的文件</td> 
  </tr> 
  <tr> 
   <td>9</td> 
   <td align="left"><code>public boolean exists()</code></td> 
   <td align="left">判断此抽象路径名表示的文件或目录是否存在</td> 
  </tr> 
  <tr> 
   <td>10</td> 
   <td align="left"><code>public boolean isDirectory()</code></td> 
   <td align="left">判断此抽象路径名表示的文件是否是一个目录</td> 
  </tr> 
  <tr> 
   <td>11</td> 
   <td align="left"><code>public boolean isFile()</code></td> 
   <td align="left">判断此抽象路径名表示的文件是否是一个标准文件</td> 
  </tr> 
  <tr> 
   <td>12</td> 
   <td align="left">public long lastModified()</td> 
   <td align="left">返回此抽象路径名表示的文件最后一次被修改的时间</td> 
  </tr> 
  <tr> 
   <td>13</td> 
   <td align="left">public long length()</td> 
   <td align="left">返回由此抽象路径名表示的文件的长度</td> 
  </tr> 
  <tr> 
   <td>14</td> 
   <td align="left">public boolean createNewFile() throws IOException</td> 
   <td align="left">当且仅当不存在具有此抽象路径名指定的名称的文件时，原子地创建由此抽象路径名指定的一个新的空文件</td> 
  </tr> 
  <tr> 
   <td>15</td> 
   <td align="left"><code>public boolean delete()</code></td> 
   <td align="left">删除此抽象路径名表示的文件或目录</td> 
  </tr> 
  <tr> 
   <td>16</td> 
   <td align="left">public void deleteOnExit()</td> 
   <td align="left">在虚拟机终止时，请求删除此抽象路径名表示的文件或目录</td> 
  </tr> 
  <tr> 
   <td>17</td> 
   <td align="left">public String[] list()</td> 
   <td align="left">返回由此抽象路径名所表示的目录中的文件和目录的名称所组成字符串数组</td> 
  </tr> 
  <tr> 
   <td>18</td> 
   <td align="left">public String[] list(FilenameFilter filter)</td> 
   <td align="left">返回<code>由包含在目录中的文件和目录的名称</code>所组成的字符串数组，这一目录是通过满足指定过滤器的抽象路径名来表示的</td> 
  </tr> 
  <tr> 
   <td>19</td> 
   <td align="left"><code>public File[] listFiles()</code></td> 
   <td align="left">返回一个抽象路径名数组，<code>这些路径名表示此抽象路径名所表示目录中的文件</code></td> 
  </tr> 
  <tr> 
   <td>20</td> 
   <td align="left">public File[] listFiles(FileFilter filter)</td> 
   <td align="left">返回表示此抽象路径名所表示目录中的文件和目录的抽象路径名数组，这些路径名满足特定过滤器</td> 
  </tr> 
  <tr> 
   <td>21</td> 
   <td align="left"><code>public boolean mkdir()</code></td> 
   <td align="left">创建此抽象路径名指定的目录</td> 
  </tr> 
  <tr> 
   <td>22</td> 
   <td align="left"><code>public boolean mkdirs()</code></td> 
   <td align="left">创建此抽象路径名指定的目录，包括创建必需但不存在的父目录</td> 
  </tr> 
  <tr> 
   <td>23</td> 
   <td align="left">public boolean renameTo(File dest)</td> 
   <td align="left">重新命名此抽象路径名表示的文件</td> 
  </tr> 
  <tr> 
   <td>24</td> 
   <td align="left">public boolean setLastModified(long time)</td> 
   <td align="left">设置由此抽象路径名所指定的文件或目录的最后一次修改时间</td> 
  </tr> 
  <tr> 
   <td>25</td> 
   <td align="left">public boolean setReadOnly()</td> 
   <td align="left">标记此抽象路径名指定的文件或目录，以便只可对其进行读操作</td> 
  </tr> 
  <tr> 
   <td>26</td> 
   <td align="left">public static File createTempFile(String prefix, String suffix, File directory) throws IOException</td> 
   <td align="left">在指定目录中创建一个新的空文件，使用给定的前缀和后缀字符串生成其名称</td> 
  </tr> 
  <tr> 
   <td>27</td> 
   <td align="left">public static File createTempFile(String prefix, String suffix) throws IOException</td> 
   <td align="left">在默认临时文件目录中创建一个空文件，使用给定前缀和后缀生成其名称</td> 
  </tr> 
  <tr> 
   <td>28</td> 
   <td align="left">public int compareTo(File pathname)</td> 
   <td align="left">按字母顺序比较两个抽象路径名</td> 
  </tr> 
  <tr> 
   <td>29</td> 
   <td align="left">public int compareTo(Object o)</td> 
   <td align="left">按字母顺序比较抽象路径名与给定对象</td> 
  </tr> 
  <tr> 
   <td>30</td> 
   <td align="left">public boolean equals(Object obj)</td> 
   <td align="left">判断此抽象路径名与给定对象是否相等</td> 
  </tr> 
  <tr> 
   <td>31</td> 
   <td align="left">public String toString()</td> 
   <td align="left">返回此抽象路径名的路径名字符串</td> 
  </tr> 
 </tbody> 
</table>

# 5 File使用实例 #

## 5.1 File基础使用 ##

【代码示例】

/** * @author smilehappiness * File对象中，基础api的使用 * @version 1.0 * @ClassName FileUse * @Date 2020/6/6 15:40 */
    public class FileUse { 
    
        public static void main(String args[]) { 
            //测试的目录名称
            String dirName = "d:\\test-case";
            File file = new File(dirName);
            //判断此抽象路径名，是不是目录类型
            if (file.isDirectory()) { 
                System.out.println("Directory of " + dirName);
    
                //返回由此抽象路径名所表示的目录中的文件和目录的名称所组成字符串数组
                String stringArrays[] = file.list();
                for (int i = 0; i < stringArrays.length; i++) { 
                    File f = new File(dirName + "/" + stringArrays[i]);
                    if (f.isDirectory()) { 
                        System.out.println(stringArrays[i] + " is a directory");
                    } else { 
                        System.out.println(stringArrays[i] + " is a file");
                    }
                }
    
                System.out.println("------------------华丽的分割线------------------");
                //返回一个抽象路径名数组，这些路径名表示此抽象路径名所表示目录中的文件
                File fileArrays[] = file.listFiles();
                for (File fileArray : fileArrays) { 
                    File f = new File(dirName + "/" + fileArray);
                    if (f.isDirectory()) { 
                        System.out.println(fileArray + " is a directory");
                    } else { 
                        System.out.println(fileArray + " is a file");
                    }
                }
    
                //判断此抽象路径名，是不是标准文件类型
            } else if (file.isFile()) { 
                System.out.println(dirName + " is not a directory");
            }
        }
    
    }

**执行结果：**

Directory of d:\test-case
    hello is a directory
    log.txt is a file
    Person.dat is a file
    test.txt is a file
    test.txt.bak is a file
    ------------------华丽的分割线------------------
    d:\test-case\hello is a file
    d:\test-case\log.txt is a file
    d:\test-case\Person.dat is a file
    d:\test-case\test.txt is a file
    d:\test-case\test.txt.bak is a file

## 5.2 获取maven仓库中，失败的依赖 ##

项目中，目前普遍使用maven进行项目的构建，但是使用maven时，由于网络不稳定，或者需要翻墙等因素，导致部分jar可能下载失败，只能重新下载才能使项目正常启动，但是下载失败的依赖，如果你不删除，又下载不成功，导致项目启动报错。

如何快速找到哪个依赖报错了呢？找到失败的依赖，删除后，重新下载，绝大多数就成功了，不多唠叨了，见以下解决方案示例：

/** * @author smilehappiness * * 通过读取指定的目录及子目录下指定文件名的路径，获取需要的资源，返回结果为List * @version 1.0 * @ClassName MavenFailDependency * @Date 2020/6/6 14:13 */
    public class MavenFailDependency { 
    
        /** * <p> * 通过指定路径和匹配的内容后缀，来获取目录下的资源文件 * <p/> * * @param path 文件路径 * @param suffix 后缀名, 匹配具体的后缀内容的文件 * @return java.util.List<java.lang.String> * @Date 2020/6/6 14:20 */
        public static List<String> getFilesList(String path, String suffix) { 
            File file = new File(path);
            return MavenFailDependency.listFile(new ArrayList<>(), file, suffix);
        }
    
        /** * <p> * 获取目录下，指定后缀内容的资源文件 * 如：这下失败的依赖 aether-ed239b5e-5ab7-49c1-8f71-df76605fb76e-spring-beans-5.0.5.RELEASE.jar.sha1-in-progress * 以in-progress为结尾的为下载失败的依赖，常见的下载依赖失败的后缀，.sha1-in-progress/.jar-in-progress/.pom-in-progress * <p/> * * @param fileNameList * @param file * @param suffix * @return java.util.List<java.lang.String> * @Date 2020/6/6 14:30 */
        private static List<String> listFile(List<String> fileNameList, File file, String suffix) { 
            if (StringUtils.isBlank(suffix)) { 
                return Collections.emptyList();
            }
    
            // 若是目录, 采用递归的方法遍历子目录（file.isFile()、file.isDirectory()）
            if (file.isDirectory()) { 
                // 获取源目录中所有的子文件（子文件中有目录，也有可能有文件）
                File[] fileList = file.listFiles();
    
                for (File subFile : fileList) { 
                    //递归调用
                    listFile(fileNameList, subFile, suffix);
                }
            } else { 
                // 获取文件的绝对路径
                String filePath = file.getAbsolutePath();
                // 最后一个.(即后缀名前面的.)的索引
                int begIndex = filePath.lastIndexOf(".");
                // 这里可以筛选指定后缀的文件
                if (begIndex != -1) { 
                    //获取到最后一个.结尾后面的内容
                    String suffixValue = filePath.substring(begIndex + 1);
                    // sha1-in-progress包含in-progress
                    // 这里因为指定的后缀与截取.的后缀，名字不一致，所以加一个 || tempSuffix.contains(suffix)条件
                    if (suffixValue.equals(suffix) || suffixValue.contains(suffix)) { 
                        fileNameList.add(filePath);
                    }
                }
            }
    
            return fileNameList;
        }
    
    }

**测试用例：**

/** * <p> * 快速获取，maven仓库中，失败的依赖，找到失败的依赖，删除后，重新下载，功能测试 * <p/> * * @author smilehappiness * @Date 2020/6/6 14:55 */
    public class MavenFailDependencyTest { 
    
        private Logger logger = LoggerFactory.getLogger(this.getClass());
    
        @Test
        public void testGetMavenFailDependency() { 
            //本地maven仓库，依赖下载保存的地址
            String localMavenRepositoryDir = "D:\\workplace\\worktool\\maven";
            List<String> list = MavenFailDependency.getFilesList(localMavenRepositoryDir, "in-progress");
            logger.info("依赖下载失败的个数：{}", list.size());
    
            if (CollectionUtils.isNotEmpty(list)) { 
                for (int i = 0; i < list.size(); i++) { 
                    logger.info("依赖下载失败的目录{}：{}", i, list.get(i));
                }
            }
        }
    
    }

## 5.3 文件和目录的拷贝 ##

### 5.3.1 文件拷贝工具类 ###

给老铁们总结一个拷贝工具类：

/** * <p> * 文件拷贝工具类 * <p/> * * @author smilehappiness * @Date 2020/6/6 11:56 */
    public class FileCopyUtil { 
    
        private FileCopyUtil() { 
    
        }
    
        /** * <p> * 拷贝文件的功能 * <p/> * * @param srcFile 源文件（路径） * @param desPath 目标路径 * @return void * @Date 2020/6/6 11:57 */
        public static void copyFile(String srcFile, String desPath) { 
            // String -> File
            copyFile(new File(srcFile), desPath);
        }
    
        /** * <p> * 拷贝文件的功能 * <p/> * * @param srcFile 源文件（file类型） * @param desPath 目标路径 * @return void * @Date 2020/6/6 12:01 */
        public static void copyFile(File srcFile, String desPath) { 
            // 1.取出源文件名称
            String fileName = srcFile.getName();
    
            // 2.判断目标路径是否存在
            File dPath = new File(desPath);
            if (!dPath.exists()) { 
                //拷贝的目的地路径，如果目录不存在，创建目录
                // boolean mkdir() 创建此抽象路径名指定的目录，创建此抽象路径名指定的目录，包括所有必需但不存在的父目录。
                System.out.println("创建目标路径是否成功：" + dPath.mkdirs());
            }
    
            // 3.设置目标文件名称
            //static String separator() 与系统有关的默认名称分隔符，为了方便，它被表示为一个字符串。
            String desFileName = desPath + File.separator + fileName;
    
            // 声明低级流
            FileInputStream fileInputStream;
            FileOutputStream fileOutputStream;
    
            // 声明高级流
            BufferedInputStream bufferedInputStream = null;
            BufferedOutputStream bufferedOutputStream = null;
    
            try { 
                // 初始化的时候先初始化低级流（FileInputStream为文件字节输入流，FileOutputStream为文件字节输出流）
                fileInputStream = new FileInputStream(srcFile);
                fileOutputStream = new FileOutputStream(desFileName);
    
                // 然后初始化高级流，使用缓冲流提升io性能
                bufferedInputStream = new BufferedInputStream(fileInputStream);
                bufferedOutputStream = new BufferedOutputStream(fileOutputStream);
    
                //定义一个字节数组，相当于缓存
                byte[] b = new byte[1024 * 1024];
                //得到实际读取到的字节数 读到最后返回-1
                int i = 0;
                //循环读取，把bufferedInputStream里的东西读到bytes数组里去
                while ((i = bufferedInputStream.read(b)) != -1) { 
                    bufferedOutputStream.write(b, 0, i);
                }
    
                System.out.println(srcFile + " 文件拷贝到目标目录【" + desPath + "】完成！");
            } catch (FileNotFoundException e) { 
                e.printStackTrace();
            } catch (IOException e) { 
                e.printStackTrace();
            } finally { 
                // 高级流bout关闭的时候,JVM会自动的刷新缓冲区，即在关闭流之前会自动调用flush方法刷新缓存
                try { 
                    if (bufferedOutputStream != null) { 
                        bufferedOutputStream.close();
                    }
                } catch (IOException e) { 
                    e.printStackTrace();
                }
    
                try { 
                    if (bufferedInputStream != null) { 
                        bufferedInputStream.close();
                    }
                } catch (IOException e) { 
                    e.printStackTrace();
                }
            }
        }
    
        /** * <p> * 拷贝目录的功能 * <p/> * * @param srcPath 源目录（路径） * @param desPath 目标目录 * @return void * @Date 2020/6/6 13:13 */
        public static void copyDir(String srcPath, String desPath) { 
            copyDir(new File(srcPath), desPath);
        }
    
        /** * <p> * 拷贝目录的功能 * <p/> * * @param srcPath 源目录（file类型） * @param desPath 目标目录 * @return void * @Date 2020/6/6 13:20 */
        public static void copyDir(File srcPath, String desPath) { 
            // 判断srcPath是文件还是目录
            if (srcPath.isFile()) { 
                // 递归调用，如果是文件则继续调用，直到为一个目录
                copyFile(srcPath, desPath);
            } else { 
                // 获取源目录中所有的子文件
                File[] files = srcPath.listFiles();
    
                // 从源目录中获取要拷贝的目录的名称，例如：从"d:\\test-case"源目录中获取到 test-case 这个目录的名称
                String srcPathName = srcPath.getName();
    
                // 在目标路径中创建要拷贝的目录名称，例如 在d:\\创建 src 目录
                String descPathName = desPath + File.separator;
                // 通过将给定路径名字符串，转换为抽象路径名，来创建一个新 File 实例
                File filePath = new File(descPathName);
    
                // 创建此抽象路径名指定的目录，包括所有必需但不存在的父目录
                if (!filePath.exists()) { 
                    filePath.mkdirs();
                }
    
                // 遍历数组，一个一个目录的拷贝
                for (File file : files) { 
                    // 递归调用
                    copyDir(file, descPathName);
                }
            }
        }
    
    }

### 5.3.2 拷贝文件的功能 ###

/** * <p> * 拷贝文件的功能-测试 * <p/> * * @param * @return void * @Date 2020/6/6 13:33 */
    @Test
    public void testCopyFile() { 
        String srcFile = "D:\\test-case\\log.txt";
        FileCopyUtil.copyFile(srcFile, "d:\\test-case\\src");
    }

### 5.3.3 拷贝文件目录的功能 ###

/** * <p> * 拷贝目录的功能 * <p/> * * @param * @return void * @Date 2020/6/6 13:43 */
        @Test
        public void testCopyDir() { 
            String srcFile = "D:\\test-case";
            FileCopyUtil.copyDir(srcFile, "c:\\test-case\\test");
        }

## 5.4 拷贝jar资源到目标目录 ##

分布式系统项目中，部署测试的时候，需要打jar包部署。为了方便把jar资源上传到uat服务器，可以把maven成功打包后的jar资源统一备份到指定目录，方便使用。

**基础实现代码如下：**

package cn.smilehappiness;
    
    import org.apache.commons.io.FileUtils;
    import org.apache.commons.lang3.StringUtils;
    
    import java.io.File;
    import java.io.FileFilter;
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.regex.Pattern;
    
    /** * <p> * 拷贝项目打包后的jar，到指定的目录，方便后续部署测试 * <p/> * * @author smilehappiness * @Date 2020/7/3 10:13 */
    public class CopyJarToTargetUtil { 
    
        public static void main(String[] args) throws Exception { 
            String srcPath = "D:\\workplace\\git_project\\project-name";
    
            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
            String currentDate = sdf.format(new Date());
            String targetDir = StringUtils.join("D:\\jar-back", "\\", currentDate, "-back-jar");
    
            CopyJarToTargetUtil.copyJar(new File(srcPath), targetDir);
            System.out.println("资源文件拷贝完成！");
        }
    
        /** * <p> * 拷贝资源，把源文件拷贝到指定目录 * <p/> * * @param srcFilePath * @param targetFilePath * @return java.lang.String * @Date 2020/7/3 10:24 */
        public static String copyJar(File srcFilePath, String targetFilePath) throws Exception { 
            File targetFile = new File(targetFilePath);
            //如果目标目录不存在，则创建目录
            if (!targetFile.exists()) { 
                targetFile.mkdirs();
            }
    
            if (srcFilePath.exists() && srcFilePath.isDirectory()) { 
                //获取指定目标目录下，过滤后的资源文件列表
                File[] files = srcFilePath.listFiles(new MyFileFilter());
                for (File file : files) { 
                    if (file.isDirectory()) { 
                        //过滤git目录
                        if (file.getName().endsWith(".git") || file.getName().endsWith(".idea")) { 
                            continue;
                        }
    
                        //递归处理
                        copyJar(file, targetFilePath);
                    } else { 
                        File targetSourceFile = new File(targetFilePath + "\\" + file.getName());
                        FileUtils.copyFile(file, targetSourceFile);
                    }
                }
                return "success";
            } else { 
                return "文件路径不存在";
            }
    
        }
    
        /** * <p> * 过滤 *.jar文件 * <p/> * * @author smilehappiness * @Date 2020/7/3 10:20 */
        static class MyFileFilter implements FileFilter { 
    
            @Override
            public boolean accept(File file) { 
                String fileName = file.getName().toLowerCase();
                /*String regex = "^[A-Za-z-]*-impl-[0-9.]+.jar$"; Pattern compile = Pattern.compile(regex); boolean flag = compile.matcher(fileName).matches();*/
    
                String regex = "^[A-Za-z-]*-impl-[0-9.]+.jar$";//hello-word-impl-1.0.0.jar
                boolean flag = Pattern.matches(regex, fileName);
                if (flag || file.isDirectory()) { 
                    return true;
                }
    
                return false;
            }
    
        }
    
    }

# 6 总结 #

本文主要介绍了Java中File对象基础api的使用。笔者使用File类常用的api方法，写了一些案例，给老铁们加深api方法的印象。File对象，相对来说用的还是比较多的，希望老铁们多多联系和掌握。

参考资料：[https://www.runoob.com/java/java-file.html][https_www.runoob.com_java_java-file.html]

> 写博客是为了记住自己容易忘记的东西，另外也是对自己工作的总结，希望尽自己的努力，做到更好，大家一起努力进步！  
>   
> 如果有什么问题，欢迎大家评论，一起探讨，代码如有问题，欢迎各位大神指正！  
>   
> 给自己的梦想添加一双翅膀，让它可以在天空中自由自在的飞翔！

[https_www.runoob.com_java_java-file.html]: https://www.runoob.com/java/java-file.html