Lucene實例教程

Lucene是apache組織的一個用java實現全文搜索引擎的開源項目。 其功能很是的強大,api也很簡單。總得來講用Lucene來進行創建 和搜索和操做數據庫是差很少的(有點像),Document能夠看做是 數據庫的一行記錄,Field能夠看做是數據庫的字段。用lucene實 現搜索引擎就像用JDBC實現鏈接數據庫同樣簡單。java

Lucene2.0,它與之前普遍應用和介紹的Lucene 1.4.3並不兼容。 Lucene2.0的下載地址是http://apache.justdn.org/lucene/java/程序員


例子一 :

一、在windows系統下的的C盤,建一個名叫s的文件夾,在該文件夾裏面隨便建三個txt文件,隨便起名啦,就叫"1.txt","2.txt"和"3.txt"啦 
其中1.txt的內容以下:數據庫

中華人民共和國   
全國人民   
2006年  apache

而"2.txt"和"3.txt"的內容也能夠隨便寫幾寫,這裏懶寫,就複製一個和1.txt文件的內容同樣吧

二、下載lucene包,放在classpath路徑中 
創建索引:windows

package lighter.javaeye.com;   
  
import java.io.BufferedReader;   
import  java.io.File;   
import java.io.FileInputStream;   
import  java.io.IOException;   
import java.io.InputStreamReader;   
import  java.util.Date;   
  
import  org.apache.lucene.analysis.Analyzer;   
import org.apache.lucene.analysis.standard.StandardAnalyzer;   
import org.apache.lucene.document.Document;   
import org.apache.lucene.document.Field;   
import org.apache.lucene.index.IndexWriter;   
  
/** */ /**   
 * author lighter date 2006-8-7  
  */   
public   class TextFileIndexer  {   
    public   static   void  main(String[] args)  throws Exception  {   
        /**/ /*  指明要索引文件夾的位置,這裏是C盤的S文件夾下 */   
        File fileDir =   new  File( " c:\\s " );   
  
        /**/ /*  這裏放索引文件的位置  */   
        File indexDir =   new  File( " c:\\index " );   
        Analyzer luceneAnalyzer =   new  StandardAnalyzer();   
        IndexWriter indexWriter =   new  IndexWriter(indexDir, luceneAnalyzer,   
                true );   
        File[] textFiles =  fileDir.listFiles();   
        long  startTime  =   new Date().getTime();   
           
        // 增長document到索引去    
        for  ( int  i  =   0 ; i  < textFiles.length; i ++ )  {   
            if  (textFiles[i].isFile()   
                    &&  textFiles[i].getName().endsWith( " .txt " ))  {   
                System.out.println(" File  "   + textFiles[i].getCanonicalPath()   
                        +   " 正在被索引. " );   
                String temp =  FileReaderAll(textFiles[i].getCanonicalPath(),   
                        " GBK " );   
                System.out.println(temp);   
                Document document =   new  Document();   
                Field FieldPath =   new  Field( " path ", textFiles[i].getPath(),   
                        Field.Store.YES, Field.Index.NO);   
                Field FieldBody =   new  Field( " body ", temp, Field.Store.YES,   
                        Field.Index.TOKENIZED,   
                        Field.TermVector.WITH_POSITIONS_OFFSETS);   
                document.add(FieldPath);   
                document.add(FieldBody);   
                indexWriter.addDocument(document);   
            }   
        }   
        // optimize()方法是對索引進行優化    
        indexWriter.optimize();   
        indexWriter.close();   
           
        // 測試一下索引的時間    
        long  endTime  =   new  Date().getTime();   
        System.out   
                .println(" 這花費了"   
                        +  (endTime  -  startTime)   
                        +   "  毫秒來把文檔增長到索引裏面去! "   
                        +  fileDir.getPath());   
    }    
  
     public   static String FileReaderAll(String FileName, String charset)   
            throws  IOException  {   
        BufferedReader reader =   new  BufferedReader( new InputStreamReader(   
                new  FileInputStream(FileName), charset));   
        String line =   new  String();   
        String temp =   new  String();   
           
        while  ((line  =  reader.readLine())  !=   null)  {   
            temp +=  line;   
        }   
        reader.close();   
        return  temp;   
    }    
}  api

索引的結果:多線程

