Guava еквівалент IOUtils.toString (InputStream)

Apache Commons IO має приємний метод зручності IOUtils.toString () для читання InputStreamрядка.

Оскільки я намагаюся відійти від Apache Commons та до Guava : чи є еквівалент у Guava? Я переглянув усі класи в com.google.common.ioпакеті, і не зміг знайти щось майже так просто.

Редагувати: Я розумію і ціную проблеми із графіками. Так буває, що я знаю, що всі мої джерела знаходяться в ASCII (так, ASCII, а не ANSI тощо), тому в цьому випадку кодування не є проблемою для мене.

Ви сказали у своєму коментарі на відповідь Калума, що збираєтесь використовувати

CharStreams.toString(new InputStreamReader(supplier.get(), Charsets.UTF_8))

Цей код є проблематичним, оскільки перевантаження CharStreams.toString(Readable):

Не закриває Readable.

Це означає, що ваш InputStreamReader, і після розширення, що InputStreamповертається supplier.get(), не буде закритий після завершення цього коду.

Якщо, з іншого боку, ви скористаєтесь тим, що, здається, у вас вже є InputSupplier<InputStream>і використовували перевантаження CharStreams.toString(InputSupplier<R extends Readable & Closeable>), toStringметод буде обробляти як створення, так і закриття Readerдля вас.

Це саме те, що запропонував Джон Скіт, за винятком того, що насправді немає перевантаження того, CharStreams.newReaderSupplierщо приймається InputStreamяк вхід ... Ви повинні надати йому InputSupplier:

InputSupplier<? extends InputStream> supplier = ...
InputSupplier<InputStreamReader> readerSupplier = 
    CharStreams.newReaderSupplier(supplier, Charsets.UTF_8);

// InputStream and Reader are both created and closed in this single call
String text = CharStreams.toString(readerSupplier);

Сенс InputSupplierполягає в тому, щоб полегшити ваше життя, дозволяючи Guava обробляти деталі, які потребують некрасивого try-finallyблоку, щоб забезпечити належне закриття ресурсів.

Редагувати: Особисто я знаходжу наступне (саме так я насправді це написав, просто розбиваючи кроки в коді вище)

String text = CharStreams.toString(
    CharStreams.newReaderSupplier(supplier, Charsets.UTF_8));

бути набагато менш багатослівним, ніж це:

String text;
InputStreamReader reader = new InputStreamReader(supplier.get(), 
    Charsets.UTF_8);
boolean threw = true;
try {
  text = CharStreams.toString(reader);
  threw = false;
}
finally {
  Closeables.close(reader, threw);
}

Що більш-менш те, що вам доведеться написати, щоб самостійно впоратися з цим.

Редагувати: Лютий 2014

InputSupplierі OutputSupplierметоди, які їх використовують, були застаріли в Guava 16.0. Їх заміни є ByteSource, CharSource, ByteSinkі CharSink. З огляду на ByteSource, тепер ви можете отримати його вміст так String:

ByteSource source = ...
String text = source.asCharSource(Charsets.UTF_8).read();

Якщо у вас є Readableви можете використовувати CharStreams.toString(Readable). Тож ви, ймовірно, можете зробити наступне:

String string = CharStreams.toString( new InputStreamReader( inputStream, "UTF-8" ) );

Змушує вас вказати набір символів, який, напевно, ви повинні робити все одно.

ОНОВЛЕННЯ : Озираючись назад, мені не подобається моє старе рішення. Крім того, зараз 2013 рік, і для Java7 є кращі альтернативи. Отже ось що я зараз використовую:

InputStream fis = ...;
String text;
try (  InputStreamReader reader = new InputStreamReader(fis, Charsets.UTF_8)){
        text = CharStreams.toString(reader);
}

або якщо з InputSupplier

InputSupplier<InputStreamReader> spl = ...
try (  InputStreamReader reader = spl.getInput()){
        text = CharStreams.toString(reader);
    }

Близько. Ви можете використовувати щось подібне:

InputSupplier<InputStreamReader> readerSupplier = CharStreams.newReaderSupplier
    (streamSupplier, Charsets.UTF_8);
String text = CharStreams.toString(readerSupplier);

Особисто я не думаю, що IOUtils.toString(InputStream)це "приємно" - адже воно завжди використовує кодування за замовчуванням платформи, що майже ніколи не є тим, що ви хочете. Існує перевантаження, яка приймає назву кодування, але використання імен не є чудовою ідеєю IMO. Ось чому мені подобається Charsets.*.

EDIT: Не те, що вищезазначене потребує InputSupplier<InputStream>як streamSupplier. Якщо ви вже отримали потік, ви можете це легко реалізувати:

InputSupplier<InputStream> supplier = new InputSupplier<InputStream>() {
    @Override public InputStream getInput() {
        return stream;
    }
};

Ще один варіант - читати байти з Stream та створювати з них String:

new String(ByteStreams.toByteArray(inputStream))
new String(ByteStreams.toByteArray(inputStream), Charsets.UTF_8)

Це не "чиста" Гуава, але трохи коротша.

Виходячи з прийнятої відповіді, тут є корисний метод, який висміює поведінку IOUtils.toString()(і перевантаженої версії, також із схемою). Ця версія повинна бути безпечною, правда?

public static String toString(final InputStream is) throws IOException{
    return toString(is, Charsets.UTF_8);
}


public static String toString(final InputStream is, final Charset cs)
throws IOException{
    Closeable closeMe = is;
    try{
        final InputStreamReader isr = new InputStreamReader(is, cs);
        closeMe = isr;
        return CharStreams.toString(isr);
    } finally{
        Closeables.closeQuietly(closeMe);
    }
}

Існує набагато коротше рішення для автоматичного закриття у випадку, коли вхідний потік надходить з ресурсу classpath:

URL resource = classLoader.getResource(path);
byte[] bytes = Resources.toByteArray(resource);
String text = Resources.toString(resource, StandardCharsets.UTF_8);

Використовує ресурси Guava , натхненні IOExplained .

EDIT (2015): Окіо - найкраща абстракція та інструменти для вводу-виводу в Java / Android, про які я знаю. Я ним користуюся постійно.

FWIW ось що я використовую.

Якщо у мене вже є потік у руці, то:

final InputStream stream; // this is received from somewhere
String s = CharStreams.toString(CharStreams.newReaderSupplier(new InputSupplier<InputStream>() {
    public InputStream getInput() throws IOException {
        return stream;
    }
}, Charsets.UTF_8));

Якщо я створюю потік:

String s = CharStreams.toString(CharStreams.newReaderSupplier(new InputSupplier<InputStream>() {
    public InputStream getInput() throws IOException {
        return <expression creating the stream>;
    }
}, Charsets.UTF_8));

Як конкретний приклад, я можу прочитати такий елемент текстового файлу Android:

final Context context = ...;
String s = CharStreams.toString(CharStreams.newReaderSupplier(new InputSupplier<InputStream>() {
    public InputStream getInput() throws IOException {
        return context.getAssets().open("my_asset.txt");
    }
}, Charsets.UTF_8));

Для конкретного прикладу, ось як я можу прочитати ресурс текстового файлу Android:

public static String getAssetContent(Context context, String file) {
    InputStreamReader reader = null;
    InputStream stream = null;
    String output = "";

    try {
        stream = context.getAssets().open(file);
        reader = new InputStreamReader(stream, Charsets.UTF_8);
        output = CharStreams.toString(reader);
    } catch (IOException e) {
        e.printStackTrace();
    } finally {
        if (stream != null) {
            try {
                stream.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        if (reader != null) {
            try {
                reader.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

    return output;
}