Spring data jpa 调用存储过程处理返回参数及结果集

一、环境

1.此随笔内容基于spring boot整合的spring data jpa项目，

2.数据库为mysql 5.7.9版本

二、内容

1. 新建存储过程 pro_query_object

BEGIN

       #Routine body goes here...a_theme_code varchar(10),out num int

 select o.obj_code,o.obj_name,o.obj_id from qt_object o where o.theme_code=a_theme_code;

select count(*) into num from qt_object o where o.theme_code=a_theme_code GROUP BY o.theme_code;

END

　　

2. 新建实体，首先把我们需要返回的结果集的实体字段定义好，然后加上@NamedStoredProcedureQueries 注解绑定存储过程

• @Entity
  @NamedStoredProcedureQueries({
          //管理列表
          @NamedStoredProcedureQuery(name = "pro_general_list", procedureName = "pro_general_list",
                  resultClasses = { QtObject.class },
                  parameters = {
                          @StoredProcedureParameter(mode = ParameterMode.IN, name = "a_theme_code", type = String.class),
                          @StoredProcedureParameter(mode = ParameterMode.OUT, name = "num", type = Integer.class)  // 记录满足条件的总条数
                   }),
  })
  public class QtObject {
      @Id
      @Column(name = "obj_id")
      private String objId;
      private String obj_code;
      private String obj_name;
  // 此处省略get、set
  }
  

  　　

  此处：

• @NamedStoredProcedureQueries 内可写多个存储过程，使用“,”隔开；
• @NamedStoredProcedureQuery中procedureName参数是数据库中存储过程的名字；
• name参数是JPA中的存储过程的名字；resultClasses参数是返回结果集绑定的实体名称（处理结果集重要参数）；
• parameters 中使用@StoredProcedureParameter来定义存储过程使用的IN、OUT参数。

3.完成实体后，我们在编写调用方法

///  调用存储过程

public StoredProcedureQuery callStore(String themeCode) {

    StoredProcedureQuery store = this.entityManager.createNamedStoredProcedureQuery("pro_general_list");
      store.setParameter("a_theme_code", themeCode);
      store.execute();

    return store;

}

　　

调用存储过程时，需要先注入实体管理器EntityManager，调用其中的 createNamedStoredProcedureQuery方法，传入jpa 的存储过程名称，然后只需要传入in 参数，执行之后返回StoredProcedureQuery对象。

4. 结果处理

public ResultInfo queryInitGeneral(String themeCode) {

    ResultInfo<List> resultInfo = new ResultInfo<List>();

        StoredProcedureQuery storedProcedureQuery= callStore(start_date, end_date,themeCode,deptCode,obj_name,start_num,end_num);

        Integer nums = (Integer)storedProcedureQuery.getOutputParameterValue("num");

        resultInfo.setRows(storedProcedureQuery.getResultList());

        resultInfo.setTotal(nums);

        resultInfo.setResult(1);

        resultInfo.setMsg("查询成功！");

    return resultInfo;

}

　　

在调用过程中，使用StoredProcedureQuery中的getResultList()方法可以返回存储过程执行之后的结果集（此处的结果集是一个，多个还未实验）；
然后使用storedProcedureQuery的 getOutputParameterValue() 方法可以返回out 参数