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


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

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

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

19 ответов

Лучший ответ

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

2686
Marko Zajc 21 Май 2018 в 16:09
ToString устарел? Я вижу IOUtils.convertStreamToString()
 – 
RCB
2 Июл 2020 в 18:26

Обобщите другие ответы. Я нашел 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
2874
Luke Hutchison 28 Фев 2021 в 05:07
Хорошая работа. Может быть полезно предоставить сводку tl; dr внизу, то есть отбросить решения, у которых есть проблемы с разрывами строк / Unicode, а затем (из оставшихся) указать, что быстрее всего с внешними библиотеками или без них.
 – 
Steve Chambers
1 Авг 2020 в 14:16
31
Кажется, этот ответ неполный
 – 
Gigino
26 Авг 2020 в 09:59
1
Мне было интересно узнать о решениях 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
В 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»).

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

2333
Peter Mortensen 5 Янв 2019 в 13:33
Разве мы не должны закрыть сканер перед возвратом значения?
 – 
Oleg Markelov
19 Окт 2020 в 09:13
Наверное.
 – 
Pavel Repin
9 Ноя 2020 в 23:05

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

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

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

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

Если вы не можете использовать 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);
    }
}
24
Peter Mortensen 5 Янв 2019 в 13:31

Не забудьте закрыть потоки в конце, если вы используете 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();
    }
}
20
Thamme Gowda 24 Фев 2017 в 22:28

Это ответ, адаптированный из 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();
}
19
Hai Zhang 10 Окт 2015 в 07:37

Используйте 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);
}
19
jmehrens 28 Ноя 2017 в 17:47

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

  • Он безопасно обращается с 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);
    }
}
19
Daniel De León 20 Июн 2019 в 08:57

Еще один для всех пользователей 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

Вот полный метод преобразования 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();
}
16
rtruszk 16 Дек 2015 в 12:20

Вот как это сделать, используя только 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
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)
  • безупречное решение
  • нет обработки символа новой строки
14
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

Вот мое решение на основе 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

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

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

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

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

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

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

26
Community 23 Май 2017 в 15:18

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

println(InputStreamReader(is).readText())

В то время как

readText()

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

15
Alex 4 Фев 2015 в 04:12