目录
集成配置步骤
步骤1:加入 Maven 相关依赖
步骤2:配置 elasticsearch 的主机和端口
步骤3:配置 Elaseticsearch 客户端
步骤4:创建文档实体
步骤5:创建 controller,service, dao 层
相关功能实现
1. 添加文档
?2. 修改文档
?3. 根据ID查询文档
?4. 根据ID删除文档
?5. 查询所有文档
6. 条件查询(单个条件)
?7. 条件查询(多条件)
?8. 分页查询(降序)
?9. 分页查询(升序)
?10. 分页查询
?11. 范围查询( > )
12. 范围查询( >= )?
?13. 范围查询( < )
?14. 范围查询( <= )
集成配置步骤
步骤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 层:
List<User> findByName(String name);
测试效果:
?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);
测试效果:
|