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


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

Как проще всего преобразовать InputStream в String?

public String convertStreamToString(InputStream is) {
// ???
}
4560
Johnny Maelstrom 21 Ноя 2008 в 19:47
 – 
Kevin Anderson
8 Окт 2020 в 17:02
1
Помните, что вам нужно учитывать кодировку входного потока. Системный параметр по умолчанию не всегда тот, который вам нужен.
 – 
Thorbjørn Ravn Andersen
30 Окт 2020 в 12:52
13
Большинство этих ответов были написаны до Java 9, но теперь вы можете получить массив байтов из InputStream с помощью .readAllBytes. Итак, просто «new String (inputStream.readAllBytes ())» работает с использованием конструктора String byte [].
 – 
Shmuel Newmark
29 Май 2021 в 00:19

30 ответов

Лучший ответ

Хороший способ сделать это - использовать общие ресурсы Apache 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, если не хотите смешивать свои потоки и писатели.

2733
Marko Zajc 21 Май 2018 в 16:09
ToString устарел? Я вижу IOUtils.convertStreamToString()
 – 
RCB
2 Июл 2020 в 18:26
Я добавил правку, чтобы включить в качестве ссылки доступную для поиска ссылку на сам исходный код. Я считаю, что это дополняет ответ для тех, кто хочет увидеть, как работает команда.
 – 
satchel
6 Июл 2021 в 03:03

Я бы использовал некоторые уловки Java 8.

public static String streamToString(final InputStream inputStream) throws Exception {
    // buffering optional
    try
    (
        final BufferedReader br
           = new BufferedReader(new InputStreamReader(inputStream))
    ) {
        // parallel optional
        return br.lines().parallel().collect(Collectors.joining("\n"));
    } catch (final IOException e) {
        throw new RuntimeException(e);
        // whatever.
    }
}

По сути, так же, как и некоторые другие ответы, за исключением более краткого.

42
Ian2thedv 15 Июл 2015 в 14:03

Если вы не можете использовать Commons IO (FileUtils / IOUtils / CopyUtils), вот пример использования BufferedReader для чтения файла построчно:

public class StringFromFile {
    public static void main(String[] args) /*throws UnsupportedEncodingException*/ {
        InputStream is = StringFromFile.class.getResourceAsStream("file.txt");
        BufferedReader br = new BufferedReader(new InputStreamReader(is/*, "UTF-8"*/));
        final int CHARS_PER_PAGE = 5000; //counting spaces
        StringBuilder builder = new StringBuilder(CHARS_PER_PAGE);
        try {
            for(String line=br.readLine(); line!=null; line=br.readLine()) {
                builder.append(line);
                builder.append('\n');
            }
        } 
        catch (IOException ignore) { }

        String text = builder.toString();
        System.out.println(text);
    }
}

