JPA - FindByExample

Question

有没有人有一个很好的例子来说明如何在JPA中执行findByExample,它将通过任何实体类型的反射在泛型DAO中工作？我知道我可以通过我的提供商(Hibernate)来做,但我不想打破中立......

似乎标准API可能是要走的路......但我不知道如何处理它的反射部分.

Answer 1

实际上,查询示例(QBE)已被考虑包含在JPA 2.0规范中,但不包括在内,即使主要供应商支持它.引用Mike Keith:

我很遗憾地说我们实际上没有在JPA 2.0中做QBE.Criteria API没有任何特殊的运算符,因此实体相等就像JP QL一样,基于PK值.对不起,但希望我们在下一轮比赛中能在这方面取得更大的成功.目前,它是每个供应商支持的供应商功能之一,但尚未在规范中.

为了以防万一,我为下面的主要供应商添加了(非通用的)示例代码以用于文档目的.

的EclipseLink

以下是在EclipseLink JPA 2.0参考实现中使用QBE的示例:

// Create a native EclipseLink query using QBE policy
QueryByExamplePolicy policy = new QueryByExamplePolicy();
policy.excludeDefaultPrimitiveValues();
ReadObjectQuery q = new ReadObjectQuery(sampleEmployee, policy);

// Wrap the native query in a standard JPA Query and execute it 
Query query = JpaHelper.createQuery(q, em); 
return query.getSingleResult(); 

OpenJPA的

OpenJPA通过其扩展OpenJPAQueryBuilder接口支持这种查询方式:

CriteriaQuery<Employee> q = cb.createQuery(Employee.class);

Employee example = new Employee();
example.setSalary(10000);
example.setRating(1);

q.where(cb.qbe(q.from(Employee.class), example);

过冬

使用Hibernate的Criteria API:

// get the native hibernate session
Session session = (Session) getEntityManager().getDelegate();
// create an example from our customer, exclude all zero valued numeric properties 
Example customerExample = Example.create(customer).excludeZeroes();
// create criteria based on the customer example
Criteria criteria = session.createCriteria(Customer.class).add(customerExample);
// perform the query
criteria.list();

现在,尽管应该可以通过JPA 2.0 Criteria API和反射以供应商中立的方式实现一些接近的东西,但我真的很想知道它是否值得付出努力.我的意思是,如果您将上述任何代码段设为通用代码并将代码放入DAO方法中,则在需要时可以很容易地从一个供应商切换到另一个供应商.我同意这不理想,但仍然.

参考

• 那JPA书中的findByExample怎么样？
• JPA 2.0中的动态,类型安全查询

Answer 2

这是相当粗糙的,我不相信这是一个好主意.但无论如何,让我们尝试使用JPA-2.0标准API实现QBE.

首先定义一个可持久的接口:

public interface Persistable {
    public <T extends Persistable> Class<T> getPersistableClass();
}

该getPersistableClass()方法是在那里,因为DAO将需要一流的,我找不到更好的办法说T.getClass()以后.您的模型类将实现Persistable:

public class Foo implements Persistable {
    private String name;
    private Integer payload;

    @SuppressWarnings("unchecked")
    @Override
    public <T extends Persistable> Class<T> getPersistableClass() {
        return (Class<T>) getClass();
    }
}

然后你的DAO可以有一个findByExample(Persistable example)方法(EDITED):

public class CustomDao {
    @PersistenceContext
    private EntityManager em;

    public <T extends Persistable> List<T> findByExample(T example) throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, SecurityException, NoSuchMethodException {
        Class<T> clazz = example.getPersistableClass();
        CriteriaBuilder cb = em.getCriteriaBuilder();
        CriteriaQuery<T> cq = cb.createQuery(clazz);
        Root<T> r = cq.from(clazz);
        Predicate p = cb.conjunction();
        Metamodel mm = em.getMetamodel();
        EntityType<T> et = mm.entity(clazz);
        Set<Attribute<? super T, ?>> attrs = et.getAttributes();
        for (Attribute<? super T, ?> a: attrs) {
            String name = a.getName();
            String javaName = a.getJavaMember().getName();
            String getter = "get" + javaName.substring(0,1).toUpperCase() + javaName.substring(1);
            Method m = cl.getMethod(getter, (Class<?>[]) null);
            if (m.invoke(example, (Object[]) null) !=  null)
                p = cb.and(p, cb.equal(r.get(name), m.invoke(example, (Object[]) null)));
        }
        cq.select(r).where(p);
        TypedQuery<T> query = em.createQuery(cq);
        return query.getResultList();
    }

这很难看.它假设getter方法可以从字段名称派生(这可能是安全的,例如应该是Java Bean),在循环中进行字符串操作,并且可能抛出一堆异常.这种方法中的大多数笨拙都围绕着我们重新发明轮子的事实.也许有一种更好的方法来重新发明轮子,但也许这就是我们应该承认失败并采用上面Pascal列出的方法之一.对于Hibernate,这会简化接口:

public interface Persistable {}

而DAO方法几乎失去了所有的重量和笨重:

@SuppressWarnings("unchecked")
public <T extends Persistable> List<T> findByExample(T example) {       
    Session session = (Session) em.getDelegate();
    Example ex = Example.create(example);
    Criteria c = session.createCriteria(example.getClass()).add(ex);
    return c.list();
}

编辑:那么以下测试应该成功:

@Test
@Transactional
public void testFindFoo() {
    em.persist(new Foo("one",1));
    em.persist(new Foo("two",2));

    Foo foo = new Foo();
    foo.setName("one");
    List<Foo> l = dao.findByExample(foo);
    Assert.assertNotNull(l);
    Assert.assertEquals(1, l.size());
    Foo bar = l.get(0);
    Assert.assertNotNull(bar);
    Assert.assertEquals(Integer.valueOf(1), bar.getPayload());      
}

Answer 3

Criteria API 是您最好的选择。不过，您需要一个 JPA-2.0 提供程序。因此，如果您有这样的实体：

@Entity
public class Foo {
    @Size(max = 20)
    private String name;
}

以下单元测试应该成功（我使用 EclipseLink 对其进行了测试，但它应该适用于任何 JPA-2.0 提供程序）：

@PersistenceContext
private EntityManager em;

@Test
@Transactional
public void testFoo(){
    Foo foo = new Foo();
    foo.setName("one");
    em.persist(foo);
    CriteriaBuilder cb = em.getCriteriaBuilder();
    CriteriaQuery<Foo> c = cb.createQuery(Foo.class);
    Root<Foo> f = c.from(Foo.class);
    c.select(f).where(cb.equal(f.get("name"), "one"));
    TypedQuery<Foo> query = em.createQuery(c);
    Foo bar = query.getSingleResult();
    Assert.assertEquals("one", bar.getName());
}

另外，您可能需要点击此处引用的教程的链接。