Как да чета файл в Java

1. Общ преглед

В този урок ще изследваме различни начини за четене от файл в Java .

Първо ще видим как да заредим файл от пътя на класа, URL или от JAR файл, използвайки стандартни Java класове.

На второ място, ще видим как да се чете съдържанието с BufferedReader , скенер , StreamTokenizer , DataInputStream , SequenceInputStream, и FileChannel . Също така ще обсъдим как да четем UTF-8 кодиран файл.

Накрая ще изследваме новите техники за зареждане и четене на файл в Java 7 и Java 8.

Тази статия е част от поредицата „Java - Back to Basic“ тук на 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. Четене на файл от Classpath

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 , пътят се третира като абсолютен, започвайки от корена на пътя на класа.

Когато се използва срещу екземпляр на Class , пътят може да бъде спрямо пакета или абсолютен път, което се намеква от водещата наклонена черта.

Разбира се, имайте предвид, че на практика отворените потоци винаги трябва да бъдат затворени , като 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()); }

Тук предаваме обекта File на метода 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. Четене на малък файл

Следният код показва как да четете малък файл с помощта на новия клас Files :

@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.