Lucene8學習：工具類

1.1. Lucene工具類

為了后面的開發、測試方便，這里編寫一個工具類：

 

import java.io.IOException;

import java.nio.file.Paths;

import java.util.List;

 

import org.apache.lucene.analysis.Analyzer;

import org.apache.lucene.document.Document;

import org.apache.lucene.index.DirectoryReader;

import org.apache.lucene.index.IndexReader;

import org.apache.lucene.index.IndexWriter;

import org.apache.lucene.index.IndexWriterConfig;

import org.apache.lucene.index.IndexableField;

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.Formatter;

import org.apache.lucene.search.highlight.Highlighter;

import org.apache.lucene.search.highlight.QueryScorer;

import org.apache.lucene.search.highlight.Scorer;

import org.apache.lucene.search.highlight.SimpleHTMLFormatter;

import org.apache.lucene.store.Directory;

import org.apache.lucene.store.FSDirectory;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.wltea.analyzer.lucene.IKAnalyzer;

 

import cn.lmc.myworld.common.utils.PropertyUtil;

 

 

/**

 * 全文檢索工具類

 * @author limingcheng

 *

 */

public class LuceneUtils {

    // 打印日志

private static final Logger LOGGER = LoggerFactory.getLogger(LuceneUtils.class);

 

    private static Directory directory; // 索引文件存放目錄對象

    private static IndexWriter indexWriter; // 索引寫對象,線程安全

    private static IndexReader indexReader; // 索引讀對象，線程安全

    private static IndexSearcher indexSearcher; // 索引搜索對象，線程安全

    private static Analyzer analyzer; // 分詞器對象

    public static IndexWriterConfig indexWriterConfig; // 索引配置

//    public static Version matchVersion; // 索引版本(Lucene4.0之前需要用到，4.0之后被取消)

    

static{

try {

     //初始化索引文件存放目錄對象

// directory =

// FSDirectory.open(Paths.get((String)PropertyUtil.getParamFromConfig("lucene.index.directory")));

directory = FSDirectory.open(Paths.get("E://index"));

// 虛擬機退出時關閉

Runtime.getRuntime().addShutdownHook(new Thread(){

@Override

public void run() {

LOGGER.info("--------Lucene釋放關閉資源中....");

try{

//釋放關閉資源

if(null!=indexWriter){

indexWriter.close();

}

if(null!=indexReader){

indexReader.close();

}

if(null!=directory){

directory.close();

}

if(null!=analyzer){

analyzer.close();

}

} catch (IOException e) {

e.printStackTrace();

}

LOGGER.info("--------Lucene釋放關閉資源成功....");

}

});

       

} catch (Exception e) {

       e.printStackTrace();

    }

}

    

/**

     *

     * @return 返回用於操作索引的對象

     * @throws IOException

     */

    public static IndexWriter getIndexWriter() throws IOException{

     if(null==indexWriter){

            // 初始化IK分詞器

            Analyzer analyzer = getAnalyzer();

            // 初始化索引的寫配置對象

            indexWriterConfig = new IndexWriterConfig(analyzer);

            // 初始化索引的寫對象

            indexWriter=new IndexWriter(directory, indexWriterConfig);

         }

         return indexWriter;

    }

    

    /**

     *

     * @return 返回用於操作索引的對象

     * @throws IOException

     */

    public static IndexReader getIndexReader() throws IOException{

     indexReader = DirectoryReader.open(directory);

        return indexReader;

    }

    

    /**

     *

     * @return 返回用於讀取索引的對象

     * @throws IOException

     */

    public static IndexSearcher getIndexSearcher() throws IOException{

        indexReader = DirectoryReader.open(directory);

        indexSearcher = new IndexSearcher(indexReader);

        return indexSearcher;

    }

    

    /**

     *

     * @return 返回用於讀取索引的對象

     * @throws IOException

     */

    public static IndexSearcher getIndexSearcher(Directory directory) throws IOException{

     indexReader = DirectoryReader.open(directory);

        indexSearcher = new IndexSearcher(indexReader);

        return indexSearcher;

    }

 

    /**

     *

     * @return 返回版本信息

     */

//    public static Version getMatchVersion() {

//        return matchVersion;

//    }

 

    /**

     *

     * @return 返回分詞器

     */

