Wie lese ich in Kotlin den gesamten Inhalt eines InputStreams in einen String?

Ich habe kürzlich Code zum Lesen des gesamten Inhalts InputStreameines Strings in Kotlin gesehen, wie zum Beispiel:

// input is of type InputStream
val baos = ByteArrayOutputStream()
input.use { it.copyTo(baos) }
val inputAsString = baos.toString()

Und auch:

val reader = BufferedReader(InputStreamReader(input))
try {
    val results = StringBuilder()
    while (true) { 
        val line = reader.readLine()
        if (line == null) break
        results.append(line) 
    }
    val inputAsString = results.toString()
} finally {
    reader.close()
}

Und selbst das sieht flüssiger aus, da es automatisch schließt InputStream:

val inputString = BufferedReader(InputStreamReader(input)).useLines { lines ->
    val results = StringBuilder()
    lines.forEach { results.append(it) }
    results.toString()
}

Oder eine leichte Variation davon:

val results = StringBuilder()
BufferedReader(InputStreamReader(input)).forEachLine { results.append(it) }
val resultsAsString = results.toString()   

Dann dieses funktionale Faltding:

val inputString = input.bufferedReader().useLines { lines ->
    lines.fold(StringBuilder()) { buff, line -> buff.append(line) }.toString()
}

Oder eine schlechte Variante, die das nicht schließt InputStream:

val inputString = BufferedReader(InputStreamReader(input))
        .lineSequence()
        .fold(StringBuilder()) { buff, line -> buff.append(line) }
        .toString()

Aber sie sind alle klobig und ich finde immer wieder neuere und unterschiedliche Versionen derselben ... und einige von ihnen schließen die nicht einmal InputStream. Was ist eine nicht klobige (idiomatische) Art, das zu lesen InputStream?

Hinweis: Diese Frage wurde absichtlich vom Autor geschrieben und beantwortet ( Selbst beantwortete Fragen ), sodass die idiomatischen Antworten auf häufig gestellte Kotlin-Themen in SO vorhanden sind.

Kotlin hat speziell für diesen Zweck spezielle Erweiterungen.

Das einfachste:

val inputAsString = input.bufferedReader().use { it.readText() }  // defaults to UTF-8

Und in diesem Beispiel können Sie sich zwischen bufferedReader()oder nur entscheiden reader(). Der Aufruf der Funktion Closeable.use()schließt die Eingabe am Ende der Lambda-Ausführung automatisch.

Weiterführende Literatur:

Wenn Sie so etwas häufig tun, können Sie dies als Erweiterungsfunktion schreiben:

fun InputStream.readTextAndClose(charset: Charset = Charsets.UTF_8): String {
    return this.bufferedReader(charset).use { it.readText() }
}

Was Sie dann leicht nennen könnten als:

val inputAsString = input.readTextAndClose()  // defaults to UTF-8

Nebenbei bemerkt, alle Kotlin-Erweiterungsfunktionen, für die die Kenntnis der charsetbereits vorhandenen Standardeinstellung UTF-8erforderlich ist. Wenn Sie also eine andere Codierung benötigen, müssen Sie den obigen Code in Aufrufen anpassen, um eine Codierung für reader(charset)oder einzuschließen bufferedReader(charset).

Warnung: Möglicherweise werden kürzere Beispiele angezeigt:

val inputAsString = input.reader().readText() 

Aber diese schließen den Strom nicht . Stellen Sie sicher, dass Sie die API-Dokumentation für alle von Ihnen verwendeten E / A-Funktionen überprüfen , um sicherzustellen, welche geschlossen sind und welche nicht. Normalerweise, wenn sie das Wort use(wie useLines()oder use()) enthalten, schließen Sie den Strom danach. Eine Ausnahme ist, dass sie sich dadurch File.readText()unterscheidet, Reader.readText()dass erstere nichts offen lässt und letztere tatsächlich ein explizites Schließen erfordert.

Siehe auch: Kotlin IO-bezogene Erweiterungsfunktionen

Ein Beispiel, das den Inhalt eines InputStream in einen String liest

import java.io.File
import java.io.InputStream
import java.nio.charset.Charset

fun main(args: Array<String>) {
    val file = File("input"+File.separator+"contents.txt")
    var ins:InputStream = file.inputStream()
    var content = ins.readBytes().toString(Charset.defaultCharset())
    println(content)
}

Als Referenz - Kotlin Read File