一、概述
java.io.File 类是文件和目录路径名(相对路径名或绝对路径名)的抽象表示,主要用于文件和目录的创建、查找和删除等操作。
二、构造方法
public File(String pathname) :通过将给定的路径名字符串转换为抽象路径名来创建新的 File实例。
public File(String parent, String child) :从父路径名字符串和子路径名字符串创建新的 File实例。
public File(File parent, String child) :从父抽象路径名和子路径名字符串创建新的 File实例。
构造举例,代码如下:
// 文件路径名 String pathname = "D:\\aaa.txt"; File file1 = new File(pathname); // 文件路径名 String pathname2 = "D:\\aaa\\bbb.txt"; File file2 = new File(pathname2); // 通过父路径和子路径字符串 String parent = "d:\\aaa"; String child = "bbb.txt"; File file3 = new File(parent, child); // 通过父级File对象和子路径字符串 File parentDir = new File("d:\\aaa"); String child = "bbb.txt"; File file4 = new File(parentDir, child);
小贴士:
1、 一个File对象代表硬盘中实际存在的一个文件或者目录。
2、 无论该路径下是否存在文件或者目录,都不影响File对象的创建。
三、常见方法
1、获取功能的方法
public String getAbsolutePath() :返回此File的绝对路径名字符串。
public String getPath() :将此File转换为路径名字符串。
public String getName() :返回由此File表示的文件或目录的名称。
public long length() :返回由此File表示的文件的长度。该方法获取的是构造方法指向的文件的大小。以字节为单位,文件夹是没有大小概念的,不能获取文件夹的大小,返回的是0。如果构造方法中给出的文件不存在,那么length()方法返回0.
getAbsolutePath()和getPath()方法的区别:
getAbsolutePath():不管你传入的是相对路径还是绝对路径,返回的都是绝对路径。而对于getPath()方法,如果传入的是相对路径,那么返回的是相对路径。
方法演示,代码如下:
public class FileGet { public static void main(String[] args) { File f = new File("D:/upload/20211013/1.txt"); System.out.println("文件绝对路径:"+f.getAbsolutePath()); // 文件绝对路径:D:\upload\20211013\1.txt System.out.println("文件构造路径:"+f.getPath()); // 文件构造路径:D:\upload\20211013\1.txt System.out.println("文件名称:"+f.getName()); // 文件名称:1.txt System.out.println("文件长度:"+f.length()+"字节"); // 文件长度:9字节 File f2 = new File("D:/upload"); System.out.println("目录绝对路径:"+f2.getAbsolutePath()); // 目录绝对路径:D:\upload System.out.println("目录构造路径:"+f2.getPath()); // 目录构造路径:D:\upload System.out.println("目录名称:"+f2.getName()); // 目录名称:upload System.out.println("目录长度:"+f2.length()); // 目录长度:4096 } }
API中说明:length(),表示文件的长度。但是File对象表示目录,则返回值未指定。
注意:File的toString()方法就是调用getPath()方法
public String toString() { return getPath(); }
如果不希望使用toString()得到对象的内存地址,那么就可以对它进行覆盖重写。
绝对路径和相对路径
绝对路径:从盘符开始的路径,这是一个完整的路径。
相对(项目根目录)路径:相对于项目根目录的路径,这是一个便捷的路径,可以简化书写,开发中经常使用。
如项目根路径为:D:\\project\\prism\\java9-test,我们可以将D:\\project\\prism\\java9-test\\aaa.txt简化书写为aaa.txt。可以省略项目的根目录。
注意:
(1)、路径不区分大小写
(2)、路径中的文件名称分隔符:windows使用反斜杠,由于反斜杠是转义字符,故两个反斜杠代表一个普通的反斜杠。
public class FilePath { public static void main(String[] args) { // D盘下的bbb.java文件 File f = new File("D:/upload/20211013/1.txt"); System.out.println(f.getAbsolutePath()); // D:\\upload\\20211013\\1.txt // 项目下的bbb.java文件 File f2 = new File("FileGet.java"); System.out.println(f2.getAbsolutePath()); // D:\\project\\prism\\java9-test\\FileGet.java } }
2、判断功能的方法
public boolean exists() :此File表示的文件或目录是否实际存在。
public boolean isDirectory() :此File表示的是否为目录。
public boolean isFile() :此File表示的是否为文件。
方法演示,代码如下:
public class FileIs { public static void main(String[] args) { File f = new File("D:/upload/20211013/1.txt"); File f2 = new File("D:/upload"); // 判断是否存在 System.out.println("D:/upload/20211013/1.txt 是否存在:"+f.exists()); System.out.println("D:/upload 是否存在:"+f2.exists()); // 判断是文件还是目录 System.out.println("D:/upload 文件?:"+f2.isFile()); System.out.println("D:/upload 目录?:"+f2.isDirectory()); } }
结果:
D:/upload/20211013/1.txt 是否存在:true D:/upload 是否存在:true D:/upload 文件?:false D:/upload 目录?:true
3、创建删除功能的方法
public boolean createNewFile() :当且仅当具有该名称的文件尚不存在时,创建一个新的空文件。
public boolean delete() :删除由此File表示的文件或目录。
public boolean mkdir() :创建由此File表示的目录。
public boolean mkdirs() :创建由此File表示的目录,包括任何必需但不存在的父目录。创建多级目录
方法演示,代码如下:
public class FileCreateDelete { public static void main(String[] args) throws IOException { // 文件的创建 File f = new File("aaa.txt"); System.out.println("是否存在:"+f.exists()); // false System.out.println("是否创建:"+f.createNewFile()); // true 在项目根目录下创建aaa.txt文件 System.out.println("是否存在:"+f.exists()); // true // 目录的创建 File f2= new File("newDir"); System.out.println("是否存在:"+f2.exists());// false System.out.println("是否创建:"+f2.mkdir()); // true 在项目根目录下创建newDir文件夹 System.out.println("是否存在:"+f2.exists());// true // 创建多级目录 File f3= new File("newDira\\newDirb"); System.out.println(f3.mkdir());// false File f4= new File("newDira\\newDirb"); System.out.println(f4.mkdirs());// true 在项目根目录下创建newDira/newDirb多级文件夹 // 文件的删除 System.out.println(f.delete());// true // 目录的删除 System.out.println(f2.delete());// true System.out.println(f4.delete());// false } }
创建的文件夹如下所示:
API中说明:delete方法,如果此File表示目录,则目录必须为空才能删除。
项目使用:
List<AttachFile> list = attachFileMapper.select(attachFile); list.forEach(item -> { attachFileMapper.deleteByPrimaryKey(item.getFileId()); //删除图片 String filePath = nfsRootPath+item.getUploadPath()+"/"+item.getFileName(); File file = new File(filePath); if(file.exists()){ // 先判断文件是否存在,存在则删除 file.delete(); } });
如果目录不存在,则创建目录
String path1 = nfsRootPath + "/";
File exportPath1 = new File(path1);
if (!exportPath1.exists()) exportPath1.mkdir();
将二进制数据写入文件
/** * 118. * <p> * 119. * 二进制数据写文件 * 120. * </p> * 121. * * 122. * @param bytes 二进制数据 * 123. * @param filePath 文件生成目录 * 124. */ public static void byteArrayToFile(byte[] bytes, String filePath) throws Exception { InputStream in = new ByteArrayInputStream(bytes); // 接收字节数组作为参数创建字节数组输入流 File destFile = new File(filePath); // 根据路径名字符串创建File对象,filePath为文件路径名 if (!destFile.getParentFile().exists()) { // 判断父路径是否存在,如果不存在,则通过mkdirs()方法创建多级目录 destFile.getParentFile().mkdirs(); } destFile.createNewFile(); // 创建一个空的新文件, OutputStream out = new FileOutputStream(destFile); byte[] cache = new byte[CACHE_SIZE]; int nRead = 0; while ((nRead = in.read(cache)) != -1) { out.write(cache, 0, nRead); out.flush(); } out.close(); in.close(); }
4、目录的遍历
public String[] list() :返回一个String数组,表示该File目录中的所有子文件或目录的名称。
public File[] listFiles() :返回一个File数组,表示该File目录中的所有的子文件或目录。
示例:
public class FileFor { public static void main(String[] args) { File dir = new File("D:\\upload\\20211013"); //获取当前目录下的文件以及文件夹的名称。 String[] names = dir.list(); for(String name : names){ System.out.println(name); } //获取当前目录下的文件以及文件夹对象,只要拿到了文件对象,那么就可以获取更多信息 File[] files = dir.listFiles(); for (File file : files) { System.out.println(file); // 打印File对象,就是打印File.toString() } } }
结果如下:
1.txt 13e74a23-a901-4c66-ad52-84ef510d43a0.jpg aa f507acb3-d8dc-4da4-9d4d-c27605709ae5.jpg src=http___img.jj20.com_up_allimg_mx11_0313201H637_2003131H637-0-lp.jpg&refer=http___img.jj20.jpg u=3030472672,2110611487&fm=253&fmt=auto&app=138&f=JPEG.jpg D:\upload\20211013\1.txt D:\upload\20211013\13e74a23-a901-4c66-ad52-84ef510d43a0.jpg D:\upload\20211013\aa D:\upload\20211013\f507acb3-d8dc-4da4-9d4d-c27605709ae5.jpg D:\upload\20211013\src=http___img.jj20.com_up_allimg_mx11_0313201H637_2003131H637-0-lp.jpg&refer=http___img.jj20.jpg D:\upload\20211013\u=3030472672,2110611487&fm=253&fmt=auto&app=138&f=JPEG.jpg
小贴士:调用listFiles方法的File对象,表示的必须是实际存在的目录,否则返回null,无法进行遍历。
通过路径,返回路径里的所有文件
/** * 通过路径,返回路径里的所有文件 * @param path * @return */ private static void getFilesByDir(String path, List<String> fileNames) { File file = new File(path); // 如果这个路径是文件夹 if (file.isDirectory()) { // 获取路径下的所有文件 File[] files = file.listFiles(); // 返回该目录的所有子文件或目录 for (int i = 0; i < files.length; i++) { // 通过for循环遍历 // 如果还是文件夹 递归获取里面的文件 文件夹 if (files[i].isDirectory()) { // System.out.println("目录:" + files[i].getPath()); getFilesByDir(files[i].getPath(), fileNames); } else { fileNames.add(files[i].getName()); } } } else { fileNames.add(file.getName()); } }
四、正斜杠和反斜杠的区别
(1)、windows的路径分隔符是\;
在Windows中,路径分隔采用反斜杠\”,比如"C:\Windows\System"
(2)、但\也是转义字符,所以需要写成\\;
有时我们会看到这样的路径写法,"C:\\Windows\\System”也就是用两个反斜杠来分隔路径,这种写法在网络应用或编程中经常看到
(3)、其他操作系统都是用/
在Unix/Linux 网络地址中,路径的分隔采用正斜杠”/”,比如”/home/hutaow"
(4)、windows也支持/
事实上,上面这个路径可以用"C:/Windows/System"来代替,不会出错。
但是如果写成了"C:\Windows\System",那就可能会出现各种奇怪的错误了。
比如微信开发者工具中图片src出现:http://192.168.10.114:8012/upload\20230224\e4ae8832-846b-43ae-8eda-395d42e81b71.png,图片将无法显示。微信小程序中image组件要想显示图片,应该写为如下所示:
http://192.168.10.114:8012/upload/20230224/e4ae8832-846b-43ae-8eda-395d42e81b71.png
常见问题:
(1)、根据文件路径截取文件名称是,使用\来截取
错误代码如下:
String filePath = outstoreUploadLog.getFilePath(); String fileName = filePath.substring(filePath.lastIndexOf("\\") + 1); String path = filePath.substring(0, filePath.lastIndexOf("\\"));
由于windows系统中为\,在windows系统中,当使用\\获取路径文件名称时,不会出错。但是在linux系统中,不存在\,故后台会报错。
修改如下:
即通过File.separator来分割。
@Override public void download(Long id, String queryDate, HttpServletResponse response) throws IOException { String tableName = outstoreLogTableName + queryDate; OutstoreUploadLog outstoreUploadLog = outstoreUploadLogMapper.selectById(id, tableName); String filePath = outstoreUploadLog.getFilePath(); String fileName = filePath.substring(filePath.lastIndexOf(File.separator) + 1); String path = filePath.substring(0, filePath.lastIndexOf(File.separator)); FileUtil.downloadFile(tempPath + path, fileName, response); }
(2)、后台在文件上传后,保存文件路径时,需要将\转成/
vue页面中img标签不管是\还是/都能显示图片,如:http://192.168.10.114:8012/upload\20230224\e4ae8832-846b-43ae-8eda-395d42e81b71.png,但是微信小程序的image组件无法显示带有反斜杠\的src。
错误代码:
public Result uploadImage(MultipartFile multipartFile) { Map<String, String> uploadMap = FileUtil.imgUpload(multipartFile, uploadPath); String fullPath = uploadMap.get("uploadPath") + File.separator + uploadMap.get("fileName"); String imgPath = File.separator + uploadMap.get("dirPath") + File.separator + uploadMap.get("fileName"); fullPath = fullPath.replace("\\", SystemConst.FILE_SEPARATOR); uploadMap.put("uploadPath", fullPath); uploadMap.put("imgPath", imgPath); return Result.operating("文件上传成功", true, ResultCode.SUCCESS, uploadMap); }
其中:public static String FILE_SEPARATOR = "/";
由于imgPath没有将\转成/,故小程序中无法显示图片。
修改如下:
public Result uploadImage(MultipartFile multipartFile) { Map<String, String> uploadMap = FileUtil.imgUpload(multipartFile, uploadPath); String fullPath = uploadMap.get("uploadPath") + File.separator + uploadMap.get("fileName"); String imgPath = File.separator + uploadMap.get("dirPath") + File.separator + uploadMap.get("fileName"); fullPath = fullPath.replace("\\", SystemConst.FILE_SEPARATOR); imgPath = imgPath.replace("\\", SystemConst.FILE_SEPARATOR); uploadMap.put("uploadPath", fullPath); uploadMap.put("imgPath", imgPath); return Result.operating("文件上传成功", true, ResultCode.SUCCESS, uploadMap); }