ReadString: примеры (JAVA)

Базовые примеры использования

Несложные демонстрации чтения с показом кода и результата.

Пример 1. Чтение небольшого файла простым способом.

import java.nio.file.*;
import java.io.IOException;

public class Ex1 {
  public static void main(String[] args) throws IOException {
    Path p = Paths.get("sample.txt");
    Files.writeString(p, "Привет\nМир");
    String s = Files.readString(p);
    System.out.println(s);
  }
}

Привет
Мир

Пример 2. Чтение с явной кодировкой UTF-8.

import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.IOException;

public class Ex2 {
  public static void main(String[] args) throws IOException {
    Path p = Paths.get("utf8.txt");
    Files.writeString(p, "Текст с Unicode");
    String s = Files.readString(p, StandardCharsets.UTF_8);
    System.out.println(s);
  }
}

Текст с Unicode

Пример 3. Обработка ошибки отсутствующего файла.

import java.nio.file.*;
import java.io.IOException;

public class Ex3 {
  public static void main(String[] args) {
    Path p = Paths.get("no-such-file.txt");
    try {
      String s = Files.readString(p);
      System.out.println(s);
    } catch (IOException e) {
      System.out.println("Ошибка: " + e.getClass().getSimpleName() + ": " + e.getMessage());
    }
  }
}

Ошибка: NoSuchFileException: no-such-file.txt

Аналоги внутри Java и их особенности

В экосистеме Java доступно несколько подходов, которые частично заменяют Files.readString в разных сценариях.

• Files.readAllBytes(Path) + new String(bytes, charset) - эквивалент по результату. Более явно показывает работу с байтами, полезно при дополнительной обработке байтов.
• Files.lines(Path, Charset) - возвращает поток строк Stream<String>. Удобно для ленивой построчной обработки и больших файлов, так как не загружает весь файл в память сразу.
• Files.newBufferedReader(Path, Charset) и BufferedReader.readLine() - традиционный построчный подход с контролем буферизации и ресурсами.
• Scanner - удобен для разбора по токенам или чтения отдельных значений, но медленнее и менее предсказуем в плане кодировок по умолчанию.
• FileChannel.map - использование memory-mapped файла для очень больших файлов, когда требуется производительность и частичный доступ без загрузки всего файла в кучу.

Выбор предпочтительного метода зависит от размера файла, требований к памяти, необходимости построчной обработки и скорости. Для простого чтения небольших файлов Files.readString обеспечивает лаконичность и удобство.

Аналоги в других языках и их особенности

Краткие эквиваленты в популярных языках с примером чтения того же файла sample.txt содержащего "Привет\nМир".

PHP

$s = file_get_contents('sample.txt');
echo $s;

Привет
Мир

JavaScript (Node.js)

const fs = require('fs');
const s = fs.readFileSync('sample.txt', 'utf8');
console.log(s);

Привет
Мир

Python

from pathlib import Path
s = Path('sample.txt').read_text(encoding='utf-8')
print(s)

Привет
Мир

C# (.NET)

using System;
using System.IO;
class P { static void Main(){
  var s = File.ReadAllText("sample.txt");
  Console.WriteLine(s);
}}

Привет
Мир

Go

package main
import (
  "fmt"
  "os"
)
func main(){
  b, _ := os.ReadFile("sample.txt")
  fmt.Print(string(b))
}

Привет
Мир

Kotlin

import java.nio.file.Files
import java.nio.file.Paths
fun main(){
  val s = Files.readString(Paths.get("sample.txt"))
  println(s)
}

Привет
Мир

Lua

local f = io.open('sample.txt','r')
local s = f:read('*a')
f:close()
print(s)

Привет
Мир

SQL (PostgreSQL, при наличии прав на файловой системе)

SELECT pg_read_file('sample.txt', 0, 10000);

Привет
Мир

Особенности и отличия: большинство языков предоставляет синхронные утилиты для чтения всего файла в память, но нюансы с кодировками, правами и безопасностью зависят от окружения. В браузерном JavaScript чтение локального файла требует других API, а в SQL обычно доступ возможен только на сервере и с ограничениями безопасности.

Типичные ошибки и их причины

Распространные ситуации при использовании метода.

• NoSuchFileException - файл не найден по указанному пути. Частая причина: неправильный относительный путь, запуск из другой рабочей директории.
• AccessDeniedException - недостаточно прав для чтения файла.
• IOException - общая ошибка ввода-вывода, возникающая при проблемах с диском или доступом.
• OutOfMemoryError - попытка прочитать очень большой файл целиком в память.
• UnsupportedCharsetException - при попытке использовать несуществующую кодировку через Charset.forName("...").

