IOUtils.toString(InputStream) 的番石榴等价物

Question

Apache Commons IO 有一个很好的便捷方法 IOUtils.toString() 可以将 InputStream 读取到字符串。

由于我试图从 Apache Commons 转移到 Guava：在 Guava 中是否有等价物？我查看了com.google.common.io 包中的所有类，但找不到任何简单的东西。

编辑：我理解并理解字符集的问题。碰巧我知道我所有的来源都是 ASCII（是的，ASCII，不是 ANSI 等），所以在这种情况下，编码对我来说不是问题。

Answer 1

如果您有Readable，则可以使用CharStreams.toString(Readable)。因此，您可能可以执行以下操作：

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

强制你指定一个字符集，我猜你应该这样做。

Answer 2

几乎。你可以使用这样的东西：

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

我个人不认为IOUtils.toString(InputStream) 是“不错的” - 因为它总是使用平台的默认编码，这几乎不是你想要的。有一个采用编码名称的重载，但使用名称不是一个好主意IMO。这就是我喜欢Charsets.*的原因。

编辑：并不是说上面需要InputSupplier<InputStream> 作为streamSupplier。如果你已经有了流，你可以很容易地实现它：

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

Answer 3

您在对 Calum 的回答的评论中声明您将使用

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

此代码有问题，因为重载CharStreams.toString(Readable) 状态：

不关闭Readable。

这意味着您的InputStreamReader 以及supplier.get() 返回的扩展InputStream 在此代码完成后不会关闭。

另一方面，如果您利用了您似乎已经拥有InputSupplier<InputStream> 并使用了重载CharStreams.toString(InputSupplier<R extends Readable & Closeable>），则toString 方法将处理@ 的创建和关闭987654331@给你。

这正是 Jon Skeet 所建议的，除了实际上没有任何将 InputStream 用作输入的 CharStreams.newReaderSupplier 重载...你必须给它一个 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 年 2 月

InputSupplier 和 OutputSupplier 以及使用它们的方法在 Guava 16.0 中已被弃用。他们的替代品是ByteSource、CharSource、ByteSink 和CharSink。给定一个ByteSource，您现在可以像这样以String 的形式获取其内容：

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

Answer 4

根据接受的答案，这是一个模拟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);
    }
}

Answer 5

更新：回想起来，我不喜欢我的旧解决方案。此外，现在是 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);
    }

Answer 6

EDIT (2015)：Okio 是我所知道的 Java/Android 中最好的 I/O 抽象和工具。我一直在使用它。

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

Answer 7

另一种选择是从 Stream 中读取字节并从中创建一个字符串：

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

它不是“纯”番石榴，但它更短一些。

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

Answer 9

如果输入流来自类路径资源，自动关闭解决方案会更短：

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

使用 Guava Resources，灵感来自 IOExplained。