Или, если вам нужна чистая скорость, я бы предложил вариант того, что предложил Поль де Вриз (который позволяет избежать использования StringWriter (который использует StringBuffer внутри):

public class StringFromFileFast {
    public static void main(String[] args) /*throws UnsupportedEncodingException*/ {
        InputStream is = StringFromFileFast.class.getResourceAsStream("file.txt");
        InputStreamReader input = new InputStreamReader(is/*, "UTF-8"*/);
        final int CHARS_PER_PAGE = 5000; //counting spaces
        final char[] buffer = new char[CHARS_PER_PAGE];
        StringBuilder output = new StringBuilder(CHARS_PER_PAGE);
        try {
            for(int read = input.read(buffer, 0, buffer.length);
                    read != -1;
                    read = input.read(buffer, 0, buffer.length)) {
                output.append(buffer, 0, read);
            }
        } catch (IOException ignore) { }

        String text = output.toString();
        System.out.println(text);
    }
}
27
Peter Mortensen 5 Янв 2019 в 13:31

Этот хорош тем, что:

  • Он безопасно обращается с Charset.
  • Вы управляете размером буфера чтения.
  • Вы можете указать длину конструктора, и это не обязательно должно быть точное значение.
  • Свободен от библиотечных зависимостей.
  • Для Java 7 или выше.

Как это сделать?

public static String convertStreamToString(InputStream is) throws IOException {
   StringBuilder sb = new StringBuilder(2048); // Define a size if you have an idea of it.
   char[] read = new char[128]; // Your buffer size.
   try (InputStreamReader ir = new InputStreamReader(is, StandardCharsets.UTF_8)) {
     for (int i; -1 != (i = ir.read(read)); sb.append(read, 0, i));
   }
   return sb.toString();
}

Для JDK 9

public static String inputStreamString(InputStream inputStream) throws IOException {
    try (inputStream) {
        return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
    }
}
20
Daniel De León 20 Июн 2019 в 08:57

Это ответ, адаптированный из org.apache.commons.io.IOUtils исходный код, для тех, кто хочет иметь реализацию apache, но не хочет всю библиотеку.

private static final int BUFFER_SIZE = 4 * 1024;

public static String inputStreamToString(InputStream inputStream, String charsetName)
        throws IOException {
    StringBuilder builder = new StringBuilder();
    InputStreamReader reader = new InputStreamReader(inputStream, charsetName);
    char[] buffer = new char[BUFFER_SIZE];
    int length;
    while ((length = reader.read(buffer)) != -1) {
        builder.append(buffer, 0, length);
    }
    return builder.toString();
}
20
Hai Zhang 10 Окт 2015 в 07:37

Еще один для всех пользователей Spring:

import java.nio.charset.StandardCharsets;
import org.springframework.util.FileCopyUtils;

public String convertStreamToString(InputStream is) throws IOException { 
    return new String(FileCopyUtils.copyToByteArray(is), StandardCharsets.UTF_8);
}

Служебные методы в org.springframework.util.StreamUtils аналогичны методам в FileCopyUtils, но по завершении они оставляют поток открытым.

17
James 21 Июл 2017 в 13:24

Используйте java. io.InputStream.transferTo (OutputStream) поддерживается в Java 9 и ByteArrayOutputStream.toString (String), который принимает имя кодировки:

public static String gobble(InputStream in, String charsetName) throws IOException {
    ByteArrayOutputStream bos = new ByteArrayOutputStream();
    in.transferTo(bos);
    return bos.toString(charsetName);
}
23
jmehrens 28 Ноя 2017 в 17:47

Вот полный метод преобразования InputStream в String без использования сторонней библиотеки. Используйте StringBuilder для однопоточной среды, в противном случае используйте StringBuffer.

public static String getString( InputStream is) throws IOException {
    int ch;
    StringBuilder sb = new StringBuilder();
    while((ch = is.read()) != -1)
        sb.append((char)ch);
    return sb.toString();
}
17
rtruszk 16 Дек 2015 в 12:20

Вот мое решение на основе Java 8 , в котором используется новый Stream API для сбора всех строк из InputStream:

public static String toString(InputStream inputStream) {
    BufferedReader reader = new BufferedReader(
        new InputStreamReader(inputStream));
    return reader.lines().collect(Collectors.joining(
        System.getProperty("line.separator")));
}
8
Christian Rädel 2 Сен 2015 в 14:19

Вот как это сделать, используя только JDK с использованием буферов байтовых массивов. Именно так работают все методы commons-io IOUtils.copy(). Вы можете заменить byte[] на char[], если копируете из Reader вместо InputStream.

import java.io.ByteArrayOutputStream;
import java.io.InputStream;

...

InputStream is = ....
ByteArrayOutputStream baos = new ByteArrayOutputStream(8192);
byte[] buffer = new byte[8192];
int count = 0;
try {
  while ((count = is.read(buffer)) != -1) {
    baos.write(buffer, 0, count);
  }
}
finally {
  try {
    is.close();
  }
  catch (Exception ignore) {
  }
}

String charset = "UTF-8";
String inputStreamAsString = baos.toString(charset);
15
Matt 13 Авг 2014 в 08:30

Пользователи Kotlin просто делают:

println(InputStreamReader(is).readText())

В то время как

readText()

- это встроенный метод расширения стандартной библиотеки Kotlin.

15
Alex 4 Фев 2015 в 04:12
String inputStreamToString(InputStream inputStream, Charset charset) throws IOException {
    try (
            final StringWriter writer = new StringWriter();
            final InputStreamReader reader = new InputStreamReader(inputStream, charset)
        ) {
        reader.transferTo(writer);
        return writer.toString();
    }
}
  • чистая стандартная библиотека Java - без библиотек
  • начиная с Java 10 - Reader # transferTo (java.io.Writer)
  • безупречное решение
  • нет обработки символа новой строки
20
czerny 5 Апр 2020 в 03:03

Самый простой способ использовать JDK - использовать следующие фрагменты кода.

String convertToString(InputStream in){
    String resource = new Scanner(in).useDelimiter("\\Z").next();
    return resource;
}
10
Raghu K Nair 9 Авг 2016 в 23:18

В терминах reduce и concat это может быть выражено в Java 8 как:

String fromFile = new BufferedReader(new   
InputStreamReader(inputStream)).lines().reduce(String::concat).get();
9
Derlin 20 Июн 2018 в 10:37

Не забудьте закрыть потоки в конце, если вы используете Stream Readers

private String readStream(InputStream iStream) throws IOException {
    //build a Stream Reader, it can read char by char
    InputStreamReader iStreamReader = new InputStreamReader(iStream);
    //build a buffered Reader, so that i can read whole line at once
    BufferedReader bReader = new BufferedReader(iStreamReader);
    String line = null;
    StringBuilder builder = new StringBuilder();
    while((line = bReader.readLine()) != null) {  //Read till end
        builder.append(line);
        builder.append("\n"); // append new line to preserve lines
    }
    bReader.close();         //close all opened stuff
    iStreamReader.close();
    //iStream.close(); //EDIT: Let the creator of the stream close it!
                       // some readers may auto close the inner stream
    return builder.toString();
}

РЕДАКТИРОВАТЬ: в JDK 7+ вы можете использовать конструкцию try-with-resources.

/**
 * Reads the stream into a string
 * @param iStream the input stream
 * @return the string read from the stream
 * @throws IOException when an IO error occurs
 */
private String readStream(InputStream iStream) throws IOException {

    //Buffered reader allows us to read line by line
    try (BufferedReader bReader =
                 new BufferedReader(new InputStreamReader(iStream))){
        StringBuilder builder = new StringBuilder();
        String line;
        while((line = bReader.readLine()) != null) {  //Read till end
            builder.append(line);
            builder.append("\n"); // append new line to preserve lines
        }
        return builder.toString();
    }
}
21
Thamme Gowda 24 Фев 2017 в 22:28

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

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

  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)

     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();
    
  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];
     for (int length; (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();
     for (String line; (line = reader.readLine()) != null; ) {
         if (result.length() > 0) {
             result.append(newLine);
         }
         result.append(line);
     }
     return result.toString();
    
  10. Использование 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");
    
  11. Использование inputStream.read() и StringBuilder (JDK). Предупреждение : у этого решения есть проблемы с Unicode, например, с русским текстом (корректно работает только с текстом, отличным от Unicode).

    StringBuilder sb = new StringBuilder();
    for (int ch; (ch = inputStream.read()) != -1; ) {
        sb.append((char) ch);
    }
    return sb.toString();
    

< Сильный > Предупреждение :

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

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

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

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

              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 (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
3276
Luke Hutchison 28 Фев 2021 в 05:07
Хорошая работа. Может быть полезно предоставить сводку tl; dr внизу, то есть отбросить решения, у которых есть проблемы с разрывами строк / Unicode, а затем (из оставшихся) указать, что быстрее всего с внешними библиотеками или без них.
 – 
Steve Chambers
1 Авг 2020 в 14:16
102
Кажется, этот ответ неполный
 – 
Gigino
26 Авг 2020 в 09:59
2
Мне было интересно узнать о решениях Java 9 InputStream.transferTo и Java 10 Reader.transferTo, которые были добавлены после публикации этого ответа, поэтому я проверил связанный код и добавил для них тесты. Я тестировал только тесты «большой строки». InputStream.transferTo был самым быстрым из всех протестированных решений, он работал в 60% случаев, как test8 на моей машине. Reader.transferTo был медленнее, чем test8, но быстрее, чем все другие тесты. Тем не менее, в 95% случаев он работал как test1, так что это не является значительным улучшением.
 – 
M. Justin
19 Ноя 2020 в 11:03
2
Я преобразовал все циклы while в циклы for при редактировании этого сообщения, чтобы избежать загрязнения пространства имен переменной, которая не используется вне цикла. Это изящный трюк, который работает в большинстве циклов чтения / записи Java.
 – 
Luke Hutchison
28 Фев 2021 в 05:10
11
В Java 9 вы можете получить массив байтов из InputStream, используя .readAllBytes. Итак, «new String (inputStream.readAllBytes ())» работает с использованием конструктора String byte [].
 – 
Shmuel Newmark
29 Май 2021 в 00:18

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

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

2346
Peter Mortensen 5 Янв 2019 в 13:33
Разве мы не должны закрыть сканер перед возвратом значения?
 – 
Oleg Markelov
19 Окт 2020 в 09:13
Сделает то же самое и закроет ресурс с помощью try с помощью ресурса try( java.util.Scanner s = new java.util.Scanner(is).useDelimiter("\\A")){ return s.hasNext() ? s.next() : ""; }
 – 
CodeMonkey
1 Сен 2022 в 01:17

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

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

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

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

880
Peter Mortensen 5 Янв 2019 в 13:29
Попытка вернуть InputStream, не работает stackoverflow.com/q/66349701/3425489
 – 
Shantaram Tupe
24 Фев 2021 в 15:06

С учетом файла сначала нужно получить экземпляр 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();
}
315
11 revs, 8 users 39% 15 Июл 2015 в 13:23

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

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();
265
Peter Mortensen 5 Янв 2019 в 13:35
2
readLine() удаляет символ перевода строки, поэтому результирующая строка не будет содержать разрывов строки, если вы не добавите разделитель строк между каждой строкой, которую вы добавляете в построитель.
 – 
Rangi Keen
16 Мар 2021 в 01:11

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

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

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

180
ralfoide 30 Янв 2013 в 20:35

Для полноты картины приведем решение Java 9 :

public static String toString(InputStream input) throws IOException {
    return new String(input.readAllBytes(), StandardCharsets.UTF_8);
}

Здесь используется readAllBytes < / a>, который был добавлен в Java 9.

161
M. Justin 19 Ноя 2020 в 01:50
2
Я проверил это здесь, и обнаружил, что это самое быстрое решение на моей машине, работающее примерно на 60% быстрее, чем у следующего по скорости тестируемого решения.
 – 
M. Justin
19 Ноя 2020 в 11:05
> Этот метод блокируется до тех пор, пока не будут прочитаны все оставшиеся байты и не будет обнаружен конец потока, или пока не возникнет исключение.
 – 
Martin Meeser
13 Дек 2021 в 22:35
1
Все решения на этой странице подходят, так как это часть задачи.
 – 
Holger
16 Сен 2022 в 17:52
Read=br.readLine() НЕ БУДЕТ блокироваться до тех пор, пока не будут прочитаны все байты или не будет обнаружен конец строки, InputStream.read прочитает один байт или заданный размер буфера, разница с readAllBytes весьма существенна
 – 
Martin Meeser
20 Сен 2022 в 09:12
задача состоит в том, чтобы прочитать все InputStream в одну строку. Конечно, вы можете разделить его на несколько шагов, которые не считывают весь поток, но это бессмысленно, когда все, что вы делаете с этими шагами, — это повторная сборка частичных результатов в один результат после того, как весь поток был прочитан. Таким образом, ни одно из решений этой конкретной задачи не вернется, пока не будет прочитан весь поток.
 – 
Holger
20 Сен 2022 в 09:37

Это лучшее решение на чистой Java, которое идеально подходит для Android и любой другой JVM.

Это решение работает на удивление хорошо ... оно простое, быстрое и одинаково работает как с маленькими, так и с большими потоками !! (см. тест выше .. № 8 )

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;
}
134
TacB0sS 23 Июл 2019 в 23:38

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

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();
}
75
Peter Mortensen 5 Янв 2019 в 13:30

