使用 JpaRepository .findById() 方法获取请求和错误处理 [重复]

Question

所以我正在尝试学习 Spring Boot 和 Rest API 的各种资源，我在几个不同的教程和教科书中遇到了同样的问题。它似乎源于 CrudRepository 接口，更具体地说是 JpaRepository.findById() 方法。

我读过的每个教程都有以下内容：

@GetMapping("/{id}")
    public ResponseEntity<UserDTO> getUserById(@PathVariable("id") final Long id){
        UserDTO user = userJpaRepository.findById(id);
        if (user == null) {
            return new ResponseEntity<UserDTO>(
                    new CustomErrorType("User with id " + id + " not found"),
                    HttpStatus.NOT_FOUND);
        }
        return new ResponseEntity<UserDTO>(user, HttpStatus.OK);

但是， UserDTO user = userJpaRepository.findById(id); 不会编译。

我想如果我将其更改为UserDTO user = userJpaRepository.findById(id).get();，它会编译、运行并且 GET 成功。问题是如果在 GET 请求中找不到用户 ID，它不会返回 NULL，并且我会收到 500 内部服务器错误。

来自我的 IDE 的工具提示和建议将代码更正为

@GetMapping("/{id}")
    public ResponseEntity<UserDTO> getUserById(@PathVariable("id") final Long id){
        Optional<UserDTO> user = userJpaRepository.findById(id);
        if (user == null) {
            return new ResponseEntity<UserDTO>(
                    new CustomErrorType("User with id " + id + " not found"),
                    HttpStatus.NOT_FOUND);
        }
        return new ResponseEntity<UserDTO>(HttpStatus.OK);
    }

这与 GET 请求和错误处理一样有效。为什么所有教程都以第一种方式列出？ 有人可以向我解释这里发生了什么吗？

Answer 1

JpaRepository.getById 可以通过 id 检索数据库记录。 该方法是预定义的，与findAll 方法相同。 提到的方法CrudRepository.findById 继承自祖先类CrudRepository。它返回一个Optional<T>因为 spring-data 迁移到 Java 8（从 Spring-Data-Jpa 2.0 版开始）。

查看更多： Spring Data JPA findOne() change to Optional how to use this?

实现 JpaRepository 的查找方法

但是，如果您实现JpaRepository 并添加一个新的findByName 方法，这将依赖于JPA's Query Language (JPQL) 并隐式发出一个准备好的语句，如SELECT * FROM table WHERE name = ?。这里WHERE子句的谓词如name = ?是从方法名中提取和构建的，在By之后。

Optional 背后的理性回归

任何find 方法的默认返回都是Optional<T> 自Java 8（引入了Optional 类型）。 这是因为搜索可能会找到一些，也可能找不到。如果没有找到，返回Optional 而不是null 或抛出异常会更安全。 Optional 回报背后的主要好处和意图是：

• signal empty = 方法签名中的可选结果（而不是之前的隐式null）
• 强制 API 用户/开发者处理空返回
• 避免偶然的NullPointerExceptions (NPE)

---

更新以处理发现的空结果：

在 REST 控制器中处理 NOT FOUND

在 CRUD 资源上的结果为空或未找到的情况下响应的 RESTful 方式是：

• 返回 HTTP 状态 404 NOT FOUND 以及一些自定义/描述性错误消息。

这条“不愉快的道路”可以通过像Baeldung's REST exception-handling tutorial 中描述的那样抛出 Spring 的 ResponseStatusException 来轻松实现：

@GetMapping("/{id}")
public UserDTO getUserById(@PathVariable("id") final Long id) {
    Optional<UserDTO> user = userJpaRepository.findById(id);
    if (user.isEmpty()) {
        throw new ResponseStatusException(HttpStatus.NOT_FOUND, String.format("User with id %d not found", id));
    }

    return user;
}

简化的内容：

• 抛出 ResponseStatusException 会导致异常返回，并向 Spring 发出信号以指定状态 (404) 和正文（消息）进行响应。
• 控制器方法可以简单地返回 UserDTO 类型（无需包装在 ResponseEntity 中），因为 Spring 将转换为响应表示
• 对于@GetMapping，return 总是默认分配HttpStatus.OK

进一步，像Mauricio Gracia Gutierrez tutoring answer解释ideomatic Optional处理，方法体可以简化为单行：

return userJpaRepository.findById(id)
       .orElseThrow(() -> new ResponseStatusException(HttpStatus.NOT_FOUND, String.format("User with id %d not found", id)));

Answer 2

关于如何使用Optional 和Optional<T> findById(ID id) 的一些提示。

通常，当您通过 id 查找实体时，如果没有检索到，您希望返回它或进行特定处理。

以下是三个经典用法示例。

1. 假设如果找到实体，您想要获取它，否则您想要获取默认值。

你可以写：

Foo foo = repository.findById(id)
                    .orElse(new Foo());

或在有意义的情况下获取 null 默认值（与 API 更改之前的行为相同）：

Foo foo = repository.findById(id)
                    .orElse(null);

1. 假设如果实体被发现你想返回它，否则你想抛出一个异常。

你可以写：

return repository.findById(id)
        .orElseThrow(() -> new EntityNotFoundException(id));

1. 假设您想根据是否找到实体应用不同的处理（不一定抛出异常）。

你可以写：

Optional<Foo> fooOptional = fooRepository.findById(id);
if (fooOptional.isPresent()) {
    Foo foo = fooOptional.get();
    // processing with foo ...
} else {
    // alternative processing....
}

摘自 Spring Data JPA findOne() change to Optional how to use this?