java中的文件操作

基础知识

1.File类对象的常用方法

一、 创建文件和目录
1.createNewFile()
用于创建一个新的文件，如果文件已经存在，则返回 false
File file = new File("C:\\Users\\P51\\Desktop\\file.txt");
file.createNewFile();
2.mkdir()
用于创建一个单一目录，无法创建不存在的父级目录的目录
File file = new File("C:\\Users\\P51\\Desktop\\files");
file.mkdir();
3.mkdirs()
创建目录以及所有不存在的父目录。如果目录已经存在，返回false
File file = new File("C:\\Users\\P51\\Desktop\\files\\test\\testa");
file.mkdirs();二、删除文件或目录
1.delete()
删除文件或空目录。删除成功返回 true，失败返回 false。
2.deleteOnExit()
文件在 JVM 退出时自动删除。删除临时文件的方法三、获取文件和目录信息
1.exists()
检查文件或目录是否存在。
2.isFile()
判断文件是否为普通文件。
3.isDirectory())
判断是否为目录。
4.length()
返回文件的字节长度。对于目录，返回 0。
5.lastModified())
返回文件最后修改的时间，单位为毫秒。
6.getName()
获取文件或目录的名称。
7.getAbsolutePath()
获取文件或目录的绝对路径。
8.getParent()
获取文件的父目录路径。四、列出目录中的文件
1.file.listFiles()
返回目录中所有文件和子目录的 File 对象数组。
2.file.list()
方法仅返回目录下的文件名（不包括文件的属性）。这个方法通常比 listFiles() 更快速，因为它只返回文件名字符串，而不返回File 对象。
五、文件权限操作
1.setReadable(boolean readable)设置文件是否可读。
2.setWritable(boolean writable)设置文件是否可写。
3.setExecutable(boolean executable)设置文件是否可执行。（一般指的是脚本文件）
六、文件路径相关操作
1.renameTo(File dest)
重命名文件或将文件移动到目标路径。如果重命名成功，返回 true
2.toURI()获取文件的 URI。

2.File类的静态方法

//创建临时文件
File tempFile = File.createTempFile("test", ".txt", new File("C:\\Users\\P51\\Desktop\\files\\test\\testa"));
//这里就可以调用以下方法，该方法会在JVM 退出时自动删除文件
tempFile.deleteOnExit();

一、将数据作为文件保存到本地（序列化）

Java 序列化是一种将对象状态转换为字节序列的过程，以便可以将其持久化到磁盘或通过网络发送到其他 JVM 实例。序列化是 Java 的一种内置机制，它允许你将对象转换为字节流，之后可以将这些字节流重新转换回对象。

步骤

1.实现 Serializable 接口

要使一个类的对象可序列化，该类需要实现 java.io.Serializable 接口。这是一个标记接口，不包含任何方法。

2. serialVersionUID

为了确保序列化和反序列化过程中的版本兼容性，建议在类中声明一个名为 serialVersionUID 的静态常量。如果类在序列化后被修改，而没有更新这个版本号，反序列化时可能会抛出InvalidClassException。

