写点什么

ActiveJPA——针对 JPA 的活动记录模式

  • 2014-03-31
  • 本文字数:4422 字

    阅读完需:约 15 分钟

ActiveRecord 是 Ruby on Rails 的 ORM 层,大体上类似于 Java 中的 Hibernate。ActiveRecord 基于约定优于配置的原则,所以它使用起来比 Hibernate 更容易。在简化基本的数据操作方面,如创建、读取、更新和删除,它确实是非常棒的。

借助于 ActiveRecord,你的模型类也会作为数据访问对象(Data Access Object,DAO)来执行 CRUD 操作。在初步探究之后,我对 ActiveRecord 产生了浓厚的兴趣,因此开始寻找一种解决方案来简化基于 Java 持久化 API(Java Persistence API,JPA)的 ORM 框架的使用。

大多数 JPA 应用都会有某种类型的数据访问层(Data Access Layer,DAL)来与数据库进行交互。通常 DAL 会包含数据访问对象或符合 Repository 设计模式的类。

DAO 的实现与实体对象通常是一对一的关系,而 Repository 则是针对每个聚合根(aggregate root)实现一个。不管是哪种场景,应用最后都会创建多个类与数据库进行交互。尽管适当的抽象能够有效限制所创建类的数量,但是它终究还是会在应用中引入一个额外的层,这都是需要维护和测试的。

ActiveJPA 基于 JPA,提供了 Martin Fowler 所提出的活动记录模式(Active Record pattern)的 Java 实现。借助于 ActiveJPA,模型本身会作为 DAO 并与数据库交互,这样就不需要额外的代码作为数据访问层了。

ActiveJPA 使用到了 JPA 规范,因此所有 JPA 的 ORM 实现(Hibernate、EclipseLink、OpenJPA 等)都可以与 ActiveJPA 协同使用。

将已有的 JPA 模型转换为 ActiveJPA

要将已有的模型转换为 ActiveJPA,只需让你的模型实现扩展 org.activejpa.entity. Model 即可:

复制代码
@java.persistence.Entity
public class YourModel extends org.activejpa.entity.Model {
}

执行 CRUD 操作

你的模型将会从 ActiveJPA 的模型类中继承得到很多的 CRUD 功能。

复制代码
// 根据 id 获得订单
Order order = Order.findById(12345L);
// 根据 customer 获得其已发货的订单
List orders = Order.where("customerEmail", "dummyemail@dummy.com",
"status", "shipped");
// 得到匹配过滤条件的第一条订单记录
Long count = Order.first("customerEmail", "dummyemail@dummy.com",
"status", "shipped");
// 得到匹配过滤条件的唯一一条订单记录
Long count = Order.one("customerEmail", "dummyemail@dummy.com",
"status", "shipped");
// 得到所有的记录
List orders = Order.all();
// 检查指定标识符的订单是否存在
boolean exists = Order.exists(1234L);
// 保存订单
order.persist();
// 删除订单
order.delete();
// 刷新订单
order.refresh();
// 与持久化上下文中已有的订单进行合并
order.merge();

过滤与分页

对记录进行过滤时,你并不需要创建 JPQL 或 criteria 查询。ActiveJPA 提供了一个复杂的过滤器,用于在不同的操作间进行连接(conjunction):

