Java java.nio.file.Files.newBufferedWriter()Method

Java File Java java.nio.file.Files

Files.newBufferedWriter()The method is used to create aBufferedWriterobject that can efficiently write text to the specified file. Compared with traditionalFileWriterit provides buffering functionality, which can significantly improve write performance.

Method Definition

public static BufferedWriter newBufferedWriter(Path path, OpenOption... options) throws IOException
public static BufferedWriter newBufferedWriter(Path path, Charset charset, OpenOption... options) throws IOException

Parameter Analysis

Path path

  • Function: Specifies the file path to write to
  • Example： 
    Path path = Paths.get("example.txt");

Charset charset(Optional)

  • Function: Specifies the character encoding format
  • Default value: If not specified, UTF-8 encoding is used by default
  • Common encodings：
    • StandardCharsets.UTF_8
    • StandardCharsets.ISO_8859_1
    • StandardCharsets.US_ASCII

OpenOption... options(Optional)

  • Function: Specifies the file open mode
  • Common options：
    • StandardOpenOption.CREATE- Create the file if it does not exist
    • StandardOpenOption.APPEND- Append to the end of the file
    • StandardOpenOption.TRUNCATE_EXISTING- Clear existing file content
    • StandardOpenOption.WRITE- Open for writing

Basic Usage Examples

Example 1: Basic Writing

Example

import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;

public class BufferedWriterExample {
    public static void main(String[] args) {
        Path path = Paths.get("output.txt");
       
        try (BufferedWriter writer = Files.newBufferedWriter(path)) {
            writer.write("Hello, World!");
            writer.newLine();  // Write newline
            writer.write("This is a new line.");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Example 2: Specifying Encoding and Options

Example

import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;

public class BufferedWriterExample2 {
    public static void main(String[] args) {
        Path path = Paths.get("output_append.txt");
       
        try (BufferedWriter writer = Files.newBufferedWriter(
                path,
                StandardCharsets.UTF_8,
                StandardOpenOption.CREATE,
                StandardOpenOption.APPEND)) {
            writer.write("Appended line 1");
            writer.newLine();
            writer.write("Appended line 2");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Advanced Usage

Batch Writing Large Amounts of Data

Example

import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.stream.IntStream;

public class LargeFileWriter {
    public static void main(String[] args) {
        Path path = Paths.get("large_file.txt");
       
        try (BufferedWriter writer = Files.newBufferedWriter(path)) {
            IntStream.range(0, 100000).forEach(i -> {
                try {
                    writer.write("Line " + i + "\n");
                } catch (IOException e) {
                    e.printStackTrace();
                }
            });
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Best Practices

  1. Use try-with-resources: EnsureBufferedWriterautomatically closes after use
  2. Handling exceptions: Always handle possibleIOException
  3. Reasonably choose buffer size: The default buffer size is usually sufficient, but you can adjust it throughBufferedWriterconstructor adjustment
  4. Consider encoding: Explicitly specify the character encoding to avoid cross-platform issues
  5. Batch writing: For large amounts of data, consider batch writing instead of single writes

Frequently Asked Questions

Q1: Compared toFileWriterWhat are the advantages?

newBufferedWriter()It provides buffering functionality, reduces the number of actual I/O operations, and significantly improves write performance.

Q2: How to ensure the file is properly closed?

Using try-with-resources syntax ensures that resources are automatically closed, even when exceptions occur.

Q3: What is the difference between append mode and overwrite mode?

  • Append mode (APPEND) adds new content at the end of the file
  • Overwrite mode (TRUNCATE_EXISTING) clears the original content of the file

Summary

Files.newBufferedWriter()It is a powerful and flexible file writing tool in Java NIO. It combines buffering technology and multiple open options, providing an efficient and safe solution for file writing operations. By using this method reasonably, you can significantly improve the performance and reliability of file writing.

Java File Java java.nio.file.Files

Other extensions