Luence5分钟快速入门示例

使用Lucene&＃xff0c;可以非常方便给我们的应用增加上全文索引的功能&＃xff0c;使用上也非常简单&＃xff0c;只需要5分钟我们就可以学会如何使用它。

1、先从官方下载&＃xff0c;现在的最新版本是4.4.0&＃xff0c;下面的示例代码也是基于4.4的&＃xff1b;

2、建立一个JAVA工程&＃xff0c;将这些个jar从Lucene的目录中找出来&＃xff1a;lucene-analyzers-common-4.4.0.jar、lucene-core-4.4.0.jar、lucene-queries-4.4.0.jar、lucene-queryparser-4.4.0.jar&＃xff0c;并加入到工程的classpath中&＃xff1b;

3、示例JAVA代码&＃xff0c;为了简单好理解&＃xff0c;示例是以将内存中加入一些字符串&＃xff0c;并通过查询结果&＃xff0c;再将结果显示出来。

1&＃xff09;、建立内容索引

[java] view plaincopyprint?

1. //创建一个分析器&＃xff0c;这里使用的是标准分析器&＃xff0c;适用于大多数场景&＃xff0c;并且在StandardAnalyzer中包括了部分中文分析处理功能&＃xff0c;虽然其本身也有一个中文分析器ChineseAnalyzer&＃xff0c;   
2. //不过ChineseAnalyzer将会在5.0的版本中被去掉&＃xff0c;使用StandardAnalyzer即可。   
3. //另外在analyzers-common中&＃xff0c;包括了针对很多种不同语言的分析器&＃xff0c;其中包括中文分析器   
4. Analyzer analyzer &＃61; new StandardAnalyzer(Version.LUCENE_44);  
5.   
6. //Directory是用于索引文件的存储的抽象类&＃xff0c;其子类有将索引文件写到文件的&＃xff0c;也有直接放到内存中的&＃xff0c;这里的RAMDirectory就是放在内存中索引   
7. //优点是速度快&＃xff0c;缺少是不适合于大量数据的索引。这里的数据比较少&＃xff0c;所以使用RAMDirctory非常适合。   
8. //具体的可以查看Directory, RAMDirectory,FSDirectory等API说明&＃xff0c;这里要强调一下的是FSDirectory是一个文件索引存储的抽象类&＃xff0c;下面还有三个子类:MMapDirectory, NIOFSDirectory, SimpleFSDirectory&＃xff0c;根据不同的操作系统及使用场景进行不同的选择了。   
9. Directory index &＃61; new RAMDirectory();  
10.   
11. //IndexWriterConfig包括了所有创建IndexWriter的配置&＃xff0c;一旦IndexWriter创建完成后&＃xff0c;此时再去修改IndexWriterConfig是不会影响到IndexWriter实例的&＃xff0c;此时如果想获取正确的IndexWirter的配置&＃xff0c;最好是通过IndexWirter.getConfig()方法了&＃xff0c;另外IndexWriterConfig本身也是一个final类。   
12. IndexWriterConfig config &＃61; new IndexWriterConfig(Version.LUCENE_44, analyzer);  
13.   
14. //顾名思义,IndexWriter是用于维护及增加索引的   
15. IndexWriter w &＃61; new IndexWriter(index, config);  
16.   
17. addDoc(w, "Lucene in Action", "193398817");  
18. addDoc(w, "Lucene for Dummies", "55320055Z");  
19. addDoc(w, "Managing Gigabytes", "55063554A");  
20. addDoc(w, "The Art of Computer Science", "9900333X");  
21. w.close();  