复制代码
// 获取匹配指定 Email 地址且账单额大于 1000 的所有订单,并且要进行分页
Filter filter = new Filter();
filter.setPageNo(1);
filter.setPerPage(25);
filter.addCondition(new Condition("customerEmail", Operator.eq,
"dummyemail@dummy.com");
filter.addCondition(new Condition("billingAmount", Operator.gt,
1000.00);
List orders = Order.where(filter);
// 对满足过滤条件的订单进行计数
Long count = Order.count(filter);
// 删除匹配这个过滤器的订单
Long count = Order.deleteAll(filter);

嵌套查询

ActiveJPA 允许嵌套过滤参数。这样的话就能更容易地在运行时创建动态查询。例如,你获取的订单中,至少要有一个订单项是基于“book”类别的产品创建的。

复制代码
// 得到至少包含一个 book 项的所有订单
Filter filter = new Filter();
filter.setPageNo(1);
filter.setPerPage(25);
filter.addCondition(new Condition("orderItems.product.category",
Operator.eq, "books");
List orders = Order.where(filter);

使用集合

上面讨论的所有 CRUD 操作同时可以在集合级别执行。将查询范围设置到集合类的用法如下所示:

复制代码
// 在订单中,根据 id 查找订单项
order.collections("orderItems").findById(123L);
// 得到第一个已发货的订单项
order.collections(“orderItems”).first(“status”, “shipped”);
// 得到所有取消的订单项
order.collections(“orderItems”).where(“status”, “cancelled”);
// 得到集合中的所有项
order.collections(“orderItems”).all();
// 往集合中添加一项
order.collections(“orderItems”).add(orderItem);
// 移除集合中的一项
order.collections(“orderItems”).remove(orderItem);

过滤和分页也可以使用到集合之中

复制代码
// 对一个订单中的订单项基于过滤器进行查询并进行分页
Filter filter = new Filter();
filter.setPageNo(1);
filter.setPerPage(25);
filter.addCondition(new Condition(“status”, “shipped”);
order.collections("orderItems").where(filter);
// 在订单中,得到匹配过滤器的订单项的数量
order.collections(“orderItems”).count(filter);

动态更新

ActiveJPA 支持对模型的动态更新。在有些场景下这是很有用的,例如用户通过浏览器更新一个表单。你可以传递一个包含属性的 map 来进行更新,而不是调用每个属性的 setter 方法:

复制代码
// 更新属性 <br></br>
Map attributes = new HashMap();
attributes.put("billingAmount", 1000.0);
order.updateAttributes(attributes);

你也可以更新非原始 / 非包装类型的域,只需给这些对象传递 map 即可。以下的样例展现了更新一个订单的收获地址和账单金额。

复制代码
// 更新一个订单的收获地址和账单金额 <br></br>
Map attributes = new HashMap();<br></br>
Map address = new HashMap();<br></br>
address.put(“city”, “Bangalore”);<br></br>
address.put(“state”, “Karnataka”);<br></br>
attributes.put(“shippingAddress”, address);<br></br>
attributes.put("billingAmount", 1000.0);<br></br>
order.updateAttributes(attributes);

注意:目前尚不支持更新 list/set/array 域,未来的版本将会提供支持。

事务处理

默认情况下,如果没有事务,ActiveJPA 将会为所有的更新操作启动一个事务,不过你也可以将整个工作单元包装到一个事务之中:

复制代码
JPAContext context = JPA.instance.getDefaultConfig().getContext();
context.beginTxn();
boolean failed = true;
try {
// 你的工作单元置于此处
failed = false;
} finally {
// 提交或回滚事务
context.closeTxn(failed);
}

如果已经存在了外部的事务,那么 ActiveJPA 将会使用这个事务,但是不会进行提交或回滚。应该由应用来负责关闭该事务。

测试你的模型

ActiveJPA 为 TestNG 提供了一个基本的测试类,它会将 ActiveJPA 以挂钩(hook)的方式添加到测试运行时之中。只需让你的测试类扩展自 _org.activejpa.entity.testng.BaseModelTest_ 类即可。以下为一个样例代码:

复制代码
public class OrderTest extends BaseModelTest {
@Test
public void testCreateOrder() {
Order order = new Order();
order.setCustomerEmail("dummyemail@dummy.com");
...
...
order.persist();
Assert.assertEquals(Order.where("customerEmail",
"dummyemail@dummy.com").get(0), order);
}
}
}

使用起步

搭建 Maven

ActiveJPA 可以以 Maven artifact 的方式来获取,能够非常容易地集成到你的应用之中。只需在你的 pom.xml 文件中添加如下的 maven 依赖:

复制代码
<dependencies> <br></br><dependency> <br></br><groupId>org.activejpa</groupId> <br></br><artifactId>activejpa-core</artifactId> <br></br><version>0.1.5</version> <br></br></dependency> <br></br></dependencies>
<br></br><repositories> <br></br><repository> <br></br><id>activejpa-repo</id> <br></br><url>https://raw.github.com/ActiveJpa/activejpa/mvn-repo/releases</url> <br></br><snapshots> <br></br><enabled>true</enabled> <br></br><updatePolicy>always</updatePolicy> <br></br></snapshots> <br></br></repository> <br></br></repositories>

嵌入到你的应用之中

ActiveJPA 需要在实体类加载前就嵌入到你的应用之中。如果你使用 Tomcat 的话,那么 ServletContextListener 就是做这件事的一个很好的地方。你可以将以下的代码编写到上下文监听器的 contextInitialized() 方法之中。

复制代码
// 动态加载 Java 代理
ActiveJpaAgentLoader.instance().loadAgent();
// 添加定义在 persistence.xml 中的持久化单元,以“order”名进行标识。
persistence.xml 应该位于类路径下
JPA.addPersistenceUnit("order");
// 如果你已经创建了实体管理工厂的话,可以将其关联到 ActiveJpa 上
// JPA.addPersistenceUnit("order", entityManagerFactory);

与 Spring 框架集成

将 ActiveJPA 与 Spring 这样的框架进行集成是很容易的。大多数的应用都会使用 Spring 的注解来配置 JPA 和管理事务。ActiveJPA 能够以两种方式来进行配置——你可以让它来创建实体管理工厂也可以传入一个已存在的对象。在 Spring 配置 JPA 的情况下,我们可以使用 Spring 所创建的实体管理工厂。这样就能保证 ActiveJPA 使用 Spring 所创建的相同的连接和事务,从而提供无缝的集成。

以下的代码展现了如何将 ActiveJPA 集成到 Spring 应用之中,这个应用是部署在 servlet 容器里面的。它使用了一个自定义的上下文加载监听器,从而将 ActiveJPA 嵌入到应用之中。需要注意的是,这很类似与上面的 servlet 样例,区别在于这里使用了 Spring 框架的 ContextLoaderListener:

复制代码
public class CustomContextListener extends ContextLoaderListener {
@Override
public void contextInitialized(ServletContextEvent event) {
try {
// 在这里动态加载 Java 代理
ActiveJpaAgentLoader.instance().loadAgent();
} catch (Exception e) {
throw new RuntimeException(e);
}
super.contextInitialized(event);
JPA.instance.addPersistenceUnit("default",
getCurrentWebApplicationContext().getBean(EntityManagerFactory.
class), true);
}
}

样例应用

在 GitHub 的 ActiveJPA 工程页面上有一个示例应用,包含了很多更具体的样例,展现了 Spring-ActiveJPA 的集成。

关于作者

Ganesh Subramanian Hightail 的架构师,在构建高扩展、低延迟的跨域分布式应用架构方面有超过十年的工作经验。Ganesh 曾经参与 Flipkart (印度最大的电子商务厂商)的供应链管理平台的架构,他还是活跃的开源社区( ActiveJPA , Minnal , AutoPojo 等)贡献者以及技术博客的作者,在业余时间,他喜欢看电影(各种流派)以及陪伴家人。

原文英文链接: ActiveJPA – Active Record Pattern for JPA

2014-03-31 05:355307

评论

发布
暂无评论
发现更多内容

【墨菲安全实验室】WPS Office 存在代码执行漏洞

墨菲安全

网络安全 安全 漏洞 WPS Office

面部表情识别技术的挑战与解决方案

来自四九城儿

面部表情识别技术在安全领域的应用

来自四九城儿

嵌入式软件开发为什么需要DevOps?

DevOps和数字孪生

DevOps 嵌入式软件

Dragonfly 发布 v2.1.0 版本!

SOFAStack

AI 算法 后端 基础设施 分发

实现分布式事务:Java与MySQL的XA事务协调

树上有只程序猿

Java MySQL 数据库 分布式 XA

如何在Confluence上设置到期日提醒?Confluence到期日提醒插件重要更新发布,优化表格提醒,增加屏蔽提醒功能

龙智—DevSecOps解决方案

confluence插件

大型集团公司如何打破“信息孤岛”问题?

优秀

打破信息孤岛 消除信息孤岛 信息孤岛

值得收藏!堪称神器的30个插件

Finovy Cloud

插件 渲染 建模 maya 3d建模

【华秋干货铺】电源PCB设计汇总

华秋电子

KeyShot 2023.2 Pro for mac(3D渲染和动画制作软件) v12.1.1.12激活版

mac

苹果mac Windows软件 KeyShot Pro 动画软件

【低代码预研】通过低代码平台开发应用程序

互联网工科生

软件开发 低代码 应用开发 JNPF

百度、NVIDIA、Intel……各大厂商集结,共话文心与飞桨共享生态下的大模型训推部署创新实践计划

飞桨PaddlePaddle

人工智能 百度飞桨 硬件生态 WAVE SUMMIT

电动汽车安全概述

DevOps和数字孪生

电动汽车 汽车安全

甭提ChatGPT了,这个新的AI助手将永远改变人们的工作方式

互联网工科生

人工智能 AI 机器人

【墨菲安全实验室】Microsoft Teams 远程代码执行漏洞 (CVE-2023-29330)

墨菲安全

安全 漏洞 网络安全、 Microsoft Teams

【墨菲安全实验室】Microsoft Exchange Server 远程代码执行漏洞(CVE-2023-38182)

墨菲安全

网络安全 安全 漏洞 Microsoft Exchange

【墨菲安全实验室】Microsoft Office Visio 远程执行代码漏洞(CVE-2023-36865)

墨菲安全

网络安全 安全 漏洞 Microsoft Office Visio

【墨菲安全实验室】Zoom Desktop Client for Windows <5.14.5 权限升级漏洞(CVE-2023-36541)

墨菲安全

网络安全 安全 Zoom 漏洞 墨菲安全

〔支付接入〕微信的 h5 支付和 jsapi 支付

极客飞兔

微信支付 支付 经验分享 H5支付 jsapi支付

腾讯云大数据ES:结合AI大模型与向量检索的新一代云端检索分析引擎

腾讯云大数据

ES

IoTDB 小白“踩坑”心得:入门安装部署篇

Apache IoTDB

面部表情识别在医疗领域的应用

来自四九城儿

确保数据一致性:单一可信数据源(SSOT)的概念与5个应用示例

龙智—DevSecOps解决方案

ssot single source

PP-ChatOCR:基于文心大模型的通用图像关键信息抽取利器,开发提效 50%!

飞桨PaddlePaddle

人工智能 百度飞桨

14个前端开发者应该知道的实用网站

高端章鱼哥

前端 提高效率 前端开发工具

聊聊低代码的本质,是应用开发的未来吗?

高端章鱼哥

低代码 应用开发 JNPF

巧用Maya轴心操作小技巧,工作事半功倍!

3DCAT实时渲染

maya制作技巧 3D软件教程

UE虚幻引擎游戏开发:游戏鼠标双击判定方法!

3DCAT实时渲染

UE虚幻引擎 UE教程 3D游戏制作教程

ActiveJPA——针对JPA的活动记录模式_Java_Ganesh Subramanian_InfoQ精选文章