使用 getOne 和 findOne 方法时 Spring Data JPA

TL;博士

T findOne(ID id)（旧 API 中的名称）/Optional<T> findById(ID id)（新 API 中的名称）依赖于执行实体预加载的 EntityManager.find()。

T getOne(ID id) 依赖于执行实体延迟加载的 EntityManager.getReference()。所以为了保证实体的有效加载，需要对其调用方法。

findOne()/findById() 确实比 getOne() 更清晰、更易于使用。
因此，在大多数情况下，findOne()/findById() 优于 getOne()。

API 变更

至少从 2.0 版本开始，Spring-Data-Jpa 修改了 findOne()。
以前，它在 CrudRepository 接口中定义为：

T findOne(ID primaryKey);

现在，您将在 CrudRepository 中找到的单个 findOne() 方法是在 QueryByExampleExecutor 接口中定义为：

<S extends T> Optional<S> findOne(Example<S> example);

这最终由 CrudRepository 接口的默认实现 SimpleJpaRepository 实现。
此方法是按示例搜索的查询，您不希望将其作为替换。

实际上，具有相同行为的方法仍然存在于新 API 中，但方法名称已更改。
在 CrudRepository 接口中将其从 findOne() 重命名为 findById() ：

Optional<T> findById(ID id); 

现在它返回一个 Optional。防止 NullPointerException 并不是那么糟糕。

因此，现在实际的选择是在 Optional<T> findById(ID id) 和 T getOne(ID id) 之间。

两种不同的方法，它们依赖于两种不同的 JPA EntityManager 检索方法

1) Optional<T> findById(ID id) javadoc 声明它：

通过 id 检索实体。

当我们研究实现时，我们可以看到它依赖于 EntityManager.find() 来进行检索：

public Optional<T> findById(ID id) {

    Assert.notNull(id, ID_MUST_NOT_BE_NULL);

    Class<T> domainType = getDomainClass();

    if (metadata == null) {
        return Optional.ofNullable(em.find(domainType, id));
    }

    LockModeType type = metadata.getLockModeType();

    Map<String, Object> hints = getQueryHints().withFetchGraphs(em).asMap();

    return Optional.ofNullable(type == null ? em.find(domainType, id, hints) : em.find(domainType, id, type, hints));
}

这里 em.find() 是一个 EntityManager 方法，声明为：

public <T> T find(Class<T> entityClass, Object primaryKey,
                  Map<String, Object> properties);

它的 javadoc 状态：

通过主键查找，使用指定的属性

因此，检索加载的实体似乎是意料之中的。

2）虽然 T getOne(ID id) javadoc 状态（重点是我的）：

返回对具有给定标识符的实体的引用。

事实上，reference 术语确实是板子，JPA API 没有指定任何 getOne() 方法。
因此，了解 Spring 包装器所做的最好的事情是研究实现：

@Override
public T getOne(ID id) {
    Assert.notNull(id, ID_MUST_NOT_BE_NULL);
    return em.getReference(getDomainClass(), id);
}

这里 em.getReference() 是一个 EntityManager 方法，声明为：

public <T> T getReference(Class<T> entityClass,
                              Object primaryKey);

幸运的是，EntityManager javadoc 更好地定义了它的意图（重点是我的）：

获取一个实例，其状态可能会被延迟获取。如果请求的实例在数据库中不存在，则在第一次访问实例状态时抛出 EntityNotFoundException。 （当调用 getReference 时，允许持久性提供程序运行时抛出 EntityNotFoundException。）应用程序不应期望实例状态在分离时可用，除非它在实体管理器打开时由应用程序访问。

因此，调用 getOne() 可能会返回一个延迟获取的实体。
这里，延迟获取不是指实体的关系，而是实体本身。

这意味着如果我们调用 getOne() 然后关闭 Persistence 上下文，实体可能永远不会加载，因此结果确实是不可预测的。
例如，如果代理对象被序列化，您可以获得 null引用作为序列化结果或者如果在代理对象上调用方法，则会抛出 LazyInitializationException 等异常。
因此在这种情况下，EntityNotFoundException 的抛出是使用 {1 的主要原因} 来处理数据库中不存在的实例，因为当实体不存在时，可能永远不会执行错误情况。

在任何情况下，为了确保它的加载，您必须在会话打开时操作实体。您可以通过调用实体上的任何方法来实现。
或者更好的替代方法是使用 findById(ID id) 代替。

