springboot集成Lucene的详细指南

2025-05-04 17:50

本文主要是介绍springboot集成Lucene的详细指南,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《springboot集成Lucene的详细指南》这篇文章主要为大家详细介绍了springboot集成Lucene的详细指南,文中的示例代码讲解详细,具有一定的借鉴价值,感兴趣的小伙伴可以跟随小编一起...

以下是 Spring Boot 集成 Lucene 的详细步骤:

添加依赖

在 Spring Boot 项目的 pom.XML 文件中添加 Lucene 的依赖,常用的核心依赖和中文分词器依赖如下:

<dependency>
    <groupId>org.apache.lucene</groupId>
    <artifactId>lucene-core</artifactId>
    <version>8.11.0</version>
</dependency>
<dependency>
    <groupId>org.apache.lucene</groupId>
    <artifactId>lucene-analyzers-common</artifactId>
    <version>8.11.0</version>
</dependency>
<dependency>
    <groupId>org.wltea</groupId>
    <artifactId>ik-analyzer</artifactId>
    <version>20200623</version>
</dependency>

创建配置类

创建一个配置类,对 Lucene 的相关组件进行配置,如索引目录、分词器等:

import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.standard.StandardAnalyzer;
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.FSDirectory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import Java.nio.file.Paths;
 
@Configuration
public class LuceneConfig {
 
    private final String indexPath = "indexDir"; // 索引存储路径
 
    @Bean
    public Directory directory() throws Exception {
        return FSDirectory.open(Paths.get(indexPath));
    }
 
    @Bean
    public Analyzer analyzer() {
        return new StandardAnalyzer(); // 可替换为其他分词器,如 IKAnalyzer
    }
}

创建实体类

根据实际需求创建一个实体类,用于表示要索引的文档对象,例如:

public class Book {
    private String id;
    private String title;
    private String author;
    private String content;
    // 省略getter、setter等方法
}

创建索引服务类

创建一个服务类,用于处理索引相关的操作,如创建索引、添加文档、删除文档等:

import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.document.TextField;
import org.apache.lucene.index.*;
import org.apache.lucene.search.*;
import org.apache.lucene.store.Directory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
 
@Service
public class LuceneIndexService {
 
    @Autowired
    private Directory directory;
 
    @Autowired
    private Analyzer analyzer;
 
    // 创建索引
    public void createIndex(List<Book> bookList) throws IOException {
        IndexWriterConfig config = new IndexWriterConfig(analyzer);
        IndexWriter writer = China编程new IndexWriter(directorypython, config);
        for (Book book : bookList) {
            Document doc = new Document();
            doc.add(new TextField("id", book.getId(), Field.Store.YES));
            doc.add(new TextField("title", book.getTitle(), Field.Store.YES));
            doc.add(new TextField("author", book.getAuthor(), Field.Store.YES));
            doc.add(new TextField("content", book.getContent(), Field.Store.YES));
            writer.addDocument(doc);
        }
        writer.close();
    }
 
    // 添加文档到索引
    public void addDocument(Book book) throws IOException {
        IndexWriterConfig config = new IndexWriterConfig(analyzer);
        IndexWriter writer = new IndexWriter(directory, config);
        Document doc = new Document();
        doc.add(new TextField("id", book.getId(), Field.Store.YES));
        doc.add(new TextField("title", book.getTitle(), Field.Store.YES));
        doc.add(new TextField("author", book.getAuthor(), Field.Store.YES));
        doc.add(new TextField("content", book.getContent(), Field.Store.YES));
        writer.addDocument(doc);
        writer.close();
    }
 
    // 删除文档
    public void deleteDocument(String id) throws IOException {
        IndexWriterConfig config = new IndexWriterConfig(analyzer);
        IndexWriter writer = new IndexWriter(directory, config);
        writer.deleteDocuments(new Term(DppdpICOqi"id", id));
        writer.forceMergeDeletes();
        writer.close();
    }
}

创建搜索服务类

创建一个服务类,用于处理搜索相关的操作,如简单搜索、高亮搜索等:

import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.document.Document;
import org.apache.lucene.index.DirectoryReader;
import org.apache.lucene.queryparser.classic.QueryParser;
import org.apache.lucene.search.*;
import org.apache.lucene.search.highlight.*;
import org.apache.lucene.store.Directory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
 
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
 
@Service
public class LuceneSearchService {
 
    @Autowired
    private Directory directory;
 
    @Autowired
    private Analyzer analyzer;
 
    // 简单搜索
    public List<Document> search(String queryStr) throws Exception {
        DirectoryReader reader = DirectoryReader.open(directory);
        IndexSearcher searcher = new IndexSearcher(reader);
        QueryParser parser = new QueryParser("content", analyzer);
        Query query = parser.parse(queryStr);
        TopDocs results = searcher.search(query, 10);
        List<Document> docs = new ArrayList<>();
        for (ScoreDoc scoreDoc : results.scoreDocs) {
            docs.add(searcher.doc(scoreDoc.doc));
        }
        reader.close();
        return docs;
    }
 
    // 高亮搜索
    public List<Map<String, String>> searchWithHighlight(String queryStr) throws Exception {
        DirectoryReader reader = DirectoryReader.open(directory);
        IndexSearcher searcher = new IndexSearcher(reader);
        QueryParser parser = new QueryParser("content", analyzer);
        Query query = parser.parse(queryStr);
        TopDocs results = searcher.search(query, 10);
        List<Map<String, String>> docs = new ArrayList<>();
 
        SimplehtmlFormatter htmlFormatter = new SimpleHTMLFormatter("<span style='color:red'>", "</span>");
        Highlighter highlighter = new Highlighter(htmlFormatter, new QueryScorer(query));
 
        for (ScoreDoc scoreDoc : results.scoreDocs) {
            Document doc = searcher.doc(scoreDoc.doc);
            String content = doc.get("content");
            TokenStream tokenStream = analyzer.tokenStream("content", new StringReader(content));
            String highlightedText = highlighter.getBestFragment(tokenStream, content);
 
            Map<String, String> docMap = new HashMap<>();
            docMap.put("id", doc.get("id"));
            docMap.put("title", doc.get("title"));
            docMap.put("author", doc.get("author"));
            docMap.www.chinasem.cnput("content", highlightedText != null ? highlightedText : content);
            docs.add(docMap);
        }
        reader.close();
        return docs;
    }
}

创建控制器类

创建一个控制器类,用于处理 HTTP 请求,并调用相应的服务类方法:

impoandroidrt org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
 
import java.io.IOException;
import java.util.List;
import java.util.Map;
 
@RestController
@RequestMapping("/search")
public class SearchController {
 
    @Autowired
    private LuceneIndexService luceneIndexService;
 
    @Autowired
    private LuceneSearchService luceneSearchService;
 
    // 创建索引
    @PostMapping("/index")
    public String createIndex(@RequestBody List<Book> bookList) {
        try {
            luceneIndexService.createIndex(bookList);
            return "索引创建成功";
        } catch (IOException e) {
            e.printStackTrace();
            return "索引创建失败";
        }
    }
 
    // 搜索结果
    @GetMapping
    public List<Document> search(@RequestParam String query) {
        try {
            return luceneSearchService.search(query);
        } catch (Exception e) {
            e.printStackTrace();
            return new ArrayList<>();
        }
    }
 
    // 高亮搜索
    @GetMapping("/highlight")
    public List<Map<String, String>> searchWithHighlight(@RequestParam String query) {
        try {
            return luceneSearchService.searchWithHighlight(query);
        } catch (Exception e) {
            e.printStackTrace();
            return new ArrayList<>();
        }
    }
}

使用示例

此外,还可以根据实际需求对上述代码进行扩展和优化,例如添加更复杂的查询条件、实现分页功能、优化索引的性能等。

创建索引 :启动 Spring Boot 应用后,发送一个 POST 请求到http://localhost:8080/search/index,请求体中包含要索引的图书列表,如:

[
    {
        "id": "1",
        "title": " Lucene in Action ",
        "author": "Robert Muir",
        "content": "Lucene is a search library from Apache"
    },
    {
        "id": "2",
        "title": " Java编程思想 ",
        "author": "Bruce Eckel",
        "content": "Java is a programming language"
    }
]

