如何使用 Hibernate (EntityManager) 或 JPA 调用 Oracle 函数或过程

Posted 2023-02-26

【中文标题】如何使用 Hibernate (EntityManager) 或 JPA 调用 Oracle 函数或过程

【英文标题】：How to call Oracle Function or Procedure using Hibernate (EntityManager) or JPA

【发布时间】：2012-12-29 10:41:37

【问题描述】：

我有一个返回 sys-refcursor 的 Oracle 函数，当我使用 Hibernate 调用此函数时，出现以下异常。

Hibernate:  ? = call my_function(?) 
 org.hibernate.exception.GenericJDBCException: could not execute query
javax.persistence.PersistenceException: org.hibernate.exception.GenericJDBCException: could not execute query
    at org.hibernate.ejb.AbstractEntityManagerImpl.convert(AbstractEntityManagerImpl.java:1360)
    at org.hibernate.ejb.AbstractEntityManagerImpl.convert(AbstractEntityManagerImpl.java:1288)
    at org.hibernate.ejb.QueryImpl.getSingleResult(QueryImpl.java:313)

我该如何解决这个问题？

Oracle 函数

create or replace 
FUNCTION my_function(p_val IN varchar2)
    RETURN SYS_REFCURSOR
  AS
    my_cursor SYS_REFCURSOR;
  BEGIN
    OPEN my_cursor FOR SELECT emp_name FROM employees
    WHERE lower(emp_name) like lower(p_val||'%');
    RETURN my_cursor;    
  END;

我的实体类

@Entity
@javax.persistence.NamedNativeQuery(name = "getFunc", query = 
" ? = call my_function(:empName) ", 
 resultClass = Employee.class, hints = 
  @javax.persistence.QueryHint(name = "org.hibernate.callable", value = "true") )
 @Table(name = "EMPLOYEES")

在 DAO 中

    @Override
        public void findEmployees(QueryData data,
                String empName) 

        List query = (List) entityManager.createNamedQuery("getFunc")
                         .setParameter("empName", empName)
                         .getSingleResult();
                data.setResult(query);

【问题讨论】：

命名查询与存储过程不同。我不确定你能不能按照你的提议去做。

@duffymo 那么使用 Hibernate 4，调用数据库函数的最佳方式是什么？

类似这样的东西：***.com/questions/4524841/…

【参考方案1】：

可以通过以下方式使用EntityManager调用Oracle函数或存储过程。

对于 Oracle 函数

创建一个以 sys_refcursor 作为返回类型的函数

CREATE OR REPLACE FUNCTION my_function
(p_val IN varchar2)
    RETURN SYS_REFCURSOR
  AS
    my_cursor SYS_REFCURSOR;
  BEGIN
    OPEN my_cursor FOR SELECT emp_name FROM employees
    WHERE lower(emp_name) like lower(p_val||'%');
    RETURN my_cursor;    
  END;

在Entity类中，定义函数为

@javax.persistence.NamedNativeQuery(name = "getFunc", query = "? =  call
my_function(:empName) ", resultClass = Employee.class, hints = 
@javax.persistence.QueryHint(name = "org.hibernate.callable", value = "true") )

对于 Oracle 存储过程

使用sys_refcursor 作为第一个 OUT 参数创建过程

CREATE OR REPLACE PROCEDURE myProcedure(p_cursor out sys_refcursor,
     p_val  in varchar2
)
 AS
BEGIN
     OPEN o_cursor FOR
          SELECT     emp_name 
             FROM     employees 
            WHERE     LOWER (emp_name) LIKE lower(p_val||'%');

在实体类中定义过程为

@javax.persistence.NamedNativeQuery(name = "getProc", query = " call
my_procedure(?,:empName) ", resultClass = Employee.class, hints = 
@javax.persistence.QueryHint(name = "org.hibernate.callable", value = "true") )

最后在DAO类中调用函数或过程为

Query query = entityManager.createNamedQuery("getFunc"); // if procedure then getProc 
query.setParameter("empName","smith"); 
query.getResultList(); 

谢谢

【讨论】：

JPA 2.1 为存储过程引入了更好的支持（例如，不止一个输出参数）。更多详情请见JPA 2.1 Stored Procedures

@Jacob 嘿，我在调用函数时遇到 Invalid Column Index 异常。是什么原因？

@FaizanMubasher 我的估计是用代码 sn-p 发布一个问题来分析而不是评论。

你是对的！但是后来我遇到了这个问题：***.com/questions/54017772/…

【参考方案2】：

为了你的功能，

create or replace 
FUNCTION my_function(p_val IN varchar2)
    RETURN SYS_REFCURSOR
  AS
    my_cursor SYS_REFCURSOR;
  BEGIN
    OPEN my_cursor FOR SELECT emp_name FROM employees
    WHERE lower(emp_name) like lower(p_val||'%');
    RETURN my_cursor;    
  END;

您可以定义以下NamedNativeQuery：

@NamedNativeQuery(
    name = "my_function",
    query = " ? = call my_function( ? ) ",
    callable = true,
    resultClass = String.class
)

而且，您可以这样调用查询：

List<String> employeeNames = entityManager
    .createNamedQuery("my_function")
    .setParameter(1, 1L)
    .getResultList();

对于存储过程：

