JPA 设计模式系列一 DAO Pattern in JPA
作为JavaEE5 规范一部分的JPA,已经有众多的实现,比如:Hiberante,TopLink, EclipseLink和OpenJPA 等许多ORM框架。JPA不仅仅应用于EJB3中,你也可以应用EJB3之外的应用,比如Spring 中。甚至Gavin King Hiberante的作者 在Hiberante in Action 的第二版书中也推荐使用JPA。很明显,JPA将被广泛的应用。
一旦你熟悉annotation,并尝试过Hello world之类的程序后,你会感觉,恩 JPA确实不错。然后,当你在你的项目中开始应用JPA时,你会发现其实并不那么简单,你需要考虑如何处理事务,惰性加载,移除对象实例, 继承等等。这些问题会在本系列中给你答案。
首先进入第一的设计模式 DAO。
我们需要DAO吗?
在二年前,我们已经讨论了这个问题了,讨论的结果是:是否使用DAO依赖于你的应用,类似于GOF的设计模式,如果是很简单的应用程序,应用设计模式,只能增加你的复杂度。 而对于复杂应用程序,正因为其复杂,应用设计模式可以减低复杂度,提高可维护性。
应用了DAO我们可以得到如下好处:
1. 避免在任何存取数据的代码中引入EntityManager,减少了依赖。
2. 对某些实体Bean操作增加限制。比如你不想对LogEntry提供删除操作,应用DAO,你仅仅做的是不要在LogEntry DAO中不要添加remove的方法。
3. 理论上,应用DAO层,你一个自由切换其他的持久机制比如纯JDBC或者Ibatis.而实际上,JPA已经是一个抽象层,这种切 换是没有意义的。
4. 你可以在一个实体中集中所有的查询避免这些查询在其他代码中出现。你可以使用named queries 在实体类中查询,但是您仍然需要正确的参数被设置。对应这种查询,你可以在DAO中设置参数,然后转换成正确的返回类型,比如:
public List<ChangePlan> findExecutingChangePlans() {
Query query = entityManager.createQuery(
"SELECT plan FROM ChangePlan plan where plan.state = 'EXECUTING'");
return (List<ChangePlan>) query.getResultList();
}
然后,但你决定使用DAO时,如何正确合理的使用它呢? 在Spring的JpaTemplate的JavaDoc中建议,不要使用类似特殊的类,类似JpaDaoSupport。 而是你应该自己通过@PersistenceContext注释获取EntityManger来维护你的DAO。这种方式可以在EJB3的容器中工作,并且如果你在Spring的context 加入PersistenceAnnotationBeanpostProcessor Bean的话,在Spring2.0里也是没有问题的。
类型安全且泛化的DAO pattern
因为每一个DAO都包含一些相同的逻辑,所以我们应该抽取这些逻辑放入到父类中。
实体类
比如,我们想实例化OrderClass:
@Entity
@Table(name = "ORDERS")
public class Order {
@Id
@GeneratedValue
private int id;
private String customerName;
private Date date;
public int getId() { return id; }
public void setId(int id) { this.id = id; }
public String getCustomerName() { return customerName; }
public void setCustomerName(String customerName) { this.customerName = customerName; }
public Date getDate() { return date; }
public void setDate(Date date) { this.date = date;}
DAO 接口
首先我们定义一个泛化的DAO接口,包括最常用的方法,比如:
public interface Dao<K, E> {
void persist(E entity);
void remove(E entity);
E findById(K id);
}
K ,E为泛型,你可以加其他的方法比如:List findAll().
然后我们定义一个自接口,实现特殊的方法,比如,我们想查找一定条件的Order信息:
public interface OrderDao extends Dao<Integer, Order> {
List<Order> findOrdersSubmittedSince(Date date);
}
基本DAO的实现
第三步就是创建基本的JPA DAO的实现。它实现了Dao接口。
public abstract class JpaDao<K, E> implements Dao<K, E> {
protected Class<E> entityClass;
@PersistenceContext
protected EntityManager entityManager;
public JpaDao() {
ParameterizedType genericSuperclass = (ParameterizedType) getClass().getGenericSuperclass();
this.entityClass = (Class<E>) genericSuperclass.getActualTypeArguments()[1];
}
public void persist(E entity) { entityManager.persist(entity); }
public void remove(E entity) { entityManager.remove(entity); }
public E findById(K id) { return entityManager.find(entityClass, id); }
上述实现是直接明了的,大家还要注意几点:
JpaDao的构造方法是通过ParameterizedType获取具体的实体类。
通过@PersistenceContext 获取EntityManager
entityClass和EntityManager是Protected类型,子类可以直接访问。
特殊的DAO实现
最后,我们创建特殊的DAO,它扩张了基本的DAO接口实现了OrderDAO接口
public class JpaOrderDao extends JpaDao<Integer, Order> implements OrderDao {
public List<Order> findOrdersSubmittedSince(Date date) {
Query q = entityManager.createQuery(
"SELECT e FROM " + entityClass.getName() + " e WHERE date >= :date_since");
q.setParameter("date_since", date);
return (List<Order>) q.getResultList();
DAO的使用
在EJB3中,
@EJB(name="orderDao")
private OrderDao orderDao;
在Spring中,我们使用XML bean 文件,或者通过autowiring 如下:
@Autowired
public OrderDao orderDao;
总之。当我们获取到了DAO的引用后,我们可以如下使用:
Order o = new Order();
o.setCustomerName("Peter Johnson");
o.setDate(new Date());
orderDao.persist(o);
当然,我们可以再OrderDao接口中加入其它的查询:
List<Order> orders = orderDao.findOrdersSubmittedSince(date);
for (Order each : orders) {
System.out.println("order id = " + each.getId());
}
总之,使用了类型安全的DAO Pattern有如下优势:
1. 从Client的角度讲,不会直接依赖于JPA的API
2. 通过泛型实现类型安全,避免Cast异常。
3. 集中处理所有跟JPA相关的代码。
4. 可以在集中点上加入事务,log 性能测试等逻辑。
5. 通过一个类可以测试数据库访问代码。
希望这些可以说服你使用DAO Pattern . 接下来我们将讨论Bidirectional assocations 双向关联模式。