Vraag Lezen / converteren van een InputStream naar een string


Als je een ... hebt java.io.InputStream object, hoe moet je dat object verwerken en produceren a String?


Stel dat ik een InputStream dat tekstgegevens bevat, en ik wil het omzetten naar een String, dus ik kan dat bijvoorbeeld schrijven naar een logbestand.

Wat is de gemakkelijkste manier om de InputStream en converteer het naar een String?

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

3263
2017-11-21 16:47


oorsprong


antwoorden:


Een leuke manier om dit te doen is met behulp van Apache-commons  IOUtils om het te kopiëren InputStream in een StringWriter... zoiets als

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

of zelfs

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

Als alternatief zou je kunnen gebruiken ByteArrayOutputStream als je je Streams and Writers niet wilt mixen


2044
2017-11-21 16:54



Hier is een manier om alleen de standaard Java-bibliotheek te gebruiken (merk op dat de stream niet is afgesloten, YMMV).

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

Ik heb deze truc geleerd "Stupid Scanner tricks" artikel. De reden waarom het werkt, is omdat Scanner itereert over tokens in de stream en in dit geval scheiden we tokens met gebruik van "begin van de invoergrens" (\ A), waardoor we slechts één token voor de volledige inhoud van de stream hebben.

Opmerking: als u specifiek wilt zijn over de codering van de invoerstroom, kunt u het tweede argument opgeven Scanner constructor die aangeeft welke tekenset moet worden gebruikt (bijvoorbeeld "UTF-8").

Hat tip gaat ook naar Jakob, die me ooit naar het genoemde artikel wees.

Bewerkt: Dankzij een suggestie van Patrick, maakte de functie robuuster bij het verwerken van een lege invoerstroom. Nog een bewerking: nixed try / catch, Patrick's manier is meer laconiek.


2092
2018-03-26 20:40



Vat andere antwoorden samen Ik vond 11 belangrijke manieren om dit te doen (zie hieronder). En ik heb een aantal prestatietests geschreven (zie onderstaande resultaten):

Manieren om een ​​InputStream naar een String te converteren:

  1. Gebruik makend van IOUtils.toString (Apache Utils)

    String result = IOUtils.toString(inputStream, StandardCharsets.UTF_8);
    
  2. Gebruik makend van CharStreams (Guava)

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

    Scanner s = new Scanner(inputStream).useDelimiter("\\A");
    String result = s.hasNext() ? s.next() : "";
    
  4. Gebruik makend van Stream API (Java 8). Waarschuwing: Deze oplossing converteert verschillende regeleinden (zoals \r\n) naar \n.

    String result = new BufferedReader(new InputStreamReader(inputStream))
      .lines().collect(Collectors.joining("\n"));
    
  5. Gebruik makend van parallelle Stream API (Java 8). Waarschuwing: Deze oplossing converteert verschillende regeleinden (zoals \r\n) naar \n.

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

    StringWriter writer = new StringWriter();
    IOUtils.copy(inputStream, writer, "UTF-8");
    return writer.toString();
    
  8. Gebruik makend van ByteArrayOutputStream en 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. Gebruik makend van BufferedReader (JDK). Waarschuwing: Deze oplossing converteert verschillende regeleinden (zoals \n\r) naar line.separator systeemeigenschap (bijvoorbeeld in Windows naar "\ 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. Gebruik makend van BufferedInputStream en 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. Gebruik makend van inputStream.read() en StringBuilder (JDK). Waarschuwing: Deze oplossing heeft problemen met Unicode, bijvoorbeeld met Russische tekst (werkt alleen correct met niet-Unicode-tekst)

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

Waarschuwing:

  1. Oplossingen 4, 5 en 9 zetten verschillende regeleinden om naar één.

  2. Oplossing 11 kan niet correct werken met Unicode-tekst

Prestatie testen

Prestatietests voor klein String (lengte = 175), url in github (modus = gemiddelde tijd, systeem = Linux, score 1.343 is de beste):

              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

Prestatietests voor groot String (lengte = 50100), url in github (modus = Gemiddelde tijd, systeem = Linux, score 200.715 is de beste):

               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

Grafieken (prestatietests afhankelijk van de lengte van de invoerstroom in het Windows 7-systeem)
enter image description here

Prestatietest (gemiddelde tijd), afhankelijk van de lengte van de invoerstroom in het Windows 7-systeem:

 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 staat het volgende toe:

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

Natuurlijk kunt u naast UTF-8 ook andere tekencoderingen kiezen.

Zie ook: (Docs)


794
2017-12-08 20:13



Rekening houdend met bestand moet men eerst een java.io.Reader aanleg. Dit kan dan worden gelezen en toegevoegd aan een StringBuilder (we hebben het niet nodig StringBuffer als we het niet in meerdere threads gebruiken, en StringBuilder is sneller). De truc hier is dat we in blokken werken en als zodanig geen andere bufferstromen nodig hebben. De blokgrootte is geparametreerd voor optimalisatie van de runtime-prestaties.

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



Wat denk je hiervan?

InputStream in = / * uw 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



Als u Google-Collections / Guava gebruikt, kunt u het volgende doen:

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

Merk op dat de tweede parameter (d.w.z. Charsets.UTF_8) voor de InputStreamReader is niet noodzakelijk, maar het is over het algemeen een goed idee om de codering op te geven als je het weet (wat je zou moeten doen!)


153
2018-05-08 20:24



Dit is mijn pure Java & Android-oplossing, werkt goed ...

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



Wat dacht je van:

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



Hier is de meest elegante, pure-Java (geen bibliotheek) oplossing die ik bedacht na wat experimenteren:

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

55
2017-09-02 11:50