Як читати файл на Java

Програмування

1. Огляд

У цьому посібнику ми розглянемо різні способи читання з файлу на Java .

Спочатку ми побачимо, як завантажити файл із шляху до класу, URL-адреси або з файлу JAR, використовуючи стандартні класи Java.

По-друге, ми побачимо, як читати вміст за допомогою BufferedReader , Scanner , StreamTokenizer , DataInputStream , SequenceInputStream та FileChannel . Також ми обговоримо, як читати файл, закодований UTF-8.

Нарешті, ми вивчимо нові методи завантаження та читання файлів у Java 7 та Java 8.

Ця стаття є частиною серії "Java - Назад до основного" тут, на Baeldung.

2. Налаштування

2.1 Вхідний файл

У більшості прикладів цієї статті ми прочитаємо текстовий файл з ім'ям fileTest.txt, який містить один рядок:

Hello, world!

У кількох прикладах ми використаємо інший файл. У цих випадках ми будемо прямо згадувати файл та його вміст.

2.2 Допоміжний метод

Ми будемо використовувати набір тестових прикладів, використовуючи лише основні класи Java, і в тестах ми будемо використовувати твердження, використовуючи збіги Hamcrest.

Тести матимуть спільний метод readFromInputStream, який перетворює InputStream в String для полегшення затвердження результатів:

private String readFromInputStream(InputStream inputStream) throws IOException { StringBuilder resultStringBuilder = new StringBuilder(); try (BufferedReader br = new BufferedReader(new InputStreamReader(inputStream))) { String line; while ((line = br.readLine()) != null) { resultStringBuilder.append(line).append("\n"); } } return resultStringBuilder.toString(); }

Зверніть увагу, що існують і інші способи досягнення того самого результату. Ви можете ознайомитися з цією статтею, щоб дізнатися про інші варіанти.

3. Читання файлу зі шляху до класу

3.1. Використання стандартної Java

У цьому розділі пояснюється, як читати файл, доступний на шляху до класу. Ми прочитаємо “ fileTest.txt ”, доступний у розділі src / main / resources :

@Test public void givenFileNameAsAbsolutePath_whenUsingClasspath_thenFileData() { String expectedData = "Hello, world!"; Class clazz = FileOperationsTest.class; InputStream inputStream = clazz.getResourceAsStream("/fileTest.txt"); String data = readFromInputStream(inputStream); Assert.assertThat(data, containsString(expectedData)); }

У наведеному вище фрагменті коду ми використовували поточний клас для завантаження файлу за допомогою методу getResourceAsStream та передавали абсолютний шлях до файлу для завантаження.

Той же метод доступний і в екземплярі ClassLoader :

ClassLoader classLoader = getClass().getClassLoader(); InputStream inputStream = classLoader.getResourceAsStream("fileTest.txt"); String data = readFromInputStream(inputStream);

Ми отримуємо classLoader поточного класу за допомогою getClass (). GetClassLoader () .

Основна відмінність полягає в тому, що при використанні getResourceAsStream на екземплярі ClassLoader шлях розглядається як абсолютний, починаючи з кореня шляху шляху до класу.

При використанні проти класу , наприклад , шлях може бути відносним до пакету, або абсолютного шляху, який натякає провідну косою рисою.

Звичайно, зауважте, що на практиці відкриті потоки завжди повинні бути закритими , наприклад InputStream у нашому прикладі:

InputStream inputStream = null; try { File file = new File(classLoader.getResource("fileTest.txt").getFile()); inputStream = new FileInputStream(file); //... } finally { if (inputStream != null) { try { inputStream.close(); } catch (IOException e) { e.printStackTrace(); } } }

3.2. Використання бібліотеки commons-io

Інший поширений варіант - використання класу FileUtils пакета commons-io :

@Test public void givenFileName_whenUsingFileUtils_thenFileData() { String expectedData = "Hello, world!"; ClassLoader classLoader = getClass().getClassLoader(); File file = new File(classLoader.getResource("fileTest.txt").getFile()); String data = FileUtils.readFileToString(file, "UTF-8"); assertEquals(expectedData, data.trim()); }

Тут ми передаємо файл об'єкт методи readFileToString () з FileUtils класу. Цей утилітний клас вдається завантажувати вміст без необхідності писати будь-який шаблонний код для створення екземпляра InputStream та читання даних.

Ця ж бібліотека також пропонує IOUtilsклас:

@Test public void givenFileName_whenUsingIOUtils_thenFileData() { String expectedData = "Hello, world!"; FileInputStream fis = new FileInputStream("src/test/resources/fileTest.txt"); String data = IOUtils.toString(fis, "UTF-8"); assertEquals(expectedData, data.trim()); }

Тут ми передаємо FileInputStream об'єкт в метод ToString () з IOUtils класу. Цей утилітний клас вдається завантажувати вміст без необхідності писати будь-який шаблонний код для створення екземпляра InputStream та читання даних.

4. Читання за допомогою BufferedReader

Зупинимося тепер на різних способах синтаксичного аналізу вмісту файлу.

Ми почнемо з простого способу читання з файлу за допомогою BufferedReader:

@Test public void whenReadWithBufferedReader_thenCorrect() throws IOException { String expected_value = "Hello, world!"; String file; BufferedReader reader = new BufferedReader(new FileReader(file)); String currentLine = reader.readLine(); reader.close(); assertEquals(expected_value, currentLine); }

Зверніть увагу, що readLine () поверне значення null, коли буде досягнуто кінець файлу.

5. Читання з файлу за допомогою Java NIO

У JDK7 пакет NIO був значно оновлений.

Давайте розглянемо приклад використання класу Файли та методу readAllLines . Метод readAllLines приймає шлях.

Клас шляху можна розглядати як оновлення файлу java.io.File з деякими додатковими операціями.

5.1. Читання невеликого файлу

У наступному коді показано, як читати невеликий файл за допомогою нового класу " Файли" :

@Test public void whenReadSmallFileJava7_thenCorrect() throws IOException { String expected_value = "Hello, world!"; Path path = Paths.get("src/test/resources/fileTest.txt"); String read = Files.readAllLines(path).get(0); assertEquals(expected_value, read); }

Note that you can use the readAllBytes() method as well if you need binary data.

5.2. Reading a Large File

If we want to read a large file with Files class, we can use the BufferedReader:

The following code reads the file using the new Files class and BufferedReader:

@Test public void whenReadLargeFileJava7_thenCorrect() throws IOException { String expected_value = "Hello, world!"; Path path = Paths.get("src/test/resources/fileTest.txt"); BufferedReader reader = Files.newBufferedReader(path); String line = reader.readLine(); assertEquals(expected_value, line); }

5.3. Reading a File Using Files.lines()

JDK8 offers the lines() method inside the Files class. It returns a Stream of String elements.

Let’s look at an example of how to read data into bytes and decode using UTF-8 charset.

The following code reads the file using the new Files.lines():

@Test public void givenFilePath_whenUsingFilesLines_thenFileData() { String expectedData = "Hello, world!"; Path path = Paths.get(getClass().getClassLoader() .getResource("fileTest.txt").toURI()); Stream lines = Files.lines(path); String data = lines.collect(Collectors.joining("\n")); lines.close(); Assert.assertEquals(expectedData, data.trim()); }

Using Stream with IO channels like file operations, we need to close the stream explicitly using the close() method.

As we can see, the Files API offers another easy way to read the file contents into a String.

In the next sections, let's have a look at other, less common methods of reading a file, that may be appropriate in some situations.

6. Reading with Scanner

Next, let's use a Scanner to read from the File. Here, we'll use whitespace as the delimiter:

@Test public void whenReadWithScanner_thenCorrect() throws IOException { String file = "src/test/resources/fileTest.txt"; Scanner scanner = new Scanner(new File(file)); scanner.useDelimiter(" "); assertTrue(scanner.hasNext()); assertEquals("Hello,", scanner.next()); assertEquals("world!", scanner.next()); scanner.close(); }

Note that the default delimiter is the whitespace, but multiple delimiters can be used with a Scanner.

The Scanner class is useful when reading content from the console, or when the content contains primitive values, with a known delimiter (eg: a list of integers separated by space).

7. Reading with StreamTokenizer

Next, let's read a text file into tokens using a StreamTokenizer.

The way the tokenizer works is – first, we need to figure out what the next token is – String or number; we do that by looking at the tokenizer.ttype field.

Then, we'll read the actual token based on this type:

  • tokenizer.nval – if the type was a number
  • tokenizer.sval – if the type was a String

In this example we'll use a different input file which simply contains:

Hello 1

The following code reads from the file both the String and the number:

@Test public void whenReadWithStreamTokenizer_thenCorrectTokens() throws IOException { String file = "src/test/resources/fileTestTokenizer.txt"; FileReader reader = new FileReader(file); StreamTokenizer tokenizer = new StreamTokenizer(reader); // token 1 tokenizer.nextToken(); assertEquals(StreamTokenizer.TT_WORD, tokenizer.ttype); assertEquals("Hello", tokenizer.sval); // token 2 tokenizer.nextToken(); assertEquals(StreamTokenizer.TT_NUMBER, tokenizer.ttype); assertEquals(1, tokenizer.nval, 0.0000001); // token 3 tokenizer.nextToken(); assertEquals(StreamTokenizer.TT_EOF, tokenizer.ttype); reader.close(); }

Note how the end of file token is used at the end.

This approach is useful for parsing an input stream into tokens.

8. Reading with DataInputStream

We can use DataInputStream to read binary or primitive data type from a file.

The following test reads the file using a DataInputStream:

@Test public void whenReadWithDataInputStream_thenCorrect() throws IOException { String expectedValue = "Hello, world!"; String file; String result = null; DataInputStream reader = new DataInputStream(new FileInputStream(file)); int nBytesToRead = reader.available(); if(nBytesToRead > 0) { byte[] bytes = new byte[nBytesToRead]; reader.read(bytes); result = new String(bytes); } assertEquals(expectedValue, result); }

9. Reading with FileChannel

If we are reading a large file, FileChannel can be faster than standard IO.

The following code reads data bytes from the file using FileChannel and RandomAccessFile:

@Test public void whenReadWithFileChannel_thenCorrect() throws IOException { String expected_value = "Hello, world!"; String file = "src/test/resources/fileTest.txt"; RandomAccessFile reader = new RandomAccessFile(file, "r"); FileChannel channel = reader.getChannel(); int bufferSize = 1024; if (bufferSize > channel.size()) { bufferSize = (int) channel.size(); } ByteBuffer buff = ByteBuffer.allocate(bufferSize); channel.read(buff); buff.flip(); assertEquals(expected_value, new String(buff.array())); channel.close(); reader.close(); }

10. Reading a UTF-8 Encoded File

Now, let's see how to read a UTF-8 encoded file using BufferedReader. In this example, we'll read a file that contains Chinese characters:

@Test public void whenReadUTFEncodedFile_thenCorrect() throws IOException { String expected_value = "青空"; String file = "src/test/resources/fileTestUtf8.txt"; BufferedReader reader = new BufferedReader (new InputStreamReader(new FileInputStream(file), "UTF-8")); String currentLine = reader.readLine(); reader.close(); assertEquals(expected_value, currentLine); }

11. Reading Content from URL

To read content from a URL, we will use “/” URL in our example as:

@Test public void givenURLName_whenUsingURL_thenFileData() { String expectedData = "Baeldung"; URL urlObject = new URL("/"); URLConnection urlConnection = urlObject.openConnection(); InputStream inputStream = urlConnection.getInputStream(); String data = readFromInputStream(inputStream); Assert.assertThat(data, containsString(expectedData)); }

There are also alternative ways of connecting to a URL. Here we used the URL and URLConnection class available in the standard SDK.

12. Reading a File from a JAR

To read a file which is located inside a JAR file, we will need a JAR with a file inside it. For our example we will read “LICENSE.txt” from the “hamcrest-library-1.3.jar” file:

@Test public void givenFileName_whenUsingJarFile_thenFileData() { String expectedData = "BSD License"; Class clazz = Matchers.class; InputStream inputStream = clazz.getResourceAsStream("/LICENSE.txt"); String data = readFromInputStream(inputStream); Assert.assertThat(data, containsString(expectedData)); }

Here we want to load LICENSE.txt that resides in Hamcrest library, so we will use the Matcher's class that helps to get a resource. The same file can be loaded using the classloader too.

13. Conclusion

As you can see, there are many possibilities for loading a file and reading data from it using plain Java.

You can load a file from various locations like classpath, URL or jar files.

Потім ви можете використовувати BufferedReader для читання рядків за рядком, Scanner для читання з використанням різних роздільників, StreamTokenizer для читання файлу в маркери, DataInputStream для читання двійкових даних та примітивних типів даних, SequenceInput Stream для зв’язку декількох файлів в один потік, FileChannel для швидшого читання з великих файлів тощо.

Ви можете знайти вихідний код у наступному репозиторії GitHub.