Springboot集成Elasticsearch的步骤与相关功能

 更新时间:2021年12月14日 10:53:55   作者:zyqok  
ElasticSearch是开源搜索平台领域的一个新成员, ElasticSearch是一个基于Lucene构建的开源,分布式,RESTful搜索引擎,这篇文章主要给大家介绍了关于Springboot集成Elasticsearch的相关资料,需要的朋友可以参考下

集成配置步骤

步骤1:加入 Maven 相关依赖

<!-- 指定 Springboot 版本 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.7</version>
    <relativePath/>
</parent>
 
<!-- 相关jar包 -->
<dependencies>
    <!-- SpringBoot核心jar包 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <!-- web开发包:包含Tomcat和Springmvc -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- ES 核心包 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-elasticsearch</artifactId>
    </dependency>
    <!-- lombok 实体简化插件 -->
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

步骤2:配置 elasticsearch 的主机和端口

elasticsearch:
  host: 127.0.0.1
  port: 9200

步骤3:配置 Elaseticsearch 客户端

@Data
@Configuration
@ConfigurationProperties(prefix = "elasticsearch")
public class ElasticSearchConfig extends AbstractElasticsearchConfiguration {
 
    private String host;
    private Integer port;
 
    @Override
    public RestHighLevelClient elasticsearchClient() {
        return new RestHighLevelClient(RestClient.builder(new HttpHost(host, port)));
    }
 
}

步骤4:创建文档实体

@Data
@Document(indexName = "users")
public class User {
 
    @Id
    @Field(type = FieldType.Long)
    private Long id;
 
    @Field(type = FieldType.Text)
    private String name;
 
    @Field(type = FieldType.Keyword)
    private String sex;
 
    @Field(type = FieldType.Integer)
    private Integer age;
 
    @Field(type = FieldType.Text)
    private String address;
 
}

步骤5:创建 controller,service, dao 层

(5.1)contrller 层

@RestController
@RequestMapping("/user")
public class UserController {
 
    @Autowired
    private UserService userService;
 
}

(5.2)service 层

public interface UserService {
 
}

(5.3)service 实现层(UserDao 见 5.4)

@Service
public class UserServiceImpl implements UserService {
 
    @Autowired
    private UserDao userDao;
 
}

(5.4)dao 层

@Repository
public interface UserDao extends ElasticsearchRepository<User, Long> {
 
}

整个相关类创建完成后,项目结构应该如下图所示:

相关功能实现

这里以实际功能举例,并列出 controller 和 service 层的实现类写法作为参考。

主流的一些功能,ES 已经给你封装,默认给与了支持(如:示例1-6),这些相关的实现不需要我们再写 dao 层,但一些较为业务性的查询,还需要自己手动来写。

1. 添加文档

controller 层:

@PostMapping("/save")
public String save(@RequestBody User user) {
    long id = System.currentTimeMillis();
    user.setId(id);
    userService.save(user);
    return "新增成功,id为:" + id;
}

service 层:

@Override
public Long save(User user) {
    userDao.save(user);
    return user.getId();
}

测试效果:

 2. 修改文档

【注】新增文档和修改文档操作,dao 层都是调用的 save() 方法,当 id 不存在的时候,ES(ElasticSearch)就会执行新增操作,当 id 对象已经存在的时候,就会执行修改操作。

controller 层:

@PostMapping("/update")
public String update(@RequestBody User user) {
    userService.save(user);
    return "修改成功";
}

service 层:

@Override
public Long save(User user) {
    userDao.save(user);
    return user.getId();
}

测试效果:

 3. 根据ID查询文档

controller 层:

@GetMapping("/{id}")
public User getById(@PathVariable("id") Long id) {
    return userService.getById(id);
}

service 层:

@Override
public User getById(Long id) {
    Optional<User> find = userDao.findById(id);
    if (find.isPresent()) {
        return find.get();
    }
    return null;
}

测试效果:

 4. 根据ID删除文档

controller 层:

@DeleteMapping("/{id}")
public String deleteById(@PathVariable("id") Long id) {
    userService.deleteById(id);
    return "删除成功";
}

service 层:

