lucene入门指南.docx
- 文档编号:26145284
- 上传时间:2023-06-17
- 格式:DOCX
- 页数:32
- 大小:596.02KB
lucene入门指南.docx
《lucene入门指南.docx》由会员分享,可在线阅读,更多相关《lucene入门指南.docx(32页珍藏版)》请在冰豆网上搜索。
lucene入门指南
全文搜索技术——Lucene
1.今天内容安排
实现一个文件的搜索功能,通过关键字搜索文件,凡是文件名或文件内容包括关键字的文件都需要找出来。
还可以根据中文词语进程查询,并且支持多种条件查询。
本案例中的原始内容就是磁盘上的文件,如下图:
2.需求分析
数据分类
我们生活中的数据总体分为两种:
结构化数据和非结构化数据。
结构化数据:
指具有固定格式或有限长度的数据,如数据库,元数据等。
非结构化数据:
指不定长或无固定格式的数据,如邮件,word文档等磁盘上的文件
非结构化数据查询方法
(1)顺序扫描法(SerialScanning)
所谓顺序扫描,比如要找内容包含某一个字符串的文件,就是一个文档一个文档的看,对于每一个文档,从头看到尾,如果此文档包含此字符串,则此文档为我们要找的文件,接着看下一个文件,直到扫描完所有的文件。
如利用windows的搜索也可以搜索文件内容,只是相当的慢。
(2)全文检索(Full-textSearch)
将非结构化数据中的一部分信息提取出来,重新组织,使其变得有一定结构,然后对此有一定结构的数据进行搜索,从而达到搜索相对较快的目的。
这部分从非结构化数据中提取出的然后重新组织的信息,我们称之索引。
例如:
字典。
字典的拼音表和部首检字表就相当于字典的索引,对每一个字的解释是非结构化的,如果字典没有音节表和部首检字表,在茫茫辞海中找一个字只能顺序扫描。
然而字的某些信息可以提取出来进行结构化处理,比如读音,就比较结构化,分声母和韵母,分别只有几种可以一一列举,于是将读音拿出来按一定的顺序排列,每一项读音都指向此字的详细解释的页数。
我们搜索时按结构化的拼音搜到读音,然后按其指向的页数,便可找到我们的非结构化数据——也即对字的解释。
这种先建立索引,再对索引进行搜索的过程就叫全文检索(Full-textSearch)。
如何实现全文检索
可以使用Lucene实现全文检索。
Lucene是apache下的一个开放源代码的全文检索引擎工具包。
提供了完整的查询引擎和索引引擎,部分文本分析引擎。
Lucene的目的是为软件开发人员提供一个简单易用的工具包,以方便的在目标系统中实现全文检索的功能。
全文检索的应用场景
对于数据量大、数据结构不固定的数据可采用全文检索方式搜索,比如XX、Google等搜索引擎、论坛站内搜索、电商网站站内搜索等。
3.Lucene实现全文检索的流程
索引和搜索流程图
1、绿色表示索引过程,对要搜索的原始内容进行索引构建一个索引库,索引过程包括:
确定原始内容即要搜索的内容采集文档创建文档分析文档索引文档
2、红色表示搜索过程,从索引库中搜索内容,搜索过程包括:
用户通过搜索界面创建查询执行搜索,从索引库搜索渲染搜索结果
创建索引
对文档索引的过程,将用户要搜索的文档内容进行索引,索引存储在索引库(index)中。
这里我们要搜索的文档是磁盘上的文本文件,根据案例描述:
凡是文件名或文件内容包括关键字的文件都要找出来,这里要对文件名和文件内容创建索引。
获得原始文档
原始文档是指要索引和搜索的内容。
原始内容包括互联网上的网页、数据库中的数据、磁盘上的文件等。
本案例中的原始内容就是磁盘上的文件,如下图:
从互联网上、数据库、文件系统中等获取需要搜索的原始信息,这个过程就是信息采集,信息采集的目的是为了对原始内容进行索引。
在Internet上采集信息的软件通常称为爬虫或蜘蛛,也称为网络机器人,爬虫访问互联网上的每一个网页,将获取到的网页内容存储起来。
Lucene不提供信息采集的类库,需要自己编写一个爬虫程序实现信息采集,也可以通过一些开源软件实现信息采集,如下:
Nutch(http:
//lucene.apache.org/nutch),Nutch是apache的一个子项目,包括大规模爬虫工具,能够抓取和分辨web网站数据。
jsoup(http:
//jsoup.org/),jsoup是一款Java的HTML解析器,可直接解析某个URL地址、HTML文本内容。
它提供了一套非常省力的API,可通过DOM,CSS以及类似于jQuery的操作方法来取出和操作数据。
heritrix(是一个由java开发的、开源的网络爬虫,用户可以使用它来从网上抓取想要的资源。
其最出色之处在于它良好的可扩展性,方便用户实现自己的抓取逻辑。
本案例我们要获取磁盘上文件的内容,可以通过文件流来读取文本文件的内容,对于pdf、doc、xls等文件可通过第三方提供的解析工具读取文件内容,比如ApachePOI读取doc和xls的文件内容。
创建文档对象
获取原始内容的目的是为了索引,在索引前需要将原始内容创建成文档(Document),文档中包括一个一个的域(Field),域中存储内容。
这里我们可以将磁盘上的一个文件当成一个document,Document中包括一些Field(file_name文件名称、file_path文件路径、file_size文件大小、file_content文件内容),如下图:
注意:
每个Document可以有多个Field,不同的Document可以有不同的Field,同一个Document可以有相同的Field(域名和域值都相同)
每个文档都有一个唯一的编号,就是文档id。
分析文档
将原始内容创建为包含域(Field)的文档(document),需要再对域中的内容进行分析,分析的过程是经过对原始文档提取单词、将字母转为小写、去除标点符号、去除停用词等过程生成最终的语汇单元,可以将语汇单元理解为一个一个的单词。
比如下边的文档经过分析如下:
原文档内容:
LuceneisaJavafull-textsearchengine.Luceneisnotacomplete
application,butratheracodelibraryandAPIthatcaneasilybeused
toaddsearchcapabilitiestoapplications.
分析后得到的语汇单元:
lucene、java、full、search、engine。
。
。
。
每个单词叫做一个Term,不同的域中拆分出来的相同的单词是不同的term。
term中包含两部分一部分是文档的域名,另一部分是单词的内容。
例如:
文件名中包含apache和文件内容中包含的apache是不同的term。
创建索引
对所有文档分析得出的语汇单元进行索引,索引的目的是为了搜索,最终要实现只搜索被索引的语汇单元从而找到Document(文档)。
注意:
创建索引是对语汇单元索引,通过词语找文档,这种索引的结构叫倒排索引结构。
传统方法是根据文件找到该文件的内容,在文件内容中匹配搜索关键字,这种方法是顺序扫描方法,数据量大、搜索慢。
倒排索引结构是根据内容(词语)找文档,如下图:
倒排索引结构也叫反向索引结构,包括索引和文档两部分,索引即词汇表,它的规模较小,而文档集合较大。
查询索引
查询索引也是搜索的过程。
搜索就是用户输入关键字,从索引(index)中进行搜索的过程。
根据关键字搜索索引,根据索引找到对应的文档,从而找到要搜索的内容(这里指磁盘上的文件)。
用户查询接口
全文检索系统提供用户搜索的界面供用户提交搜索的关键字,搜索完成展示搜索结果。
比如:
Lucene不提供制作用户搜索界面的功能,需要根据自己的需求开发搜索界面。
创建查询
用户输入查询关键字执行搜索之前需要先构建一个查询对象,查询对象中可以指定查询要搜索的Field文档域、查询关键字等,查询对象会生成具体的查询语法,比如:
语法“fileName:
spring.txt”表示要搜索Field域的内容为“spring.txt”的文档
语法“luceneANDjava”表示要搜索即包括关键字“lucene”也包括“java”的文档。
执行查询
搜索索引过程:
1.根据查询语法在倒排索引词典表中分别找出对应搜索词的索引,从而找到索引所链接的文档链表。
比如搜索语法为“luceneANDjava”表示搜索出的文档中即要包括lucene也要包括java。
2、由于是AND,所以要对包含lucene或java词语的链表进行交集,得到文档链表应该包括每一个搜索词语
3、获取文档中的Field域数据。
渲染结果
以一个友好的界面将查询结果展示给用户,用户根据搜索结果找自己想要的信息,为了帮助用户很快找到自己的结果,提供了很多展示的效果,比如搜索结果中将关键字高亮显示,XX提供的快照等。
4.配置开发环境
Lucene下载
Lucene是开发全文检索功能的工具包,从官方网站下载Lucene4.10.3,并解压。
官方网站:
http:
//lucene.apache.org/
版本:
lucene4.10.3
Jdk要求:
1.7以上
IDE:
Eclipse
使用的jar包
Lucene包:
lucene-core-4.10.3.jar
lucene-analyzers-common-4.10.3.jar
lucene-queryparser-4.10.3.jar
其它:
commons-io-2.4.jar
junit-4.9.jar
5.功能一:
创建索引库
使用indexwriter对象创建索引
实现步骤
第一步:
创建一个java工程,并导入jar包。
第二步:
创建一个indexwriter对象。
1)指定索引库的存放位置Directory对象
2)指定一个分析器,对文档内容进行分析。
第二步:
创建document对象。
第三步:
创建field对象,将field添加到document对象中。
第四步:
使用indexwriter对象将document对象写入索引库,此过程进行索引创建。
并将索引和document对象写入索引库。
第五步:
关闭IndexWriter对象。
Field域的属性
是否分析:
是否对域的内容进行分词处理。
前提是我们要对域的内容进行查询。
是否索引:
将Field分析后的词或整个Field值进行索引,只有索引方可搜索到。
比如:
商品名称、商品简介分析后进行索引,订单号、身份证号不用分析但也要索引,这些将来都要作为查询条件。
是否存储:
将Field值存储在文档中,存储在文档中的Field才可以从Document中获取
比如:
商品名称、订单号,凡是将来要从Document中获取的Field都要存储。
是否存储的标准:
是否要将内容展示给用户
Field类
数据类型
Analyzed
是否分析
Indexed
是否索引
Stored
是否存储
说明
StringField(FieldName,FieldValue,Store.YES))
字符串
N
Y
Y或N
这个Field用来构建一个字符串Field,但是不会进行分析,会将整个串存储在索引中,比如(订单号,姓名等)
是否存储在文档中用Store.YES或Store.NO决定
LongField(FieldName,FieldValue,Store.YES)
Long型
Y
Y
Y或N
这个Field用来构建一个Long数字型Field,进行分析和索引,比如(价格)
是否存储在文档中用Store.YES或Store.NO决定
StoredField(FieldName,FieldValue)
重载方法,支持多种类型
N
N
Y
这个Field用来构建不同类型Field
不分析,不索引,但要Field存储在文档中(如图片,因为要存放图片地址)
TextField(FieldName,FieldValue,Store.NO)
或
TextField(FieldName,reader)
字符串
或
流
Y
Y
Y或N
如果是一个Reader,lucene猜测内容比较多,会采用Unstored的策略.
代码实现
//创建索引
@Test
publicvoidcreateIndex()throwsException{
//指定索引库存放的路径
//D:
\temp\0108\index
Directorydirectory=FSDirectory.open(newFile("D:
\\temp\\0108\\index"));
//索引库还可以存放到内存中
//Directorydirectory=newRAMDirectory();
//创建一个标准分析器
Analyzeranalyzer=newStandardAnalyzer();
//创建indexwriterCofig对象
//第一个参数:
Lucene的版本信息,可以选择对应的lucene版本也可以使用LATEST
//第二根参数:
分析器对象
IndexWriterConfigconfig=newIndexWriterConfig(Version.LATEST,analyzer);
//创建indexwriter对象
IndexWriterindexWriter=newIndexWriter(directory,config);
//原始文档的路径D:
\传智播客\01.课程\04.lucene\01.参考资料\searchsource
Filedir=newFile("D:
\\传智播客\\01.课程\\04.lucene\\01.参考资料\\searchsource");
for(Filef:
dir.listFiles()){
//文件名
StringfileName=f.getName();
//文件内容
StringfileContent=FileUtils.readFileToString(f);
//文件路径
StringfilePath=f.getPath();
//文件的大小
longfileSize=FileUtils.sizeOf(f);
//创建文件名域
//第一个参数:
域的名称
//第二个参数:
域的内容
//第三个参数:
是否存储
FieldfileNameField=newTextField("filename",fileName,Store.YES);
//文件内容域
FieldfileContentField=newTextField("content",fileContent,Store.YES);
//文件路径域(不分析、不索引、只存储)
FieldfilePathField=newStoredField("path",filePath);
//文件大小域
FieldfileSizeField=newLongField("size",fileSize,Store.YES);
//创建document对象
Documentdocument=newDocument();
document.add(fileNameField);
document.add(fileContentField);
document.add(filePathField);
document.add(fileSizeField);
//创建索引,并写入索引库
indexWriter.addDocument(document);
}
//关闭indexwriter
indexWriter.close();
}
使用Luke工具查看索引文件
6.功能二:
查询索引
实现步骤
第一步:
创建一个Directory对象,也就是索引库存放的位置。
第二步:
创建一个indexReader对象,需要指定Directory对象。
第三步:
创建一个indexsearcher对象,需要指定IndexReader对象
第四步:
创建一个TermQuery对象,指定查询的域和查询的关键词。
第五步:
执行查询。
第六步:
返回查询结果。
遍历查询结果并输出。
第七步:
关闭IndexReader对象
IndexSearcher搜索方法
方法
说明
indexSearcher.search(query,n)
根据Query搜索,返回评分最高的n条记录
indexSearcher.search(query,filter,n)
根据Query搜索,添加过滤策略,返回评分最高的n条记录
indexSearcher.search(query,n,sort)
根据Query搜索,添加排序策略,返回评分最高的n条记录
indexSearcher.search(booleanQuery,filter,n,sort)
根据Query搜索,添加过滤策略,添加排序策略,返回评分最高的n条记录
代码实现
//查询索引库
@Test
publicvoidsearchIndex()throwsException{
//指定索引库存放的路径
//D:
\temp\0108\index
Directorydirectory=FSDirectory.open(newFile("D:
\\temp\\0108\\index"));
//创建indexReader对象
IndexReaderindexReader=DirectoryReader.open(directory);
//创建indexsearcher对象
IndexSearcherindexSearcher=newIndexSearcher(indexReader);
//创建查询
Queryquery=newTermQuery(newTerm("filename","apache"));
//执行查询
//第一个参数是查询对象,第二个参数是查询结果返回的最大值
TopDocstopDocs=indexSearcher.search(query,10);
//查询结果的总条数
System.out.println("查询结果的总条数:
"+topDocs.totalHits);
//遍历查询结果
//topDocs.scoreDocs存储了document对象的id
for(ScoreDocscoreDoc:
topDocs.scoreDocs){
//scoreDoc.doc属性就是document对象的id
//根据document的id找到document对象
Documentdocument=indexSearcher.doc(scoreDoc.doc);
System.out.println(document.get("filename"));
//System.out.println(document.get("content"));
System.out.println(document.get("path"));
System.out.println(document.get("size"));
}
//关闭indexreader对象
indexReader.close();
}
TopDocs
Lucene搜索结果可通过TopDocs遍历,TopDocs类提供了少量的属性,如下:
方法或属性
说明
totalHits
匹配搜索条件的总记录数
scoreDocs
顶部匹配记录
注意:
Search方法需要指定匹配记录数量n:
indexSearcher.search(query,n)
TopDocs.totalHits:
是匹配索引库中所有记录的数量
TopDocs.scoreDocs:
匹配相关度高的前边记录数组,scoreDocs的长度小于等于search方法指定的参数n
7.功能三:
支持中文分词
分析器(Analyzer)的执行过程
如下图是语汇单元的生成过程:
从一个Reader字符流开始,创建一个基于Reader的Tokenizer分词器,经过三个TokenFilter生成语汇单元Token。
要看分析器的分析效果,只需要看Tokenstream中的内容就可以了。
每个分析器都有一个方法tokenStream,返回一个tokenStream对象。
分析器的分词效果
//查看标准分析器的分词效果
publicvoidtestTokenStream()throwsException{
//创建一个标准分析器对象
Analyzeranalyzer=newStandardAnalyzer();
//获得tokenStream对象
//第一个参数:
域名,可以随便给一个
//第二个参数:
要分析的文本内容
TokenStreamtokenStream=analyzer.tokenStream("test","TheSpringFrameworkprovidesacomprehensiveprogrammingandconfigurationmodel.");
//添加一个引用,可以获得每个关键词
CharTermAttributecharTermAttribute=tokenStream.addAttribute(CharTermAttribute.class);
//添加一个偏移量的引用,记录了关键词的开始位置以及结束位置
OffsetAttributeoffsetAttribute=tokenStream.addAttribute(OffsetAttribute.class);
//将指针调整到列表的头部
tokenStream.reset();
//遍历关键词列表,通过incrementToken方法判断列表是否结束
while(tokenStream.incrementToken()){
//关键词的起始位置
System.out.println("start->"+offsetAttribute.startOffset());
//取关键词
System.out.println(charTermAttribute);
//结束位置
System.out.println("end->"+offsetAttribute.endOffset());
}
tokenStream.close();
}
中文分析器
Lucene自带中文分词器
●StandardAnalyzer:
单字分词:
就是按照中文一个字一个字地进行分词。
如:
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- lucene 入门 指南