java - كيفية قراءة / تحويل InputStream إلى سلسلة في جاوة؟




string io (25)

مستخدمو Kotlin يقومون ببساطة بما يلي:

println(InputStreamReader(is).readText())

بينما

readText()

هي طريقة التمديد المدمجة في مكتبة Kotlin القياسية.

إذا كان لديك كائن java.io.InputStream ، كيف يمكنك معالجة هذا الكائن وإنتاج String ؟

لنفترض أن لدي InputStream يحتوي على بيانات نصية ، وأريد تحويله إلى String ، لذلك على سبيل المثال يمكنني كتابته إلى ملف السجل.

ما هي أسهل طريقة لأخذ InputStream وتحويله إلى String ؟

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

مع الأخذ في الاعتبار الملف الأول يجب الحصول على نسخة 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();
}

إذا كنت تستخدم Google-Collections / Guava ، فيمكنك إجراء ما يلي:

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

لاحظ أن المعلمة الثانية (أي Charsets.UTF_8) لـ InputStreamReader ليست ضرورية ، ولكن من الجيد بشكل عام تحديد الترميز إذا كنت تعرفه (وهو ما يجب عليك!)


الطريقة الأسهل في JDK هي مع مقتطفات الشفرة التالية.

String convertToString(InputStream in){
    String resource = new Scanner(in).useDelimiter("\\Z").next();
    return resource;
}

يسمح Apache Commons بما يلي:

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

بالطبع ، يمكنك اختيار ترميزات الأحرف الأخرى إلى جانب UTF-8.

انظر أيضًا: ( Docs )


إذا كنت تشعرين بالمغامرة ، فيمكنك مزج سكالا وجافا وتنتهي بذلك:

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

مزج جافا ورمز سكالا والمكتبات لديها فوائد.

انظر الوصف الكامل هنا: طريقة بديهية لتحويل InputStream إلى سلسلة في سكالا


تأكد من إغلاق الدفق في النهاية إذا كنت تستخدم دفق القراء

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

لقد فعلت ذلك على أساس 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
  • GuavaCharStreams: 589
  • ScannerReaderNoNextTest: 614
  • ScannerReader: 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);
        }
    }

}

للتأكد من اكتماله ، يوجد حل Java 9 :

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

يعد readAllBytes حاليًا في كود البرمجة الرئيسي لـ JDK 9 ، لذا فمن المحتمل أن يظهر في الإصدار. يمكنك تجربتها الآن باستخدام نسخ لقطة JDK 9 .


واحد آخر ، لجميع مستخدمي الربيع:

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، ولكنها تترك الدفق مفتوحًا عند الانتهاء.


إليك الحل الأكثر أناقة ونقية (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();
}

هذا هو حل جافا وأندرويد الخاص بي ، ويعمل بشكل جيد ...

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

لقد قمت بكتابة فصل دراسي يفعل ذلك بالضبط ، لذا فكنت أحسب أنني سأشاركه مع الجميع. في بعض الأحيان لا ترغب في إضافة Apache Commons لشيء واحد فقط ، وتريد شيئًا أقل من الماسح الضوئي الذي لا يفحص المحتوى.

الاستخدام هو على النحو التالي

byte[] bytes = Resources.toByteArray(classLoader.getResource(path));

هنا هو رمز ReaderSink:

String text = Resources.toString(classLoader.getResource(path), StandardCharsets.UTF_8);

هذا لطيف لأن:

  • سلامة اليد و charset.
  • يمكنك التحكم في حجم المخزن المؤقت للقراءة.
  • يمكنك توفير طول البناء ويمكن أن لا يكون بالضبط.
  • خالي من اعتمادات المكتبات.
  • هو لجافا 7 أو أعلى.

ماذا عن؟

public static String convertStreamToString(InputStream is) {
   if (is == null) return null;
   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));
   } catch (Throwable t) {}
   return sb.toString();
}

هذه إجابة مأخوذة من org.apache.commons.io.IOUtils كود المصدر ، لأولئك الذين يريدون تطبيق أباتشي ولكنهم لا يريدون المكتبة بأكملها.

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

طريقة لطيفة للقيام بذلك هي استخدام Apache commons IOUtils لنسخ StringWriter في 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 إذا كنت لا تريد خلط الدفق الخاص بك والكتاب


حل جافا الصافي باستخدام 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()));
    }
}

كما ذكر Christoffer Hammarström تحت إجابة أخرى ، من Charset أن تحدد Charset بوضوح . يمكن أن يكون منشئ InputStreamReader التغييرات كما يلي:

new InputStreamReader(is, Charset.forName("UTF-8"))

جريت بعض اختبارات التوقيت لأن الوقت مهم ، دائمًا.

حاولت الحصول على رد في سلسلة 3 طرق مختلفة. (ظاهر أدناه)
تركت خارج محاولة / التقاط كتل من أجل قابلية القراءة.

لإعطاء السياق ، هذا هو الرمز السابق لجميع الطرق الثلاثة:

   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

أي من هذه الطرق هو الحل المناسب لجذب الاستجابة وإنشاء سلسلة منه.


وماذا عن هذا؟

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

وإليك طريقة باستخدام مكتبة Java القياسية فقط (لاحظ أن الدفق غير مغلق ، YMMV).

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").

يذهب تلميح قبعة أيضا إلى Jacob, الذي أشار لي مرة واحدة على المادة المذكورة.

EDITED: بفضل اقتراح من Patrick ، جعل الوظيفة أكثر قوة عند التعامل مع تدفق مدخلات فارغ. تحرير واحد آخر: محاولة / صيد نيكس ، طريقة باتريك أكثر مقتضبة.


إليك كيفية القيام بذلك باستخدام JDK فقط باستخدام المخازن المؤقتة لصفيف البايت. هذا هو في الواقع كيف IOUtils.copy()تعمل جميع أساليب commons-io . يمكنك استبدال 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);

سأستخدم بعض حيل جافا 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.
    }
}

أساسا نفس بعض الإجابات الأخرى باستثناء أكثر مقتضبة.


إليك إجابة سامباث أكثر أو أقل ، وتنظيفها قليلاً وتمثيلها كدالة:

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

إليك حل يستند إلى Java 8 ، والذي يستخدم واجهة برمجة تطبيقات Stream الجديدة لجمع كل الأسطر من InputStream:

public static String toString(InputStream inputStream) {
    BufferedReader reader = new BufferedReader(
        new InputStreamReader(inputStream));
    return reader.lines().collect(Collectors.joining(
        System.getProperty("line.separator")));
}

يمكنك استخدام new Scanner("1244").nextInt() . أو أسأل ما إذا كان حتى int موجود: new Scanner("1244").hasNextInt()





java string io stream inputstream