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

Question

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

---

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

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

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

Answer 1

Хороший способ сделать это - использовать Apache commons <a href="https://commons.apache.org/proper/commons-io/javadocs/api-release/org/apache/commons/io/IOUtils.html" rel="noreferrer">IOUtils</a> для копирования 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, если не хотите смешивать свои потоки и пишущие устройства

Answer 2

Вот способ использования только стандартной библиотеки 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").

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

Answer 3

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

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

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

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

2. Использование CharStreams (Гуава)

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

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

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

4. Использование Stream API (Java 8). Предупреждение : Это решение преобразует различные разрывы строк (например, \r\n) в \n.

   String result = new BufferedReader(new InputStreamReader(inputStream))
     .lines().collect(Collectors.joining("\n"));
   

5. Использование API параллельного потока (Java 8). Предупреждение : Это решение преобразует различные разрывы строк (например, \r\n) в \n.

   String result = new BufferedReader(new InputStreamReader(inputStream)).lines()
      .parallel().collect(Collectors.joining("\n"));
   

6. Использование InputStreamReader и StringBuilder (JDK)

   final int bufferSize = 1024;
   final char[] buffer = new char[bufferSize];
   final StringBuilder out = new StringBuilder();
   Reader in = new InputStreamReader(inputStream, "UTF-8");
   for (; ; ) {
       int rsz = in.read(buffer, 0, buffer.length);
       if (rsz < 0)
           break;
       out.append(buffer, 0, rsz);
   }
   return out.toString();
   

7. Использование StringWriter и IOUtils.copy (Apache Commons)

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

8. Использование ByteArrayOutputStream и inputStream.read (JDK)

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

9. Использование 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();
   boolean flag = false;
   for (String line; (line = reader.readLine()) != null; ) {
       result.append(flag? newLine: "").append(line);
       flag = true;
   }
   return result.toString();
   

10. Использование BufferedInputStream и ByteArrayOutputStream (JDK)

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

11. Использование inputStream.read() и StringBuilder (JDK). Предупреждение : Это решение имеет проблемы с Unicode, например с русским текстом (работает корректно только с текстом не-Unicode)

    int ch;
    StringBuilder sb = new StringBuilder();
    while((ch = inputStream.read()) != -1)
        sb.append((char)ch);
    reset();
    return sb.toString();
    

Внимание

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

2. Решение 11 не может корректно работать с текстом Unicode

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

Тесты производительности для малых String (длина = 175), URL в github (режим = Среднее время, система = 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

Тесты производительности для больших String (длина = 50100), URL-адрес в github (режим = Среднее время, система = 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

Answer 4

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

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

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

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

Answer 5

Учитывая файл, сначала нужно получить экземпляр java.io.Reader. Затем его можно прочитать и добавить к StringBuilder (нам не нужен StringBuffer, если мы не обращаемся к нему в нескольких потоках, а StringBuilder быстрее). Хитрость в том, что мы работаем в блоках, и поэтому не нуждаемся в других потоках буферизации. Размер блока параметризован для оптимизации производительности во время выполнения.

public static String slurp(final InputStream is, final int bufferSize) {
    final char[] buffer = new char[bufferSize];
    final StringBuilder out = new StringBuilder();
    try (Reader in = new InputStreamReader(is, "UTF-8")) {
        for (;;) {
            int rsz = in.read(buffer, 0, buffer.length);
            if (rsz < 0)
                break;
            out.append(buffer, 0, rsz);
        }
    }
    catch (UnsupportedEncodingException ex) {
        /* ... */
    }
    catch (IOException ex) {
        /* ... */
    }
    return out.toString();
}

Answer 6

Использование:

InputStream in = /* Your InputStream */;
StringBuilder sb = new StringBuilder();
BufferedReader br = new BufferedReader(new InputStreamReader(in));
String read;

while ((read=br.readLine()) != null) {
    //System.out.println(read);
    sb.append(read);
}

br.close();
return sb.toString();

Answer 7

Если вы используете Google-Collections / Guava, вы можете сделать следующее:

InputStream stream = ...
String content = CharStreams.toString(new InputStreamReader(stream, Charsets.UTF_8));
Closeables.closeQuietly(stream);

Обратите внимание, что второй параметр (т. Е. Charsets.UTF_8) для InputStreamReader необязателен, но, как правило, рекомендуется указывать кодировку, если вы ее знаете (что следует!)

Answer 8

Это мое чистое решение для Java и Android, и оно хорошо работает ...

public String readFullyAsString(InputStream inputStream, String encoding)
        throws IOException {
    return readFully(inputStream).toString(encoding);
}

public byte[] readFullyAsBytes(InputStream inputStream)
        throws IOException {
    return readFully(inputStream).toByteArray();
}

private ByteArrayOutputStream readFully(InputStream inputStream)
        throws IOException {
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    byte[] buffer = new byte[1024];
    int length = 0;
    while ((length = inputStream.read(buffer)) != -1) {
        baos.write(buffer, 0, length);
    }
    return baos;
}

Answer 9

Вот самое элегантное решение на чистой Java (без библиотеки), которое я придумал после некоторых экспериментов:

public static String fromStream(InputStream in) throws IOException
{
    BufferedReader reader = new BufferedReader(new InputStreamReader(in));
    StringBuilder out = new StringBuilder();
    String newLine = System.getProperty("line.separator");
    String line;
    while ((line = reader.readLine()) != null) {
        out.append(line);
        out.append(newLine);
    }
    return out.toString();
}

Answer 10

Использование:

import java.io.BufferedInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.IOException;

public static String readInputStreamAsString(InputStream in)
    throws IOException {

    BufferedInputStream bis = new BufferedInputStream(in);
    ByteArrayOutputStream buf = new ByteArrayOutputStream();
    int result = bis.read();
    while(result != -1) {
      byte b = (byte)result;
      buf.write(b);
      result = bis.read();
    }
    return buf.toString();
}