Lucene（全文检索技术）教程

た入场券 2023-06-04 14:58 5阅读 0赞

# 1.什么是全文检索 #

##   1.1数据分类 ##

> 我们生活中的数据总体分为两种：结构化数据和非结构化数据。
> 
> 1.  结构化数据：指具有固定格式或有限长度的数据，如数据库，元数据等。
> 2.  非结构化数据：指不定长或无固定格式的数据，如邮件，word文档等磁盘上的文件

##  1.2结构化数据搜索 ##

> 常见的结构化数据也就是数据库中的数据。在数据库中搜索很容易实现，通常都是使用sql语句进行查询，而且能很快的得到查询结果。
> 
> 为什么数据库搜索很容易？
> 
> 因为数据库中的数据存储是有规律的，有行有列而且数据格式、数据长度都是固定的。

## 1.3非结构化数据查询方法 ##

1.  **顺序扫描法****(Serial Scanning)**

> 所谓顺序扫描，比如要找内容包含某一个字符串的文件，就是一个文档一个文档的看，对于每一个文档，从头看到尾，如果此文档包含此字符串，则此文档为我们要找的文件，接着看下一个文件，直到扫描完所有的文件。如利用windows的搜索也可以搜索文件内容，只是相当的慢。

**  2.全文检索****(Full-text Search)**

> 将非结构化数据中的一部分信息提取出来，重新组织，使其变得有一定结构，然后对此有一定结构的数据进行搜索，从而达到搜索相对较快的目的。这部分从非结构化数据中提取出的然后重新组织的信息，我们称之**索引**。
> 
> 例如：字典。字典的拼音表和部首检字表就相当于字典的索引，对每一个字的解释是非结构化的，如果字典没有音节表和部首检字表，在茫茫辞海中找一个字只能顺序扫描。然而字的某些信息可以提取出来进行结构化处理，比如读音，就比较结构化，分声母和韵母，分别只有几种可以一一列举，于是将读音拿出来按一定的顺序排列，每一项读音都指向此字的详细解释的页数。我们搜索时按结构化的拼音搜到读音，然后按其指向的页数，便可找到我们的非结构化数据——也即对字的解释。
> 
> **这种先建立索引，再对索引进行搜索的过程就叫全文检索****(Full-text Search)****。**

**虽然创建索引的过程也是非常耗时的，但是索引一旦创建就可以多次使用，全文检索主要处理的是查询，所以耗时间创建索引是值得的。**

##   1.4如何实现全文检索 ##

> 可以使用Lucene实现全文检索。Lucene是apache下的一个开放源代码的全文检索引擎工具包。提供了完整的查询引擎和索引引擎，部分文本分析引擎。Lucene的目的是为软件开发人员提供一个简单易用的工具包，以方便的在目标系统中实现全文检索的功能。

##  1.5全文检索的应用场景 ##

对于数据量大、数据结构不固定的数据可采用全文检索方式搜索，比如百度、Google等搜索引擎、论坛站内搜索、电商网站站内搜索等。

# 2. Lucene实现全文检索的流程 #

##     2.1索引和搜索流程图 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70][]

> 1、绿色表示索引过程，对要搜索的原始内容进行索引构建一个索引库，索引过程包括：
> 
> 确定原始内容即要搜索的内容à采集文档à创建文档à分析文档à索引文档        
> 
> 2、红色表示搜索过程，从索引库中搜索内容，搜索过程包括：
> 
> 用户通过搜索界面à创建查询à执行搜索，从索引库搜索à渲染搜索结果

## 2.2创建索引 ##

> 对文档索引的过程，将用户要搜索的文档内容进行索引，索引存储在索引库（index）中。
> 
> 这里我们要搜索的文档是磁盘上的文本文件，根据案例描述：凡是文件名或文件内容包括关键字的文件都要找出来，这里要对文件名和文件内容创建索引。

###          2.2.1获得原始文档 ###

**原始文档**是是指要索引和搜索的内容。原始内容包括互联网上的网页、数据库中的数据、磁盘上的文件等。

> 从互联网上、数据库、文件系统中等获取需要搜索的原始信息，这个过程就是信息采集，信息采集的目的是为了对原始内容进行索引。在Internet上采集信息的软件通常称为爬虫或蜘蛛，也称为网络机器人，爬虫访问互联网上的每一个网页，将获取到的网页内容存储起来。本案例我们要获取磁盘上文件的内容，可以通过文件流来读取文本文件的内容，对于pdf、doc、xls等文件可通过第三方提供的解析工具读取文件内容，比如Apache POI读取doc和xls的文件内容。

##       2.2.2创建文档对象 ##

获取原始内容的目的是为了索引，在索引前需要将原始内容创建成文档（Document），文档中包括一个一个的域（Field），域中存储内容。

