Question Lire / convertir un InputStream en String


Si tu as un java.io.InputStream objet, comment devez-vous traiter cet objet et produire un String?


Supposons que j'ai un InputStream qui contient des données de texte, et je veux le convertir en String, par exemple je peux écrire cela dans un fichier journal.

Quelle est la manière la plus simple de prendre InputStream et le convertir en un String?

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

3263
2017-11-21 16:47


origine


Réponses:


Une bonne façon de le faire est d'utiliser Commands Apache  IOUtils copier le InputStream dans une StringWriter... quelque chose comme

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

ou même

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

Alternativement, vous pouvez utiliser ByteArrayOutputStream si vous ne voulez pas mélanger vos Streams et Ecrivains


2044
2017-11-21 16:54



Voici une façon d'utiliser seulement la bibliothèque Java standard (notez que le flux n'est pas fermé, YMMV).

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

J'ai appris ce tour de "Astuces stupide Scanner" article. La raison pour laquelle cela fonctionne est parce que Scanner itère sur les jetons dans le flux, et dans ce cas, nous séparons les jetons en utilisant le "début de la limite d'entrée" (\ A), ce qui ne nous donne qu'un jeton pour tout le contenu du flux.

Notez, si vous devez être spécifique au codage du flux d'entrée, vous pouvez fournir le second argument Scanner constructeur qui indique quel jeu de caractères utiliser (par exemple "UTF-8").

La pointe du chapeau va aussi à Jacob, qui m'a une fois indiqué le dit article.

ÉDITÉ: Merci à une suggestion de Patrick, rend la fonction plus robuste lors de la gestion d'un flux d'entrée vide. Encore une édition: nixed try / catch, Patrick est plus laconique.


2092
2018-03-26 20:40



Résumez les autres réponses. J'ai trouvé 11 façons principales de le faire (voir ci-dessous). Et j'ai écrit quelques tests de performance (voir les résultats ci-dessous):

Façons de convertir un InputStream en String:

  1. En utilisant IOUtils.toString (Apache Utils)

    String result = IOUtils.toString(inputStream, StandardCharsets.UTF_8);
    
  2. En utilisant CharStreams (Goyave)

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

    Scanner s = new Scanner(inputStream).useDelimiter("\\A");
    String result = s.hasNext() ? s.next() : "";
    
  4. En utilisant API de flux (Java 8). Attention: Cette solution convertit différents sauts de ligne (comme \r\n) à \n.

    String result = new BufferedReader(new InputStreamReader(inputStream))
      .lines().collect(Collectors.joining("\n"));
    
  5. En utilisant API de flux parallèle (Java 8). Attention: Cette solution convertit différents sauts de ligne (comme \r\n) à \n.

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

    StringWriter writer = new StringWriter();
    IOUtils.copy(inputStream, writer, "UTF-8");
    return writer.toString();
    
  8. En utilisant ByteArrayOutputStream et 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. En utilisant BufferedReader (JDK). Attention: Cette solution convertit différentes ruptures de ligne (comme \n\r) à line.separator propriété système (par exemple, dans Windows à "\ 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. En utilisant BufferedInputStream et 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. En utilisant inputStream.read() et StringBuilder (JDK). Attention: Cette solution a des problèmes avec Unicode, par exemple avec du texte russe (ne fonctionne correctement qu'avec du texte non-Unicode)

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

Attention:

  1. Les solutions 4, 5 et 9 convertissent différentes sauts de ligne en un seul.

  2. La solution 11 ne peut pas fonctionner correctement avec le texte Unicode

Des tests de performance

Tests de performance pour les petites String (longueur = 175), URL dans github (mode = temps moyen, système = Linux, score 1 343 est le meilleur):

              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

Tests de performance pour gros String (longueur = 50100), URL dans github (mode = temps moyen, système = Linux, score 200,715 est le meilleur):

               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

Graphes (tests de performance en fonction de la longueur du flux d'entrée dans le système Windows 7)
enter image description here

Test de performance (durée moyenne) en fonction de la longueur du flux d'entrée dans le système 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 permet:

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

Bien sûr, vous pouvez choisir d'autres encodages de caractères en plus de UTF-8.

Regarde aussi: (Docs)


794
2017-12-08 20:13



Prendre en compte le fichier un devrait d'abord obtenir un java.io.Reader exemple. Cela peut ensuite être lu et ajouté à un StringBuilder (nous n'avons pas besoin StringBuffer si nous n'y accédons pas dans plusieurs threads, et StringBuilder est plus rapide). L'astuce ici est que nous travaillons en blocs, et en tant que tels n'ont pas besoin d'autres flux de tamponnage. La taille de bloc est paramétrée pour l'optimisation des performances d'exécution.

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



Que dis-tu de ça?

InputStream in = / * votre 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 vous utilisez Google-Collections / Guava, vous pouvez faire ce qui suit:

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

Notez que le second paramètre (c'est-à-dire Charsets.UTF_8) pour le InputStreamReader n'est pas nécessaire, mais c'est généralement une bonne idée de spécifier l'encodage si vous le connaissez (ce que vous devriez faire!)


153
2018-05-08 20:24