@Override
public void deleteById(Long id) {
    userDao.deleteById(id);
}

测试效果:

 5. 查询所有文档

controller 层:

@GetMapping("/all")
public List<User> all() {
    return userService.getAll();
}

service 层:

@Override
public List<User> getAll() {
    Iterable<User> users = userDao.findAll();
    if (users == null) {
        return Collections.emptyList();
    }
    List<User> userList = new ArrayList<User>();
    users.forEach(o -> userList.add(o));
    return userList;
}

测试效果:

 6. 条件查询(单个条件)

如:查询name包含"玛丽"的数据

controller 层:

@GetMapping("/listByName")
public List<User> listByName(String name) {
    return userService.getListByName(name);
}

service 层:

@Override
public List<User> getListByName(String name) {
    return userDao.findByName(name);
}

dao 层:测试效果:

 7. 条件查询(多条件)

如:查询 name包含"玛丽",年龄为25的数据。

controller 层:

@GetMapping("/listByNameAndAge")
public List<User> listByNameAndAge(String name, Integer age) {
    return userService.getListByNameAndAge(name, age);
}

service 层:

@Override
public List<User> getListByNameAndAge(String name, Integer age) {
    return userDao.findByNameAndAge(name, age);
}

dao 层:

List<User> findByNameAndAge(String name, Integer age);

 8. 分页查询(降序)

controller 层:

@GetMapping("/listOrderByAgeDesc")
public List<User> listOrderByAgeDesc() {
    return userService.getListOrderByAgeDesc();
}

service 层:

@Override
public List<User> getListOrderByAgeDesc() {
    return userDao.findByOrderByAgeDesc();
}

dao 层:

List<User> findByOrderByAgeDesc();

测试效果:

 9. 分页查询(升序)

 controller 层:

@GetMapping("/listOrderByAgeAsc")
public List<User> listOrderByAgeAsc() {
    return userService.getListOrderByAgeAsc();
}

service 层:

@Override
public List<User> getListOrderByAgeAsc() {
    return userDao.findByOrderByAgeAsc();
}

dao 层:

List<User> findByOrderByAgeAsc();

测试效果:

 10. 分页查询

controller 层:

@GetMapping("/page")
public Page<User> page(Integer pageNum, Integer pageSize) {
    return userService.getPage(pageNum, pageSize);
}

service 层:

@Override
public Page<User> getPage(int pageNum, int pageSize) {
    // 注意,这里的pageNum是从0开始的,如果要查询第1页数据,pageNum应该为0
    Pageable pageable = PageRequest.of(pageNum, pageSize);
    return userDao.findAll(pageable);
}

测试效果:

 11. 范围查询( > )

controller 层:

@GetMapping("/listGreaterThanAge")
public List<User> listGreaterThanAge(Integer age) {
    return userService.getListGreaterThanAge(age);
}

service 层:

@Override
public List<User> getListGreaterThanAge(Integer age) {
    return userDao.findByAgeGreaterThan(age);
}

dao 层:

List<User> findByAgeGreaterThan(Integer age);

测试效果:

12. 范围查询( >= ) 

controller 层:

@GetMapping("/listGreaterThanEqualAge")
public List<User> listGreaterThanEqualAge(Integer age) {
    return userService.getListGreaterThanEqualAge(age);
}

service 层:

@Override
public List<User> getListGreaterThanEqualAge(Integer age) {
    return userDao.findByAgeGreaterThanEqual(age);
}

dao 层:

List<User> findByAgeGreaterThanEqual(Integer age);

测试效果:

 13. 范围查询( < )

controller 层:

@GetMapping("/listLessThanAge")
public List<User> listLessThanAge(Integer age) {
    return userService.getListLessThanAge(age);
}

service 层:

@Override
public List<User> getListLessThanAge(Integer age) {
    return userDao.findByAgeLessThan(age);
}

dao 层:

List<User> findByAgeLessThan(Integer age);

测试效果:

 14. 范围查询( <= )

controller 层:

@GetMapping("/listLessThanEqualAge")
public List<User> listLessThanEqualAge(Integer age) {
    return userService.getListLessThanEqualAge(age);
}

service 层:

@Override
public List<User> getListLessThanEqualAge(Integer age) {
    return userDao.findByAgeLessThanEqual(age);
}

dao 层:

List<User> findByAgeLessThanEqual(Integer age);

测试效果:

附:ElasticSearch中对索引的一些常用操作

1. 获取Elasticsearch中所有的index:

curl -XGET 'localhost:9200/_cat/indices?v&pretty'

2. 获取某索引下所有的type:

获取elasticsearch索引下所有的type定义

curl -XGET 'localhost:9200/elasticsearch/_mapping'

3. 删除索引:

删除elasticsearch1索引

curl -XDELETE 'localhost:9200/elasticsearch1?pretty'

4. 删除某索引下的某type数据:

删除索引elasticsearch下的article类型

curl -XDELETE 'http://localhost:9200/elasticsearch/article/'

5. 查看某索引的某type下所有的数据:

查找elasticsearch索引中所有的类型为Company的数据

http://localhost:9200/elasticsearch/Company/_search

总结

到此这篇关于Springboot集成Elasticsearch的文章就介绍到这了,更多相关Springboot集成Elasticsearch内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 解析Mybatis Porxy动态代理和sql解析替换问题

    解析Mybatis Porxy动态代理和sql解析替换问题

    这篇文章主要介绍了Mybatis Porxy动态代理和sql解析替换,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • @DubboService注解使用以及应用场景和示例代码

    @DubboService注解使用以及应用场景和示例代码

    文章详细介绍了Dubbo框架中@DubboService注解的使用,包括其核心定义、属性详解、应用场景及示例代码,该注解用于简化Dubbo服务的暴露配置,支持灵活的服务属性配置,并提供了多种服务治理功能
    2026-02-02
  • springboot使用过滤器详解

    springboot使用过滤器详解

    本文主要介绍了过滤器的基本概念,过滤器的生命周期,以及如何通过注解方式和非注解方式实现过滤器,过滤器是客户端与服务器资源文件之间的一道过滤网,能够帮助我们过滤不符合要求的请求,通常用作Session校验
    2024-10-10
  • 基于批处理脚本bat打造一个高效Java版本切换工具

    基于批处理脚本bat打造一个高效Java版本切换工具

    本文介绍了作者开发的一款用于Windows系统多Java版本自动化管理的批处理工具,该工具具备自动扫描JDK目录、智能识别版本号、权限管理、双重设置、清理重复路径、实时验证等功能,需要的朋友可以参考下
    2026-01-01
  • java process.waitfor返回1的原因及解决

    java process.waitfor返回1的原因及解决

    这篇文章主要介绍了java process.waitfor返回1的原因及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • spring boot集成smart-doc自动生成接口文档详解

    spring boot集成smart-doc自动生成接口文档详解

    这篇文章主要介绍了spring boot集成smart-doc自动生成接口文档详解,smart-doc是一款同时支持java restful api和Apache Dubbo rpc接口文档生成的工具,smart-doc颠覆了传统类似swagger这种大量采用注解侵入来生成文档的实现方法
    2022-09-09
  • SpringSecurity导致SpringBoot跨域失效的问题解决

    SpringSecurity导致SpringBoot跨域失效的问题解决

    本文主要介绍了SpringSecurity导致SpringBoot跨域失效的问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • 一次Spring无法启动的问题排查实战之字节码篇

    一次Spring无法启动的问题排查实战之字节码篇

    最近学习了spring相关知识,公司项目也用到了spring,下面这篇文章主要给大家介绍了一次Spring无法启动的问题排查实战之字节码篇的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2022-04-04
  • 详解Java中log4j.properties配置与加载应用

    详解Java中log4j.properties配置与加载应用

    这篇文章主要介绍了 log4j.properties配置与加载应用的相关资料,需要的朋友可以参考下
    2018-02-02
  • Java用邻接矩阵存储图的示例代码

    Java用邻接矩阵存储图的示例代码

    邻接矩阵通常采用一个一维数组存储图中节点的信息,采用一个二维数组存储图中节点之间的邻接关系。本文将利用Java实现用邻接矩阵存储图,需要的可以参考一下
    2022-06-06

最新评论