public class MyClass implements Serializable {private static final long serialVersionUID = 1L;private int id;private String name;// 构造函数、getter 和 setter}

3.定义输出编码格式（GBK，UTF-8等）进行输出

3.1基本的文件输出流（OutputStream）

使用 FileOutputStream 时，可以在写入数据之前将字符串转换为字节数组，并指定编码格式。

在 getBytes() 方法中传入 charset 参数来指定编码格式

public static void main(String[] args) {String data = "Hello, world!";String filePath = "path/to/your/output.txt";String charset = "UTF-8"; // 指定编码格式try (OutputStream outputStream = new FileOutputStream(filePath)) {byte[] bytes = data.getBytes(charset);outputStream.write(bytes);System.out.println("File exported successfully.");} catch (IOException e) {e.printStackTrace();} finally{outputStream.close();        }}

3.2BufferedWriter 和 FileWriter（推荐使用）

这种方法在处理大量数据时性能表现较好，因为它们使用了缓冲机制，可以减少频繁的磁盘访问。

在 OutputStreamWriter 的构造函数中传入 charset 参数来指定编码格式。

public static void main(String[] args) {String filePath = "path/to/your/output.txt";String charset = "UTF-8"; // 指定编码格式try (BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(filePath), charset))) {writer.write("Line 1\n");writer.write("Line 2\n");writer.write("Line 3\n");System.out.println("File exported successfully.");} catch (IOException e) {e.printStackTrace();} finally{//关闭流write.close();        }}

demo示例

List<ClientLog> clientLogList = clientLogRepository.findAll();
DateTimeFormatter simpleDateFormat = DateTimeFormatter.ofPattern("yyyy-MM-dd HH-mm-ss");
String fileFullPath;
if(startDate != null && endDate != null) {fileFullPath = downloadPath + File.separator + "log-client" + File.separator +simpleDateFormat.format(startDate) + "-" + simpleDateFormat.format(endDate) + ".txt";
}else {fileFullPath = downloadPath + File.separator + "log-client" + File.separator +simpleDateFormat.format(LocalDateTime.now()) + ".txt";
}
File file = new File(downloadPath + File.separator + "log-client");
if(!file.exists()){file.mkdir();
}
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(fileFullPath), "GBK"));
StringBuilder stringBuilder = new StringBuilder();
for (Object line:clientLogList){//JSON解析,按需添加//String jsonString = JSON.toJSONString(line);stringBuilder.append(jsonString).append("\n");
}
writer.write(stringBuilder.toString());
//使用完流要关闭，否则可能没有内容
writer.close();

二、读取本地的指定文件内容并返回给前端文件流

步骤

1.读取文件

按照文件路径来进行读取。

注意读取指定文件时一定把文件名写全包括文件的后缀（txt,pdf,json等）

String filePath = "path_to_your_file"; 
// 替换为你的文件路径File file = new File(filePath);

方式1：使用 java.io 包（将内容存储为缓冲输入流

String filePath = "path_to_your_file.txt";try (BufferedReader reader = new BufferedReader(new InputStreamReader(new FileInputStream(filePath), "UTF-8"))) {String line;while ((line = reader.readLine()) != null) {System.out.println(line);}} catch (IOException e) {e.printStackTrace();}

方式2：使用 java.nio.file 包（将内容存储为集合）

String filePath = "path_to_your_file.txt";try {List<String> lines = Files.readAllLines(Paths.get(filePath));for (String line : lines) {System.out.println(line);}} catch (IOException e) {e.printStackTrace();}

方式3：如果需要读取整个文件为字节数组（适用于二进制文件）

可以使用Files.readAllBytes 方法。

String filePath = "path_to_your_file.bin";try {byte[] bytes = Files.readAllBytes(Paths.get(filePath));System.out.println("File size: " + bytes.length + " bytes");} catch (IOException e) {e.printStackTrace();}

方式4：使用 java.util.Scanner

 String filePath = "path_to_your_file.txt";try (Scanner scanner = new Scanner(new File(filePath))) {while (scanner.hasNextLine()) {System.out.println(scanner.nextLine());}} catch (FileNotFoundException e) {e.printStackTrace();}

方式5： 使用第三方库如 Apache Commons IO

String filePath = "path_to_your_file.txt";File file = new File(filePath);try {List<String> lines = FileUtils.readLines(file, "UTF-8");for (String line : lines) {System.out.println(line);}} catch (IOException e) {e.printStackTrace();}

2.文件读取和返回

2.1检查文件是否存在

.exists()

if (file.exists()) { ... }

2.2设置响应类型和头部信息

这两行代码告诉浏览器返回的内容是一个二进制流，同时指定了下载文件时的文件名。

response.setContentType("application/octet-stream");
response.setHeader("Content-Disposition", "attachment; filename=" + file.getName());

响应类型（即MIME类型）：常见 MIME 类型列表 - HTTP | MDN (mozilla.org)

application/x-download 是一种被废弃的 MIME 类型，用于指示要下载的文件类型。它在过去被广泛使用，但现在已经不推荐使用了。

MIME（Multipurpose Internet Mail Extensions）是一种互联网标准，用于标识文档的性质和格式。MIME类型通常由一种主要类型和一个子类型组成，中间使用斜杠分隔。主要类型表示文档的大类，例如文本、图像、音频等，而子类型则表示特定类型的细分，比如文本类型可以进一步细分为HTML、XML等。

MIME类型在互联网上的应用非常广泛，最常见的用途之一是通过HTTP协议来指示服务器发送的文件类型。这对于浏览器正确解释和展示不同类型的文件至关重要，比如指示浏览器一个链接指向的是图片、视频、文本还是其他类型的文件。

除了在Web开发中的应用外，MIME类型还被用于电子邮件系统中，以标识附件的类型，并确保接收者能够正确地打开或处理这些附件。MIME类型的标准化使得不同系统之间能够准确地识别和处理各种类型的文档，提高了互操作性和信息交换的可靠性。

2.3创建输入流和输出流

使用文件的输入流读取文件内容，然后使用响应的输出流将文件内容写入响应中。

 try (InputStream inputStream = new FileInputStream(file);
OutputStream outputStream = response.getOutputStream());

2.4通过循环读取和写入数据实现文件流返回

这个循环从输入流中读取数据到缓冲区，然后将数据写入到响应的输出流中。