Вот самое элегантное решение на чистой 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();
}
67
Drew Noakes 7 Дек 2013 в 20:39

Я провел тест на 14 различных ответах здесь (извините, что не предоставил кредиты, но дубликатов слишком много).

Результат очень удивительный. Оказывается, Apache IOUtils - самое медленное, а ByteArrayOutputStream - самое быстрое решение:

Итак, сначала вот лучший метод:

public String inputStreamToString(InputStream inputStream) throws IOException {
    try(ByteArrayOutputStream result = new ByteArrayOutputStream()) {
        byte[] buffer = new byte[1024];
        int length;
        while ((length = inputStream.read(buffer)) != -1) {
            result.write(buffer, 0, length);
        }

        return result.toString(UTF_8);
    }
}

Результаты теста: случайные байты 20 МБ за 20 циклов

Время в миллисекундах

  • ByteArrayOutputStreamTest: 194
  • NioStream: 198
  • Java9ISTransferTo: 201
  • Java9ISReadAllBytes: 205
  • BufferedInputStreamVsByteArrayOutputStream: 314
  • ApacheStringWriter2: 574
  • Потоков: 589
  • ScannerReaderNoNextTest: 614
  • СканерЧтение: 633
  • ApacheStringWriter: 1544
  • StreamApi: ошибка
  • ParallelStreamApi: ошибка
  • BufferReaderTest: ошибка
  • InputStreamAndStringBuilder: ошибка

