Java I/O API的补充更易于存取数据:Okio

jopen 10年前

Okio是一个新的Java库,它补充了java.io和java.nio库,让其更易于访问,存储和处理你的数据。

ByteStrings and Buffers

Okio is built around two types that pack a lot of capability into a straightforward API:

  • ByteString is an immutable sequence of bytes. For character data,Stringis fundamental.ByteStringis String's long-lost brother, making it easy to treat binary data as a value. This class is ergonomic: it knows how to encode and decode itself as hex, base64, and UTF-8.

  • Buffer is a mutable sequence of bytes. LikeArrayList, you don't need to size your buffer in advance. You read and write buffers as a queue: write data to the end and read it from the front. There's no obligation to manage positions, limits, or capacities.

Internally,ByteStringandBufferdo some clever things to save CPU and memory. If you encode a UTF-8 string as aByteString, it caches a reference to that string so that if you decode it later, there's no work to do.

Bufferis implemented as a linked list of segments. When you move data from one buffer to another, it reassigns ownership of the segments rather than copying the data across. This approach is particularly helpful for multithreaded programs: a thread that talks to the network can exchange data with a worker thread without any copying or ceremony.

Sources and Sinks

An elegant part of thejava.iodesign is how streams can be layered for transformations like encryption and compression. Okio includes its own stream types called Source and Sink that work likeInputStreamandOutputStream, but with some key differences:

  • Timeouts. The streams provide access to the timeouts of the underlying I/O mechanism. Unlike thejava.iosocket streams, bothread()andwrite()calls honor timeouts.

  • Easy to implement. Sourcedeclares three methods:read(),close(), andtimeout(). There are no hazards likeavailable()or single-byte reads that cause correctness and performance surprises.

  • Easy to use. Although implementations ofSourceandSinkhave only three methods to write, callers are given a rich API with the BufferedSource and BufferedSink interfaces. These interfaces give you everything you need in one place.

  • No artificial distinction between byte streams and char streams. It's all data. Read and write it as bytes, UTF-8 strings, big-endian 32-bit integers, little-endian shorts; whatever you want. No moreInputStreamReader!

  • Easy to test. TheBufferclass implements bothBufferedSourceandBufferedSinkso your test code is simple and clear.

Sources and sinks interoperate withInputStreamandOutputStream. You can view anySourceas anInputStream, and you can view anyInputStreamas aSource. Similarly forSinkandOutputStream.

Dependable

Okio started as a component of OkHttp, the capable HTTP+SPDY client included in Android. It's well-exercised and ready to solve new problems.

Example: a PNG decoder

Decoding the chunks of a PNG file demonstrates Okio in practice.

private static final ByteString PNG_HEADER = ByteString.decodeHex("89504e470d0a1a0a");    public void decodePng(InputStream in) throws IOException {    BufferedSource pngSource = Okio.buffer(Okio.source(in));      ByteString header = pngSource.readByteString(PNG_HEADER.size());    if (!header.equals(PNG_HEADER)) {      throw new IOException("Not a PNG.");    }      while (true) {      Buffer chunk = new Buffer();        // Each chunk is a length, type, data, and CRC offset.      int length = pngSource.readInt();      String type = pngSource.readUtf8(4);      pngSource.readFully(chunk, length);      int crc = pngSource.readInt();        decodeChunk(type, chunk);      if (type.equals("IEND")) break;    }      pngSource.close();  }    private void decodeChunk(String type, Buffer chunk) {    if (type.equals("IHDR")) {      int width = chunk.readInt();      int height = chunk.readInt();      System.out.printf("%08x: %s %d x %d%n", chunk.size(), type, width, height);    } else {      System.out.printf("%08x: %s%n", chunk.size(), type);    }  }

项目主页:http://www.open-open.com/lib/view/home/1427160971793