lunce搜索引擎框架教程

1、 java 技术网，欢迎大家访问!学习不息，进步不止全文搜索lucene使用与优化2008-01-23 20:581 lucene 简介1.1什么是luceneLucene是一个全文搜索框架，而不是应用产品。因此它并不像或 者google Desktop那么拿来就能用，它只是提供了一种工具让你能实现这些产 品。1.2 luce ne能做什么要回答这个问题，先要了解lucene的本质。实际上lucene的功能很单一，说 到底，就是你给它若干个字符串，然后它为你提供一个全文搜索服务，告诉你你 要搜索的关键词出现在哪里。知道了这个本质，你就可以发挥想象做任何符合这 个条件的事情了。你可以把站内新闻都

2、索引了，做个资料库；你可以把一个数据 库表的若干个字段索引起来，那就不用再担心因为“like%”而锁表了；你也可以写个自己的搜索引擎,1.3你该不该选择lucene下面给出一些测试数据，如果你觉得可以接受，那么可以选择。测试一：250万记录，300M左右文本，生成索引380M左右，800线程下平均处 理时间300ms测试二：37000记录，索引数据库中的两个 varchar字段，索引文件2.6M, 800 线程下平均处理时间1.5ms。2 lucene 的工作方式lucene提供的服务实际包含两部分：一入一出。所谓入是写入，即将你提供的 源（本质是字符串）写入索引或者将其从索引中删除；所谓出是

3、读出，即向用户 提供全文搜索服务，让用户可以通过关键词定位源。2.1写入流程源字符串首先经过analyzer处理，包括：分词，分成一个个单词；去除stopword （可选）。将源中需要的信息加入 Document的各个Field中，并把需要索引的Field索引 起来，把需要存储的Field存储起来。将索引写入存储器，存储器可以是内存或磁盘。2.2读出流程用户提供搜索关键词，经过 analyzer处理。对处理后的关键词搜索索引找出对应的Docume n。用户根据需要从找到的Document中提取需要的Field。3 一些需要知道的概念lucene用到一些概念，了解它们的含义，有利于下面的讲解。3

4、.1 an alyzerAnalyzer是分析器，它的作用是把一个字符串按某种规则划分成一个个词语， 并去除其中的无效词语，这里说的无效词语是指英文中的“ of”、“the ”，中文中的“的”、“地”等词语，这些词语在文章中大量出现，但是本身不包含 什么关键信息，去掉有利于缩小索引文件、提高效率、提高命中率。分词的规则千变万化，但目的只有一个：按语义划分。这点在英文中比较容易实 现，因为英文本身就是以单词为单位的，已经用空格分开；而中文则必须以某种方法将连成一片的句子划分成一个个词语。具体划分方法下面再详细介绍，这里 只需了解分析器的概念即可。3.2 docume nt用户提供的源是一条条记录

5、，它们可以是文本文件、字符串或者数据库表的一条 记录等等。一条记录经过索引之后，就是以一个 Docume nt的形式存储在索引文 件中的。用户进行搜索，也是以 Docume nt列表的形式返回。3.3 field一个Document可以包含多个信息域，例如一篇文章可以包含“标题”、“正 文”、“最后修改时间”等信息域，这些信息域就是通过 Field在Document中 存储的。Field有两个属性可选：存储和索引。通过存储属性你可以控制是否对这个 Field 进行存储；通过索引属性你可以控制是否对该 Field进行索引。这看起来似乎有 些废话，事实上对这两个属性的正确组合很重要，下面举例说明：

6、还是以刚才的文章为例子，我们需要对标题和正文进行全文搜索，所以我们要把索引属性设置为真，同时我们希望能直接从搜索结果中提取文章标题，所以我们把标题域的存储属性设置为真，但是由于正文域太大了，我们为了缩小索引文件大小，将正文域的存储属性设置为假，当需要时再直接读取文件；我们只是 希望能从搜索解 果中提取最后修改时间，不需要对它进行搜索，所以我们把最 后修改时间域的存储属性设置为真，索引属性设置为假。上面的三个域涵盖了两 个属性的三种组合，还 有一种全为假的没有用到，事实上 Field不允许你那么 设置，因为既不存储又不索引的域是没有意义的。3.4 termterm由两部分组成：它表示term是搜