这里我们可以将磁盘上的一个文件当成一个document，Document中包括一些Field（file\_name文件名称、file\_path文件路径、file\_size文件大小、file\_content文件内容），如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 1][]

注意：每个Document可以有多个Field，不同的Document可以有不同的Field，同一个Document可以有相同的Field（域名和域值都相同）

每个文档都有一个唯一的编号，就是文档id。

### 2.2.3分析文档 ###

将原始内容创建为包含域（Field）的文档（document），需要再对域中的内容进行分析，分析的过程是经过对原始文档提取单词、将字母转为小写、去除标点符号、去除停用词等过程生成最终的语汇单元，可以将语汇单元理解为一个一个的单词。

比如下边的文档经过分析如下：

原文档内容：

Lucene is a Java full-text search engine.  Lucene is not a complete

application, but rather a code library and API that can easily be used

to add search capabilities to applications.

分析后得到的语汇单元：

lucene、java、full、search、engine。。。。

每个单词叫做一个Term，不同的域中拆分出来的相同的单词是不同的term。term中包含两部分一部分是文档的域名，另一部分是单词的内容。

例如：文件名中包含apache和文件内容中包含的apache是不同的term。

###    2.2.4创建索引 ###

对所有文档分析得出的语汇单元进行索引，索引的目的是为了搜索，最终要实现只搜索被索引的语汇单元从而找到Document（文档）。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 2][]

注意：创建索引是对语汇单元索引，通过词语找文档，这种索引的结构叫**倒排索引结构**。

传统方法是根据文件找到该文件的内容，在文件内容中匹配搜索关键字，这种方法是顺序扫描方法，数据量大、搜索慢。

**倒排索引结构**是根据内容（词语）找文档，如下图：

![2019100811054953.png][]

**倒排索引结构也叫反向索引结构，包括索引和文档两部分，索引即词汇表，它的规模较小，而文档集合较大。**

# 2.3 查询索引 #

查询索引也是搜索的过程。搜索就是用户输入关键字，从索引（index）中进行搜索的过程。根据关键字搜索索引，根据索引找到对应的文档，从而找到要搜索的内容（这里指磁盘上的文件）。

##   2.3.1用户查询接口 ##

全文检索系统提供用户搜索的界面供用户提交搜索的关键字，搜索完成展示搜索结果。

比如：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 3][]

Lucene不提供制作用户搜索界面的功能，需要根据自己的需求开发搜索界面。

## 2.3.2创建查询 ##

用户输入查询关键字执行搜索之前需要先构建一个查询对象，查询对象中可以指定查询要搜索的Field文档域、查询关键字等，查询对象会生成具体的查询语法，

例如：

语法 “fileName:lucene”表示要搜索Field域的内容为“lucene”的文档

##  2.3.3执行查询 ##

搜索索引过程：

根据查询语法在倒排索引词典表中分别找出对应搜索词的索引，从而找到索引所链接的文档链表。

比如搜索语法为“fileName:lucene”表示搜索出fileName域中包含Lucene的文档。

搜索过程就是在索引上查找域为fileName，并且关键字为Lucene的term，并根据term找到文档id列表

![20191008110852734.png][]

##  2.3.4 渲染结果 ##

以一个友好的界面将查询结果展示给用户，用户根据搜索结果找自己想要的信息，为了帮助用户很快找到自己的结果，提供了很多展示的效果，比如搜索结果中将关键字高亮显示，百度提供的快照等。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 4][]

# 3.0配置开发环境 #

##    3.1Lucene下载 ##

Lucene是开发全文检索功能的工具包，从官方网站下载lucene-7.4.0，并解压。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 5][]

官方网站：[http://lucene.apache.org/][http_lucene.apache.org]

版本：lucene-7.4.0

Jdk要求：1.8以上

##   3.2使用的jar包 ##

lucene-core-7.4.0.jar

![20191008111323380.png][]

lucene-analyzers-common-7.4.0.jar

![20191008111402133.png][]

# 4.0入门程序 #

实现一个文件的搜索功能，通过关键字搜索文件，凡是文件名或文件内容包括关键字的文件都需要找出来。还可以根据中文词语进行查询，并且需要支持多个条件查询。

本案例中的原始内容就是磁盘上的文件，如下图：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 6][]

> 1.  创建索引
>     
>     1.  实现步骤
> 
> 第一步：创建一个java工程，并导入jar包。
> 
> 第二步：创建一个indexwriter对象。
> 
> 1.  指定索引库的存放位置Directory对象
> 2.  指定一个IndexWriterConfig对象。
> 
> 第二步：创建document对象。
> 
> 第三步：创建field对象，将field添加到document对象中。
> 
> 第四步：使用indexwriter对象将document对象写入索引库，此过程进行索引创建。并将索引和document对象写入索引库。
> 
> 第五步：关闭IndexWriter对象。

