孙卫琴的《精通JPA与Hibernate》的读书笔记: JPQL和QBC查询的绑定参数

1. JPQL的参数绑定

1.1 按参数名字绑定

在JPQL查询语句中定义命名参数，命名参数以“:”开头，形式如下：

TypedQuery<Customer> query=entityManager.createQuery(
      "from Customer as c where c.name=:customerName "
      +"and c.age=:customerAge",Customer.class);

以上JPQL查询语句定义了两个命名参数“customerName”和“customerAge”。接下来调用Query的setParameter()方法来绑定参数：

query.setParameter("customerName",name);
query.setParameter("customerAge",age);

Query的setParameter()方法能够绑定各种数据类型的命名参数。该方法的第一个参数代表命名参数的名字，第二个参数代表命名参数的值。

在SQL语句中，如果字符串中包含单引号，应该采用重复单引号的形式，例如：

update CUSTOMERS set NAME='''Tom' where ID=1;

以上update语句把NAME字段的值改为：'Tom

1.2 按参数位置绑定

在JPQL查询语句中用“?”来定义参数的位置，形式如下：

TypedQuery<Customer> query=entityManager.createQuery(
        "from Customer as c where c.name=?1 "
        +"and c.age=?2 ",Customer.class);

以上JPQL查询语句定义了两个参数，第一个参数的位置为1，第二个参数的位置为2。接下来调用Query的setParameter()方法来绑定参数：

`query.setParameter(1,name);
query.setParameter(2,age);

Query的setParameter()方法的第1个参数代表JPQL查询语句中参数的位置，第2个参数代表JPQL查询语句中参数的值。

比较按名字绑定和按位置绑定这两种绑定参数的形式，按名字绑定方式有以下优势：

• 使程序代码有较好的可读性。
• 按名字绑定方式有利于程序代码的维护，而对于按位置绑定方式，如果参数在JPQL查询语句中的位置改变了，就必须修改相关绑定参数的代码，这削弱了程序代码的健壮性和可维护性。例如以下程序代码交换了name和age参数的位置，那么Query的setParameter()方法的参数也要进行相应的调整：

TypedQuery<Customer> query=entityManager.createQuery(
   "from Customer as c where c.age=?1 "
   +"and c.name=?2 ",Customer.class);
query.setParameter(2,name);
query.setParameter(1,age);

• 按名字绑定方式允许一个参数在JPQL查询语句中出现多次，例如：

from Customer as c 
where c.name like :stringMode and c.email like :stringMode

由此可见，应该优先考虑使用按名字绑定方式。

2．通过QBC定义命名参数

CriteriaBuilder接口的parameter()方法用来定义一个命名参数，该方法返回一个ParameterExpression对象，表示命名参数：

CriteriaQuery<Customer> criteriaQuery =
      criteriaBuilder.createQuery( Customer.class );    
Root<Customer> root = criteriaQuery.from(Customer.class );

criteriaQuery.select(root);  

//定义命名参数
ParameterExpression<String> customerNameParameter=
    criteriaBuilder.parameter(String.class,"customerName");

//设置查询条件
Predicate predicate=criteriaBuilder.equal(root.get("name"),
                                            customerNameParameter);
criteriaQuery.where(predicate);  

List<Customer> result=entityManager
       .createQuery(criteriaQuery);
       .setParameter("customerName","Mike") //绑定参数
       .getResultList();
以上程序代码也可以按照方法链编程风格简写为：
CriteriaQuery<Customer> criteriaQuery =
      criteriaBuilder.createQuery( Customer.class );    
Root<Customer> root = criteriaQuery.from(Customer.class );

List<Customer> result= entityManager.createQuery(
   criteriaQuery
      .select(root)
      .where(
         criteriaBuilder.equal(
           root.get("name"),
           criteriaBuilder.parameter(String.class,"customerName"))
        )
     ).setParameter("customerName","Mike") //绑定参数
       .getResultList();