JPA/JPQL中如何用对象替代@Query的单个@Param参数？

当然可以这么做，Spring Data JPA完全支持通过传入自定义对象、引用对象属性的方式编写@Query查询，这种方式在参数较多时能大幅简化代码，避免方法参数列表过长。

实现步骤与示例 #

1. 定义参数对象
   创建包含所有查询参数的自定义类，确保每个参数都有对应的getter方法（Spring Data JPA会通过getter读取属性值）：

   public class SomeCustomObject {
       private String param1;
       private String param2;
       // 其余18个查询参数...
   
       // 必须提供getter方法
       public String getParam1() {
           return param1;
       }
   
       public String getParam2() {
           return param2;
       }
   
       // 其余参数的getter...
   }
   

2. 编写Repository的@Query方法
   在Repository接口中，用@Param注解指定参数对象的名称，然后在JPQL语句中通过对象名.属性名的方式引用参数：

   public interface DBTABLERepository extends JpaRepository<DBTABLE, Long> {
       @Query(value = "SELECT v FROM DBTABLE v WHERE v.param1 = :queryObj.param1 AND v.param2 = :queryObj.param2")
       List<DBTABLE> search(@Param("queryObj") SomeCustomObject queryObj);
   }
   

原生SQL的写法 #

如果需要使用原生SQL查询，只需开启nativeQuery=true，注意字段名要对应数据库表的实际列名：

@Query(value = "SELECT * FROM DBTABLE v WHERE v.param1 = :queryObj.param1 AND v.param2 = :queryObj.param2", nativeQuery = true)
List<DBTABLE> searchNative(@Param("queryObj") SomeCustomObject queryObj);

注意事项 #

• @Param注解的名称必须和JPQL/SQL中引用的对象名完全一致（比如示例中的queryObj）
• 参数对象的属性必须有对应的getter方法，Spring无法直接访问私有属性
• 若实体类属性与数据库列名不一致，JPQL中使用实体类属性名，原生SQL中使用数据库列名

内容的提问来源于stack exchange，提问作者sander