Исходный код теста

import com.google.common.io.CharStreams;
import org.apache.commons.io.IOUtils;

import java.io.*;
import java.nio.ByteBuffer;
import java.nio.channels.Channels;
import java.nio.channels.ReadableByteChannel;
import java.nio.channels.WritableByteChannel;
import java.util.Arrays;
import java.util.List;
import java.util.Random;
import java.util.stream.Collectors;

/**
 * Created by Ilya Gazman on 2/13/18.
 */
public class InputStreamToString {


    private static final String UTF_8 = "UTF-8";

    public static void main(String... args) {
        log("App started");
        byte[] bytes = new byte[1024 * 1024];
        new Random().nextBytes(bytes);
        log("Stream is ready\n");

        try {
            test(bytes);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    private static void test(byte[] bytes) throws IOException {
        List<Stringify> tests = Arrays.asList(
                new ApacheStringWriter(),
                new ApacheStringWriter2(),
                new NioStream(),
                new ScannerReader(),
                new ScannerReaderNoNextTest(),
                new GuavaCharStreams(),
                new StreamApi(),
                new ParallelStreamApi(),
                new ByteArrayOutputStreamTest(),
                new BufferReaderTest(),
                new BufferedInputStreamVsByteArrayOutputStream(),
                new InputStreamAndStringBuilder(),
                new Java9ISTransferTo(),
                new Java9ISReadAllBytes()
        );

        String solution = new String(bytes, "UTF-8");

        for (Stringify test : tests) {
            try (ByteArrayInputStream inputStream = new ByteArrayInputStream(bytes)) {
                String s = test.inputStreamToString(inputStream);
                if (!s.equals(solution)) {
                    log(test.name() + ": Error");
                    continue;
                }
            }
            long startTime = System.currentTimeMillis();
            for (int i = 0; i < 20; i++) {
                try (ByteArrayInputStream inputStream = new ByteArrayInputStream(bytes)) {
                    test.inputStreamToString(inputStream);
                }
            }
            log(test.name() + ": " + (System.currentTimeMillis() - startTime));
        }
    }

    private static void log(String message) {
        System.out.println(message);
    }

    interface Stringify {
        String inputStreamToString(InputStream inputStream) throws IOException;

        default String name() {
            return this.getClass().getSimpleName();
        }
    }

    static class ApacheStringWriter implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            StringWriter writer = new StringWriter();
            IOUtils.copy(inputStream, writer, UTF_8);
            return writer.toString();
        }
    }