## 代码实现 ##

//查询索引库
    @Test
    public void searchIndex() throws Exception {
        //指定索引库存放的路径
        //D:\temp\index
        Directory directory = FSDirectory.open(new File("D:\\temp\\index").toPath());
        //创建indexReader对象
        IndexReader indexReader = DirectoryReader.open(directory);
        //创建indexsearcher对象
        IndexSearcher indexSearcher = new IndexSearcher(indexReader);
        //创建查询
        Query query = new TermQuery(new Term("filename", "apache"));
        //执行查询
        //第一个参数是查询对象，第二个参数是查询结果返回的最大值
        TopDocs topDocs = indexSearcher.search(query, 10);
        //查询结果的总条数
        System.out.println("查询结果的总条数："+ topDocs.totalHits);
        //遍历查询结果
        //topDocs.scoreDocs存储了document对象的id
        for (ScoreDoc scoreDoc : topDocs.scoreDocs) {
            //scoreDoc.doc属性就是document对象的id
            //根据document的id找到document对象
            Document document = 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"));
            System.out.println("-------------------------");
        }
        //关闭indexreader对象
        indexReader.close();
    }

# 6.分析器 #

##       6.1分析器的分词效果 ##

//查看标准分析器的分词效果
    @Test
    public void testTokenStream() throws Exception {
        //创建一个标准分析器对象
        Analyzer analyzer = new StandardAnalyzer();
        //获得tokenStream对象
        //第一个参数：域名，可以随便给一个
        //第二个参数：要分析的文本内容
        TokenStream tokenStream = analyzer.tokenStream("test", "The Spring Framework provides a comprehensive programming and configuration model.");
        //添加一个引用，可以获得每个关键词
        CharTermAttribute charTermAttribute = tokenStream.addAttribute(CharTermAttribute.class);
        //添加一个偏移量的引用，记录了关键词的开始位置以及结束位置
        OffsetAttribute offsetAttribute = 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();
    }

##    6.2中文分析器 ##

##       6.2.1 Lucene自带中文分词器 ##

StandardAnalyzer：

单字分词：就是按照中文一个字一个字地进行分词。如：“我爱中国”，  
                             效果：“我”、“爱”、“中”、“国”。

SmartChineseAnalyzer

对中文支持较好，但扩展性差，扩展词库，禁用词库和同义词库等不好处理

###  6.2.2 IKAnalyzer ###

![20191008112516100.png][]

使用方法：

第一步：把jar包添加到工程中

第二步：把配置文件和扩展词典和停用词词典添加到classpath下

注意：hotword.dic和ext\_stopword.dic文件的格式为UTF-8，注意是无BOM 的UTF-8 编码。

也就是说禁止使用windows记事本编辑扩展词典文件

使用EditPlus.exe保存为无BOM 的UTF-8 编码格式，如下图：

![20191008112636884.png][]

## 6.3 使用自定义分析器 ##

@Test
    public void addDocument() throws Exception {
        //索引库存放路径
        Directory directory = FSDirectory.open(new File("D:\\temp\\index").toPath());
        IndexWriterConfig config = new IndexWriterConfig(new IKAnalyzer());
        //创建一个indexwriter对象
        IndexWriter indexWriter = new IndexWriter(directory, config);
    //...
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70]: /images/20230601/213bee6b0f9741feb4a445110f55efdb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 1]: /images/20230601/a9742aa0300f471eb7aa737396b29767.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 2]: /images/20230601/8d1e632798b942e4b36e4973919c13f4.png
[2019100811054953.png]: /images/20230601/e3359e8b818149c98595a33935a764ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 3]: /images/20230601/474e261508d94b648095f0088f2f6b6f.png
[20191008110852734.png]: /images/20230601/e37a9835f2ad4947988ee2ecc483dcbe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 4]: /images/20230601/98a54ad7e03045ba87e75dea3d23cb8a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 5]: /images/20230601/d737e563caaf4398a253c7542133fe03.png
[http_lucene.apache.org]: http://lucene.apache.org/
[20191008111323380.png]: /images/20230601/2b275802951f4bce8c137e365e99747e.png
[20191008111402133.png]: /images/20230601/8250d76248e14350ab8b5351d214f4e3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2h1emVjb20_size_16_color_FFFFFF_t_70 6]: /images/20230601/5288645af3b64962941357863c431514.png
[20191008112516100.png]: /images/20230601/62c10d180e134130b35ff726c12c18d4.png
[20191008112636884.png]: /images/20230601/db7b3dc3e89f4699ab1f4030111cff92.png