File C:\s\ 1 .txt正在被索引.   
中華人民共和國全國人民2006年   
File C:\s\ 2 .txt正在被索引.   
中華人民共和國全國人民2006年   
File C:\s\ 3 .txt正在被索引.   
中華人民共和國全國人民2006年   
這花費了297 毫秒來把文檔增長到索引裏面去 ! c:\s  函數


三、創建了索引以後,查詢啦....工具

package  lighter.javaeye.com;   
  
import java.io.IOException;   
  
import org.apache.lucene.analysis.Analyzer;   
import org.apache.lucene.analysis.standard.StandardAnalyzer;   
import  org.apache.lucene.queryParser.ParseException;   
import org.apache.lucene.queryParser.QueryParser;   
import org.apache.lucene.search.Hits;   
import org.apache.lucene.search.IndexSearcher;   
import org.apache.lucene.search.Query;   
  
public   class TestQuery  {   
    public   static   void  main(String[] args)  throws IOException, ParseException  {   
        Hits hits =   null ;   
        String queryString =   " 中華 ";   
        Query query =   null ;   
        IndexSearcher searcher =   new  IndexSearcher( " c:\\index " );   
  
        Analyzer analyzer =   new  StandardAnalyzer();   
        try   {   
            QueryParser qp =   new  QueryParser( " body ", analyzer);   
            query =  qp.parse(queryString);   
        }  catch  (ParseException e)  {   
        }   
        if  (searcher  !=   null )  {   
            hits =  searcher.search(query);   
            if  (hits.length()  >   0 )  {   
                System.out.println(" 找到: "  +  hits.length()  +   "  個結果! " );   
            }   
        }   
    }  
  
}   測試

其運行結果:

找到: 3  個結果!

 

Lucene 其實很簡單的,它最主要就是作兩件事:創建索引和進行搜索 
來看一些在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類的實例來表示的。

上面做了一大堆名詞解釋,下面就看幾個簡單的實例吧: 
一、簡單的的StandardAnalyzer測試例子

 

package  lighter.javaeye.com;   
  
import java.io.IOException;   
import java.io.StringReader;   
  
import org.apache.lucene.analysis.Analyzer;   
import  org.apache.lucene.analysis.Token;   
import org.apache.lucene.analysis.TokenStream;   
import org.apache.lucene.analysis.standard.StandardAnalyzer;   
  
public   class StandardAnalyzerTest    
{   
     // 構造函數,    
     public StandardAnalyzerTest()   
    {   
    }    
     public   static  void  main(String[] args)    
    {   
        // 生成一個StandardAnalyzer對象    
        Analyzer aAnalyzer =   new  StandardAnalyzer();   
        // 測試字符串   
        StringReader sr =   new  StringReader( "lighter javaeye com is the are on ");   
        // 生成TokenStream對象    
        TokenStream ts =  aAnalyzer.tokenStream( " name ", sr);    
        try   {   
            int  i = 0 ;   
            Token t =  ts.next();   
            while (t != null )   
            {   
                // 輔助輸出時顯示行號   
                i++ ;   
                // 輸出處理後的字符   
                System.out.println(" 第 " + i + " 行: " + t.termText());   
                // 取得下一個字符   
                t= ts.next();   
            }   
        }  catch  (IOException e)  {   
            e.printStackTrace();   
        }   
    }    
}    

顯示結果:

第1行:lighter 
第2行:javaeye 
第3行:com

提示一下: 
StandardAnalyzer是lucene中內置的"標準分析器",能夠作以下功能: 
一、對原有句子按照空格進行了分詞 
二、全部的大寫字母均可以能轉換爲小寫的字母 
三、能夠去掉一些沒有用處的單詞,例如"is","the","are"等單詞,也刪除了全部的標點 
查看一下結果與"newStringReader("lighter javaeye com is the are on")"做一個比較就清楚明瞭。 
這裏不對其API進行解釋了,具體見lucene的官方文檔。須要注意一點,這裏的代碼使用的是lucene2的API,與1.43版有一些明顯的差異。

二、看另外一個實例,簡單地創建索引,進行搜索

package lighter.javaeye.com;   
import org.apache.lucene.analysis.standard.StandardAnalyzer;   
import org.apache.lucene.document.Document;   
import org.apache.lucene.document.Field;   
import  org.apache.lucene.index.IndexWriter;   
import org.apache.lucene.queryParser.QueryParser;   
import org.apache.lucene.search.Hits;   
import org.apache.lucene.search.IndexSearcher;   
import org.apache.lucene.search.Query;   
import org.apache.lucene.store.FSDirectory;   
  
