IndexWriterConfig这个类的作用

分析了IndexReader家族的两个重要模块分别是它的两个重要的子类,一种是基于原子的Reader可以直接获取索引存储的具体信息,另外一种复合Reader,用于宏观层面上接入索引的重要辅助类,两者相辅相成,缺一不可。

那么本篇,简要分析下IndexWriterConfig这个类的作用,IndexWriterConfig这个类并不是一个顶级基类,在它的上面还有一个父类LiveIndexWriterConfig,我们先来分析下这个父类的一些作用,LiveIndexWriterConfig这个类是4.0以后新扩展的父类,在4.0之前并没有这个类,那么引入这个类的作用是什么呢?

这个先不着急,我们先来看下LiveIndexWriterConfig里面的部分源码:




Java代码 复制代码 收藏代码
1.private final Analyzer analyzer; 
2.   
3.  private volatile int maxBufferedDocs; 
4.  private volatile double ramBufferSizeMB; 
5.  private volatile int maxBufferedDeleteTerms; 
6.  private volatile int readerTermsIndexDivisor; 
7.  private volatile IndexReaderWarmer mergedSegmentWarmer; 
8.  private volatile int termIndexInterval; // TODO: this should be private to the codec, not settable here 
9. 
10.  // modified by IndexWriterConfig 
11.  /** {@link IndexDeletionPolicy} controlling when commit
12.   *  points are deleted. */ 
13.  protected volatile IndexDeletionPolicy delPolicy; 
14. 
15.  /** {@link IndexCommit} that {@link IndexWriter} is
16.   *  opened on. */ 
17.  protected volatile IndexCommit commit; 
18. 
19.  /** {@link OpenMode} that {@link IndexWriter} is opened
20.   *  with. */ 
21.  protected volatile OpenMode openMode; 
22. 
23.  /** {@link Similarity} to use when encoding norms. */ 
24.  protected volatile Similarity similarity; 
25. 
26.  /** {@link MergeScheduler} to use for running merges. */ 
27.  protected volatile MergeScheduler mergeScheduler; 
28. 
29.  /** Timeout when trying to obtain the write lock on init. */ 
30.  protected volatile long writeLockTimeout; 
31. 
32.  /** {@link IndexingChain} that determines how documents are
33.   *  indexed. */ 
34.  protected volatile IndexingChain indexingChain; 
35. 
36.  /** {@link Codec} used to write new segments. */ 
37.  protected volatile Codec codec; 
38. 
39.  /** {@link InfoStream} for debugging messages. */ 
40.  protected volatile InfoStream infoStream; 
41. 
42.  /** {@link MergePolicy} for selecting merges. */ 
43.  protected volatile MergePolicy mergePolicy; 
44. 
45.  /** {@code DocumentsWriterPerThreadPool} to control how
46.   *  threads are allocated to {@code DocumentsWriterPerThread}. */ 
47.  protected volatile DocumentsWriterPerThreadPool indexerThreadPool; 
48. 
49.  /** True if readers should be pooled. */ 
50.  protected volatile boolean readerPooling; 
51. 
52.  /** {@link FlushPolicy} to control when segments are
53.   *  flushed. */ 
54.  protected volatile FlushPolicy flushPolicy; 
55. 
56.  /** Sets the hard upper bound on RAM usage for a single
57.   *  segment, after which the segment is forced to flush. */ 
58.  protected volatile int perThreadHardLimitMB; 
59. 
60.  /** {@link Version} that {@link IndexWriter} should emulate. */ 
61.  protected final Version matchVersion; 
62. 
63.  /** True if segment flushes should use compound file format */ 
64.  protected volatile boolean useCompoundFile = IndexWriterConfig.DEFAULT_USE_COMPOUND_FILE_SYSTEM; 


看过之后,我们就会发现这个类里面,除了版本号和分词器是普通的成员变量外,其他的filed都有一个volite关键字修饰,从这个特点上,我们其实就可以看出点猫腻,这个类的主要作用,除了保存一个全局的配置信息外,其实就是抽象了一些IndexWriterConfig一些通用的全局变量,注意这个全局指的是基于JVM主存可见的,意思就是只要这个类的某个属性发生改变,那么这个变化就会立刻反映在主存中,这时候所有这个类的子类也就是IndexWriterConfig就会立刻获取最新的动态信息,从而做出相应的改变。
其中重要的方法有设置最大的文档数,设置最大的缓冲大小,设置删除合并策略,设置是否开启复合索引,以及设置一些自定义的打分策略等等。



那么,接下来我们在分析IndexWriterConfig就容易了,IndexWriterConfig是LiveIndexWriterConfig的子类,里面的大部分filed都是静态的常量,这个类的作用直接继承自它的父类,也是起到一个全局配置的作用,给IndexWriter提供一系列初始化的配置参数。


下面散仙来重点说下,IndexWriterConfig里面的一个静态内部类OpenMode的作用,很多人对这个参数不是太理解,那么散仙今天就来详细介绍下这个类的作用。

其实这个类里面最重要的还是它里面的三个枚举变量CREATE,APPEND,CREATE_OR_APPEND,另外此类还有还有2个方法values(),valueOf(String name)方法,前一个是返回所有的枚举变量,后一个是构造指定名称的OPENMODE,注意必须和三个枚举一样的字符串,才有可能被构造成功。


下面来说明下三个枚举常量的作用:

CREATE模式:这个模式下,每次新建的索引都会先清空上次索引的目录,然后在新建当前的索引,注意可以不用事先创建索引目录,这个模式一般是测试时候用的。


APPEND模式:这个模式下,每次新添加的索引,会被追加到原来的索引里,有一点需要注意的是,如果这个索引路径不存在的话,这个操作,将会导致报出一个异常,所以,使用此模式前,务必确定你有一个已经创建好的索引。

CREATE_OR_APPEND模式:这个模式就是我们默认 的模式,也是比较安全或者比较通用的模式,如果这个索引不存在,那么在此模式下就会新建一个索引目录,如果已存在,那么在添加文档的时候,直接会以Append的方式追加到索引里,所以此模式下,并不会出现一些意外的情况,所以大多数时候,建议使用此方式,进行构建索引。

猜你喜欢

转载自weitao1026.iteye.com/blog/2266834