    static class ApacheStringWriter2 implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            return IOUtils.toString(inputStream, UTF_8);
        }
    }

    static class NioStream implements Stringify {

        @Override
        public String inputStreamToString(InputStream in) throws IOException {
            ReadableByteChannel channel = Channels.newChannel(in);
            ByteBuffer byteBuffer = ByteBuffer.allocate(1024 * 16);
            ByteArrayOutputStream bout = new ByteArrayOutputStream();
            WritableByteChannel outChannel = Channels.newChannel(bout);
            while (channel.read(byteBuffer) > 0 || byteBuffer.position() > 0) {
                byteBuffer.flip();  //make buffer ready for write
                outChannel.write(byteBuffer);
                byteBuffer.compact(); //make buffer ready for reading
            }
            channel.close();
            outChannel.close();
            return bout.toString(UTF_8);
        }
    }

    static class ScannerReader implements Stringify {

        @Override
        public String inputStreamToString(InputStream is) throws IOException {
            java.util.Scanner s = new java.util.Scanner(is).useDelimiter("\\A");
            return s.hasNext() ? s.next() : "";
        }
    }

    static class ScannerReaderNoNextTest implements Stringify {

        @Override
        public String inputStreamToString(InputStream is) throws IOException {
            java.util.Scanner s = new java.util.Scanner(is).useDelimiter("\\A");
            return s.next();
        }
    }

    static class GuavaCharStreams implements Stringify {

        @Override
        public String inputStreamToString(InputStream is) throws IOException {
            return CharStreams.toString(new InputStreamReader(
                    is, UTF_8));
        }
    }

    static class StreamApi implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            return new BufferedReader(new InputStreamReader(inputStream))
                    .lines().collect(Collectors.joining("\n"));
        }
    }

    static class ParallelStreamApi implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            return new BufferedReader(new InputStreamReader(inputStream)).lines()
                    .parallel().collect(Collectors.joining("\n"));
        }
    }

    static class ByteArrayOutputStreamTest implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            try(ByteArrayOutputStream result = new ByteArrayOutputStream()) {
                byte[] buffer = new byte[1024];
                int length;
                while ((length = inputStream.read(buffer)) != -1) {
                    result.write(buffer, 0, length);
                }

                return result.toString(UTF_8);
            }
        }
    }

    static class BufferReaderTest implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            String newLine = System.getProperty("line.separator");
            BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
            StringBuilder result = new StringBuilder(UTF_8);
            String line;
            boolean flag = false;
            while ((line = reader.readLine()) != null) {
                result.append(flag ? newLine : "").append(line);
                flag = true;
            }
            return result.toString();
        }
    }

    static class BufferedInputStreamVsByteArrayOutputStream implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            BufferedInputStream bis = new BufferedInputStream(inputStream);
            ByteArrayOutputStream buf = new ByteArrayOutputStream();
            int result = bis.read();
            while (result != -1) {
                buf.write((byte) result);
                result = bis.read();
            }

            return buf.toString(UTF_8);
        }
    }

    static class InputStreamAndStringBuilder implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            int ch;
            StringBuilder sb = new StringBuilder(UTF_8);
            while ((ch = inputStream.read()) != -1)
                sb.append((char) ch);
            return sb.toString();
        }
    }

    static class Java9ISTransferTo implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            ByteArrayOutputStream bos = new ByteArrayOutputStream();
            inputStream.transferTo(bos);
            return bos.toString(UTF_8);
        }
    }

    static class Java9ISReadAllBytes implements Stringify {

        @Override
        public String inputStreamToString(InputStream inputStream) throws IOException {
            return new String(inputStream.readAllBytes(), UTF_8);
        }
    }

}
62
Peter Mortensen 6 Янв 2019 в 03:45
Создание тестов на Java - непростая задача (особенно из-за JIT). Прочитав исходный код Benchmark, я убедился, что приведенные выше значения неточны, и всем следует быть осторожными, веря им.
 – 
