Java: Outputting text file to Console

Question

I'm attempting to output a text file to the console with Java. I was wondering what is the most efficient way of doing so?

I've researched several methods however, it's difficult to discern which is the least performance impacted solution.

Outputting a text file to the console would involve reading in each line in the file, then writing it to the console.

Is it better to use:

1. Buffered Reader with a FileReader, reading in lines and doing a bunch of system.out.println calls?

   BufferedReader in = new BufferedReader(new FileReader("C:\\logs\\")); 
   while (in.readLine() != null) {
         System.out.println(blah blah blah);          
   }         
   in.close();
   

2. Scanner reading each line in the file and doing system.print calls?

   while (scanner.hasNextLine()) { 
       System.out.println(blah blah blah);   
   }
   

Thanks.

Solution 1

If you're not interested in the character based data the text file is containing, just stream it "raw" as bytes.

InputStream input = new BufferedInputStream(new FileInputStream("C:/logs.txt"));
byte[] buffer = new byte[8192];

try {
    for (int length = 0; (length = input.read(buffer)) != -1;) {
        System.out.write(buffer, 0, length);
    }
} finally {
    input.close();
}

This saves the cost of unnecessarily massaging between bytes and characters and also scanning and splitting on newlines and appending them once again.

As to the performance, you may find this article interesting. According the article, a FileChannel with a 256K byte array which is read through a wrapped ByteBuffer and written directly from the byte array is the fastest way.

FileInputStream input = new FileInputStream("C:/logs.txt");
FileChannel channel = input.getChannel();
byte[] buffer = new byte[256 * 1024];
ByteBuffer byteBuffer = ByteBuffer.wrap(buffer);

try {
    for (int length = 0; (length = channel.read(byteBuffer)) != -1;) {
        System.out.write(buffer, 0, length);
        byteBuffer.clear();
    }
} finally {
    input.close();
}

Solution 2

If all you want to do is print the contents of a file (and don't want to print the next int/double/etc.) to the console then a BufferedReader is fine.

Your code as it is won't produce the result you're after, though. Try this instead:

BufferedReader in = new BufferedReader(new FileReader("C:\\logs\\log001.txt"));
String line = in.readLine();
while(line != null)
{
  System.out.println(line);
  line = in.readLine();
}
in.close();

I wouldn't get too hung up about it, though because it's more likely that the main bottleneck will be the ability of your console to print the information that Java is sending it.

Solution 3

If it's a relatively small file, a one-line Java 7+ way to do this is:

System.out.println(new String(Files.readAllBytes(Paths.get("logs.txt"))));

See https://docs.oracle.com/javase/7/docs/api/java/nio/file/package-summary.html for more details.

Cheers!

Solution 4

If all you want is most efficiently dump the file contents to the console with no processing in-between, converting the data into characters and finding line breaks is unnecessary overhead. Instead, you can just read blocks of bytes from the file and write then straight out to System.out:

package toconsole;

import java.io.BufferedInputStream;
import java.io.FileInputStream;

public class Main {
    public static void main(String[] args) {
        BufferedInputStream bis = null;
        byte[] buffer = new byte[8192];
        int bytesRead = 0;
        try {
            bis = new BufferedInputStream(new FileInputStream(args[0]));
            while ((bytesRead = bis.read(buffer)) != -1) {
                System.out.write(buffer, /* start */ 0, /* length */ bytesRead);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try { bis.close(); } catch (Exception e) { /* meh */ }
        }
    }
}

In case you haven't come across this kind of idiom before, the statement in the while condition both assigns the result of bis.read to bytesRead and then compares it to -1. So we keep reading bytes into the buffer until we are told that we're at the end of the file. And we use bytesRead in System.out.write to make sure we write only the bytes we've just read, as we can't assume all files are a multiple of 8 kB long!

View more solutions

Comments

[Steve Kuo]

You should use slash (/) in path names. Java will translate it to the OS specific separator.

[user459811]

Interesting article. It was exactly what I was looking for, thanks! :)

[Raedwald]

Transferring the raw byes will produce odd results (appear to be broken) if the file and output destination use different character encodings.

[BalusC]

@Raedwald: That's correct. This is only not server's mistake anymore (provided that headers are correct), but client's mistake, so generally easier to fix.

[vinS]

It would be nice to put some information about the code.