//创建一个分析器&＃xff0c;这里使用的是标准分析器&＃xff0c;适用于大多数场景&＃xff0c;并且在StandardAnalyzer中包括了部分中文分析处理功能&＃xff0c;虽然其本身也有一个中文分析器ChineseAnalyzer&＃xff0c;
//不过ChineseAnalyzer将会在5.0的版本中被去掉&＃xff0c;使用StandardAnalyzer即可。
//另外在analyzers-common中&＃xff0c;包括了针对很多种不同语言的分析器&＃xff0c;其中包括中文分析器
Analyzer analyzer &＃61; new StandardAnalyzer(Version.LUCENE_44);//Directory是用于索引文件的存储的抽象类&＃xff0c;其子类有将索引文件写到文件的&＃xff0c;也有直接放到内存中的&＃xff0c;这里的RAMDirectory就是放在内存中索引
//优点是速度快&＃xff0c;缺少是不适合于大量数据的索引。这里的数据比较少&＃xff0c;所以使用RAMDirctory非常适合。
//具体的可以查看Directory, RAMDirectory,FSDirectory等API说明&＃xff0c;这里要强调一下的是FSDirectory是一个文件索引存储的抽象类&＃xff0c;下面还有三个子类:MMapDirectory, NIOFSDirectory, SimpleFSDirectory&＃xff0c;根据不同的操作系统及使用场景进行不同的选择了。
Directory index &＃61; new RAMDirectory();//IndexWriterConfig包括了所有创建IndexWriter的配置&＃xff0c;一旦IndexWriter创建完成后&＃xff0c;此时再去修改IndexWriterConfig是不会影响到IndexWriter实例的&＃xff0c;此时如果想获取正确的IndexWirter的配置&＃xff0c;最好是通过IndexWirter.getConfig()方法了&＃xff0c;另外IndexWriterConfig本身也是一个final类。
IndexWriterConfig config &＃61; new IndexWriterConfig(Version.LUCENE_44, analyzer);//顾名思义,IndexWriter是用于维护及增加索引的
IndexWriter w &＃61; new IndexWriter(index, config);addDoc(w, "Lucene in Action", "193398817");
addDoc(w, "Lucene for Dummies", "55320055Z");
addDoc(w, "Managing Gigabytes", "55063554A");
addDoc(w, "The Art of Computer Science", "9900333X");
w.close();
以下是addDoc方法的代码&＃xff0c;功能是将内容加入到索引中

[java] view plaincopyprint?

1. private static void addDoc(IndexWriter w, String title, String isbn) throws IOException {  
2.   Document doc &＃61; new Document();  
3.   doc.add(new TextField("title", title, Field.Store.YES));  
4.   doc.add(new StringField("isbn", isbn, Field.Store.YES));  
5.   w.addDocument(doc);  
6. }  

private static void addDoc(IndexWriter w, String title, String isbn) throws IOException {Document doc &＃61; new Document();doc.add(new TextField("title", title, Field.Store.YES));doc.add(new StringField("isbn", isbn, Field.Store.YES));w.addDocument(doc);
}


这里我们需要注意一下&＃xff0c;增加标题索引使用的是TextField&＃xff0c;增加isbn索引使用的是StringField&＃xff0c;这两个都是IndexableField的子类&＃xff0c;TextField表示是会被拆分并且被索引的字段&＃xff0c;而StringField只会一个整体被索引&＃xff0c;而不会进行拆分索引。

2)、查询通过读取命令行参数&＃xff0c;并将其传给luence的QueryParset&＃xff0c;再通过Query执行查询

[java] view plaincopyprint?

1. String querystr &＃61; args.length > 0 ? args[0] : "lucene";  
2. //通过查询解析器QueryParser创建一个查询Query.   
3. //QueryParser是JavaCC(http://javacc.java.net)编译的其中最重要的方法就是QueryParserBase.parse(String)&＃xff0c;   
4. //特别需要注意的是QueryParser不是线程安全的   
5. Query q &＃61; new QueryParser(Version.LUCENE_44, "title", analyzer).parse(querystr);  

String querystr &＃61; args.length > 0 ? args[0] : "lucene";
//通过查询解析器QueryParser创建一个查询Query.
//QueryParser是JavaCC(http://javacc.java.net)编译的其中最重要的方法就是QueryParserBase.parse(String)&＃xff0c;
//特别需要注意的是QueryParser不是线程安全的
Query q &＃61; new QueryParser(Version.LUCENE_44, "title", analyzer).parse(querystr);


[java] view plaincopyprint?

1.   

3&＃xff09;、执行查询根据index创建IndexSearcher&＃xff0c;然后TopScoreDocCollector就会返回查询的结果

[java] view plaincopyprint?

1. //这个表示每次最多显示的结果数   
2. int hitsPerPage &＃61; 10;  
3. //创建索引读取器   
4. IndexReader reader &＃61; IndexReader.open(index);  
5. //创建索引查询器   
6. IndexSearcher searcher &＃61; new IndexSearcher(reader);  
7. //以TopDocs的方式返回最多hitsPerPage的查询结果   
8. TopScoreDocCollector collector &＃61; TopScoreDocCollector.create(hitsPerPage, true);  
9. //执行查询   
10. searcher.search(q, collector);  
11. ScoreDoc[] hits &＃61; collector.topDocs().scoreDocs;  

//这个表示每次最多显示的结果数
int hitsPerPage &＃61; 10;
//创建索引读取器
IndexReader reader &＃61; IndexReader.open(index);
//创建索引查询器
IndexSearcher searcher &＃61; new IndexSearcher(reader);
//以TopDocs的方式返回最多hitsPerPage的查询结果
TopScoreDocCollector collector &＃61; TopScoreDocCollector.create(hitsPerPage, true);
//执行查询
searcher.search(q, collector);
ScoreDoc[] hits &＃61; collector.topDocs().scoreDocs;