简单搜索 :发送一个 GET 请求到http://localhost:8080/search/?query=Java,即可搜索出与“Java”相关的文档。

高亮搜索 :发送一个 GET 请求到http://localhost:8080/search/highlight/?query=Java,即可搜索出与“Java”相关的文档,并且搜索结果中的“Java”会以高亮显示。

到此这篇关于springboot集成Lucene的详细指南的文章就介绍到这了,更多相关springboot集成Lucene内容请搜索编程China编程(www.chinasem.cn)以前的文章或继续浏览下面的相关文章希望大家以后多多支持China编程(www.chinasem.cn)!

这篇关于springboot集成Lucene的详细指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154481

相关文章

Java调用Python的四种方法小结

《Java调用Python的四种方法小结》在现代开发中,结合不同编程语言的优势往往能达到事半功倍的效果,本文将详细介绍四种在Java中调用Python的方法,并推荐一种最常用且实用的方法,希望对大家有... 目录一、在Java类中直接执行python语句二、在Java中直接调用Python脚本三、使用Run

Java根据IP地址实现归属地获取

《Java根据IP地址实现归属地获取》Ip2region是一个离线IP地址定位库和IP定位数据管理框架,这篇文章主要为大家详细介绍了Java如何使用Ip2region实现根据IP地址获取归属地,感兴趣... 目录一、使用Ip2region离线获取1、Ip2region简介2、导包3、下编程载xdb文件4、J

浅析如何使用xstream实现javaBean与xml互转

《浅析如何使用xstream实现javaBean与xml互转》XStream是一个用于将Java对象与XML之间进行转换的库,它非常简单易用,下面将详细介绍如何使用XStream实现JavaBean与... 目录1. 引入依赖2. 定义 JavaBean3. JavaBean 转 XML4. XML 转 J

Flutter实现文字镂空效果的详细步骤

《Flutter实现文字镂空效果的详细步骤》:本文主要介绍如何使用Flutter实现文字镂空效果,包括创建基础应用结构、实现自定义绘制器、构建UI界面以及实现颜色选择按钮等步骤,并详细解析了混合模... 目录引言实现原理开始实现步骤1:创建基础应用结构步骤2:创建主屏幕步骤3:实现自定义绘制器步骤4:构建U

SpringBoot中四种AOP实战应用场景及代码实现

《SpringBoot中四种AOP实战应用场景及代码实现》面向切面编程(AOP)是Spring框架的核心功能之一,它通过预编译和运行期动态代理实现程序功能的统一维护,在SpringBoot应用中,AO... 目录引言场景一:日志记录与性能监控业务需求实现方案使用示例扩展:MDC实现请求跟踪场景二:权限控制与

Android开发环境配置避坑指南

《Android开发环境配置避坑指南》本文主要介绍了Android开发环境配置过程中遇到的问题及解决方案,包括VPN注意事项、工具版本统一、Gerrit邮箱配置、Git拉取和提交代码、MergevsR... 目录网络环境:VPN 注意事项工具版本统一:android Studio & JDKGerrit的邮

Java NoClassDefFoundError运行时错误分析解决

《JavaNoClassDefFoundError运行时错误分析解决》在Java开发中,NoClassDefFoundError是一种常见的运行时错误,它通常表明Java虚拟机在尝试加载一个类时未能... 目录前言一、问题分析二、报错原因三、解决思路检查类路径配置检查依赖库检查类文件调试类加载器问题四、常见

Java注解之超越Javadoc的元数据利器详解

《Java注解之超越Javadoc的元数据利器详解》本文将深入探讨Java注解的定义、类型、内置注解、自定义注解、保留策略、实际应用场景及最佳实践,无论是初学者还是资深开发者,都能通过本文了解如何利用... 目录什么是注解?注解的类型内置注编程解自定义注解注解的保留策略实际用例最佳实践总结在 Java 编程

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》:本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景:在controller编写的接口,在前后端交互过程中一般都会涉及