Lucene是一款高性能的、可扩展的信息检索（IR）工具库。信息检索是指文档搜索、文档内信息搜索或者文档相关的元数据搜索等操作。

lucene实现全文检索的流程为：

a) 创建索引

b）查询索引

1、绿色表示索引过程，对要搜索的原始内容进行索引构建一个索引库，索引过程包括：

               确定原始内容即要搜索的内容———采集文档———创建文档———分析文档———索引文档

2、红色表示搜索过程，从索引库中搜索内容，搜索过程包括：

               用户通过搜索界面———创建查询———执行搜索，从索引库搜索———渲染搜索结果

#

创建索引

原始文档

对文档索引的过程，将用户要搜索的文档内容进行索引，索引存储在索引库（index）中。这里我们要搜索的文档是磁盘上的文本文件.

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

从互联网上、数据库、文件系统中等获取需要搜索的原始信息，这个过程就是信息采集，信息采集的目的是为了对原始内容进行索引。

在Internet上采集信息的软件通常称为爬虫或蜘蛛，也称为网络机器人，爬虫访问互联网上的每一个网页，将获取到的网页内容存储起来。

       Lucene不提供信息采集的类库，需要自己编写一个爬虫程序实现信息采集，也可以通过一些开源软件实现信息采集，如下：
       Nutch（[http://lucene.apache.org/nutch][http_lucene.apache.org_nutch]）, Nutch是apache的一个子项目，包括大规模爬虫工具，能够抓取和分辨web网站数据。
       jsoup（http://jsoup.org/ ），jsoup 是一款Java 的HTML解析器，可直接解析某个URL地址、HTML文本内容。它提供了一套非常省力的API，可通过DOM，CSS以及类似于jQuery的操作方法来取出和操作数据。
       heritrix（http://sourceforge.net/projects/archive-crawler/files/），Heritrix 是一个由 java 开发的、开源的网络爬虫，用户可以使用它来从网上抓取想要的资源。其最出色之处在于它良好的可扩展性，方便用户实现自己的抓取逻辑。

创建文档对象

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

这里我们可以将磁盘上的一个文件当成一个document，Document中包括一些Field（fileName文件名称、filePath文件路径、fileSize文件大小、fileContent文件内容）

分析文档

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

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

创建索引

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

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

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

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

70 1

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

70 2

代码实现

@Test
    public void testIndex() throws  Exception{
        //1.创建一个indexWriter对象
            //1)创建一个Directory对象，指定索引库的存放位置
        Directory directory = FSDirectory.open(new File("C:/Users/LSD/Desktop/temp"));
        //Directory directory = new RAMDirectory();//保存索引到内存中(内存索引库，关机就没了)
            //2)指定一个分析器，对文档内容进行分析
        Analyzer analyzer = new StandardAnalyzer();//官方推荐
        IndexWriterConfig config = new IndexWriterConfig(Version.LUCENE_4_10_3, analyzer);
        IndexWriter indexWriter = new IndexWriter(directory, config);
        //2.创建Docutment对象
        //  创建field对象，将field添加到document对象中
        File [] listFiles = new File("C:/Users/LSD/Desktop/新建文件夹").listFiles();
        for (File file : listFiles) {
            Document document = new Document();
            //文件名
            String fileName = file.getName();
            Field fileNameField = new TextField("fileName", fileName, Store.YES);
            //文件大小
            long fileSize = FileUtils.sizeOf(file);  
            Field fileSizeField = new LongField("fileSize", fileSize, Store.YES);
            //文件路径
            String filePath = file.getAbsolutePath();
            Field filePathField = new StoredField("filePath", filePath);
            //文件内容
            String fileContent = FileUtils.readFileToString(file);
            Field fileContentField = new  TextField("fileContent", fileContent,Store.NO);
            document.add(fileNameField);
            document.add(fileSizeField);
            document.add(filePathField);
            document.add(fileContentField);
            //3.使用indexWriter对象将document对象添加到索引库，
            //  此过程进行索引创建，并将索引和document对象写进索引库
            indexWriter.addDocument(document);
        }
        //4.关闭IndexWriter对象
        indexWriter.close();
    }

查询索引

用户查询接口

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

比如：

70 3

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

创建查询

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

例如：

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

执行查询

搜索索引过程：

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

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

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

渲染结果

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

70 4

代码实现

//搜索索引
        @Test
        public void testSearch() throws Exception{
            //1.创建一个Directory对象，即从哪儿(索引库)读
            Directory directory = FSDirectory.open(new File("C:/Users/LSD/Desktop/temp"));
            //2.创建一个indexReader对象，指定Directory
            IndexReader indexReader = DirectoryReader.open(directory);
            //3.创建一个indexSearcher对象，需要指定IndexReader对象
            IndexSearcher indexSearcher = new IndexSearcher(indexReader);
            //4.创建一个TermQuery对象，指定查询的域和查询的关键词
            Query query = new TermQuery(new Term("fileName","post"));
            //5.执行查询,返回查询结果并输出
            TopDocs topDocs = indexSearcher.search(query, 2);
            //6.返回查询结果，遍历并输出
            ScoreDoc [] scoreDocs = topDocs.scoreDocs;
            for (ScoreDoc scoreDoc : scoreDocs) {
                int doc = scoreDoc.doc;
                Document document = indexSearcher.doc(doc);
                //文件名
                String fileName = document.get("fileName");
                //文件内容
                String fileContent = document.get("fileContent");
                //文件大小
                String fileSize = document.get("fileSize");
                //文件路径
                String filePath = document.get("filePath");
                System.out.println("文件名："+ fileName + "\n文件内容：" + fileContent + "\n文件大小：" + fileSize+ "\n文件路径：" + filePath);
            }
             indexReader.close();
        }

TopDocs

Lucene搜索结果可通过TopDocs遍历，TopDocs类提供了少量的属性，如下：

方法或属性	说明
totalHits	匹配搜索条件的总记录数
scoreDocs	顶部匹配记录

注意：

Search方法需要指定匹配记录数量n：indexSearcher.search(query, n)

TopDocs.totalHits：是匹配索引库中所有记录的数量

TopDocs.scoreDocs：匹配相关度高的前边记录数组，scoreDocs的长度小于等于search方法指定的参数n

Analyzer

如下图是语汇单元的生成过程：

70 5

从一个Reader字符流开始，创建一个基于Reader的Tokenizer分词器，经过三个TokenFilter生成语汇单元Tokens。

要看分析器的分析效果，只需要看Tokenstream中的内容就可以了。每个分析器都有一个方法tokenStream，返回一个tokenStream对象。

Lucene自带中文分词器

1.StandardAnalyzer：

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

2.CJKAnalyzer
      二分法分词：按两个字进行切分。如：“我是中国人”，效果：“我是”、“是中”、“中国”“国人”。
       上边两个分词器无法满足需求。
3.SmartChineseAnalyzer
       对中文支持较好，但扩展性差，扩展词库，禁用词库和同义词库等不好处理

IKAnalyzer

IK-analyzer：最新版在https://code.google.com/p/ik-analyzer/上，支持Lucene 4.10从2006年12月推出1.0版开始， IKAnalyzer已经推出了4个大版本。最初，它是以开源项目Luence为应用主体的，结合词典分词和文法分析算法的中文分词组件。从3.0版本开始，IK发展为面向Java的公用分词组件，独立于Lucene项目，同时提供了对Lucene的默认优化实现。在2012版本中，IK实现了简单的分词歧义排除算法，标志着IK分词器从单纯的词典分词向模拟语义分词衍化。但是也就是2012年12月后没有在更新。

70 6

使用方法：

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

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

注意：mydict.dic和ext_stopword.dic文件的格式为UTF-8，注意是无BOM 的UTF-8 编码。

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

70 7

Analyzer使用时机
1. 索引时使用Analyzer
  
  输入关键字进行搜索，当需要让该关键字与文档域内容所包含的词进行匹配时需要对文档域内容进行分析，需要经过Analyzer分析器处理生成语汇单元（Token）。分析器分析的对象是文档中的Field域。当Field的属性tokenized（是否分词）为true时会对Field值进行分析，如下图：

70 8

对于一些Field可以不用分析：

1、不作为查询条件的内容，比如文件路径

2、不是匹配内容中的词而匹配Field的整体内容，比如订单号、身份证号等。

   2.搜索时使用Analyzer
     对搜索关键字进行分析和索引分析一样，使用Analyzer对搜索关键字进行分析、分词处理，使用分析后每个词语进行搜索。比如：搜索关键字：spring web ，经过分析器进行分词，得出：spring  web拿词去索引词典表查找 ，找到索引链接到Document，解析Document内容。
     对于匹配整体Field域的查询可以在搜索时不分析，比如根据订单号、身份证号查询等。

注意：搜索使用的分析器要和索引使用的分析器一致。

代码实现

// 查看标准分析器的分词效果
        @Test
        public void testTokenStream() throws Exception {
            // 创建一个标准分析器对象
//            Analyzer analyzer = new StandardAnalyzer();
//            Analyzer analyzer = new CJKAnalyzer();
//            Analyzer analyzer = new SmartChineseAnalyzer();
            Analyzer analyzer = new IKAnalyzer();
            // 获得tokenStream对象
            // 第一个参数：域名，可以随便给一个
            // 第二个参数：要分析的文本内容
//            TokenStream tokenStream = analyzer.tokenStream("test",
//                    "The Spring Framework provides a comprehensive programming and configuration model.");
            TokenStream tokenStream = analyzer.tokenStream("test",
                    "高富帅可以用二维表结构来逻辑表达实现的数据");
            // 添加一个引用，可以获得每个关键词
            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();
        }

索引库维护

索引库的添加
1. 步骤

向索引库中添加document对象。

第一步：先创建一个indexwriter对象

第二步：创建一个document对象

第三步：把document对象写入索引库

第四步：关闭indexwriter。

         2.代码实现
//添加索引
     @Test
     public void addDocument() throws Exception {
          //索引库存放路径
          Directory directory = FSDirectory.open(new File("D:\\temp\\0108\\index"));
          IndexWriterConfig config = new IndexWriterConfig(Version.LATEST, new IKAnalyzer());
          //创建一个indexwriter对象
          IndexWriter indexWriter = new IndexWriter(directory, config);
          //创建一个Document对象
          Document document = new Document();
          //向document对象中添加域。
          //不同的document可以有不同的域，同一个document可以有相同的域。
          document.add(new TextField("filename", "新添加的文档", Store.YES));
          document.add(new TextField("content", "新添加的文档的内容", Store.NO));
          document.add(new TextField("content", "新添加的文档的内容第二个content", Store.YES));
          document.add(new TextField("content1", "新添加的文档的内容要能看到", Store.YES));
          //添加文档到索引库
          indexWriter.addDocument(document);
          //关闭indexwriter
          indexWriter.close();
     }
2.索引库删除
      1.删除全部
  @Test
     public void deleteAllIndex() throws Exception {
          IndexWriter indexWriter = getIndexWriter();
          //删除全部索引
          indexWriter.deleteAll();
          //关闭indexwriter
          indexWriter.close();
     }
    说明：将索引目录的索引信息全部删除，直接彻底删除，无法恢复。

此方法慎用！！

         2.指定查询条件删除
//根据查询条件删除索引
     @Test
     public void deleteIndexByQuery() throws Exception {
          IndexWriter indexWriter = getIndexWriter();
          //创建一个查询条件
          Query query = new TermQuery(new Term("filename", "apache"));
          //根据查询条件删除
          indexWriter.deleteDocuments(query);
          //关闭indexwriter
          indexWriter.close();
     }
3.索引库的修改
         原理就是先删除后添加。
//修改索引库
     @Test
     public void updateIndex() throws Exception {
          IndexWriter indexWriter = getIndexWriter();
          //创建一个Document对象
          Document document = new Document();
          //向document对象中添加域。
          //不同的document可以有不同的域，同一个document可以有相同的域。
          document.add(new TextField("filename", "要更新的文档", Store.YES));
          document.add(new TextField("content", "2013年11月18日 - Lucene 简介 Lucene 是一个基于 Java 的全文信息检索工具包,它不是一个完整的搜索应用程序,而是为你的应用程序提供索引和搜索功能。", Store.YES));
          indexWriter.updateDocument(new Term("content", "java"), document);
          //关闭indexWriter
          indexWriter.close();
     }

Lucene索引库查询

     对要搜索的信息创建Query查询对象，Lucene会根据Query查询对象生成最终的查询语法，类似关系数据库Sql语法一样Lucene也有自己的查询语法，比如：“name:lucene”表示查询Field的name为“lucene”的文档信息。
     可通过两种方法创建查询对象：
     1）使用Lucene提供Query子类
     Query是一个抽象类，lucene提供了很多查询对象，比如TermQuery项精确查询，NumericRangeQuery数字范围查询等。
     如下代码：
                Query query = **new** TermQuery(**new** Term("name", "lucene"));
     2）使用QueryParse解析查询表达式
     QueryParse会将用户输入的查询表达式解析成Query对象实例。
     如下代码：
                QueryParser queryParser = **new** QueryParser("name", **new** IKAnalyzer());
                Query query = queryParser.parse("name:lucene");

使用query的子类查询

MatchAllDocsQuery

使用MatchAllDocsQuery查询索引目录中的所有文档

@Test
     public void testMatchAllDocsQuery() throws Exception {
          IndexSearcher indexSearcher = getIndexSearcher();
          //创建查询条件
          Query query = new MatchAllDocsQuery();
          //执行查询
          printResult(query, indexSearcher);
     }

2.TermQuery

TermQuery，通过项查询，TermQuery不使用分析器所以建议匹配不分词的Field域查询，比如订单号、分类ID号等。

指定要查询的域和要查询的关键词。

//使用Termquery查询
     @Test
     public void testTermQuery() throws Exception {
          IndexSearcher indexSearcher = getIndexSearcher();
          //创建查询对象
          Query query = new TermQuery(new Term("content", "lucene"));
          //执行查询
          TopDocs topDocs = indexSearcher.search(query, 10);
          //共查询到的document个数
          System.out.println("查询结果总数量：" + topDocs.totalHits);
          //遍历查询结果
          for (ScoreDoc scoreDoc : topDocs.scoreDocs) {
               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"));
          }
          //关闭indexreader
          indexSearcher.getIndexReader().close();
     }
3.NumericRangeQuery

可以根据数值范围查询。

//数值范围查询
     @Test
     public void testNumericRangeQuery() throws Exception {
          IndexSearcher indexSearcher = getIndexSearcher();
          //创建查询
          //参数：
          //1.域名
          //2.最小值
          //3.最大值
          //4.是否包含最小值
          //5.是否包含最大值
          Query query = NumericRangeQuery.newLongRange("size", 1l, 1000l, true, true);
          //执行查询
          printResult(query, indexSearcher);
     }

4.BooleanQuery

可以组合查询条件。

//组合条件查询
     @Test
     public void testBooleanQuery() throws Exception {
          IndexSearcher indexSearcher = getIndexSearcher();
          //创建一个布尔查询对象
          BooleanQuery query = new BooleanQuery();
          //创建第一个查询条件
          Query query1 = new TermQuery(new Term("filename", "apache"));
          Query query2 = new TermQuery(new Term("content", "apache"));
          //组合查询条件
          query.add(query1, Occur.MUST);
          query.add(query2, Occur.MUST);
          //执行查询
          printResult(query, indexSearcher);
     }

Occur.MUST：必须满足此条件，相当于and

Occur.SHOULD：应该满足，但是不满足也可以，相当于or

Occur.MUST_NOT：必须不满足。相当于not

使用queryparser查询

通过QueryParser也可以创建Query，QueryParser提供一个Parse方法，此方法可以直接根据查询语法来查询。Query对象执行的查询语法可通过System.out.println(query);查询。

需要使用到分析器。建议创建索引时使用的分析器和查询索引时使用的分析器要一致。

1.QueryParser

需要加入queryParser依赖的jar包。

@Test
     public void testQueryParser() throws Exception {
          IndexSearcher indexSearcher = getIndexSearcher();
          //创建queryparser对象
          //第一个参数默认搜索的域
          //第二个参数就是分析器对象
          QueryParser queryParser = new QueryParser("content", new IKAnalyzer());
          Query query = queryParser.parse("Lucene是java开发的");
          //执行查询
          printResult(query, indexSearcher);
     }

     查询语法

1、基础的查询语法，关键词查询：

域名+“：”+搜索的关键字

例如：content:java

       2. 范围查询
                  域名+“:”+\[最小值 TO 最大值\]
                  例如：size:\[1 TO 1000\]
             范围查询在lucene中支持数值类型，不支持字符串类型。在solr中支持字符串类型。
       3.组合条件查询
                 1）+条件1 +条件2：两个条件之间是并且的关系and
                  例如：+filename:apache +content:apache
                 2)   +条件1 条件2：必须满足第一个条件，应该满足第二个条件
                  例如：+filename:apache content:apache
                3)条件1 条件2：两个条件满足其一即可。
                   例如：filename:apache content:apache
                 4）-条件1 条件2：必须不满足条件1，要满足条件2
                     例如：-filename:apache content:apache

Occur.MUST 查询条件必须满足，相当于and

+（加号）

Occur.SHOULD 查询条件可选，相当于or

空（不用符号）

Occur.MUST_NOT 查询条件不能满足，相当于not非

-（减号）

第二种写法：

条件1 AND 条件2

条件1 OR 条件2

条件1 NOT 条件2

2.MultiFieldQueryParser

        可以指定多个默认搜索域
@Test
     public void testMultiFiledQueryParser() throws Exception {
          IndexSearcher indexSearcher = getIndexSearcher();
          //可以指定默认搜索的域是多个
          String[] fields = {"filename", "content"};
          //创建一个MulitFiledQueryParser对象
          MultiFieldQueryParser queryParser = new MultiFieldQueryParser(fields, new IKAnalyzer());
          Query query = queryParser.parse("java AND apache");
          System.out.println(query);
          //执行查询
          printResult(query, indexSearcher);
     }