Dalibor
17 Май 2019 в 01:08
Вам, вероятно, следует предоставить больше аргументов в пользу своей претензии, чем просто ссылку.
 – 
Ilya Gazman
28 Май 2019 в 17:06
Я думаю, что это действительно известный факт, что сделать свой собственный бенчмарк непросто. Для тех, кто этого не знает, есть ссылка;)
 – 
Dalibor
30 Май 2019 в 01:04
Возможно, я не лучший, но я хорошо разбираюсь в тестах производительности Java, поэтому, если вы не укажете конкретную проблему, вы просто вводите в заблуждение, и я не буду продолжать разговор с вами в таких условиях.
 – 
Ilya Gazman
30 Май 2019 в 02:56
1
Из принятого ответа: Правило 0: прочтите статью, в которой, по сути, содержится предостережение от попыток проведения микротеста. Правило 1: У вас нет фазы разминки. Правило 2-3: Вы не указали, что использовали эти флаги. Правило 8: Используйте такую ​​библиотеку, как JMH. В комментариях подано 135 голосов: не используйте System.currentTimeMillis(). Переходим к другим высоко оцененным ответам. Джон Скит: используйте System.gc() между итерациями и запускайте тест достаточно долго, чтобы измерить результаты в секундах, а не миллисекундах. Смешивание тестов в одном запуске JVM - это плохо, поскольку оптимизация компилятора, выполненная для одного теста, повлияет на другой.
 – 