    public static Analyzer getAnalyzer() {

     // Lucene4以前的版本需要用到版本配置

     // matchVersion = Version.LUCENE_44;

     // 分詞器

     // analyzer = new StandardAnalyzer(); // 標准分詞

     if(analyzer == null) {

     System.out.println("創建新的分析器");

     analyzer = new IKAnalyzer();

     }

        return analyzer;

    }

    

    /**

     * 打印一個文檔的所有字段的內容

     * @param

     */

    public static void printDocument(Document document){

     //打印具體字段

     List<IndexableField> fieldList = document.getFields();

     //遍歷列表

     for (IndexableField field : fieldList){

     //打印出所有的字段的名字和值（必須存儲了的）

     LOGGER.info(field.name()+":"+field.stringValue());

     }

     //文檔詳情

     LOGGER.info(document.toString());

    }

 

    /**

     * 打印ScoreDoc

     * @param scoreDoc

     * @throws IOException

     */

    public static void printScoreDoc(ScoreDoc scoreDoc) throws IOException{

     //獲取文檔的編號（類似索引主鍵）

     int docId = scoreDoc.doc;

     LOGGER.info("======文檔編號："+docId);

     // 取出文檔得分

     LOGGER.info("得分： " + scoreDoc.score);

     //獲取具體文檔

     Document document = indexSearcher.doc(docId);

     //打印具體字段

     printDocument(document);

    }

 

    /**

     * 打印命中的文檔（帶得分）的詳情

     * @param topDocs

     */

    public static void printTopDocs(TopDocs topDocs) throws IOException {

     // 1)打印總記錄數（命中數）：類似於百度為您找到相關結果約100,000,000個

     long totalHits = topDocs.totalHits.value;

     LOGGER.info("查詢（命中）總的文檔條數："+totalHits);

//      LOGGER.info("查詢（命中）文檔最大分數："+topDocs.getMaxScore());

     //2)獲取指定的最大條數的、命中的查詢結果的文檔對象集合

     ScoreDoc[] scoreDocs = topDocs.scoreDocs;

     //打印具體文檔

     for (ScoreDoc scoreDoc : scoreDocs) {

     printScoreDoc(scoreDoc);

     }

    }

 

    public static void printTopDocsByQueryForHighlighter(Query query, int n) throws Exception{

 

       //=========1.創建一個高亮工具對象

       // 格式化器：參數1：前置標簽，參數2：后置標簽

       Formatter formatter = new SimpleHTMLFormatter("<em>", "</em>");

       //打分對象，參數：query里面的條件，條件里面有搜索關鍵詞

       Scorer fragmentScorer = new QueryScorer(query);

       //高亮工具

       //參數1.需要高亮什么顏色, 參數2.將哪些關鍵詞進行高亮

       Highlighter highlighter = new Highlighter(formatter, fragmentScorer);

       //=======搜索相關

       IndexSearcher indexSearcher = getIndexSearcher();

       // 搜索數據,兩個參數：查詢條件對象要查詢的最大結果條數

       // 返回的結果是 按照匹配度排名得分前N名的文檔信息（包含查詢到的總條數信息、所有符合條件的文檔的編號信息）

       TopDocs topDocs = indexSearcher.search(query, n);

       // 打印命中的總條數

//     LOGGER.info("本次搜索共" + topDocs.totalHits + "條數據,最高分："+topDocs.getMaxScore());

 

       // 獲取得分文檔對象（ScoreDoc）數組.SocreDoc中包含：文檔的編號、文檔的得分

       ScoreDoc[] scoreDocs = topDocs.scoreDocs;

 

       //循環

       for (ScoreDoc scoreDoc : scoreDocs) {

        // 取出文檔編號

        int docID = scoreDoc.doc;

        System.out.println("=========文檔的編號是："+docID);

        // 取出文檔得分

        System.out.println("當前文檔得分： " + scoreDoc.score);

        // 根據編號去找文檔

        Document document = indexSearcher.doc(docID);

        //獲取文檔的所有字段對象

        List<IndexableField> fieldList= document.getFields();

        //遍歷列表

        for (IndexableField field : fieldList) {

        String highlighterValue = highlighter.getBestFragment(getAnalyzer(), field.name(), field.stringValue());

        //如果沒有得到高亮的值

        if (null==highlighterValue) {

        //則讓高亮結果等不高亮的值

        highlighterValue = field.stringValue();

        }

        //打印出所有的字段的名字和值（必須存儲了的）

        LOGGER.info(field.name()+":"+highlighterValue);

        }

 

        }

    }

    

}