存储过程

JPA 2.1 规范引入了对使用 JPA 条件查询 API 调用存储过程的支持。我们引入了用于在存储库方法上声明存储过程元数据的注释。@Procedurespring-doc.cn

下面的示例使用以下存储过程：spring-doc.cn

示例 1.HSQL DB 中过程的定义。plus1inout

/;
DROP procedure IF EXISTS plus1inout
/;
CREATE procedure plus1inout (IN arg int, OUT res int)
BEGIN ATOMIC
 set res = arg + 1;
END
/;

可以通过对实体类型使用注释来配置存储过程的元数据。NamedStoredProcedureQueryspring-doc.cn

示例 2.实体上的 StoredProcedure 元数据定义。

@Entity
@NamedStoredProcedureQuery(name = "User.plus1", procedureName = "plus1inout", parameters = {
  @StoredProcedureParameter(mode = ParameterMode.IN, name = "arg", type = Integer.class),
  @StoredProcedureParameter(mode = ParameterMode.OUT, name = "res", type = Integer.class) })
public class User {}

请注意，存储过程有两个不同的名称。是 JPA 使用的名称。是存储过程在数据库中的名称。@NamedStoredProcedureQuerynameprocedureNamespring-doc.cn

您可以通过多种方式从存储库方法引用存储过程。要调用的存储过程可以使用注释的 or 属性直接定义。这直接引用数据库中的存储过程，并忽略通过 .valueprocedureName@Procedure@NamedStoredProcedureQueryspring-doc.cn

或者，您也可以将 attribute 指定为 attribute。如果未配置，则存储库方法的名称将用作属性。@NamedStoredProcedureQuery.name@Procedure.namevalueprocedureNamenamenamespring-doc.cn

下面的示例演示如何引用显式映射的过程：spring-doc.cn

例 3.引用数据库中名称为 “plus1inout” 的显式映射过程。

@Procedure("plus1inout")
Integer explicitlyNamedPlus1inout(Integer arg);

以下示例等效于上一个示例，但使用别名：procedureNamespring-doc.cn

示例 4.通过别名引用数据库中名称为 “plus1inout” 的隐式映射过程。procedureName

@Procedure(procedureName = "plus1inout")
Integer callPlus1InOut(Integer arg);

以下内容再次等效于前两个，但使用方法名称而不是显式 annotation 属性。spring-doc.cn

例 5.使用方法名称引用隐式映射的命名存储过程 “User.plus1”。EntityManager

@Procedure
Integer plus1inout(@Param("arg") Integer arg);

下面的示例演示如何通过引用属性来引用存储过程。@NamedStoredProcedureQuery.namespring-doc.cn

例 6.引用中显式映射的命名存储过程 “User.plus1IO”。EntityManager

@Procedure(name = "User.plus1IO")
Integer entityAnnotatedCustomNamedProcedurePlus1IO(@Param("arg") Integer arg);

如果被调用的存储过程具有单个 out 参数，则该参数可以作为方法的返回值返回。如果 annotation 中指定了多个 out 参数，则可以将这些参数作为 a 返回，键是 annotation 中给出的参数名称。@NamedStoredProcedureQueryMap@NamedStoredProcedureQueryspring-doc.cn

请注意，如果存储过程返回 a，则省略任何参数，因为 Java 只能返回单个方法返回值，除非该方法声明返回类型。ResultSetOUTMap

以下示例说明如果存储过程具有多个参数并注册为，如何获取多个参数。需要注册才能提供参数元数据。OUTOUT@NamedStoredProcedureQuery@NamedStoredProcedureQueryspring-doc.cn

例 7.实体上的 StoredProcedure 元数据定义。

@Entity
@NamedStoredProcedureQuery(name = "User.multiple_out_parameters", procedureName = "multiple_out_parameters", parameters = {
  @StoredProcedureParameter(mode = ParameterMode.IN, name = "arg", type = Integer.class),
  @StoredProcedureParameter(mode = ParameterMode.REF_CURSOR, name = "some_cursor", type = void.class),
  @StoredProcedureParameter(mode = ParameterMode.OUT, name = "res", type = Integer.class) })
public class User {}

例 8.返回多个 OUT 参数

@Procedure(name = "User.multiple_out_parameters")
Map<String, Object> returnsMultipleOutParameters(@Param("arg") Integer arg);