7、索的最小单位，它表示文档的一个词语, 的词语和这个词语所出现的field 。3.5 tocke ntocken是term的一次出现，它包含trem文本和相应的起止偏移，以及一个类 型字符串。一句话中可以出现多次相同的词语，它们都用同一个term表示，但是用不同的tocken，每个tocken标记该词语出现的地方。3.6 segme nt添加索引时并不是每个docume nt都马上添加到同一个索引文件，它们首先被写 入到不同的小文件，然后再合并成一个大索引文件，这里每个小文件都是一个segme nt。4 lucene的结构lucene包括core和sandbox两部分，其中core是lucene

8、稳定的核心部分， san dbox包含了一些附加功能，例如 highlighter 、各种分析器。Lucene core 有七个包：analysis ，document，index，queryParser， search， store ，util 。4.1 an alysisAnalysis包含一些内建的分析器，例如按空白字符分词的 WhitespaceAnalyzer ， 添加了 stopwrod 过滤的 StopAnalyzer，最常用的 StandardAnalyzer 。4.2 docume ntDocume nt包含文档的数据结构，例如 Docume nt类定义了存储文档的数据结构，

9、 Field类定义了 Document的一个域。4.3 in dexIndex包含了索引的读写类，例如对索引文件的segment进行写、合并、优化的 IndexWriter类和对索引进行读取和删除操作的IndexReader类，这里要注意的 是不要被IndexReader这个名字误导，以为它是索引文件的读取类，实际上删除 索引也是由它完成，IndexWriter只关心如何将索引写入一个个 segment，并将 它们合并优化；IndexReader则关注索引文件中各个文档的组织形式。4.4 queryParserQueryParser包含了解析查询语句的类，lucene的查询语句和sql语句有点

10、类 似，有各种保留字，按照一定的语法可以组成各种查询。Lucene有很多种Query 类，它们都继承自Query，执行各种特殊的查询，QueryParser的作用就是解析 查询语句，按顺序调用各种Query类查找出结果。4.5 searchSearch包含了从索引中搜索结果的各种类，例如刚才说的各种Query类，包括TermQuery BooleanQuery 等就在这个包里。4.6 storeStore包含了索引的存储类，例如 Directory定义了索引文件的存储结构，FSDirectory为存储在文件中的索引，RAMDirectory为存储在内存中的索引， MmapDirectory为使

