Lucene系列之全局搜索引擎入门教程

朱雀 2021-09-15 07:00 478阅读 0赞

### Lucene简介 ###

> Lucent：Apache软件基金会Jakarta项目组的一个子项目，Lucene提供了一个简单却强大的应用程式接口，能够做全文索引和搜寻。在Java开发环境里Lucene是一个成熟的免费开源工具。就其本身而言，Lucene是当前以及最近几年最受欢迎的免费Java信息检索程序库。 —— [ \[ 百度百科 \]][_ _]

数据库索引和Lucene检索对比

<table> 
 <thead> 
  <tr> 
   <th align="left">比较项</th> 
   <th align="left">Lucene检索</th> 
   <th align="left">数据库检索</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">数据检索</td> 
   <td align="left">从Lucene的索引文件中检出</td> 
   <td align="left">由数据库索引检索记录</td> 
  </tr> 
  <tr> 
   <td align="left">索引结构</td> 
   <td align="left">Document（文档）</td> 
   <td align="left">Record（记录）</td> 
  </tr> 
  <tr> 
   <td align="left">全文检索</td> 
   <td align="left">支持</td> 
   <td align="left">不支持</td> 
  </tr> 
  <tr> 
   <td align="left">模糊查询</td> 
   <td align="left">支持</td> 
   <td align="left">不支持</td> 
  </tr> 
  <tr> 
   <td align="left">结果排序</td> 
   <td align="left">支持排序</td> 
   <td align="left">不能排序</td> 
  </tr> 
 </tbody> 
</table>

Lucene搜索的API类主要有4个 IndexSearch，Query，QueryParser，Hits

### Lucene搜索过程 ###

Lucene的索引结构是文档(Document)形式的，下面简单介绍一下Lucene搜索的过程  
（1）将文档传给分词组件(Tokenizer)，分词组件根据标点符号和停词将文档分成词元(Token)，并将标点符号和停词去掉。

停词是指没有特别意思的词。英语的是指比如a、the等等单词

文章1内容：Tom favorite fruit is apple.

经过分词处理后，变成\[Tom\]\[facorite\]\[fruit\]\[apple\]

（2）再将词元传给语言处理组件(Linguistic Processor)

英语的单词经过语言处理组件处理后，字母变为小写，词元会变成最基本的词根形式，比如likes变成like

经过分词处理后，变成\[tom\]\[favorite\]\[fruit\]\[apple\]

（3） 然后得到的词元传给索引组件(Indexer)，索引组件处理得到索引结构，得到关键字、出现频率、出现位置分别作为词典文件（Term Dictionary）、频率文件（frequencies）和位置文件（positions）保存起来，然后通过二元搜索算法快速查找关键字