DavidS
16 Ноя 2019 в 00:55

Я провел несколько тестов по времени, потому что время всегда имеет значение.

Я попытался получить ответ в строке 3 разными способами. (показано ниже)
Я не использовал блоки try / catch для удобства чтения.

Чтобы дать контекст, это предыдущий код для всех трех подходов:

   String response;
   String url = "www.blah.com/path?key=value";
   GetMethod method = new GetMethod(url);
   int status = client.executeMethod(method);

1)

 response = method.getResponseBodyAsString();

2)

InputStream resp = method.getResponseBodyAsStream();
InputStreamReader is=new InputStreamReader(resp);
BufferedReader br=new BufferedReader(is);
String read = null;
StringBuffer sb = new StringBuffer();
while((read = br.readLine()) != null) {
    sb.append(read);
}
response = sb.toString();

3)

InputStream iStream  = method.getResponseBodyAsStream();
StringWriter writer = new StringWriter();
IOUtils.copy(iStream, writer, "UTF-8");
response = writer.toString();

Итак, после запуска 500 тестов для каждого подхода с одними и теми же данными запроса / ответа, вот числа. Опять же, это мои выводы, и ваши выводы могут быть не совсем такими же, но я написал это, чтобы указать другим на различия в эффективности этих подходов.

Звания:
Подход №1
Подход №3 - на 2,6% медленнее, чем №1
Подход №2 - на 4,3% медленнее, чем №1

Любой из этих подходов является подходящим решением для получения ответа и создания из него String.

38
martijnn2008 17 Окт 2017 в 11:55

Решение на чистом Java с использованием Stream s, работает с Java 8.

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.stream.Collectors;

// ...
public static String inputStreamToString(InputStream is) throws IOException {
    try (BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
        return br.lines().collect(Collectors.joining(System.lineSeparator()));
    }
}

Как упомянул Кристофер Хаммарстрём ниже другой ответ, безопаснее явно указать Кодировка. Т.е. Конструктор InputStreamReader можно изменить следующим образом:

new InputStreamReader(is, Charset.forName("UTF-8"))
37
Community 23 Май 2017 в 15:34

Вот более или менее ответ сампата, немного очищенный и представленный в виде функции:

String streamToString(InputStream in) throws IOException {
  StringBuilder out = new StringBuilder();
  BufferedReader br = new BufferedReader(new InputStreamReader(in));
  for(String line = br.readLine(); line != null; line = br.readLine()) 
    out.append(line);
  br.close();
  return out.toString();
}
29
TKH 12 Сен 2012 в 22:31

Если вы любите приключения, вы можете смешать Scala и Java и в итоге получить следующее:

scala.io.Source.fromInputStream(is).mkString("")

Сочетание кода и библиотек Java и Scala имеет свои преимущества.

См. Полное описание здесь: Идиоматический способ преобразования InputStream в String в Scala

28
Community 23 Май 2017 в 15:18