为什么 API 这么不清楚？

最后，向 Spring-Data-JPA 开发人员提出两个问题：

为什么没有更清晰的 getOne() 文档？实体延迟加载真的不是一个细节。

为什么需要引入 getOne() 来包装 EM.getReference() ？为什么不简单地坚持包装方法 :getReference() ？这个 EM 方法真的很特别，而 getOne() 传达了一个如此简单的处理。

---

基本区别在于 getOne 是延迟加载的，而 findOne 不是。

考虑以下示例：

public static String NON_EXISTING_ID = -1;
...
MyEntity getEnt = myEntityRepository.getOne(NON_EXISTING_ID);
MyEntity findEnt = myEntityRepository.findOne(NON_EXISTING_ID);

if(findEnt != null) {
     findEnt.getText(); // findEnt is null - this code is not executed
}

if(getEnt != null) {
     getEnt.getText(); // Throws exception - no data found, BUT getEnt is not null!!!
}

---

1、为什么getOne(id)方法会失败？

请参阅本节 in the docs。您覆盖已经存在的事务可能会导致问题。但是，如果没有更多信息，这很难回答。

2. 什么时候应该使用 getOne(id) 方法？

如果不深入研究 Spring Data JPA 的内部结构，不同之处似乎在于用于检索实体的机制。

如果您查看 另请参阅 下的 getOne(ID) 的 JavaDoc：

See Also:
EntityManager.getReference(Class, Object)

似乎这个方法只是委托给 JPA 实体管理器的实现。

但是，findOne(ID) 的 docs 没有提及这一点。

线索也在存储库的名称中。 JpaRepository 是特定于 JPA 的，因此可以在需要时将调用委托给实体管理器。 CrudRepository 与所使用的持久性技术无关。 Look here。它用作 JPA、Neo4J 等多种持久性技术的标记接口。

因此，对于您的用例，这两种方法并没有真正的“区别”，只是 findOne(ID) 比更专业的 getOne(ID) 更通用。您使用哪一个取决于您和您的项目，但我个人会坚持使用 findOne(ID)，因为它使您的代码的实现不那么具体，并为将来迁移到 MongoDB 等事物打开了大门，而无需进行太多重构 :)

---

getOne 方法仅返回来自 DB 的引用（延迟加载）。所以基本上你在事务之外（不考虑你在服务类中声明的Transactional），并且发生错误。

---

从上面的答案中，我真的觉得很难。从调试的角度来看，我几乎花了 8 个小时才知道这个愚蠢的错误。

我正在测试 spring+hibernate+dozer+Mysql 项目。要清楚。

我有用户实体，图书实体。你做映射的计算。

多本书是否与一个用户绑定。但在 UserServiceImpl 我试图通过 getOne(userId); 找到它

public UserDTO getById(int userId) throws Exception {

    final User user = userDao.getOne(userId);

    if (user == null) {
        throw new ServiceException("User not found", HttpStatus.NOT_FOUND);
    }
    userDto = mapEntityToDto.transformBO(user, UserDTO.class);

    return userDto;
}

剩下的结果是

{
"collection": {
    "version": "1.0",
    "data": {
        "id": 1,
        "name": "TEST_ME",
        "bookList": null
    },
    "error": null,
    "statusCode": 200
},
"booleanStatus": null

}

上面的代码没有获取用户阅读的书籍。

由于 getOne(ID)，bookList 始终为空。更改为 findOne(ID) 后。结果是

{
"collection": {
    "version": "1.0",
    "data": {
        "id": 0,
        "name": "Annama",
        "bookList": [
            {
                "id": 2,
                "book_no": "The karma of searching",
            }
        ]
    },
    "error": null,
    "statusCode": 200
},
"booleanStatus": null

}

---

虽然 spring.jpa.open-in-view 为 true，但我对 getOne 没有任何问题，但将其设置为 false 后，我得到了 LazyInitializationException。然后通过替换 findById 解决了问题。尽管有另一种解决方案而不替换 getOne 方法，那就是将 @Transactional 放在调用 repository.getOne(id) 的方法中。这样，事务将存在，会话不会在您的方法中关闭，并且在使用实体时不会出现任何 LazyInitializationException。

---

我在理解为什么 JpaRespository.getOne(id) 不起作用并引发错误时遇到了类似的问题。

我去更改为 JpaRespository.findById(id) ，它要求您返回一个 Optional。

这可能是我对 StackOverflow 的第一条评论。

---