public   class FSDirectoryTest  {   
  
     // 創建索引的路徑    
     public   static  final  String path  =   " c:\\index2 ";   
  
    public   static   void  main(String[] args)  throws Exception  {   
        Document doc1 =   new  Document();   
        doc1.add( new  Field( " name " ,  "lighter javaeye com " ,Field.Store.YES,Field.Index.TOKENIZED));   
  
        Document doc2 =   new  Document();   
        doc2.add(new  Field( " name " ,  " lighter blog ",Field.Store.YES,Field.Index.TOKENIZED));   
  
        IndexWriter writer =   new  IndexWriter(FSDirectory.getDirectory(path,  true),  new  StandardAnalyzer(),  true );   
        writer.setMaxFieldLength(3 );   
        writer.addDocument(doc1);   
        writer.setMaxFieldLength(3 );   
        writer.addDocument(doc2);   
        writer.close();   
  
        IndexSearcher searcher =   new  IndexSearcher(path);   
        Hits hits =   null ;   
        Query query =   null ;   
        QueryParser qp =   new  QueryParser( " name " , new StandardAnalyzer());   
           
        query =  qp.parse( " lighter " );   
        hits =  searcher.search(query);   
        System.out.println(" 查找\ " lighter\ "  共 "   +  hits.length()  +  " 個結果 " );   
  
        query =  qp.parse( " javaeye " );   
        hits =  searcher.search(query);   
        System.out.println(" 查找\ " javaeye\ "  共 "   +  hits.length()  +  " 個結果 " );   
  
    }    
  
}   

運行結果:

查找 " lighter "  共2個結果   
查找 " javaeye "  共1個結果 


到如今咱們已經能夠用lucene創建索引了
下面介紹一下幾個功能來完善一下:
1.索引格式

其實索引目錄有兩種格式,

一種是除配置文件外,每個Document獨立成爲一個文件(這種搜索起來會影響速度)。

另外一種是所有的Document成一個文件,這樣屬於複合模式就快了。

2.索引文件可放的位置:

索引能夠存放在兩個地方1.硬盤,2.內存
放在硬盤上能夠用FSDirectory(),放在內存的用RAMDirectory()不過一關機就沒了

FSDirectory.getDirectory(File file, boolean  create)
FSDirectory.getDirectory(String path, boolean  create)

兩個工廠方法返回目錄
New RAMDirectory()就直接能夠
再和

IndexWriter(Directory d, Analyzer a, boolean  create)

一配合就好了
如:

IndexWrtier indexWriter  =  new  IndexWriter(FSDirectory.getDirectory(「c:\\index」, true ), new StandardAnlyazer(), true );
IndexWrtier indexWriter  =  new  IndexWriter( new  RAMDirectory(), new  StandardAnlyazer(),true );

3.索引的合併
這個可用

IndexWriter.addIndexes(Directory[] dirs)

將目錄加進去
來看個例子:

public   void  UniteIndex() throws  IOException
    {
        IndexWriter writerDisk =   new  IndexWriter(FSDirectory.getDirectory( " c:\\indexDisk" ,  true ), new  StandardAnalyzer(), true );
        Document docDisk =   new  Document();
        docDisk.add(new  Field( " name " , " 程序員之家 " ,Field.Store.YES,Field.Index.TOKENIZED));
        writerDisk.addDocument(docDisk);
        RAMDirectory ramDir =   new  RAMDirectory();
        IndexWriter writerRam =   new  IndexWriter(ramDir, new  StandardAnalyzer(), true );
        Document docRam =   new  Document();
        docRam.add(new  Field( " name " , " 程序員雜誌 " ,Field.Store.YES,Field.Index.TOKENIZED));
        writerRam.addDocument(docRam);
        writerRam.close();// 這個方法很是重要,是必須調用的 
        writerDisk.addIndexes(new  Directory[] {ramDir} );
        writerDisk.close();
    } 
     public   void UniteSearch()  throws  ParseException, IOException
    {
        QueryParser queryParser =   new  QueryParser( " name " , new StandardAnalyzer());
        Query query =  queryParser.parse( " 程序員 " );
        IndexSearcher indexSearcher = new  IndexSearcher( " c:\\indexDisk " );
        Hits hits =  indexSearcher.search(query);
        System.out.println(" 找到了 " + hits.length() + " 結果 " );
        for ( int  i = 0 ;i
        {
            Document doc =  hits.doc(i);
            System.out.println(doc.get(" name " ));
        }
}


這個例子是將內存中的索引合併到硬盤上來.
注意:合併的時候必定要將被合併的那一方的IndexWriter的close()方法調用。

4.對索引的其它操做:
IndexReader類是用來操做索引的,它有對Document,Field的刪除等操做。
下面一部分的內容是:全文的搜索
全文的搜索主要是用:IndexSearcher,Query,Hits,Document(都是Query的子類),有的時候用QueryParser
主要步驟:

1 . new  QueryParser(Field字段, new  分析器)
2 .Query query  = QueryParser.parser(「要查詢的字串」);這個地方咱們能夠用反射api看一下query到底是什麼類型
3 . new  IndexSearcher(索引目錄).search(query);返回Hits
4 .用Hits.doc(n);能夠遍歷出Document
5 .用Document可獲得Field的具體信息了。

其實1 ,2兩步就是爲了弄出個Query 實例,到底是什麼類型的看分析器了。

拿之前的例子來講吧

QueryParser queryParser  =  new  QueryParser( " name " , new  StandardAnalyzer());
        Query query =  queryParser.parse( " 程序員 " );
/**/ /* 這裏返回的就是org.apache.lucene.search.PhraseQuery */ 
        IndexSearcher indexSearcher = new  IndexSearcher( " c:\\indexDisk " );
        Hits hits =  indexSearcher.search(query);


不論是什麼類型,無非返回的就是Query的子類,咱們徹底能夠不用這兩步直接new個Query的子類的實例就ok了,不過通常仍是用這兩步由於它返回的是PhraseQuery這個是很是強大的query子類它能夠進行多字搜索用QueryParser能夠設置各個關鍵字之間的關係這個是最經常使用的了。
IndexSearcher:
其實IndexSearcher它內部自帶了一個IndexReader用來讀取索引的,IndexSearcher有個close()方法,這個方法不是用來關閉IndexSearche的是用來關閉自帶的IndexReader。

QueryParser呢能夠用parser.setOperator()來設置各個關鍵字之間的關係(與仍是或)它能夠自動經過空格從字串裏面將關鍵字分離出來。
注意:用QueryParser搜索的時候分析器必定的和創建索引時候用的分析器是同樣的。
Query:
能夠看一個lucene2.0的幫助文檔有不少的子類:
BooleanQuery, ConstantScoreQuery, ConstantScoreRangeQuery, DisjunctionMaxQuery,FilteredQuery, MatchAllDocsQuery, MultiPhraseQuery, MultiTermQuery,PhraseQuery, PrefixQuery, RangeQuery, SpanQuery, TermQuery
各自有用法看一下文檔就能知道它們的用法了
下面一部分講一下lucene的分析器:
分析器是由分詞器和過濾器組成的,拿英文來講吧分詞器就是經過空格把單詞分開,過濾器就是把the,to,of等詞去掉不被搜索和索引。
咱們最經常使用的是StandardAnalyzer()它是lucene的標準分析器它集成了內部的許多的分析器。
最後一部分了:lucene的高級搜索了
1.排序
Lucene有內置的排序用IndexSearcher.search(query,sort)可是功能並不理想。咱們須要本身實現自定義的排序。
這樣的話得實現兩個接口: ScoreDocComparator,SortComparatorSource
用IndexSearcher.search(query,newSort(new SortField(String Field,SortComparatorSource)));
就看個例子吧:
這是一個創建索引的例子:

public   void  IndexSort() throws  IOException
{
        IndexWriter writer =   new  IndexWriter( " C:\\indexStore " , new StandardAnalyzer(), true );
        Document doc =   new  Document()
        doc.add(new  Field( " sort " , " 1 ",Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        doc =   new  Document();
        doc.add(new  Field( " sort " , " 4 ",Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        doc =   new  Document();
        doc.add(new  Field( " sort " , " 3 ",Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        doc =   new  Document();
        doc.add(new  Field( " sort " , " 5 ",Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        doc =   new  Document();
        doc.add(new  Field( " sort " , " 9 ",Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        doc =   new  Document();
        doc.add(new  Field( " sort " , " 6 " ,Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        doc =   new  Document();
        doc.add(new  Field( " sort " , " 7 ",Field.Store.YES,Field.Index.TOKENIZED));
        writer.addDocument(doc);
        writer.close();


下面是搜索的例子:
[code]
public void SearchSort1() throws IOException, ParseException
{
        IndexSearcher indexSearcher = newIndexSearcher("C:\\indexStore");
        QueryParser queryParser = newQueryParser("sort",new StandardAnalyzer());
        Query query =queryParser.parse("4");
       
        Hits hits =indexSearcher.search(query);
        System.out.println("有"+hits.length()+"個結果");
        Document doc = hits.doc(0);
       System.out.println(doc.get("sort"));
}
public void SearchSort2() throws IOException, ParseException
{
        IndexSearcher indexSearcher = newIndexSearcher("C:\\indexStore");
        Query query = new RangeQuery(newTerm("sort","1"),newTerm("sort","9"),true);//這個地方前面沒有提到,它是用於範圍的Query能夠看一下幫助文檔.
        Hits hits =indexSearcher.search(query,new Sort(new SortField("sort",newMySortComparatorSource())));
        System.out.println("有"+hits.length()+"個結果");
        for(int i=0;i
        {
            Document doc= hits.doc(i);
           System.out.println(doc.get("sort"));
        }
}
public class MyScoreDocComparator implements ScoreDocComparator
{
    private Integer[]sort;
    public MyScoreDocComparator(String s,IndexReader reader,String fieldname) throws IOException
    {
        sort = new Integer[reader.maxDoc()];
        for(int i = 0;i
        {
            Document doc=reader.document(i);
            sort[i]=newInteger(doc.get("sort"));
        }
    }
    public int compare(ScoreDoc i, ScoreDoc j)
    {
        if(sort[i.doc]>sort[j.doc])
            return 1;
        if(sort[i.doc]
            return -1;
        return 0;
    }
    public int sortType()
    {
        return SortField.INT;
    }
    public Comparable sortValue(ScoreDoc i)
    {
        // TODO 自動生成方法存根
        return new Integer(sort[i.doc]);
    }
}
public class MySortComparatorSource implements SortComparatorSource
{
    private static final long serialVersionUID =-9189690812107968361L;
    public ScoreDocComparator newComparator(IndexReader reader,String fieldname)
            throwsIOException
    {
       if(fieldname.equals("sort"))
            return newMyScoreDocComparator("sort",reader,fieldname);
        return null;
    }
}[/code]
SearchSort1()輸出的結果沒有排序,SearchSort2()就排序了。
2.多域搜索MultiFieldQueryParser
若是想輸入關鍵字而不想關心是在哪一個Field裏的就能夠用MultiFieldQueryParser了
用它的構造函數便可後面的和一個Field同樣。
MultiFieldQueryParser. parse(String[] queries, String[] fields,BooleanClause.Occur[] flags, Analyzeranalyzer)                                         ~~~~~~~~~~~~~~~~~
第三個參數比較特殊這裏也是與之前lucene1.4.3不同的地方
看一個例子就知道了
String[] fields = {"filename", "contents", "description"};
 BooleanClause.Occur[] flags = {BooleanClause.Occur.SHOULD,
               BooleanClause.Occur.MUST,//在這個Field裏必須出現的
               BooleanClause.Occur.MUST_NOT};//在這個Field裏不能出現
 MultiFieldQueryParser.parse("query", fields, flags, analyzer);

一、lucene的索引不能太大,要否則效率會很低。大於1G的時候就必須考慮分佈索引的問題

二、不建議用多線程來建索引,產生的互鎖問題很麻煩。常常發現索引被lock,沒法從新創建的狀況

三、中文分詞是個大問題,目前免費的分詞效果都不好。若是有能力仍是本身實現一個分詞模塊,用最短路徑的切分方法,網上有教材和demo源碼,能夠參考。

四、建增量索引的時候很耗cpu,在訪問量大的時候會致使cpu的idle爲0

五、默認的評分機制不太合理,須要根據本身的業務定製

 

總體來講lucene要用好不容易,必須在上述方面擴充他的功能,才能做爲一個商用的搜索引擎

相關文章
相關標籤/搜索