 byte[] buffer = new byte[1024];int bytesRead;while ((bytesRead = inputStream.read(buffer)) != -1) {outputStream.write(buffer, 0, bytesRead);}

问题：为什么不能直接将输入流的数据写入到响应流中，而是需要使用缓冲区。

原因解析：

1.提高传输效率：

使用缓冲区可以减少 I/O 操作的次数，提高数据传输的效率。每次从输入流读取一定大小的数据块，然后再写入输出流，比每次只读写一个字节要高效得多。

2.减少系统调用次数：

每次对流进行读写操作都会涉及到系统调用，这些调用是有开销的。如果每次只读写一个字节，将会产生大量的系统调用，导致程序性能下降。使用缓冲区一次处理多个字节，可以显著减少系统调用次数。

3.兼容性和可移植性：

不同的底层实现可能对单字节读写操作有不同的优化程度。使用缓冲区适应性更强，能保证在各种环境下都能高效运行。

4.代码简洁性和可读性：

使用缓冲区使代码更加简洁明了，逻辑清晰。直接逐字节操作不仅繁琐，而且容易引入错误。

示例代码

import java.io.InputStream;
import java.io.OutputStream;
import java.io.IOException;public class StreamCopyUtil {public static void copyStream(InputStream inputStream, OutputStream outputStream) throws IOException {byte[] buffer = new byte[4096];int bytesRead;while ((bytesRead = inputStream.read(buffer)) != -1) {outputStream.write(buffer, 0, bytesRead);}}
}

缓冲区的作用

1.缓冲区大小：

在上面的例子中，缓冲区大小为 4096 字节（4KB）。这个大小是一个折衷，既不会太小以至于频繁地调用系统 I/O 操作，也不会太大造成不必要的内存占用。具体大小可以根据实际应用场景调整。

2.循环读取和写入：

循环读取输入流中的数据到缓冲区，然后将缓冲区中的数据写入输出流。每次读取和写入的字节数由 read() 方法返回的字节数决定。

直接逐字节操作的缺点

如果不使用缓冲区，直接逐字节操作的代码如下：

javaCopy Codepublic static void copyStreamUnbuffered(InputStream inputStream, OutputStream outputStream) throws IOException {int byteData;while ((byteData = inputStream.read()) != -1) {outputStream.write(byteData);}
}

这种方法虽然也能完成任务，但由于每次只读写一个字节，会造成频繁的系统调用，导致性能低下。

总结

使用缓冲区来进行数据传输是一种常见且有效的优化方式，可以显著提高数据传输的效率，减少系统调用的开销，并使代码更加简洁和易于维护。这也是为什么在实际开发中，通常会看到使用缓冲区来处理输入流和输出流的操作。

2.5 关闭流

关闭流是非常重要的，因为它可以释放系统资源并确保数据完全写入。在实际开发中，为了避免资源泄漏和确保数据完整性，我们应该在使用完流之后及时关闭它们。

这里在使用BufferedWriter写入文件时没有内容就是因为没有关闭流导致写入是无效的，因此一定要关闭流。（本人就因为忘记关闭流而导致写入的文件内容为空）。

JAVA-BufferedWriter写入文件没有内容_bufferedwriter写入后为空-CSDN博客

inputStream.close();
outputStream.flush();
outputStream.close();

在处理输出流时，除了关闭流以外，有时还需要使用 flush() 方法。

flush() 方法的作用是将缓冲区中的数据强制写出到目标设备（如文件、网络等）中。这个方法在某些情况下非常重要，例如在进行网络通信时，需要确保数据被及时发送出去。

关闭流时自动 flush。需要注意的是，当你调用 close() 方法关闭输出流时，流会自动调用 flush() 方法。所以，在大多数情况下，只要在完成写入操作后正确地关闭流，就已经隐式地完成了 flush 操作。

demo示例

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {String filePath = "C:\Users\P51\Desktop\files\test.txt"; // 替换为你的文件路径File file = new File(filePath);if (file.exists()) {response.setContentType("application/octet-stream");response.setHeader("Content-Disposition", "attachment; filename=" + file.getName());//不是非必要response.setHeader("Content-Length", String.valueOf(file.length()));try (InputStream inputStream = new FileInputStream(file);OutputStream outputStream = response.getOutputStream()) {byte[] buffer = new byte[1024];int bytesRead;while ((bytesRead = inputStream.read(buffer)) != -1) {outputStream.write(buffer, 0, bytesRead);}}//一定要关闭流，不要忘记！！！！！inputStream.close();outputStream.flush();outputStream.close();} else {response.getWriter().write("File not found");}}

最后祝大家新的一年，事业有成，学有所成！