11、用内存映射的索引。4.7 utilUtil包含一些公共工具类，例如时间和字符串之间的转换工具。5如何建索引5.1最简单的能完成索引的代码片断IndexWrit er writer = new IndexWriter( “/data/index/ ” , new StandardAnalyzer(), true);Docume nt doc = new Docume nt();doc.add( new Field("title", "luce ne in troductio n", Field.Store.YES, Field.I ndex.TOKENIZ

12、ED);doc.add(new Field("content", "lucene works well", Field.Store.YES,Fieldndex.TOKENIZED); writer.addDocume nt(doc); writer.optimize();writer.close();下面我们分析一下这段代码。首先我们创建了一个writer，并指定存放索引的目录为“ /data/index ”，使用 的分析器为StandardAnalyzer，第三个参数说明如果已经有索引文件在索引目 录下，我们将覆盖它们。然后我们新建一个document

13、。我们向document添加一个field ，名字是“ title ”，内容是“ lucene in troduction ”，对它进行存储并索引。再添加一个名字是“ content ”的field ，内容是“ lucene works well ”，也是 存储并索引。然后我们将这个文档添加到索引中， 如果有多个文档，可以重复上面的操作，创 建document并添加。添加完所有document，我们对索引进行优化，优化主要是将多个segment合并到一个，有利于提高索引速度。随后将writer关闭，这点很重要。对，创建索引就这么简单！当然你可能修改上面的代码获得更具个性化的服务。5.2将索引直

14、接写在内存你需要首先创建一个RAMDirectory，并将其传给writer，代码如下：Directory dir = new RAMDirectory();In dexWriter writer = new In dexWriter(dir,n ewSta ndardA nalyzer(),true);Docume nt doc = new Docume nt();doc.add( new Field("title", "luce ne in troductio n", Field.Store.YES,Field.I ndex.TOKENIZED);d

15、oc.add(new Field("content", "lucene works well", Field.Store.YES,Field.I ndex.TOKENIZED);writer.addDocume nt(doc);writer.optimize();writer.close();5.3索引文本文件如果你想把纯文本文件索引起来，而不想自己将它们读入字符串创建field，你可以用下面的代码创建field :Field field = new Field("content", new FileReader(file); 这里的

16、file就是该文本文件。该构造函数实际上是读去文件内容，并对其进行 索引，但不存储。6如何维护索引索引的维护操作都是由IndexReader类提供。6.1如何删除索引lucene提供了两种从索引中删除document的方法，一种是void deleteDocume nt(i nt docNum)这种方法是根据document在索引中的编号来删除，每个document加进索引后都 会有个唯一编号，所以根据编号删除是一种精确删除，但是这个编号是索引的内 部结构，一般我们不会知道某个文件的编号到底是几，所以用处不大。另一种是void deleteDocume nts(Term term)这种方法实际

17、上是首先根据参数term执行一个搜索操作，然后把搜索到的结果 批量删除了。我们可以通过这个方法提供一个严格的查询条件，达到删除指定 docume nt的目的。下面给出一个例子：Directory dir = FSDirectory.getDirectory(PATH, false);In dexReader reader = In dexReader.ope n( dir);Term term = new Term(field, key);reader.deleteDocume nts(term);reader.close();6.2如何更新索引lucene并没有提供专门的索引更新方法，我们需

18、要先将相应的document删除，然后再将新的document加入索引。例如：Directory dir = FSDirectory.getDirectory(PATH, false);In dexReader reader = In dexReader.ope n( dir);Term term = new Term( “title ” ,“lucene introduction”)；reader.deleteDocume nts(term);reader.close();In dexWriter writer = new In dexWriter(dir,n ewSta ndardA na

19、lyzer(),true);Docume nt doc = new Docume nt();doc.add( new Field("title", "luce ne in troductio n", Field.Store.YES, Field.I ndex.TOKENIZED);doc.add(new Field("content", "lucene is funny", Field.Store.YES,Fieldndex.TOKENIZED); writer.addDocume nt(doc); writer.

20、optimize();writer.close();7如何搜索lucene的搜索相当强大，它提供了很多辅助查询类，每个类都继承自Query类, 各自完成一种特殊的查询，你可以像搭积木一样将它们任意组合使用，完成一些复杂操作；另外lucene还提供了 Sort类对结果进行排序，提供了 Filter类对 查询条件进行限制。你或许会不自觉地拿它跟 SQL语句进行比较：“ lucene能执行 and、or、order by、where> like xx% 操作吗？ ”回答是：“当然没问题！”7.1各种各样的Query下面我们看看lucene到底允许我们进行哪些查询操作:7.1.1 TermQue

21、ry“在content域中包含首先介绍最基本的查询，如果你想执行一个这样的查询:'luce ne '的 docume nt”，那么你可以用 TermQueryTerm t = new Term("con te nt", " luce ne" Query query = new TermQuery(t);7.1.2 Boolea nQuery如果你想这么查询：“在 con te nt域中包含java或perl的docume nt”，那么 你可以建立两个TermQuery并把它们用BooleanQuery连接起来：TermQuery term

22、Query1 = new TermQuery( new Term("co nten t", "java"); TermQuery termQuery 2 = new TermQuery( new Term("co nten t", "perl"); Boolea nQuery boolea nQuery = new Boolea nQuery();boolea nQuery.add(termQuery 1, Boolea nClause.Occur.SHOULD); boolea nQuery.add(termQu

23、ery 2, Boolea nClause.Occur.SHOULD);7.1.3 WildcardQuery如果你想对某单词进行通配符查询， 你可以用WildcardQuery，通配符包括?' 匹配一个任意字符和* '匹配零个或多个任意字符，例如你搜索use* '，你 可能找到'useful '或者'useless ':Query query = new WildcardQuery( new Term("co nten t", "use*");7.1.4 PhraseQuery你可能对中日关系比较

24、感兴趣，想查找中和日挨得比较近（5个字的距离内)的文章，超过这个距离的不予考虑，你可以:PhraseQuery query = new PhraseQuery(); query.setSlop(5);query.add(new Term("content ",“中”)；query.add(new Term( “content ” ,“日”);那么它可能搜到“中日合作 高层领导说日本欠扁”。中方和日方，”，但是搜不到“中国某Luce ne搜索引擎框架教程第8页/共13页 java 技术网，欢迎大家访问!学习不息，进步不止Luce ne搜索引擎框架教程第#页/共13页 java

25、 技术网，欢迎大家访问!学习不息，进步不止7.1.5 PrefixQuery如果你想搜以中开头的词语，你可以用PrefixQuery :PrefixQuery query = new PrefixQuery (new Term("c on te nt ","7.1.6 FuzzyQueryFuzzyQuery用来搜索相似的term，使用Levenshtein算法。假设你想搜索跟 wuzza'相似的词语，你可以：Query query = new FuzzyQuery (new Term("co nte nt", "wuzza&

26、quot;);你可能得到'fuzzy '和'wuzzy'o7.1.7 Ran geQuery另一个常用的Query是RangeQuery你也许想搜索时间域从 20060101至U 20060130之间的 document,你可以用 RangeQueryRangeQueryquery = newRangeQuery(newTerm( “time ” ,“20060101” ), newTerm( “time ” , “20060130' ), true);最后的true表示用闭合区间。7.2 QueryParser看了这么多Query，你可能会问：“不会让

27、我自己组合各种Query吧，太麻烦了！ ”当然不会，lucene提供了一种类似于SQL语句的查询语句，我们 姑且叫 它lucene语句，通过它，你可以把各种查询一句话搞定，lucene会自动把它们 查分成小块交给相应Query执行。下面我们对应每种Query演示一下： TermQuery可以用“ field:key ”方式，例如“ content:lucene ”。Boolea nQuery 中'与'用'+'，'或'用''，例如“ con te nt:java conten terl ”。WildcardQuery 仍然用'

28、;？'和'* '，例如“ content:use* ”。PhraseQuery 用''，例如“ content:"中日"5”。PrefixQuery 用'* '，例如“中 * ”。FuzzyQuery 用'，例如“ content: wuzza ”。RangeQuery用'或 '，前者表示闭区间，后者表示开区间，例如“time:20060101 TO 20060130 ”，注意 TO区分大小写。你可以任意组合query string ，完成复杂操作，例如“标题或正文包括lucene， 并且时间在

29、20060101到20060130之间的文章”可以表示为：“ + (title:lucene conten t:luce ne) +time:20060101 TO 20060130”。代码如下：Directory dir = FSDirectory.getDirectory(PATH, false);In dexSearcher is = new In dexSearcher(dir);QueryParser parser = newQueryParser("content",new StandardAnalyzer();Query query = parser.pars

30、e("+(title:lucene content:lucene)+time:20060101 TO 20060130"Hits hits = is.search(query);for (i nt i = 0; i < hits .len gth(); i+)Document doc = hits.doc(i);System.out.pri ntln( doc.get("title");is.close();首先我们创建一个在指定文件目录上的IndexSearcher。然后创建一个使用StandardAnalyzer作为分析器的QueryParse

31、r，它默认搜索 的域是 content。接着我们用QueryParser来parse查询字串，生成一个 Query。然后利用这个Query去查找结果，结果以Hits的形式返回。这个Hits对象包含一个列表，我们挨个把它的内容显示出来。7.3 Filterfilter的作用就是限制只查询索引的某个子集，它的作用有点像SQL语句里的where，但又有区别，它不是正规查询的一部分，只是对数据源进行预处理，然 后交给 查询语句。注意它执行的是预处理，而不是对查询结果进行过滤，所以 使用filter的代价是很大的，它可能会使一次查询耗时提高一百倍。最常用的 filter 是 RangeFilter 和

32、QueryFilter。RangeFilter 是设定只搜索指 定范围内的索引；QueryFilter是在上次查询的结果中搜索。Filter的使用非常简单，你只需创建一个filter 实例，然后把它传给searcher， 继续上面的例子，查询“时间在20060101到20060130之间的文章”除了将限制 写在query string 中，你还可以写在 RangeFilter 中：Directory dir = FSDirectory.getDirectory(PATH, false);In dexSearcher is = new In dexSearcher(dir);QueryParse

33、r parser = newQueryParser("content",new StandardAnalyzer();Query query = parser.parse("title:lucene content:lucene"Ra ngeFilter filter = new Ran geFilter("time", "20060101", "20060230",true, true);Hits hits = is.search(query, filter); for (i nt i = 0

34、; i < hits .len gth(); i+) Document doc = hits.doc(i); System.out.pri ntln( doc.get("title"); is.close();7.4 Sort有时你想要一个排好序的结果集，就像SQL语句的“ order by ”，luce ne能做到：通过Sort。Sort sort = new Sort(“time ” ); / 相当于 SQL的“order by time ”Sort sort = new Sort(“time ” , true); /相当于 SQL的“order by timed

35、esc”下面是一个完整的例子：Directory dir = FSDirectory.getDirectory(PATH, false);In dexSearcher is = new In dexSearcher(dir);QueryParser parser = newQueryParser("content",new StandardAnalyzer();Query query = parser.parse("title:lucene content:lucene"Ra ngeFilter filter = new Ran geFilter(&qu

36、ot;time", "20060101", "20060230",true, true);Sort sort = new Sort( “time ” );Hits hits = is.search(query, filter, sort);for (i nt i = 0; i < hits .len gth(); i+)Document doc = hits.doc(i);System.out.pri ntln( doc.get("title");is.close();8分析器在前面的概念介绍中我们已经知道了分析器的作

37、用，就是把句子按照语义切分 成一个个词语。英文切分已经有了很成熟的分析器：Sta ndardA nalyzer，很多情况下StandardAnalyzer是个不错的选择。甚至你会发现 StandardAnalyzer 也能对中 文进行分词。但是我们的焦点是中文分词，StandardAnalyzer能支持中文分词吗？实践证明 是可以的，但是效果并不好，搜索“如果”会把“牛奶不如果汁好喝”也搜索出来，而且索引文件很大。那么我们手头上还有什么分析器可以使用呢？core里面没有，我们可以在 sandbox里面找到 两个：ChineseAnalyzer和CJKA nalyzer。但是它们同样都有分词不准

38、的问题。相比之下用StandardAnalyzer和ChineseAnalyzer 建立索引时间差不多，索引文件大小也 差不多，CJKAnalyzer表现会差些，索引文件大且耗时比较长。要解决问题，首先分析一下这三个分析器的分词方式。StandardAnalyzer和ChineseAnalyzer都是把句子按单个字切分，也就是说“牛奶不如果汁好喝”会被它们切分成“牛 奶不如果汁好喝”；而CJKAnalyzer则会切分成“牛奶奶不不如如果果汁汁好好喝”。这也就解释了为什么搜索“果汁” 都能匹配这个句子。以上分词的缺点至少有两个：匹配不准确和索引文件大。我们的目标是将上面的 句子分解成“牛奶不如果

39、汁好喝”。这里的关键就是语义识别，我们如何识 别“牛奶”是一个词而“奶不”不是词语？我们很自然会想到基于词库的分词 法，也就是我们先得到一个词库，里面列举了大部分词语，我们把句子按某种方式切分，当得到的词语与词库中的项匹配时，我们就认为这种切分是正确的。 这样切词的过程就转变成匹配的过程，而匹配的方式最简单的有正向最大匹配和逆向最大匹配两种，说白了就是一个从句子开头向后进行匹配，一个从句子末 尾向前进行匹配。基于词库的分词词库非常重要，词库的容量直接影响搜索结果，在相同词库的前提下，据说逆向最大匹配优于正向最大匹配。当然还有别的分词方法，这本身就是一个学科，我这里也没有深入研究。回到具体应用，

40、我们的目标是能找到成熟的、现成的分词工具，避免重新发明车轮。 经过网上搜索，用的比较多的是中科院的ICTCLAS和一个不开放源码但是免费的JE-Analysis。ICTCLAS有个问题是它是一个动态链接库，java调用需要本 地方法调用，不方便也有安全隐患，而且口碑也确实不大好。JE-Analysis效果还不错，当然也会有分词不准的地方，相比比较方便放心。9性能优化一直到这里，我们还是在讨论怎么样使lucene跑起来，完成指定任务。利用前 面说的也确实能完成大部分功能。但是测试表明lucene的性能并不是很好，在 大数据量大并发的条件下甚至会有半分钟返回的情况。另外大数据量的数据初始化建立索引

41、也是一个十分耗时的过程。那么如何提高lucene的性能呢？下面从优化创建索引性能和优化搜索性能两方面介绍。9.1优化创建索引性能这方面 的优化途径比较有限，IndexWriter提供了一些接口可以控制建立索引 的操作，另外我们可以先将索引写入 RAMDirectory，再批量写入FSDirectory ， 不管怎样，目的都是尽量少的文件I0,因为创建索引的最大瓶颈在于磁盘I0。 另外选择一个较好的分析器也能提高一些性能。9.1.1通过设置IndexWriter的参数优化索引建立 setMaxBufferedDocs(i nt maxBufferedDocs)控制写入一个新的segment前内存

42、中保存的document的数目，设置较大的数目 可以加快建索引速度，默认为10。setMaxMergeDocs(i nt maxMergeDocs)控制一个segment中可以保存的最大document数目，值较小有利于追加索引的 速度，默认Integer.MAX_VALUE,无需修改。setMergeFactor(i nt mergeFactor)控制多个segment合并的频率，值较大时建立索引速度较快，默认是10,可以在建立索引时设置为100。9.1.2通过RAMDirectory缓写提高性能我们可以先把索引写入RAMDirectory，达到一定数量时再批量写进FSDirectory，减

43、少磁盘10次数。FSDirectory fsDir = FSDirectory.getDirectory("/data/i ndex", true);RAMDirectory ramDir = new RAMDirectory。；In dexWriter fsWriter = new In dexWriter(fsDir, new Sta ndardA nalyzer(),true);In dexWriter ramWriter = new In dexWriter(ramDir,new Sta ndardA nalyzer(),true);while (there are

44、 docume nts to in dex). create Docume nt .ramWriter.addDocume nt(doc);if (condition for flushing memory to disk has been met)fsWriter.add In dexes( new Directory ramDir );ramWriter.close();ramWriter = new In dexWriter(ramDir, new Sta ndardA nalyzer(), true);9.1.3选择较好的分析器这 个优化主要是对磁盘空间的优化，可以将索引文件减小将近一

45、半，相同测试 数据下由600M减少到380M但是对时间并没有什么帮助，甚至会需要更长时间， 因为较好的分析器需要匹配词库，会消耗更多cpu，测试数据用StandardAnalyzer 耗时 133 分钟；用 MMAnalyzer耗时 150 分钟。9.2优化搜索性能虽然建立索引的操作非常耗时，但是那毕竟只在最初创建时才需要， 平时只是少 量的维护操作，更何况这些可以放到一个后台进程处理， 并不影响用户搜索。我 们创建索引的目的就是给用户搜索， 所以搜索的性能才是我们最关心的。 下面就 来探讨一下如何提高搜索性能。9.2.1将索引放入内存这是一个最直观的想法，因为内存比磁盘快很多。Lucene提

46、供了 RAMDirectory“/data/index/” , false);可以在内存中容纳索引：Directory fsDir = FSDirectory.getDirectory(Directory ramDir = new RAMDirectory(fsDir);Searcher searcher = new In dexSearcher(ramDir);但是实践证明RAMDirectory和FSDirectory速度差不多，当数据量很小时两者 都非常快，当数据量较大时（索引文件400M RAMDirectory甚至比FSDirectory 还要慢一点，这确实让人出乎意料。而且luce

47、ne的搜索非常耗内存，即使将400M的索引文件载入内存，在运行一段 时间后都会out of memory，所以个人认为载入内存的作用并不大。9.2.2优化时间范围限制既然载入内存并不能提高效率，一定有其它瓶颈，经过测试发现最大的瓶颈居然 是时间范围限制，那么我们可以怎样使时间范围限制的代价最小呢？当需要搜索指定时间范围内的结果时，可以：1、用RangeQuery,设置范围，但是RangeQuery的实现实际上是将时间范围内 的时间点展开，组成一个个 BooleanClause加入到BooleanQuery中查询，因此 时间范围不可能设置太大，经测试，范围超过一个月就会抛Boolea nQuery.TooMa nyClauses，可以通过设置Boolea nQuery.setMaxClauseCou nt （int maxClauseCou nt）扩大，但是扩大也是有限的，并且随着maxClauseCount扩大，占用内存也扩大2、 用RangeFilter 代替RangeQuery经测试速度不会比 RangeQuery慢，但是 仍然有性能瓶颈，查