Pregunta Leer / convertir un InputStream en una cadena


Si tienes un java.io.InputStream objeto, ¿cómo debe procesar ese objeto y producir un String?


Supongamos que tengo un InputStream que contiene datos de texto, y quiero convertirlo a String, entonces, por ejemplo, puedo escribir eso en un archivo de registro.

¿Cuál es la forma más fácil de tomar el InputStream y convertirlo a un String?

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

3263
2017-11-21 16:47


origen


Respuestas:


Una buena forma de hacerlo es usar Apache commons  IOUtils para copiar el InputStream en un StringWriter... algo como

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

o incluso

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

Alternativamente, podrías usar ByteArrayOutputStream si no quieres mezclar tus Streams y Escritores


2044
2017-11-21 16:54



Esta es una forma de usar solo la biblioteca estándar de Java (tenga en cuenta que la secuencia no está cerrada, YMMV).

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

Aprendí este truco de "Trucos estúpidos del escáner" artículo. La razón por la que funciona es porque Escáner itera sobre tokens en la secuencia, y en este caso separamos tokens usando "principio del límite de entrada" (\ A), dándonos así solo un token para todo el contenido de la secuencia.

Tenga en cuenta que si necesita ser específico sobre la codificación de la corriente de entrada, puede proporcionar el segundo argumento para Scanner constructor que indica qué juego de caracteres usar (por ejemplo, "UTF-8").

La punta del sombrero va también a Jacob, quien una vez me señaló el dicho artículo.

EDITADO: Gracias a una sugerencia de Patricio, hizo la función más robusta al manejar una secuencia de entrada vacía. Una edición más: nixed try / catch, el modo de Patrick es más lacónico.


2092
2018-03-26 20:40



Resumir otras respuestas Encontré 11 formas principales de hacer esto (ver abajo). Y escribí algunas pruebas de rendimiento (ver resultados a continuación):

Formas de convertir un InputStream en una cadena:

  1. Utilizando IOUtils.toString (Apache Utils)

    String result = IOUtils.toString(inputStream, StandardCharsets.UTF_8);
    
  2. Utilizando CharStreams (Guayaba)

    String result = CharStreams.toString(new InputStreamReader(
          inputStream, Charsets.UTF_8));
    
  3. Utilizando Scanner (JDK)

    Scanner s = new Scanner(inputStream).useDelimiter("\\A");
    String result = s.hasNext() ? s.next() : "";
    
  4. Utilizando Stream API (Java 8). Advertencia: Esta solución convierte diferentes saltos de línea (como \r\n) a \n.

    String result = new BufferedReader(new InputStreamReader(inputStream))
      .lines().collect(Collectors.joining("\n"));
    
  5. Utilizando API paralela de Stream (Java 8). Advertencia: Esta solución convierte diferentes saltos de línea (como \r\n) a \n.

    String result = new BufferedReader(new InputStreamReader(inputStream)).lines()
       .parallel().collect(Collectors.joining("\n"));
    
  6. Utilizando InputStreamReader y 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. Utilizando StringWriter y IOUtils.copy (Apache Commons)

    StringWriter writer = new StringWriter();
    IOUtils.copy(inputStream, writer, "UTF-8");
    return writer.toString();
    
  8. Utilizando ByteArrayOutputStream y 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. Utilizando BufferedReader (JDK) Advertencia: Esta solución convierte diferentes saltos de línea (como \n\r) a line.separator propiedad del sistema (por ejemplo, en Windows a "\ r \ n").

    String newLine = System.getProperty("line.separator");
    BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream));
    StringBuilder result = new StringBuilder();
    String line; boolean flag = false;
    while ((line = reader.readLine()) != null) {
        result.append(flag? newLine: "").append(line);
        flag = true;
    }
    return result.toString();
    
  10. Utilizando BufferedInputStream y 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. Utilizando inputStream.read() y StringBuilder (JDK) Advertencia: Esta solución tiene problemas con Unicode, por ejemplo, con texto en ruso (funciona correctamente solo con texto que no es Unicode)

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

Advertencia:

  1. Las soluciones 4, 5 y 9 convierten diferentes saltos de línea en uno.

  2. La solución 11 no puede funcionar correctamente con texto Unicode

Pruebas de rendimiento

Pruebas de rendimiento para pequeños String (longitud = 175), URL en github (modo = Tiempo promedio, sistema = Linux, puntaje 1,343 es el mejor):

              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

Pruebas de rendimiento para grandes String (longitud = 50100), url en github (modo = Tiempo promedio, sistema = Linux, puntaje 200,715 es el mejor):

               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

Gráficos (pruebas de rendimiento según la longitud del flujo de entrada en el sistema Windows 7)
enter image description here

Prueba de rendimiento (tiempo promedio) según la longitud del flujo de entrada en el sistema 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

1649
2018-02-17 00:58



Apache Commons permite:

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

Por supuesto, puedes elegir otras codificaciones de caracteres además de UTF-8.

Ver también: (Documentos)


794
2017-12-08 20:13



Teniendo en cuenta el archivo uno primero debe obtener una java.io.Reader ejemplo. Esto luego puede leerse y agregarse a un StringBuilder (no necesitamos StringBuffer si no estamos accediendo a él en múltiples hilos, y StringBuilder es más rápido). El truco aquí es que trabajamos en bloques, y como tal no necesitamos otras secuencias de almacenamiento en búfer. El tamaño del bloque está parametrizado para la optimización del rendimiento en tiempo de ejecución.

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();
}

263
2017-08-04 08:29



¿Qué tal esto?

InputStream in = / * su 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();

226
2017-07-13 15:56



Si está utilizando Google-Collections / Guava, puede hacer lo siguiente:

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

Tenga en cuenta que el segundo parámetro (es decir, Charsets.UTF_8) para el InputStreamReader no es necesario, pero generalmente es una buena idea especificar la codificación si la conoce (¡lo que debería hacer!)


153
2018-05-08 20:24



Esta es mi solución pura de Java y Android, funciona bien ...

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;
}

107
2018-06-10 21:07



Qué tal si:

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();
}

56
2018-01-01 03:43