Wie erstelle ich eine Java-Zeichenfolge aus dem Inhalt einer Datei?

Question

Ich verwende das untenstehende Idiom schon seit einiger Zeit. Und es scheint das weit verbreitetste zu sein, zumindest auf den Seiten, die ich besucht habe.

Gibt es einen besseren/anderen Weg, um eine Datei in einen String in Java zu lesen?

private String readFile(String file) throws IOException {
    BufferedReader reader = new BufferedReader(new FileReader (file));
    String line = null;
    StringBuilder stringBuilder = new StringBuilder();
    String ls = System.getProperty("line.separator");

    try {
        while((line = reader.readLine()) != null) {
            stringBuilder.append(line);
            stringBuilder.append(ls);
        }

        return stringBuilder.toString();
    } finally {
        reader.close();
    }
}

Answer 1

Verwendung von JDK 8 oder höher:

keine externen Bibliotheken verwendet

Sie können ein neues String-Objekt aus dem Dateiinhalt erstellen (Verwendung von Klassen aus dem Paket java.nio.file):

public String readStringFromFile(String filePath) throws IOException {
    String fileContent = new String(Files.readAllBytes(Paths.get(filePath)));
    return fileContent;
}

Answer 2

Wenn Sie keinen Zugriff auf die Files-Klasse haben, können Sie eine native Lösung verwenden.

static String readFile(File file, String charset)
        throws IOException
{
    FileInputStream fileInputStream = new FileInputStream(file);
    byte[] buffer = new byte[fileInputStream.available()];
    int length = fileInputStream.read(buffer);
    fileInputStream.close();
    return new String(buffer, 0, length, charset);
}

Answer 3

Es gibt eine Variante zum gleichen Thema, die eine for-Schleife verwendet, anstelle einer while-Schleife, um den Geltungsbereich der Variablen "line" zu begrenzen. Ob es "besser" ist, ist eine Frage des persönlichen Geschmacks.

for(String line = reader.readLine(); line != null; line = reader.readLine()) {
    stringBuilder.append(line);
    stringBuilder.append(ls);
}

Answer 4

Eine flexible Lösung mit IOUtils von Apache commons-io in Kombination mit StringWriter:

Reader input = new FileReader();
StringWriter output = new StringWriter();
try {
  IOUtils.copy(input, output);
} finally {
  input.close();
}
String fileContents = output.toString();

Es funktioniert mit jedem Reader oder Input-Stream (nicht nur mit Dateien), zum Beispiel beim Lesen von einer URL.

Answer 5

Beachten Sie bei der Verwendung von fileInputStream.available(), dass die zurückgegebene Ganzzahl nicht unbedingt die tatsächliche Dateigröße repräsentiert, sondern vielmehr die geschätzte Menge an Bytes, die das System aus dem Stream lesen können sollte, ohne IO-Blockaden zu verursachen. Eine sichere und einfache Möglichkeit könnte so aussehen

public String readStringFromInputStream(FileInputStream fileInputStream) {
    StringBuffer stringBuffer = new StringBuffer();
    try {
        byte[] buffer;
        while (fileInputStream.available() > 0) {
            buffer = new byte[fileInputStream.available()];
            fileInputStream.read(buffer);
            stringBuffer.append(new String(buffer, "ISO-8859-1"));
        }
    } catch (FileNotFoundException e) {
    } catch (IOException e) { }
    return stringBuffer.toString();
}

Es sollte berücksichtigt werden, dass dieser Ansatz nicht für Multi-Byte-Zeichenkodierungen wie UTF-8 geeignet ist.