CREATE OR REPLACE 
PROCEDURE my_procedure(p_val IN VARCHAR2, 
    my_cursor OUT SYS_REFCURSOR,
) 
AS
BEGIN
    OPEN my_cursor FOR
    SELECT emp_name FROM employees
    WHERE lower(emp_name) like lower(p_val||'%');
END;

，您可以使用以下 JPA 2.1 查询：

StoredProcedureQuery query = entityManager
    .createStoredProcedureQuery("my_procedure")
    .registerStoredProcedureParameter(1, String.class, 
         ParameterMode.IN)
    .registerStoredProcedureParameter(2, Class.class, 
         ParameterMode.REF_CURSOR)
    .setParameter(1, 1L);
 
query.execute();
 
List<Object[]> result = query.getResultList();

【参考方案3】：

流程：

CREATE OR REPLACE PROCEDURE my_procedure(p_val IN VARCHAR2, 
  my_cursor OUT SYS_REFCURSOR) 
AS
BEGIN
  OPEN my_cursor FOR SELECT emp_name FROM employees 
      WHERE lower(emp_name) like lower(p_val||'%');
END;

替代解决方案：使用 sys_refcursor 作为 OUT 参数调用过程而不定义 @NamedNativeQuery

StoredProcedureQuery query = entityManager.createStoredProcedureQuery("myProcedure");
    query.registerStoredProcedureParameter(1, void.class, ParameterMode.REF_CURSOR);
    query.registerStoredProcedureParameter(2, String.class, ParameterMode.IN);
    query.setParameter(2, "Umesh");
    List result = query.getResultList();

【讨论】：

使用 JPQL 和 Native SQL 查询 JPA 实体：oracle.com/technetwork/articles/vasiliev-jpql-087123.html

【参考方案4】：

您似乎将 Oracle 函数与 Oracle 存储过程混淆了。

可以从 select 语句中调用函数 - 像您这样的用户定义函数的行为方式与内置函数（如 min() 和 max()）相同。它们不能像存储过程那样被外部“调用”调用。

函数的定义见http://docs.oracle.com/cd/B19306_01/server.102/b14200/functions231.htm#i1012049。

您可能需要将函数重写为存储过程。

【讨论】：

是的，你是对的，我可以使用像 select my_function('smith') from dual 这样的 select 语句来调用函数。使用 Hibernate 4 EntityManager 如何调用此函数或选择语句以获得所需的结果？谢谢

根据您的功能，您似乎需要将其设为存储过程而不是函数。

Here 正在调用 pl/sql 函数，但不使用 EntityManager。这是如何实现的？

嗯 - 好吧，我会发誓这是不可能的。我个人在这里没有答案。

GreyBeardedGeek 我已经设法使用 EntityManager(Hibernate 4) 调用 Oracle 函数或过程，请参阅我的答案。无论如何谢谢。

【参考方案5】：

JPA 2.1 早期草案声明将支持存储过程，来自 Oracle 的 according to Arun Gupta。

对存储过程的支持：向 Java Persistence 查询语言添加了对调用预定义数据库函数和用户定义数据库函数的支持。

EntityManager.createXXXStoredProcedureQuery 方法有多种变体，它们返回用于执行存储过程的 StoredProcedureQuery。就像@NamedQuery 一样，@NamedStoredProcedureQuery 指定并命名了一个存储过程、它的参数和它的结果类型。可以在实体或映射的超类上指定此注释。然后在EntityManager.createNamedStoredProcedureQuery 中使用注释中指定的名称。 IN、OUT 和 INOUT 参数可以设置并用于检索从过程传回的值。例如：

@Entity
@NamedStoredProcedureQuery(name="topGiftsStoredProcedure", procedureName="Top10Gifts")
public class Product 
 . . .


// In your client

StoredProcedreQuery query = EntityManager.createNamedStoredProcedureQuery("topGiftsStoredProcedure");
query.registerStoredProcedureParameter(1, String.class, ParameterMode.INOUT);
query.setParameter(1, "top10");
query.registerStoredProcedureParameter(2, Integer.class, ParameterMode.IN);
query.setParameter(2, 100);
// there are other setParameter methods for defining the temporal type of a parameter
. . .
query.execute();
String response = query.getOutputParameterValue(1);

至于规范何时最终确定，或者 Hibernate 何时支持 JPA 2.1，我不能说。但这可能值得关注。

【讨论】：

一个问题，我用的是Oracle函数，可以用@NamedStoredProcedureQuery吗？

规范是这么说的，但它可能会在现在和最终版本之间发生变化（在撰写本文时，Hibernate 尚未实现 JPA 2.1，但似乎 like they are working on it ）。

prunge 我已经设法使用 EntityManager(Hibernate 4) 调用 Oracle 函数或过程，请参阅我的答案。无论如何谢谢。

JPA 2.1 为存储过程引入了更好的支持（例如，不止一个输出参数）。详情请见JPA 2.1 Stored Procedures

【参考方案6】：

以前的解决方案似乎不适用于 eclipselink。我使用

在 JPA 下运行本机查询

            List result = em.createNativeQuery("select YOURFUNCTION(?) from dual ")
                      .setParameter(1, ONEPARAMETER)
                      .getResultList();

【讨论】：

是的，您也许是对的，它不适用于 EclipseLink。我用 Hibernate 试过了。

如果你使用的是Eclipselink，试试this，寻找With Multiple Parameters (IN and OUT)