使用JPA和Hibernate调用存储过程的最佳方法 - Vlad Mihalcea

19-02-17 banq
              

在本文中,您将学习使用JPA和Hibernate时调用存储过程的最佳方法,以便尽快释放底层JDBC资源。

我决定写这篇文章,因为Hibernate处理存储过程的方式会导致ORA-01000: maximum open cursors exceededOracle 上出现问题,如本Hibernate论坛帖子StackOverflow问题所述

存储过程调用如何与JPA和Hibernate一起使用

要使用JPA调用存储过程或数据库函数,可以使用StoredProcedureQuery如以下示例所示:

StoredProcedureQuery query = entityManager
.createStoredProcedureQuery("count_comments")
.registerStoredProcedureParameter(
    "postId", 
    Long.class, 
    ParameterMode.IN
)
.registerStoredProcedureParameter(
    "commentCount", 
    Long.class, 
    ParameterMode.OUT
)
.setParameter("postId", 1L);

query.execute();
Long commentCount = (Long) query
.getOutputParameterValue("commentCount");

在幕后,StoredProcedureQuery接口通过特定于Hibernate 的接口进行扩展ProcedureCall,因此我们可以像这样重写前面的示例:

ProcedureCall query = session
.createStoredProcedureCall("count_comments");

query.registerParameter(
    "postId", 
    Long.class, 
    ParameterMode.IN
)
.bindValue(1L);

query.registerParameter(
    "commentCount", 
    Long.class, 
    ParameterMode.OUT
);

Long commentCount = (Long) call
.getOutputs()
.getOutputParameterValue("commentCount");

在执行Hibernate的ProcedureCall的JPA的StoredProcedureQuery或outputs().getCurrent()时,Hibernate执行以下操作:

请注意,JDBC CallableStatement已准备好并存储在关联的ProcedureOutputsImpl对象中。在调用getOutputParameterValue方法时,Hibernate将使用底层CallableStatement来获取OUT参数。

因此,CallableStatement即使在执行存储过程并获取OUT或REF_CURSOR参数之后,底层JDBC 仍保持打开状态。

现在,默认情况下,CallableStatement在当前正在运行的数据库事务结束时将关闭,这是通过调用commit或rollback实现。

测试时间

要验证此行为,请考虑以下测试用例:

StoredProcedureQuery query = entityManager
.createStoredProcedureQuery("count_comments")
.registerStoredProcedureParameter(
    "postId", 
    Long.class, 
    ParameterMode.IN
)
.registerStoredProcedureParameter(
    "commentCount", 
    Long.class, 
    ParameterMode.OUT
)
.setParameter("postId", 1L);

query.execute();

Long commentCount = (Long) query
.getOutputParameterValue("commentCount");

assertEquals(Long.valueOf(2), commentCount);

ProcedureOutputs procedureOutputs = query
.unwrap(ProcedureOutputs.class);

CallableStatement callableStatement = ReflectionUtils
.getFieldValue(
    procedureOutputs, 
    "callableStatement"
);

assertFalse(callableStatement.isClosed());

procedureOutputs.release();

assertTrue(callableStatement.isClosed());

请注意,CallableStatement即使在调用execute或获取commentCount OUT参数后仍处于打开状态。只有调用完成后才释放ProcedureOutputs的对象时,CallableStatement也会封闭。

尽快关闭JDBC语句

因此,要CallableStatement尽快关闭JDBC ,在存储过程中获取所需的所有数据后调用release:

StoredProcedureQuery query = entityManager
.createStoredProcedureQuery("count_comments")
.registerStoredProcedureParameter(
    "postId", 
    Long.class, 
    ParameterMode.IN
)
.registerStoredProcedureParameter(
    "commentCount", 
    Long.class, 
    ParameterMode.OUT
)
.setParameter("postId", 1L);

try {
    query.execute();
    
    Long commentCount = (Long) query
    .getOutputParameterValue("commentCount");

    assertEquals(Long.valueOf(2), commentCount);
} finally {
    query.unwrap(ProcedureOutputs.class).release();
}

CallableStatement callableStatement = ReflectionUtils
.getFieldValue(
    query.unwrap(ProcedureOutputs.class), 
    "callableStatement"
);
assertTrue(callableStatement.isClosed());

在finally块中release的关联ProcedureOutputs对象上调用方法可确保CallableStatement无论存储过程调用的结果如何都关闭JDBC 。

现在,release手动调用有点乏味,所以我决定创建HHH-13215Jira问题,我将其集成到Hibernate ORM 6分支中。

因此,从Hibernate 6开始,您可以像这样重写前面的示例:

Long commentCount = doInJPA(entityManager -> {
    try(ProcedureCall query = entityManager
            .createStoredProcedureQuery("count_comments")
            .unwrap(ProcedureCall.class)) {
             
        return (Long) query
        .registerStoredProcedureParameter(
            "postId",
            Long.class,
            ParameterMode.IN
        )
        .registerStoredProcedureParameter(
            "commentCount",
            Long.class,
            ParameterMode.OUT
        )
        .setParameter("postId", 1L)
        .getOutputParameterValue("commentCount");
    }
});

好多了,对吧?

通过ProcedureCall扩展接口AutoClosable,我们可以使用try-with-resource Java语句,因此在解除分配JDBC资源时,调用数据库存储过程会更简洁,更直观。

结论

在CallableStatement使用JPA和Hibernate调用存储过程时,尽快释放底层JDBC 非常重要,否则,数据库游标将一直打开,直到提交或回滚当前事务为止。

因此,从Hibernate ORM 6开始,您应该使用try-finally块。同时,对于Hibernate 5和4,CallableStatement在完成获取所需的所有数据后,应该使用try-finally块关闭右侧。