Lucene 简明教程
Lucene - Search Operation
搜索过程是 Lucene 提供的核心功能之一。下图说明了该过程及其用途。IndexSearcher 是搜索过程的核心组件之一。
我们首先创建包含索引的 Directory(ies)，然后将其传递给使用 IndexReader 打开 Directory 的 IndexSearcher。然后，我们使用 Term 创建一个 Query，并使用 IndexSearcher 进行搜索，方法是将 Query 传递给搜索器。IndexSearcher 返回一个 TopDocs 对象，其中包含搜索详细信息以及搜索操作结果的 Document 的文档 ID。
现在，我们将向您展示一个逐步的方法，并帮助您理解使用基本示例进行的索引过程。
Create a QueryParser
QueryParser 类将用户输入的输入解析为 Lucene 理解的格式查询。按照以下步骤创建 QueryParser −
Step 1 − 创建 QueryParser 对象。
Step 2 − 使用具有版本信息和要在此查询上运行的索引名称的标准分析器初始化创建的 QueryParser 对象。
QueryParser queryParser;
public Searcher(String indexDirectoryPath) throws IOException {
queryParser = new QueryParser(Version.LUCENE_36,
LuceneConstants.CONTENTS,
new StandardAnalyzer(Version.LUCENE_36));
}Create a IndexSearcher
IndexSearcher 类充当搜索器索引的核心组件，该索引在索引过程中创建。按照以下步骤创建 IndexSearcher −
Step 1 − 创建 IndexSearcher 对象。
Step 2 − 创建 Lucene 目录，该目录应该指向存储索引的位置。
Step 3 − 使用索引目录初始化创建的 IndexSearcher 对象。
IndexSearcher indexSearcher;
public Searcher(String indexDirectoryPath) throws IOException {
Directory indexDirectory =
FSDirectory.open(new File(indexDirectoryPath));
indexSearcher = new IndexSearcher(indexDirectory);
}Make search
按照以下步骤进行搜索 −
Step 1 − 通过 QueryParser 解析搜索表达式来创建 Query 对象。
Step 2 − 通过调用 IndexSearcher.search() 方法进行搜索。
Query query;
public TopDocs search( String searchQuery) throws IOException, ParseException {
query = queryParser.parse(searchQuery);
return indexSearcher.search(query, LuceneConstants.MAX_SEARCH);
}Get the Document
以下程序显示如何获取文档。
public Document getDocument(ScoreDoc scoreDoc)
throws CorruptIndexException, IOException {
return indexSearcher.doc(scoreDoc.doc);
}Close IndexSearcher
以下程序显示如何关闭 IndexSearcher。
public void close() throws IOException {
indexSearcher.close();
}Example Application
让我们创建一个测试 Lucene 应用程序来测试搜索过程。
Step |
Description |
1 |
在包 com.tutorialspoint.lucene 下使用名称 LuceneFirstApplication 创建一个项目，如 Lucene - 第一个应用程序章节中所述。您还可以在此章节中使用如该章节中创建的项目，以便理解搜索过程。 |
2 |
创建 LuceneConstants.java、TextFileFilter.java 和 Searcher.java，如 Lucene - 第一个应用程序章节中所述。保持其余文件不变。 |
3 |
如下所示创建 LuceneTester.java。 |
4 |
清理并构建应用程序以确保业务逻辑按需求工作。 |
LuceneConstants.java
此类用于提供将在整个示例应用程序中使用的各种常量。
package com.tutorialspoint.lucene;
public class LuceneConstants {
public static final String CONTENTS = "contents";
public static final String FILE_NAME = "filename";
public static final String FILE_PATH = "filepath";
public static final int MAX_SEARCH = 10;
}TextFileFilter.java
此类用作 .txt 文件过滤器。
package com.tutorialspoint.lucene;
import java.io.File;
import java.io.FileFilter;
public class TextFileFilter implements FileFilter {
@Override
public boolean accept(File pathname) {
return pathname.getName().toLowerCase().endsWith(".txt");
}
}Searcher.java
此类用于读取原始数据上创建的索引并使用 Lucene 库搜索数据。
package com.tutorialspoint.lucene;
import java.io.File;
import java.io.IOException;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.CorruptIndexException;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.queryParser.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.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.apache.lucene.util.Version;
public class Searcher {
IndexSearcher indexSearcher;
QueryParser queryParser;
Query query;
public Searcher(String indexDirectoryPath) throws IOException {
Directory indexDirectory =
FSDirectory.open(new File(indexDirectoryPath));
indexSearcher = new IndexSearcher(indexDirectory);
queryParser = new QueryParser(Version.LUCENE_36,
LuceneConstants.CONTENTS,
new StandardAnalyzer(Version.LUCENE_36));
}
public TopDocs search( String searchQuery)
throws IOException, ParseException {
query = queryParser.parse(searchQuery);
return indexSearcher.search(query, LuceneConstants.MAX_SEARCH);
}
public Document getDocument(ScoreDoc scoreDoc)
throws CorruptIndexException, IOException {
return indexSearcher.doc(scoreDoc.doc);
}
public void close() throws IOException {
indexSearcher.close();
}
}LuceneTester.java
此类用于测试 Lucene 库的搜索功能。
package com.tutorialspoint.lucene;
import java.io.IOException;
import org.apache.lucene.document.Document;
import org.apache.lucene.queryParser.ParseException;
import org.apache.lucene.search.ScoreDoc;
import org.apache.lucene.search.TopDocs;
public class LuceneTester {
String indexDir = "E:\\Lucene\\Index";
String dataDir = "E:\\Lucene\\Data";
Searcher searcher;
public static void main(String[] args) {
LuceneTester tester;
try {
tester = new LuceneTester();
tester.search("Mohan");
} catch (IOException e) {
e.printStackTrace();
} catch (ParseException e) {
e.printStackTrace();
}
}
private void search(String searchQuery) throws IOException, ParseException {
searcher = new Searcher(indexDir);
long startTime = System.currentTimeMillis();
TopDocs hits = searcher.search(searchQuery);
long endTime = System.currentTimeMillis();
System.out.println(hits.totalHits +
" documents found. Time :" + (endTime - startTime) +" ms");
for(ScoreDoc scoreDoc : hits.scoreDocs) {
Document doc = searcher.getDocument(scoreDoc);
System.out.println("File: "+ doc.get(LuceneConstants.FILE_PATH));
}
searcher.close();
}
}Data & Index Directory Creation
我们使用了 10 个名为 record1.txt 到 record10.txt 的文本文件，其中包含学生姓名和其他详细信息，并将它们放入目录 E:\Lucene\Data. 中。 Test Data . 索引目录路径应创建为 E:\Lucene\Index。在章节 Lucene - Indexing Process 中运行索引程序后，您可以在该文件夹中看到所创建的索引文件列表。