Tape源码解析

Tape是一个队列集合类库,主要包含内存对象队列,文件对象队列和任务队列,特别是文件对象队列的设计,使用了RandomAccessFile,可以在新增,移除对象时就把数据保存在文件里,使用起来非常方便。

使用方法

Tape的使用方法非常简单,和List差不多,包含方法size(),add(T entry),peek(),remove(),看字面意思就明白,我就不具体展开了,至于TaskQueue的使用,可以看下官方的介绍.

源码分析

QueueFile(队列文件)

内存对象队列和任务队列都比较简单,主要是看到了QueueFile(队列文件)的设计受到了一些启发,在这里和可以和大家聊聊。

数据结构设计
QueueFile数据结构.png

看到上图,我们可以清晰的看到,该数据结构包含头部信息(16 bytes)和元素列表(Length - 16 bytes)。头部信息包含文件长度(4 bytes),元素个数(4 bytes),第一个元素位置(4 bytes),最后一个元素位置(4 bytes)。元素列表里面的单个元素包含元素长度(4 bytes)和元素内容。

源码设计

里面主要用到的是RandomAccessFile(随机存储文件),用seek( )方法来访问记录,只需要记住位置和大小即可。

RandomAccessFile file = new RandomAccessFile("file", "rw");  
// 以下向file文件中写数据
file.writeInt(20);
file.seek(0);// 把文件指针位置设置到文件起始处  
  
// 以下从file文件中读数据,要注意文件指针的位置
file.readInt();

在QueueFile里面对RandomAccessFile使用主要就是用到上面这几个方法,我们接下来看看QueueFile源码。

QueueFile初始化

public QueueFile(File file) throws IOException {
    if (!file.exists()) initialize(file);//如果文件不存在,则初始化
    raf = open(file);//创建RandomAccessFile
    readHeader();//读取头部信息
  }
private static void initialize(File file) throws IOException {
    // Use a temp file so we don't leave a partially-initialized file.
    File tempFile = new File(file.getPath() + ".tmp");//创建文件*.tmp
    RandomAccessFile raf = open(tempFile);//创建RandomAccessFile
    try {
      raf.setLength(INITIAL_LENGTH);//初始化RandomAccessFile文件长度是4096
      raf.seek(0);// 把文件指针位置设置到文件起始处  
      byte[] headerBuffer = new byte[16];//初始化头部信息bytes
      writeInts(headerBuffer, INITIAL_LENGTH, 0, 0, 0);//将文件长度为4096写入headerBuffer
      raf.write(headerBuffer);//将headerBuffer写入RandomAccessFile文件
    } finally {
      raf.close();
    }

    // A rename is atomic.
    if (!tempFile.renameTo(file)) throw new IOException("Rename failed!");//将tempFile重命名成file
  }
private void readHeader() throws IOException {
    raf.seek(0);
    raf.readFully(buffer);
    fileLength = readInt(buffer, 0);
    if (fileLength > raf.length()) {
      throw new IOException("File is truncated. Expected length: " + fileLength + ", Actual length: " + raf.length());
    } else if (fileLength == 0) {
      throw new IOException("File is corrupt; length stored in header is 0.");
    }
    elementCount = readInt(buffer, 4);//读取元素个数
    int firstOffset = readInt(buffer, 8);//读取第一个元素的位置
    int lastOffset = readInt(buffer, 12);//读取最后一个元素的位置
    first = readElement(firstOffset);//读取第一个元素
    last = readElement(lastOffset);//读取最后一个元素
  }

至此,QueueFile初始化完成。

接下来看下add方法。

  public void add(byte[] data) throws IOException {
    add(data, 0, data.length);
  }

  public synchronized void add(byte[] data, int offset, int count) throws IOException {
    nonNull(data, "buffer");
    if ((offset | count) < 0 || count > data.length - offset) {
      throw new IndexOutOfBoundsException();
    }

    expandIfNecessary(count);//判断新增内容之后文件长度是否够,如果不够则进行扩大

    // Insert a new element after the current last element.
    boolean wasEmpty = isEmpty();
    int position = wasEmpty ? HEADER_LENGTH : wrapPosition(last.position + Element.HEADER_LENGTH + last.length);
    Element newLast = new Element(position, count);

    // Write length.
    writeInt(buffer, 0, count);//向buffer写入新元素长度
    ringWrite(newLast.position, buffer, 0, Element.HEADER_LENGTH);//向RandomAccessFile写入新元素长度

    // Write data.
    ringWrite(newLast.position + Element.HEADER_LENGTH, data, offset, count);//向RandomAccessFile写入新元素内容

    // Commit the addition. If wasEmpty, first == last.
    int firstPosition = wasEmpty ? newLast.position : first.position;
    writeHeader(fileLength, elementCount + 1, firstPosition, newLast.position);//写入头部信息
    last = newLast;
    elementCount++;
    if (wasEmpty) first = last; // first element
  }

peek方法,返回第一个元素内容

public synchronized byte[] peek() throws IOException {
    if (isEmpty()) return null;
    int length = first.length;
    byte[] data = new byte[length];
    ringRead(first.position + Element.HEADER_LENGTH, data, 0, length);
    return data;
  }

remove方法

public synchronized void remove() throws IOException {
    if (isEmpty()) throw new NoSuchElementException();
    if (elementCount == 1) {//如果元素个数等于1,则清空全部内容
      clear();
    } else {
      // assert elementCount > 1
      int firstTotalLength = Element.HEADER_LENGTH + first.length;

      ringErase(first.position, firstTotalLength);//清除第一个元素数据

      int newFirstPosition = wrapPosition(first.position + firstTotalLength);
      ringRead(newFirstPosition, buffer, 0, Element.HEADER_LENGTH);
      int length = readInt(buffer, 0);//新元素内容长度
      writeHeader(fileLength, elementCount - 1, newFirstPosition, last.position);//写入更新之后的头部信息
      elementCount--;
      first = new Element(newFirstPosition, length);
    }
  }
private void ringErase(int position, int length) throws IOException {
    while (length > 0) {
      int chunk = min(length, ZEROES.length);
      ringWrite(position, ZEROES, 0, chunk);
      length -= chunk;
      position += chunk;
    }
  }

需要注意的是,在清除第一个元素数据时,只是将第一个元素的数据设置成0。

总结

测试发现,RandomAccessFile在处理大数据的时候读写性能很差,主要原因是RandomAccessFile每读/写一个字节就需对磁盘进行一次I/O操作,所以QueueFile不适合大数据的读写。不过可以对RandomAccessFile进行优化,增加缓冲读写机制,看该文

参考资料

Tape
花1K内存实现高效I/O的RandomAccessFile类

可以随意转发,也欢迎关注我的简书,我会坚持给大家带来分享。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容