How do I read / convert an InputStream into a String in Java?

Как мне прочитать / преобразовать входной поток в строку в Java?

Если у вас есть java.io.InputStream объект, как вы должны обработать этот объект и создать String?

Предположим, у меня есть InputStream который содержит текстовые данные, и я хочу преобразовать его в String, так что, например, я могу записать это в файл журнала.

Какой самый простой способ взять InputStream и преобразовать его в String?

public String convertStreamToString(InputStream is) {
// ???
}

Переведено автоматически

Ответ 1

Подводя итог другим ответам, я нашел 11 основных способов сделать это (см. Ниже). И я написал несколько тестов производительности (см. Результаты Ниже).:

Способы преобразования InputStream в строку:

Использование IOUtils.toString (Apache Utils)

 String result = IOUtils.toString(inputStream, StandardCharsets.UTF_8);

Использование CharStreams (Guava)

 String result = CharStreams.toString(new InputStreamReader(
       inputStream, Charsets.UTF_8));

Использование Scanner (JDK)

 Scanner s = new Scanner(inputStream).useDelimiter("\\A");
 String result = s.hasNext() ? s.next() : "";

Используя Stream API (Java 8). Предупреждение: Это решение преобразует различные переносы строк (например, \r\n) в \n.
```
 String result = new BufferedReader(new InputStreamReader(inputStream))
   .lines().collect(Collectors.joining("\n"));
```

Используя parallel Stream API (Java 8). Предупреждение: Это решение преобразует различные переносы строк (например, \r\n) в \n.
```
 String result = new BufferedReader(new InputStreamReader(inputStream))
    .lines().parallel().collect(Collectors.joining("\n"));
```

Используя InputStreamReader и StringBuilder (JDK)

 int bufferSize = 1024;
 char[] buffer = new char[bufferSize];
 StringBuilder out = new StringBuilder();
 Reader in = new InputStreamReader(stream, StandardCharsets.UTF_8);
 for (int numRead; (numRead = in.read(buffer, 0, buffer.length)) > 0; ) {
     out.append(buffer, 0, numRead);
 }
 return out.toString();

Используя StringWriter и IOUtils.copy (Apache Commons)

 StringWriter writer = new StringWriter();
 IOUtils.copy(inputStream, writer, "UTF-8");
 return writer.toString();

Используя ByteArrayOutputStream и inputStream.read (JDK)

 ByteArrayOutputStream result = new ByteArrayOutputStream();
 byte[] buffer = new byte[1024];
 for (int length; (length = inputStream.read(buffer)) != -1; ) {
     result.write(buffer, 0, length);
 }
 // StandardCharsets.UTF_8.name() > JDK 7
 return result.toString("UTF-8");

Используя BufferedReader (JDK). Предупреждение: Это решение преобразует различные переносы строк (например, \n\r) в line.separator системное свойство (например, в Windows в "\ r \n").

 String newLine = System.getProperty("line.separator");
 BufferedReader reader = new BufferedReader(
         new InputStreamReader(inputStream));
 StringBuilder result = new StringBuilder();
 for (String line; (line = reader.readLine()) != null; ) {
     if (result.length() > 0) {
         result.append(newLine);
     }
     result.append(line);
 }
 return result.toString();

Используя BufferedInputStream и ByteArrayOutputStream (JDK)

BufferedInputStream bis = new BufferedInputStream(inputStream);
ByteArrayOutputStream buf = new ByteArrayOutputStream();
for (int result = bis.read(); result != -1; result = bis.read()) {
    buf.write((byte) result);
}
// StandardCharsets.UTF_8.name() > JDK 7
return buf.toString("UTF-8");

Using inputStream.read() and StringBuilder (JDK). Warning: This solution has problems with Unicode, for example with Russian text (works correctly only with non-Unicode text)
```
StringBuilder sb = new StringBuilder();
for (int ch; (ch = inputStream.read()) != -1; ) {
    sb.append((char) ch);
}
return sb.toString();
```

Предупреждение:

Решения 4, 5 и 9 преобразуют разные разрывы строк в один.

Решение 11 не может корректно работать с текстом в Юникоде

Тесты производительности

Тесты производительности для small String (длина = 175), url в github (mode = среднее время, system = Linux, лучший результат - 1343 балла):

              Benchmark                         Mode  Cnt   Score   Error  Units
 8. ByteArrayOutputStream and read (JDK)        avgt   10   1,343 ± 0,028  us/op
 6. InputStreamReader and StringBuilder (JDK)   avgt   10   6,980 ± 0,404  us/op