[java] view plaincopyprint?

1.   

4&＃xff09;、显示索引查询结果

[java] view plaincopyprint?

1. System.out.println("Found " &＃43; hits.length &＃43; " hits.");  
2. for(int i&＃61;0;i
3.     int docId &＃61; hits[i].doc;  
4.     Document d &＃61; searcher.doc(docId);  
5.     System.out.println((i &＃43; 1) &＃43; ". " &＃43; d.get("isbn") &＃43; "\t" &＃43; d.get("title"));  
6. }  

System.out.println("Found " &＃43; hits.length &＃43; " hits.");
for(int i&＃61;0;i}

[java] view plaincopyprint?

1. import org.apache.lucene.analysis.standard.StandardAnalyzer;  
2. import org.apache.lucene.document.Document;  
3. import org.apache.lucene.document.Field;  
4. import org.apache.lucene.document.StringField;  
5. import org.apache.lucene.document.TextField;  
6. import org.apache.lucene.index.DirectoryReader;  
7. import org.apache.lucene.index.IndexReader;  
8. import org.apache.lucene.index.IndexWriter;  
9. import org.apache.lucene.index.IndexWriterConfig;  
10. import org.apache.lucene.queryparser.classic.ParseException;  
11. import org.apache.lucene.queryparser.classic.QueryParser;  
12. import org.apache.lucene.search.IndexSearcher;  
13. import org.apache.lucene.search.Query;  
14. import org.apache.lucene.search.ScoreDoc;  
15. import org.apache.lucene.search.TopScoreDocCollector;  
16. import org.apache.lucene.store.Directory;  
17. import org.apache.lucene.store.RAMDirectory;  
18. import org.apache.lucene.util.Version;  
19.   
20. import java.io.IOException;  
21.   
22. public class HelloLucene {  
23.   public static void main(String[] args) throws IOException, ParseException {  
24.     // 0. Specify the analyzer for tokenizing text.   
25.     //    The same analyzer should be used for indexing and searching   
26.     StandardAnalyzer analyzer &＃61; new StandardAnalyzer(Version.LUCENE_44);  
27.   
28.     // 1. create the index   
29.     Directory index &＃61; new RAMDirectory();  
30.   
31.     IndexWriterConfig config &＃61; new IndexWriterConfig(Version.LUCENE_44, analyzer);  
32.   
33.     IndexWriter w &＃61; new IndexWriter(index, config);  
34.     addDoc(w, "Lucene in Action", "193398817");  
35.     addDoc(w, "Lucene for Dummies", "55320055Z");  
36.     addDoc(w, "Managing Gigabytes", "55063554A");  
37.     addDoc(w, "The Art of Computer Science", "9900333X");  
38.     w.close();  
39.   
40.     // 2. query   
41.     String querystr &＃61; args.length > 0 ? args[0] : "lucene";  
42.   
43.     // the "title" arg specifies the default field to use   
44.     // when no field is explicitly specified in the query.   
45.     Query q &＃61; new QueryParser(Version.LUCENE_44, "title", analyzer).parse(querystr);  
46.   
47.     // 3. search   
48.     int hitsPerPage &＃61; 10;  
49.     IndexReader reader &＃61; DirectoryReader.open(index);  
50.     IndexSearcher searcher &＃61; new IndexSearcher(reader);  
51.     TopScoreDocCollector collector &＃61; TopScoreDocCollector.create(hitsPerPage, true);  
52.     searcher.search(q, collector);  
53.     ScoreDoc[] hits &＃61; collector.topDocs().scoreDocs;  
54.       
55.     // 4. display results   
56.     System.out.println("Found " &＃43; hits.length &＃43; " hits.");  
57.     for(int i&＃61;0;i
58.       int docId &＃61; hits[i].doc;  
59.       Document d &＃61; searcher.doc(docId);  
60.       System.out.println((i &＃43; 1) &＃43; ". " &＃43; d.get("isbn") &＃43; "\t" &＃43; d.get("title"));  
61.     }  
62.   
63.     // reader can only be closed when there   
64.     // is no need to access the documents any more.   
65.     reader.close();  
66.   }  
67.   
68.   private static void addDoc(IndexWriter w, String title, String isbn) throws IOException {  
69.     Document doc &＃61; new Document();  
70.     doc.add(new TextField("title", title, Field.Store.YES));  
71.   
72.     // use a string field for isbn because we don&＃39;t want it tokenized   
73.     doc.add(new StringField("isbn", isbn, Field.Store.YES));  
74.     w.addDocument(doc);  
75.   }  
76. }