一个单线程的BufferedInputStream
我们知道BufferedInputStream是一个线程安全的缓冲输入流,线程安全牺牲的是性能。有时候我们已经知道我们的程
序是不需要线程安全的,但也只能使用线程安全的BufferedInputStream,因为java api没有提供非线程安全版本的实现。最
近在看solr代码的时候,发现了一个功能相当于集成了BufferedInputStream及DataInputStream,但却是非线程安全的类
FastInputStream。
BufferedInputStream和DataInputStream都是由FilterInputStream继承而来的,并且所有public的读方法都用了
synchronized修饰。FilterInputStream继承了InputStream,并且持有一个类型为InputStream且用volatile修饰的成员变
量,FilterInputStream简单覆盖了InputStream的所有方法,且委托该成员变量来实现读功能。由于该成员变量是volatile
的,因此能做到线程安全。
FastInputStream是非线程安全的,因此没有必要继承FilterInputStream,它直接继承InputStream,并实现了
DataInputStream,是一个高性能、非线程安全的BufferedInputStream和DataInputStream集合体。当然,
FastInputStream也有对应的输出流类FastOutputStream。
附上FastInputStream和FastOutputStream的源代码:
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.common.util;
import java.io.*;
/** Single threaded buffered InputStream
* Internal Solr use only, subject to change.
*/
public class FastInputStream extends InputStream implements DataInput {
private final InputStream in;
private final byte[] buf;
private int pos;
private int end;
public FastInputStream(InputStream in) {
// use default BUFSIZE of BufferedOutputStream so if we wrap that
// it won't cause double buffering.
this(in, new byte[8192], 0, 0);
}
public FastInputStream(InputStream in, byte[] tempBuffer, int start, int end) {
this.in = in;
this.buf = tempBuffer;
this.pos = start;
this.end = end;
}
public static FastInputStream wrap(InputStream in) {
return (in instanceof FastInputStream) ? (FastInputStream)in : new FastInputStream(in);
}
@Override
public int read() throws IOException {
if (pos >= end) {
refill();
if (pos >= end) return -1;
}
return buf[pos++] & 0xff;
}
public int readUnsignedByte() throws IOException {
if (pos >= end) {
refill();
if (pos >= end) throw new EOFException();
}
return buf[pos++] & 0xff;
}
public void refill() throws IOException {
// this will set end to -1 at EOF
end = in.read(buf, 0, buf.length);
pos = 0;
}
@Override
public int available() throws IOException {
return end - pos;
}
@Override
public int read(byte b[], int off, int len) throws IOException {
int r=0; // number of bytes read
// first read from our buffer;
if (end-pos > 0) {
r = Math.min(end-pos, len);
System.arraycopy(buf, pos, b, off, r);
pos += r;
}
if (r == len) return r;
// amount left to read is >= buffer size
if (len-r >= buf.length) {
int ret = in.read(b, off+r, len-r);
if (ret==-1) return r==0 ? -1 : r;
r += ret;
return r;
}
refill();
// first read from our buffer;
if (end-pos > 0) {
int toRead = Math.min(end-pos, len-r);
System.arraycopy(buf, pos, b, off+r, toRead);
pos += toRead;
r += toRead;
return r;
}
return r > 0 ? r : -1;
}
@Override
public void close() throws IOException {
in.close();
}
public void readFully(byte b[]) throws IOException {
readFully(b, 0, b.length);
}
public void readFully(byte b[], int off, int len) throws IOException {
while (len>0) {
int ret = read(b, off, len);
if (ret==-1) {
throw new EOFException();
}
off += ret;
len -= ret;
}
}
public int skipBytes(int n) throws IOException {
if (end-pos >= n) {
pos += n;
return n;
}
if (end-pos<0) return -1;
int r = end-pos;
pos = end;
while (r < n) {
refill();
if (end-pos <= 0) return r;
int toRead = Math.min(end-pos, n-r);
r += toRead;
pos += toRead;
}
return r;
}
public boolean readBoolean() throws IOException {
return readByte()==1;
}
public byte readByte() throws IOException {
if (pos >= end) {
refill();
if (pos >= end) throw new EOFException();
}
return buf[pos++];
}
public short readShort() throws IOException {
return (short)((readUnsignedByte() << 8) | readUnsignedByte());
}
public int readUnsignedShort() throws IOException {
return (readUnsignedByte() << 8) | readUnsignedByte();
}
public char readChar() throws IOException {
return (char)((readUnsignedByte() << 8) | readUnsignedByte());
}
public int readInt() throws IOException {
return ((readUnsignedByte() << 24)
|(readUnsignedByte() << 16)
|(readUnsignedByte() << 8)
| readUnsignedByte());
}
public long readLong() throws IOException {
return (((long)readUnsignedByte()) << 56)
| (((long)readUnsignedByte()) << 48)
| (((long)readUnsignedByte()) << 40)
| (((long)readUnsignedByte()) << 32)
| (((long)readUnsignedByte()) << 24)
| (readUnsignedByte() << 16)
| (readUnsignedByte() << 8)
| (readUnsignedByte());
}
public float readFloat() throws IOException {
return Float.intBitsToFloat(readInt());
}
public double readDouble() throws IOException {
return Double.longBitsToDouble(readLong());
}
public String readLine() throws IOException {
return new DataInputStream(this).readLine();
}
public String readUTF() throws IOException {
return new DataInputStream(this).readUTF();
}
}
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.solr.common.util;
import java.io.*;
/** Single threaded buffered OutputStream
* Internal Solr use only, subject to change.
*/
public class FastOutputStream extends OutputStream implements DataOutput {
private final OutputStream out;
private final byte[] buf;
private long written; // how many bytes written
private int pos;
public FastOutputStream(OutputStream w) {
// use default BUFSIZE of BufferedOutputStream so if we wrap that
// it won't cause double buffering.
this(w, new byte[8192], 0);
}
public FastOutputStream(OutputStream sink, byte[] tempBuffer, int start) {
this.out = sink;
this.buf = tempBuffer;
this.pos = start;
}
public static FastOutputStream wrap(OutputStream sink) {
return (sink instanceof FastOutputStream) ? (FastOutputStream)sink : new FastOutputStream(sink);
}
@Override
public void write(int b) throws IOException {
write((byte)b);
}
public void write(byte b[]) throws IOException {
write(b,0,b.length);
}
public void write(byte b) throws IOException {
if (pos >= buf.length) {
out.write(buf);
written += pos;
pos=0;
}
buf[pos++] = b;
}
@Override
public void write(byte arr[], int off, int len) throws IOException {
int space = buf.length - pos;
if (len < space) {
System.arraycopy(arr, off, buf, pos, len);
pos += len;
} else if (len<buf.length) {
// if the data to write is small enough, buffer it.
System.arraycopy(arr, off, buf, pos, space);
out.write(buf);
written += buf.length;
pos = len-space;
System.arraycopy(arr, off+space, buf, 0, pos);
} else {
if (pos>0) {
out.write(buf,0,pos); // flush
written += pos;
pos=0;
}
// don't buffer, just write to sink
out.write(arr, off, len);
written += len;
}
}
/** reserve at least len bytes at the end of the buffer.
* Invalid if len > buffer.length
* @param len
*/
public void reserve(int len) throws IOException {
if (len > (buf.length - pos))
flushBuffer();
}
// DataOutput methods ///
public void writeBoolean(boolean v) throws IOException {
write(v ? 1:0);
}
public void writeByte(int v) throws IOException {
write((byte)v);
}
public void writeShort(int v) throws IOException {
write((byte)(v >>> 8));
write((byte)v);
}
public void writeChar(int v) throws IOException {
writeShort(v);
}
public void writeInt(int v) throws IOException {
reserve(4);
buf[pos] = (byte)(v>>>24);
buf[pos+1] = (byte)(v>>>16);
buf[pos+2] = (byte)(v>>>8);
buf[pos+3] = (byte)(v);
pos+=4;
}
public void writeLong(long v) throws IOException {
reserve(8);
buf[pos] = (byte)(v>>>56);
buf[pos+1] = (byte)(v>>>48);
buf[pos+2] = (byte)(v>>>40);
buf[pos+3] = (byte)(v>>>32);
buf[pos+4] = (byte)(v>>>24);
buf[pos+5] = (byte)(v>>>16);
buf[pos+6] = (byte)(v>>>8);
buf[pos+7] = (byte)(v);
pos+=8;
}
public void writeFloat(float v) throws IOException {
writeInt(Float.floatToRawIntBits(v));
}
public void writeDouble(double v) throws IOException {
writeLong(Double.doubleToRawLongBits(v));
}
public void writeBytes(String s) throws IOException {
// non-optimized version, but this shouldn't be used anyway
for (int i=0; i<s.length(); i++)
write((byte)s.charAt(i));
}
public void writeChars(String s) throws IOException {
// non-optimized version
for (int i=0; i<s.length(); i++)
writeChar(s.charAt(i));
}
public void writeUTF(String s) throws IOException {
// non-optimized version, but this shouldn't be used anyway
DataOutputStream daos = new DataOutputStream(this);
daos.writeUTF(s);
}
@Override
public void flush() throws IOException {
flushBuffer();
out.flush();
}
@Override
public void close() throws IOException {
flushBuffer();
out.close();
}
/** Only flushes the buffer of the FastOutputStream, not that of the
* underlying stream.
*/
public void flushBuffer() throws IOException {
out.write(buf, 0, pos);
written += pos;
pos=0;
}
public long size() {
return written + pos;
}
}