Lucene-2.2.0 源代码阅读学习(12)

接着昨天学习的 Lucene-2.2.0 源代码阅读学习(11) 继续学习。

IndexWriter的一个构造器，定义如下所示：

public IndexWriter(String path, Analyzer a, boolean create)
       throws CorruptIndexException, LockObtainFailedException, IOException {
    init(FSDirectory.getDirectory(path), a, create, true, null, true);
}

已经知道，init方法的复杂性和重要性。对init方法所涉及到的有用的相关类进行系统地学习。

init方法的声明是这样的：

private void init(Directory d, Analyzer a, final boolean create, boolean closeDir, IndexDeletionPolicy deletionPolicy, boolean autoCommit)

首先看一下Directory这个类的继承关系，如图所示：

Directory是一个抽象类，它是与目录有关的一个类，主要定义了一些与目录相关的属性和行为，源代码如下所示：

package org.apache.lucene.store;

import java.io.IOException;

public abstract class Directory {

// 有目录相关的一个锁工厂，主要是为向目录中写入文件服务，使用工厂模式，写入文件内容必须获取锁
protected LockFactory lockFactory;

//   获取该目录下的所有文件名称字符串的一个数组
public abstract String[] list()
       throws IOException;

// 判断指定文件名称为name的文件是否存在
public abstract boolean fileExists(String name)
       throws IOException;

// 获取指定文件名称为name的文件最后修改的时间
public abstract long fileModified(String name)
       throws IOException;

//   设置指定文件名称为name的文件的修改时间为当前时间
public abstract void touchFile(String name)
       throws IOException;

// 删除已经存在于该目录下的指定文件名称为namde的文件
public abstract void deleteFile(String name)
       throws IOException;

// 重新命名文件，将原文件名from修改为to
public abstract void renameFile(String from, String to)
       throws IOException;

// 获取 指定文件名称为name的文件的长度
public abstract long fileLength(String name)
       throws IOException;

// 在该目录下创建一个名称为name的文件，同时返回一个索引输出流，以便向其中写入内容
public abstract IndexOutput createOutput(String name) throws IOException;

// 读取该目录下名称为name的文件，返回一个输入流，以便对该文件进行相关操作
public abstract IndexInput openInput(String name)
    throws IOException;

/** 读取该目录下名称为name的文件，指定了读入缓冲区的大小为bufferSize，返回一个输入流
* Currently the only Directory implementations that respect this
* parameter are {@link FSDirectory} and {@link
* org.apache.lucene.index.CompoundFileReader}.
*/
public IndexInput openInput(String name, int bufferSize) throws IOException {
    return openInput(name);
}

// 获取一个锁对象，其中name指定的锁文件的名称，即write.lock文件
public Lock makeLock(String name) {
      return lockFactory.makeLock(name);
}
// 当指定名称为name的锁文件不再被使用的时候，从锁工厂LockFactory中清除该锁；注意：是从内存中清除，并非从文件系统中删除。
public void clearLock(String name) throws IOException {
    if (lockFactory != null) {
      lockFactory.clearLock(name);
    }
}

// 关闭该目录，不再对该目录操作了
public abstract void close()
       throws IOException;

// 当该目录被管理，要对其进行操作之前，必须先创建一个锁工厂LockFactory实例，只有拥有了锁工厂才可以获取锁实例
public void setLockFactory(LockFactory lockFactory) {
      this.lockFactory = lockFactory;
      lockFactory.setLockPrefix(this.getLockID());
}

// 获取锁工厂实例
public LockFactory getLockFactory() {
      return this.lockFactory;
}

// 过去锁实例的唯一表示ID的字符串描述
public String getLockID() {
      return this.toString();
}

// 拷贝源目录src下的文件，复制到目的目录dest下面，拷贝完成后关闭源目录src
public static void copy(Directory src, Directory dest, boolean closeDirSrc) throws IOException {
      final String[] files = src.list();    // 获取源目录src下的所有文件

      if (files == null)    // 如果源目录src下没有文件，则抛出异常
        throw new IOException("cannot read directory " + src + ": list() returned null");

      // 如果获取到的源目录src目录下的文件列表files不空，就执行复制操作

      byte[] buf = new byte[BufferedIndexOutput.BUFFER_SIZE];
      for (int i = 0; i < files.length; i++) {
        IndexOutput os = null;
        IndexInput is = null;
        try {
          // 在目的目录dest下面创建一个新文件，名称与从源目录src下获得的文件名称相同
          os = dest.createOutput(files[i]);
          // 打开源目录下对应的该文件，返回一个索引输入流
          is = src.openInput(files[i]);
          // 复制到目录目录下
          long len = is.length();
          long readCount = 0;
          while (readCount < len) {
            int toRead = readCount + BufferedIndexOutput.BUFFER_SIZE > len ? (int)(len - readCount) : BufferedIndexOutput.BUFFER_SIZE;
            is.readBytes(buf, 0, toRead);    // 以字节流的方式读取源目录的文件，将toRead个字节读入到缓冲区buf中
            os.writeBytes(buf, toRead);    // 以字节流的方式写入目的目录的文件中，将缓冲区buf中toRead个字节写入到目的目录对应的文件中
            readCount += toRead;
          }
        } finally {
          // 最后要关闭输入流
          try {
            if (os != null)
              os.close();
          } finally {
            if (is != null)
              is.close();    // 关闭输入流
          }
        }
      }
      if(closeDirSrc)
        src.close();    // 关闭源目录
}
}

从Directory抽象类的定义，我们可以得到如下几点：

1、管理锁工厂及其锁实例；

2、管理Directory目录实例的基本属性，主要是通过文件名称进行管理；

3、管理与操作该目录相关的一些流对象；

4、管理索引文件的拷贝。

然后就要对Directory抽象类的具体实现类进行学习了。