JPA的本地查询(native query)
JPA支持本地查询,所谓本地查询,就是使用原生的sql语句(根据数据库的不同,在sql的语法或结构方面可能有所区别)进行查询数据库的操作。
本地查询主要使用EntityManager接口里的方法:
public interface EntityManager {
public void persist(Object entity);
public <T> T find(Class <T> entityClass, Object primaryKey);
public <T> T getReference(Class <T> entityClass, Object primaryKey);
public <T> T merge(T entity);
public void remove(Object entity);
public void lock(Object entity, LockModeType lockMode);
public void refresh(Object entity);
public boolean contains(Object entity);
public void clear( );
public void joinTransaction( );
public void flush( );
public FlushModeType getFlushMode( );
public void setFlushMode(FlushModeType type);
public Query createQuery(String queryString);
public Query createNamedQuery(String name);
public Query createNativeQuery(String sqlString);
public Query createNativeQuery(String sqlString, String resultSetMapping);
public Query createNativeQuery(String sqlString, Class resultClass);
public Object getDelegate( );
public void close( );
public boolean isOpen( );
}
即 createNativeQuery方法的三种形式,但用这个方法的缺点是,要将查询的sql语句及返回结果集类型传递进去。还有一种方法是使用createNamedQuery,这样就可以避免在这里直接写入sql语句以及返回的结果集类型等参数,而可以在相关的Entity类里对这些信息进行配置。
//这里只是传递进去一个string值
Query q = em.createNamedQuery("ReturnOrderListWithFullScalarType");
//这里是设定在sql中所需的参数
q.setParameter(1, customer.getId());
//得到结果集
List orderList = q.getResultList();
这个查询主要是根据用户的id 来获取他名下的所有订单。所以,在实体类 Order中,加入相关的native query annotation.
@NamedNativeQueries
(
{
@NamedNativeQuery(
name="ReturnOrderListWithFullScalarType",
query="select o.id as order_id,o.create_date as order_creation_date,o.description as order_description,o.sum_price as order_sum_total,
c.name as customer_name,c.ctype as customer_type,c.id as customer_id from orders o join customer c on o.cust_id=c.id where o.cust_id=?1",
resultSetMapping="ReturnOrderListWithFullScalarType"),
。。。。。。。。。。。。。可能还有更多的本地查询设置
}
)
@NamedNativeQueries 如果在一个实体类中有多个NamedNativeQuery的话,必须使用该批注,并且将单个的NamedNativeQuery都作为NamedNativeQueries数组中的一个元素。
@NamedNativeQuery,在这里设置关于该本地查询的信息。name表示传递进EntityManager.createNamedQuery(“name”)的参数,query表示实施本地查询的sql语句,resultSetMapping表示返回结果集的映射方式。它的意思就是结果集将以哪种形式来保存。
接着,就要设置这个结果集的映射方式了。
@SqlResultSetMappings(
{
@SqlResultSetMapping
(
name="ReturnOrderListWithFullScalarType",
entities={},
columns=
{
@ColumnResult(name="order_id"),
@ColumnResult(name="order_creation_date"),
@ColumnResult(name="order_description"),
@ColumnResult(name="order_sum_total"),
@ColumnResult(name="customer_id"),
@ColumnResult(name="customer_name")
}
),
。。。。。。。。。。。。。可能还有更多的结果集映射设置
})
针对每一个本地查询的返回值,都有一个结果集和它映射。它可以返回
1. 实体(包括不同类型的实体,即多个实体) Entity
2. 标量值 Scalar
3. 实体与标量值的组合 Entity+Scalar
默认情况下,JPA假设原生sql查询中select语句将会:
1. 返回一个实体类型
2. 包含与返回的实体的所有字段或属性相对应的所有列,即列名和实体属性/字段名一样
3. 查询中没有用列名别名,column alias,即没有用 AS 指定别名
@SqlResultSetMappings,如果在一个实体类中有多个@NamedNativeQuery的话,必然就有多个结果集映射@SqlResultSetMapping。在这种情况下,必须使用该批注,并且将单个的SqlResultSetMapping都作为SqlResultSetMappings数组中的一个元素。
@SqlResultSetMapping,关于结果集映射的详细信息。
name 表示该结果集映射的名字,与@NamedNativeQuery中的resultSetMapping="ReturnOrderListWithFullScalarType"的值相对应。
entities表示查询结果集会被映射进实体,如果有就要将所有返回的实体一一列出(这里我们将结果集全部映射进标量,所以entities属性是个空数组)。
columns表示将被映射进标量的结果集中的各个列。
这里要说一下标量(Scalar)这个概念。在物理学上,标量与矢量(Vector)是相互对应的,矢量是既有方向又有大小的量,而标量是只有大小的量。在此处,Scalar的含义与物理学上的定义差不多,Scalar可以认为是一个没有属性/方法的单纯的常量(可以想象为java数据类型的primitive type),而与它相对的则是有方法/属性的对象(object type)。那么采用这种映射机制,我们从数据库取来的每一条记录的每一个字段,仅仅是被单纯的作为一个常量,保存在每一个columnResult中。
@ ColumnResult,就是指在sql语句中,将哪些查询的列保存进来。每一个@ColumnResult对应一个列,name="order_id" ,注意,如果在select的时候,用AS 制定了列的别名,“order_id” 则表示的是别名。
这种映射方式比较简单,我们可以推测,得到的结果集List中,数据会是这样:
[ {“列1”, “列2”, “列3”, …}, {“列1”, “列2”, “列3”, …}, …… ]
经过运行测试程序,得到了我们的推论
*****ReturnOrderListWithFullScalarType*****
52 2009-05-27 00:00:00.0 This is an order creation example. 36817.0 39 John Smith
55 2009-05-27 00:00:00.0 This is an order creation example. 3347.0 39 John Smith
……
将结果集全部映射进标量,是比较简单的一种做法,在SqlResultSetMapping的写法上也没有太多需要注意的地方。