Spring Data JPA 从入门到精通~@Procedure 储存过程的查询方法

我们通过 @Procedure 来介绍一下，JPA 对储存过程的支持。

（1）@Procedure 源码如下：

public @interface Procedure {
   // 数据库里面储存过程的名称
   String value() default "";
   // 数据库里面储存过程的名称
   String procedureName() default "";
   //在EntityManager中的名字，NamedStoredProcedureQuery使用
   String name() default "";
   //输出参数的名字
   String outputParameterName() default "";
}

（2）首先创建一个储存过程名字叫 plus1inout 有两个参数、两个结果。

CREATE PROCEDURE plus1inout(IN arg int, OUT res int)
BEGIN
 SELECT (arg+10) into res;
END

（3）我们可以使用 @NamedStoredProcedureQueries 注释来调用存储过程，这个必须定义在一个实体上面。

@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 {
   //这个是一个Procedure实体类，可以通过NamedStoredProcedureQueries在这个类里面定义多个储存过程的查询。
}

关键要点：

• 存储过程使用了注释 @NamedStoredProcedureQuery，并绑定到一个 JPA 表；
• procedureName 是存储过程的名字；
• name 是 JPA 中的存储过程的名字；
• 使用注释 @StoredProcedureParameter 来定义存储过程使用的 IN/OUT 参数。

（4）直接通过自定义过的 Repository 完成储存过程的调用。

public interface MyUserRepository extends CrudRepository<User, Long> {
@Procedure("plus1inout")//通过储存过程的名字
Integer explicitlyNamedPlus1inout(Integer arg);
@Procedure(procedureName = "plus1inout")//通过储存过程的名字
Integer plus1inout(Integer arg);
@Procedure(name = "User.plus1IO")//自定义的储存过程的名字
Integer entityAnnotatedCustomNamedProcedurePlus1IO(@Param("arg") Integer arg);
}

关键要点：

• @Procedure 的 procedureName 参数必须匹配 @NamedStoredProcedureQuery 的 procedureName。
• @Procedure 的 name 参数必须匹配 @NamedStoredProcedureQuery 的 name。
• @Param 必须匹配 @StoredProcedureParameter 注释的 name 参数。
• 返回类型必须匹配：in_only_test存储过程返回是 void，in_and_out_test存储过程必须返回 String。