Примеры.

Отсутствие файла:

import java.nio.file.*;
import java.io.IOException;

public class Err1 {
  public static void main(String[] args) {
    try {
      Files.readString(Paths.get("no-file.txt"));
    } catch (IOException e) {
      System.out.println(e.getClass().getSimpleName() + ": " + e.getMessage());
    }
  }
}

NoSuchFileException: no-file.txt

Неправильная кодировка при использовании имени кодировки:

import java.nio.charset.Charset;
public class Err2 {
  public static void main(String[] args) {
    try {
      Charset.forName("BAD-CHARSET");
    } catch (Exception e) {
      System.out.println(e.getClass().getSimpleName() + ": " + e.getMessage());
    }
  }
}

UnsupportedCharsetException: BAD-CHARSET

Изменения и история

Метод появился в Java 11 как часть удобных утилит в классе java.nio.file.Files. До этого для быстрого получения строкового содержимого требовалось сочетание Files.readAllBytes и конструктора String или использование потоков и буферов. Начиная с Java 11 поведение и сигнатуры оставались стабильными. Появились сопутствующие методы, такие как Files.writeString, облегчающие работу с текстом.

В последующих версиях Java не вносилось значительных изменений в семантику readString. Основные отличия между версиями связаны с поведением платформы относительно кодировки по умолчанию и улучшениями производительности в реализации платформы, но сигнатуры и исключения сохраняются прежними.

Расширенные и редкие сценарии использования

Дополнительные примеры с пояснениями, показывающие границы применения и интеграцию с другими API.

1. Чтение файла внутри ZIP-архива через файловую систему ZIP.

import java.nio.file.*;
import java.util.Map;
import java.io.IOException;

public class Adv1 {
  public static void main(String[] args) throws IOException {
    Path zip = Paths.get("archive.zip");
    // Предположим, что в архиве есть file.txt
    try (FileSystem fs = FileSystems.newFileSystem(zip, (ClassLoader) null)) {
      Path inside = fs.getPath("file.txt");
      String s = Files.readString(inside);
      System.out.println(s);
    }
  }
}

(содержимое файла file.txt из архива)

Комментарий: метод readString читается одинаково независимо от конкретной реализации файловой системы, если путь представляет файл.

2. Сравнение производительности и памяти: Files.readString против Files.lines

// Псевдокод для сравнения
Path p = Paths.get("big.txt");
// Вариант A: readString
String all = Files.readString(p);
// Вариант B: stream
try (Stream lines = Files.lines(p)) {
  lines.forEach(...); // обработка без хранения всего в памяти
}

Вариант A загружает весь файл в память. Вариант B позволяет обрабатывать строки по одной и экономит кучу при больших файлах.

3. Чтение с пользовательской декодировкой и постобработкой байтов

import java.nio.file.*;
import java.nio.charset.StandardCharsets;
import java.io.IOException;

public class Adv3 {
  public static void main(String[] args) throws IOException {
    Path p = Paths.get("weird-encoding.txt");
    // Иногда требуется предварительно обработать байты
    byte[] bytes = Files.readAllBytes(p);
    // исправление CRLF, BOM или специфической логики
    String s = new String(bytes, StandardCharsets.ISO_8859_1).replace("\r\n", "\n");
    System.out.println(s);
  }
}

(текст файла после нормализации переводов строк)

Комментарий: использование readAllBytes плюс явная декодировка дает полный контроль над байтами, тогда как readString скрывает этот шаг.

4. Обработка больших файлов с memory-mapped каналом и частичным чтением

import java.nio.file.*;
import java.nio.channels.FileChannel;
import java.nio.MappedByteBuffer;
import java.nio.charset.StandardCharsets;
import java.io.IOException;

public class Adv4 {
  public static void main(String[] args) throws IOException {
    Path p = Paths.get("huge.txt");
    try (FileChannel ch = FileChannel.open(p, StandardOpenOption.READ)) {
      MappedByteBuffer mb = ch.map(FileChannel.MapMode.READ_ONLY, 0, Math.min(ch.size(), 1024*1024));
      byte[] part = new byte[mb.remaining()];
      mb.get(part);
      String s = new String(part, StandardCharsets.UTF_8);
      System.out.println(s.substring(0, Math.min(200, s.length())) + "...");
    }
  }
}

(первые 200 символов большого файла)

Комментарий: для очень больших файлов применение memory-mapped файлов или построчной обработки предпочтительнее, чем чтение целиком через readString.