<table> 
 <thead> 
  <tr> 
   <th align="left">关键字</th> 
   <th align="left">文章号[出现频率]</th> 
   <th align="left">出现位置</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">tom</td> 
   <td align="left">1[1]</td> 
   <td align="left">1</td> 
  </tr> 
  <tr> 
   <td align="left">favorite</td> 
   <td align="left">1[2]</td> 
   <td align="left">2</td> 
  </tr> 
  <tr> 
   <td align="left">fruit</td> 
   <td align="left">1[3]</td> 
   <td align="left">3</td> 
  </tr> 
  <tr> 
   <td align="left">[apple</td> 
   <td align="left">1[4]</td> 
   <td align="left">4</td> 
  </tr> 
 </tbody> 
</table>

### Lucene简单实例 ###

创建一个Maven项目，在pom.xml加入Lucene所需的jar

<dependencies>
            <dependency>
                <groupId>org.apache.lucene</groupId>
                <artifactId>lucene-core</artifactId>
                <version>5.3.1</version>
            </dependency>
            <dependency>
                <groupId>org.apache.lucene</groupId>
                <artifactId>lucene-analyzers-common</artifactId>
                <version>5.3.1</version>
            </dependency>
            <dependency>
                <groupId>org.apache.lucene</groupId>
                <artifactId>lucene-queryparser</artifactId>
                <version>5.3.1</version>
            </dependency>
            <dependency>
                <groupId>org.apache.lucene</groupId>
                <artifactId>lucene-analyzers-smartcn</artifactId>
                <version>5.3.1</version>
            </dependency>
            <dependency>
                <groupId>org.apache.lucene</groupId>
                <artifactId>lucene-highlighter</artifactId>
                <version>5.3.1</version>
            </dependency>
        </dependencies>

创建索引的简单实例

package com.demo.lucene;
    
    
    import java.io.IOException;
    import java.nio.file.Paths;
    
    import org.apache.lucene.analysis.Analyzer;
    import org.apache.lucene.analysis.cn.smart.SmartChineseAnalyzer;
    import org.apache.lucene.document.Document;
    import org.apache.lucene.document.Field;
    import org.apache.lucene.document.IntField;
    import org.apache.lucene.document.TextField;
    import org.apache.lucene.index.IndexWriter;
    import org.apache.lucene.index.IndexWriterConfig;
    import org.apache.lucene.store.Directory;
    import org.apache.lucene.store.FSDirectory;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    
    /**
     * <pre>
     * 	Lucene创建索引服务类
     * </pre>
     *
     * @author nicky
     * @version 1.00.00
     *
     *          <pre>
     * 修改记录
     *    修改后版本:     修改人：  修改日期:2018年04月18日     修改内容:
     *          </pre>
     */
    @Component
    public class LuceneIndexer {
    
        private volatile static LuceneIndexer instance;
    
        private final static String INDEX_DIR = "D:\\lucene";
    
        private static class SingletonHolder{
            private final static LuceneIndexer instance=new LuceneIndexer();
        }
    
        public static LuceneIndexer getInstance(){
            return SingletonHolder.instance;
        }
    
        public boolean createIndex(String indexDir) throws IOException{
            //加点测试的静态数据
            Integer ids[] = {1 , 2 , 3};
            String titles[] = {"标题1" , "标题2" , "标题3"};
            String tcontents[] = {
                    "内容1内容啊哈哈哈",
                    "内容2内容啊哈哈哈",
                    "内容3内容啊哈哈哈"
            };
    
            long startTime = System.currentTimeMillis();//记录索引开始时间
    
            Analyzer analyzer = new SmartChineseAnalyzer();
            Directory directory = FSDirectory.open(Paths.get(indexDir));
            IndexWriterConfig config = new IndexWriterConfig(analyzer);
    
            IndexWriter indexWriter = new IndexWriter(directory, config);
    
            for(int i = 0; i < ids.length;i++){
                Document doc = new Document();
                //添加字段
                doc.add(new IntField("id", ids[i],Field.Store.YES)); //添加内容
                doc.add(new TextField("title", titles[i], Field.Store.YES)); //添加文件名，并把这个字段存到索引文件里
                doc.add(new TextField("tcontent", tcontents[i], Field.Store.YES)); //添加文件路径
                indexWriter.addDocument(doc);
            }
    
            indexWriter.commit();
            System.out.println("共索引了"+indexWriter.numDocs()+"个文件");
            indexWriter.close();
            System.out.println("创建索引所用时间："+(System.currentTimeMillis()-startTime)+"毫秒");
    
            return true;
        }
    
        public static void main(String[] args) {
            try {
                boolean r = LuceneIndexer.getInstance().createIndex(INDEX_DIR);
                if(r){
                    System.out.println("索引创建成功!");
                }else{
                    System.out.println("索引创建失败!");
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
    
        }
    
    }

全局搜索索引

package com.demo.lucene;
    
    import org.apache.lucene.analysis.Analyzer;
    import org.apache.lucene.analysis.TokenStream;
    import org.apache.lucene.analysis.cn.smart.SmartChineseAnalyzer;
    import org.apache.lucene.document.Document;
    import org.apache.lucene.index.DirectoryReader;
    import org.apache.lucene.queryparser.classic.ParseException;
    import org.apache.lucene.queryparser.classic.QueryParser;
    import org.apache.lucene.search.IndexSearcher;
    import org.apache.lucene.search.Query;
    import org.apache.lucene.search.ScoreDoc;
    import org.apache.lucene.search.TopDocs;
    import org.apache.lucene.search.highlight.*;
    import org.apache.lucene.store.Directory;
    import org.apache.lucene.store.FSDirectory;
    
    import java.io.IOException;
    import java.io.StringReader;
    import java.nio.file.Paths;
    
    
    /**
     * <pre>
     * 	Lucene全局搜索服务类
     * </pre>
     *
     * @author nicky
     * @version 1.00.00
     *
     *          <pre>
     * 修改记录
     *    修改后版本:     修改人：  修改日期:2018年04月18日     修改内容:
     *          </pre>
     */
    public class SearchBuilder {
    
        public static void doSearch(String indexDir , String queryStr) throws IOException, ParseException, InvalidTokenOffsetsException {
            Directory directory = FSDirectory.open(Paths.get(indexDir));
            DirectoryReader reader = DirectoryReader.open(directory);
            IndexSearcher searcher = new IndexSearcher(reader);
            Analyzer analyzer = new SmartChineseAnalyzer();
            QueryParser parser = new QueryParser("tcontent",analyzer);
            Query query = parser.parse(queryStr);
    
            long startTime = System.currentTimeMillis();
            TopDocs docs = searcher.search(query,10);
    
            System.out.println("查找"+queryStr+"所用时间："+(System.currentTimeMillis()-startTime));
            System.out.println("查询到"+docs.totalHits+"条记录");
    
            
            //遍历查询结果
            for(ScoreDoc scoreDoc : docs.scoreDocs){
                Document doc = searcher.doc(scoreDoc.doc);
                String tcontent = doc.get("tcontent");
                if(tcontent != null){
                    TokenStream tokenStream =  analyzer.tokenStream("tcontent", new StringReader(tcontent));
                    String summary = highlighter.getBestFragment(tokenStream, tcontent);
                    System.out.println(summary);
                }
            }
            reader.close();
        }
    
        public static void main(String[] args){
            String indexDir = "D:\\lucene";
            String q = "内容"; //查询这个字符串
            try {
                doSearch(indexDir, q);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

加入高亮显示：

public class SearchBuilder {
    
        public static void doSearch(String indexDir , String queryStr) throws IOException, ParseException, InvalidTokenOffsetsException {
            Directory directory = FSDirectory.open(Paths.get(indexDir));
            DirectoryReader reader = DirectoryReader.open(directory);
            IndexSearcher searcher = new IndexSearcher(reader);
            Analyzer analyzer = new SmartChineseAnalyzer();
            QueryParser parser = new QueryParser("tcontent",analyzer);
            Query query = parser.parse(queryStr);
    
            long startTime = System.currentTimeMillis();
            TopDocs docs = searcher.search(query,10);
    
            System.out.println("查找"+queryStr+"所用时间："+(System.currentTimeMillis()-startTime));
            System.out.println("查询到"+docs.totalHits+"条记录");
    
            //加入高亮显示的
            SimpleHTMLFormatter simpleHTMLFormatter = new SimpleHTMLFormatter("<b><font color=red>","</font></b>");
            QueryScorer scorer = new QueryScorer(query);//计算查询结果最高的得分
            Fragmenter fragmenter = new SimpleSpanFragmenter(scorer);//根据得分算出一个片段
            Highlighter highlighter = new Highlighter(simpleHTMLFormatter,scorer);
            highlighter.setTextFragmenter(fragmenter);//设置显示高亮的片段
    
            //遍历查询结果
            for(ScoreDoc scoreDoc : docs.scoreDocs){
                Document doc = searcher.doc(scoreDoc.doc);
                String tcontent = doc.get("tcontent");
                if(tcontent != null){
                    TokenStream tokenStream =  analyzer.tokenStream("tcontent", new StringReader(tcontent));
                    String summary = highlighter.getBestFragment(tokenStream, tcontent);
                    System.out.println(summary);
                }
            }
            reader.close();
        }
    
        public static void main(String[] args){
            String indexDir = "D:\\lucene";
            String q = "内容"; //查询这个字符串
            try {
                doSearch(indexDir, q);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }

查找内容1所用时间：404  
  
查询到3条记录  
  
**内容**1**内容**啊哈哈哈  
  
**内容**2**内容**啊哈哈哈  
  
**内容**3**内容**啊哈哈哈

### Lucene重要类解释 ###

> IndexWriter:lucene 中最重要的的类之一，它主要是用来将文档加入索引，同时控制索引过程中的一些参数使用。  
>   
>   
> Analyzer:分析器,主要用于分析搜索引擎遇到的各种文本。常用的有  
> StandardAnalyzer  
> 分析器,StopAnalyzer 分析器,WhitespaceAnalyzer 分析器等。  
>   
>   
> Directory:索引存放的位置;lucene 提供了两种索引存放的位置，一种是磁盘，一种是内存。一般情况将索引放在磁盘上；相应地lucene 提供了FSDirectory 和RAMDirectory 两个类。  
>   
>   
> Document:文档;Document 相当于一个要进行索引的单元，任何可以想要被索引的文件都  
> 必须转化为Document 对象才能进行索引。  
>   
>   
> Field：字段。  
>   
>   
> IndexSearcher:是lucene 中最基本的检索工具，所有的检索都会用到IndexSearcher工具;  
>   
>   
> Query:查询，lucene 中支持模糊查询，语义查询，短语查询，组合查询等等,如有  
> TermQuery,BooleanQuery,RangeQuery,WildcardQuery 等一些类。  
>   
>   
> QueryParser:是一个解析用户输入的工具，可以通过扫描用户输入的字符串，生成Query对象。  
>   
>   
> Hits:在搜索完成之后，需要把搜索结果返回并显示给用户，只有这样才算是完成搜索的目的。在lucene 中，搜索的结果的集合是用Hits 类的实例来表示的。

### 附录 ###

[Lucene个版本下载url][Lucene_url]  
[Lucene易百教程][Lucene]  
[Lucene4.x系列教程][Lucene4.x]  
[Lucene全文搜索教程][Lucene 1]

[_ _]: https://baike.baidu.com/item/Lucene/6753302?fr=aladdin
[Lucene_url]: http://archive.apache.org/dist/lucene/java/
[Lucene]: https://www.yiibai.com/lucene/
[Lucene4.x]: https://www.cnblogs.com/anpajin/p/6371922.html
[Lucene 1]: https://blog.csdn.net/eson_15/article/category/6301481