10. BufferedInputStream, ByteArrayOutputStream  avgt   10   7,437 ± 0,735  us/op
11. InputStream.read() and StringBuilder (JDK)  avgt   10   8,977 ± 0,328  us/op
 7. StringWriter and IOUtils.copy (Apache)      avgt   10  10,613 ± 0,599  us/op
 1. IOUtils.toString (Apache Utils)             avgt   10  10,605 ± 0,527  us/op
 3. Scanner (JDK)                               avgt   10  12,083 ± 0,293  us/op
 2. CharStreams (guava)                         avgt   10  12,999 ± 0,514  us/op
 4. Stream Api (Java 8)                         avgt   10  15,811 ± 0,605  us/op
 9. BufferedReader (JDK)                        avgt   10  16,038 ± 0,711  us/op
 5. parallel Stream Api (Java 8)                avgt   10  21,544 ± 0,583  us/op

Тесты производительности для big String (длина = 50100), URL в github (mode = среднее время, system = Linux, лучший результат - 200 715 баллов):

               Benchmark                        Mode  Cnt   Score        Error  Units
 8. ByteArrayOutputStream and read (JDK)        avgt   10   200,715 ±   18,103  us/op
 1. IOUtils.toString (Apache Utils)             avgt   10   300,019 ±    8,751  us/op
 6. InputStreamReader and StringBuilder (JDK)   avgt   10   347,616 ±  130,348  us/op
 7. StringWriter and IOUtils.copy (Apache)      avgt   10   352,791 ±  105,337  us/op
 2. CharStreams (guava)                         avgt   10   420,137 ±   59,877  us/op
 9. BufferedReader (JDK)                        avgt   10   632,028 ±   17,002  us/op
 5. parallel Stream Api (Java 8)                avgt   10   662,999 ±   46,199  us/op
 4. Stream Api (Java 8)                         avgt   10   701,269 ±   82,296  us/op
10. BufferedInputStream, ByteArrayOutputStream  avgt   10   740,837 ±    5,613  us/op
 3. Scanner (JDK)                               avgt   10   751,417 ±   62,026  us/op
11. InputStream.read() and StringBuilder (JDK)  avgt   10  2919,350 ± 1101,942  us/op

Графики (тесты производительности в зависимости от длины входного потока в системе Windows 7)

Тест производительности (среднее время) в зависимости от длины входного потока в системе Windows 7:

 length  182    546     1092    3276    9828    29484   58968

 test8  0.38    0.938   1.868   4.448   13.412  36.459  72.708
 test4  2.362   3.609   5.573   12.769  40.74   81.415  159.864
 test5  3.881   5.075   6.904   14.123  50.258  129.937 166.162
 test9  2.237   3.493   5.422   11.977  45.98   89.336  177.39
 test6  1.261   2.12    4.38    10.698  31.821  86.106  186.636
 test7  1.601   2.391   3.646   8.367   38.196  110.221 211.016
 test1  1.529   2.381   3.527   8.411   40.551  105.16  212.573
 test3  3.035   3.934   8.606   20.858  61.571  118.744 235.428
 test2  3.136   6.238   10.508  33.48   43.532  118.044 239.481
 test10 1.593   4.736   7.527   20.557  59.856  162.907 323.147
 test11 3.913   11.506  23.26   68.644  207.591 600.444 1211.545

Ответ 2

Хороший способ сделать это - использовать Apache Commons IOUtils для копирования InputStream в StringWriter... Что-то вроде

StringWriter writer = new StringWriter();
IOUtils.copy(inputStream, writer, encoding);
String theString = writer.toString();

или даже

// NB: does not close inputStream, you'll have to use try-with-resources for that
String theString = IOUtils.toString(inputStream, encoding);

В качестве альтернативы вы могли бы использовать ByteArrayOutputStream, если вы не хотите смешивать свои потоки и записи.

Ответ 3

Вот способ, использующий только стандартную библиотеку Java (обратите внимание, что поток не закрыт, ваш пробег может отличаться).

static String convertStreamToString(java.io.InputStream is) {
    java.util.Scanner s = new java.util.Scanner(is).useDelimiter("\\A");
    return s.hasNext() ? s.next() : "";
}

Я научился этому трюку из статьи "Глупые трюки со сканером". Причина, по которой это работает, заключается в том, что Scanner выполняет итерацию по токенам в потоке, и в этом случае мы разделяем токены, используя "начало входной границы" (\ A), таким образом, предоставляя нам только один токен для всего содержимого потока.

Примечание, если вам нужно уточнить кодировку входного потока, вы можете предоставить второй аргумент Scanner конструктору, который указывает, какой набор символов использовать (например, "UTF-8").

Совет по шляпе также адресован Джейкобу, который однажды указал мне на указанную статью.

Ответ 4

Apache Commons позволяет:

String myString = IOUtils.toString(myInputStream, "UTF-8");

Конечно, вы могли бы выбрать другие кодировки символов, помимо UTF-8.

Также смотрите: (документация)