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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java截取中英文混合字符串的方法

    Java截取中英文混合字符串的方法

    这篇文章主要为大家详细介绍了Java截取中英文混合字符串的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-06-06
  • Java数据结构之List的使用总结

    Java数据结构之List的使用总结

    List是Java中比较常用的集合类,指一系列存储数据的接口和类,可以解决复杂的数据存储问题,本文就来拿实际案例总结介绍一下List的使用方法,感兴趣的朋友快来看看吧
    2021-11-11
  • java 对象数组排序

    java 对象数组排序

    当遇到数组排序时,我们经常会使用学过的几种排序方法,而java 本身提供了Arrays.sort,在数据元素较少或者对效率要求不是抬高时,直接使用Arrays.sort来的更容易。查看一下源码后Arrays.sort 本身采用的是快速排序。
    2015-04-04
  • java发送post请求使用multipart/form-data格式文件数据到接口代码示例

    java发送post请求使用multipart/form-data格式文件数据到接口代码示例

    这篇文章主要介绍了java发送post请求使用multipart/form-data格式文件数据到接口的相关资料,文中指定了数据编码格式为UTF-8,并强调了所需依赖工具类,需要的朋友可以参考下
    2024-12-12
  • Java运行时动态生成对象的方法小结

    Java运行时动态生成对象的方法小结

    Java是一门静态语言,通常,我们需要的class在编译的时候就已经生成了,为什么有时候我们还想在运行时动态生成class呢?今天通过本文给大家分享Java运行时动态生成对象的方法小结,需要的朋友参考下吧
    2021-08-08
  • Spring和MyBatis整合自动生成代码里面text类型遇到的坑

    Spring和MyBatis整合自动生成代码里面text类型遇到的坑

    Spring和MyBatis整合以后,使用自动生成代码工具生成dao和mapper配置文件。下面通过本文给大家介绍Spring和MyBatis整合自动生成代码里面text类型遇到的坑,需要的朋友参考下吧
    2018-01-01
  • 基于Springboot+Junit+Mockito做单元测试的示例

    基于Springboot+Junit+Mockito做单元测试的示例

    本篇文章主要介绍了基于Springboot+Junit+Mockito做单元测试的示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • SpringBoot如何统一JSON信息返回

    SpringBoot如何统一JSON信息返回

    这篇文章主要介绍了SpringBoot如何统一JSON信息返回问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Spring配置文件超详细讲解

    Spring配置文件超详细讲解

    这篇文章主要介绍了Spring配置文件超的相关资料,配置文件是一种存放应用程序或系统配置的文件,允许开发者和用户在不修改代码的情况下调整应用程序的行为和性能,
    2025-03-03
  • IDEA自动清理类中未使用的import包的操作方法

    IDEA自动清理类中未使用的import包的操作方法

    在项目开发中,经常会引入很多未使用的import包,这不仅增加了编译时间,还会使代码可读性变差,设置IDEA自动清理未使用的import包,可以提高代码的可读性,本文给大家介绍IDEA自动清理类中未使用的import包的方法,感兴趣的朋友一起看看吧
    2024-09-09

最新评论