使用 Morphia 和 MongoDB 实现域模型持久性

使用 Morphia 持久保存、加载、删除和查询映射到 MongoDB 的 Java 域模型

MongoDB 是面向文档的开源数据库,Morphia 是面向 MongoDB 的类型安全的对象映射库。本文解释了在文档和对象之间进行映射的好处,并演示了如何使用 Morphia 来实现这个功能。然后演示了如何持久保存、加载、删除和查询映射到 MongoDB 的 Java™ 域模型。

John D'Emic, 高级软件工程师, IBM

/developerworks/i/p-jdemic.jpgJohn D'Emic 是 IBM Global Services 的高级软件工程师且在过去的一年中在各种不同的开发环境中使用了 MongoDB。他是 Mule in Action(Manning Publications,2009 年)(与 David Dossot)的合著者。



2011 年 6 月 13 日

文章中对于 MongoDB 术语的翻译为:

  • Collection:集合
  • Document:文档

MongoDB 是面向文档的数据库,用于存储并检索类似 JavaScript 对象符号(JavaScript Object Notation,JSON)的文档。由于索引、复制和分片功能的增强,MongoDB 已成为强大的、可扩展的 NoSQL 竞争者(参见 参考资料)。

官方 Java 驱动程序可用于与 MongoDB 交互。该驱动程序提供 Map 的实现 BasicDBObject,用于在数据存储中表示文档。虽然 Map 表示法很方便,尤其是在读对 JSON 序列化和反序列化时,但是能够将文档表示为 Java 类层次也具有其优点。例如,反复从 Java 域模型映射文档,允许您在 Java 层上强行执行类型安全,同时通过 MongoDB 享受无模式(schema)开发的好处。

Morphia 是基于 Apache 许可证的 Google Code 项目,让您在 MongoDB 上持久保存、检索、删除和查询作为文档存储的 POJO。通过提供一系列围绕 Mongo Java 驱动程序的注释和包装程序,Morphia 完成了这些操作。Morphia 概念上类似于对象关系映射器(ORM),如 Java Persistence API (JPA) 或 Java 数据对象(Java Data Objects,JDO)实现。在本文中,我将演示如何对映射到 MongoDB 的 Java 域模型使用 Morphia。参见 下载 部分获取完整的样例代码。

定义域模型

我将使用简化的域模型来演示 Morphia 的功能。BandManager(假想的 web 应用程序)提供有关音乐活动的数据:其成员、经销商、目录、类型等等。我将定义 BandSongDistributorContactInfo 类来表示此域模型,如图 1 所示:

图 1. BandManager 的类
针对 BandManager 应用程序的域模型类层次的 UML 图表

图 1 中的统一建模语言(Unified Modeling Language,UML)显示了域模型类层次。左侧的矩形表示 Band 类。右侧的矩形分别表示 ContactInfoDistributorSong 类。从 Band 指向 ContactInfo 的箭头在 ContactInfo 旁边标有一个 1,这说明两个类之间是一对一的关系。连接 BandDistributor 的线在 Band 旁边标有 0..* 且在 Distributor 旁边标有一个 1,这说明 Band 具有单一的 DistributorDistributor 表示许多 Band。最后,从 BandSong 的箭头在 Song 旁边标有目录 0..1,这说明 Band 具有与 Song 的一对多关系且这种关系被称作 catalog

我将对这些类进行注释,然后使用 Morphia 的 Datastore 接口在 MongoDB 上将它们保存为文档。

注释域模型

清单 1 显示了如何注释 Band 类:

清单 1. Band.java
@Entity("bands")
public class Band {

    @Id
    ObjectId id;

    String name;

    String genre;

    @Reference
    Distributor distributor;

    @Reference("catalog")
    List<Song> songs = new ArrayList<Song>();

    @Embedded
    List<String> members = new ArrayList<String>();

    @Embedded("info")
    ContactInfo info;

@Entity 注释是必需的。其声明了在专用集合(collection)上该类作为文档将持久保存。提供给 @Entity 注释的值(bands)定义了如何命名集合。在默认情况下,Morphia 使用类名称来命名集合。例如,如果我遗漏了 bands 值,则在数据库中该集合将被称为 Band

数据类型

MongoDB 比 Java 语言支持更小的数据类型集合,即 integerlongdoublestring。Morphia 可自动为您转换基本 Java 类型(如 float)。

@Id 注释指示 Morphia 哪个字段用作文档 ID。如果您试图持久保存对象(其 @Id 注释的字段为 null),则 Morphia 会为您自动生成 ID 值。

Morphia 试图持久保存每一个它遇到的没有注释的字段,除非它们标有 @Transient 注释。例如,在文档中 namegenre 属性将被保存为 string,并具有 namegenre 键。

distributorsongsmembersinfo 属性引用其他对象。除非注释有 @Reference(不久将看到),否则成员对象将被视为嵌入的(embedded)。它会显示为集合中父文档的子集。例如,在持久保存时,members List 看上去如下所示:

"members" : [ "Jim", "Joe", "Frank", "Tom"]

info 属性是另外一个嵌入的对象。在本例中,我通过 info 值明确地设置 @Embedded 注释。这会覆盖文档中子集的默认命名,否则就会被称为 contactInfo。例如:

"info" : { "city" : "Brooklyn", "phoneNumber" : "718-555-5555" }

@Reference 和 DBRefs

在后台,Morphia 使用 Mongo DBRef 来在不同集合中引用对象。

使用 @Reference 注释说明对象是对另外一个集合中的文档的引用。在从 Mongo 集合中加载对象时,Morphia 遵循着这些引用来建立对象图。例如,在持久保存的文档中,distributor 属性看起来如下所示:

"distributor" : { "$ref" : "distributors", "$id" : ObjectId("4cf7ba6fd8d6daa68a510e8b") }

正如 @Embedded 注释一样,@Reference 可以采用一个值来覆盖默认命名。在本例中,我将 songsList 称为文档中的 catalog

现在看一下 SongDistributorContactInfo 的类定义。清单 2 显示了 Song 的定义:

清单 2. Song.java
@Entity("songs")
public class Song {

    @Id
    ObjectId id;

    String name;

清单 3 显示了 Distributor 的定义:

清单 3. Distributor.java
@Entity("distributors")
public class Distributor {

    @Id
    ObjectId id;

    String name;

    @Reference
    List<Band> bands = new ArrayList<Band>();

清单 4 显示了 ContactInfo 的定义:

清单 4. ContactInfo.java
public class ContactInfo {


    public ContactInfo() {
    }

    String city;

    String phoneNumber;

ContactInfo 类缺少 @Entity 注释。这是故意而为的,因为我不需要 ContactInfo 的专用集合。实例总是被嵌入 band 文档。

现在我已经定义并注释了域模型,我将向您展示如何使用 Morphia 的 Datastore 以便保存、加载和删除实体。


使用 Datastore

依赖注入(Dependency injection,DI)

Datastore 和 Mongo 都是 DI 友好型。例如,在 Spring 或 Guice 中,您不应该在连接它们的问题上遇到任何麻烦。如果有可能,您应该配置每一个作为单一实例并在合作(collaborating)bean 之间共享它们。

Datastore 接口 — Mongo Java 驱动程序的包装程序 — 用于在 MongoDB 中管理实体。因为 Datastore 需要 Mongo 实例以进行实例化,您可以重新使用现有的 Mongo 实例或为您的环境适当地配置一个实例。下面是一个实例化 Datastore 的示例,其连接到本地 MongoDB 实例:

Mongo mongo = new Mongo("localhost");
Datastore datastore = new Morphia().createDatastore(mongo, "bandmanager");

下一步我将创建 Band 实例:

Band band = new Band();
band.setName("Love Burger");
band.getMembers().add("Jim");
band.getMembers().add("Joe");
band.getMembers().add("Frank");
band.getMembers().add("Tom");
band.setGenre("Rock");

现在我拥有了 Band 实例,我可以使用 datastore 来持久保存它:

datastore.save(band);

band 现在应该保存在 bandmanager 数据库中被称为 bands 的集合中。通过使用 Mongo 命令行界面客户端,我可以查看一下以便确保(在本示例和其他示例中,折行以便适合本文页面的宽度):

> db.bands.find();
{ "_id" : ObjectId("4cf7cbf9e4b3ae2526d72587"), "className" : 
"com.bandmanager.model.Band", "name" : "Love Burger", "genre" : "Rock", 
"members" : [ "Jim", "Joe", "Frank", "Tom" ] }

这真是太棒了!它就在这里。除了 className 字段以外,一切看起来正如您所期望的。Morphia 自动创建此字段以便记录 MongoDB 中的对象类型。其主要用于确定在编译时不必知道的对象类型(例如,在您从具有混合类型的集合中加载对象时)。如果这个困扰了您且您知道您不需要该功能,那么通过将 noClassnameStored 值添加到 @Entity 注释,您可以禁用持久保存 className

@Entity(value="bands",noClassnameStored=true)

现在我将加载 Band 并断言它等同于我所持久保存的 band

assert(band.equals(datastore.get(Band.class, band.getId())));

Datastoreget() 方法允许您使用实体的 ID 加载该实体。您无需指定集合或定义查询字符串来加载对象。您只需告诉 Datastore ,您想加载哪个类及其 ID。Morphia 进行其余的操作。

现在可以查看 Band 的合作对象了。我开始先定义一些 Song,然后将它们添加到我刚刚创建的 Band 实例:

Song song1 = new Song("Stairway");
Song song2 = new Song("Free Bird");

datastore.save(song1);
datastore.save(song2);

如果我在 Mongo 中查看 songs 集合,我应该看到如下所示:

> db.songs.find();
{ "_id" : ObjectId("4cf7d249c25eae25028ae5be"), "className" : 
"com.bandmanager.model.Song", "name" : "Stairway" }
{ "_id" : ObjectId("4cf7d249c25eae25038ae5be"), "className" :
"com. bandmanager.model.Song", "name" : "Free Bird" }

请注意 Song 还没有从 band 引用。我将它们添加到 band 并查看发生了什么:

band.getSongs().add(song1);
band.getSongs().add(song2);

datastore.save(band);

现在我查询 bands 集合时,我应该看到:

{ "_id" : ObjectId("4cf7d249c25eae25018ae5be"), "name" : "Love Burger", "genre" : "Rock", 
   "catalog" : [
   {
      "$ref" : "songs",
      "$id" : ObjectId("4cf7d249c25eae25028ae5be")
   },
   {
      "$ref" : "songs",
      "$id" : ObjectId("4cf7d249c25eae25038ae5be")
   }
], "members" : [ "Jim", "Joe", "Frank", "Tom"] }

事务

非常重要的是记住 MongoDB 不像大多数关系数据库管理系统那样支持事务。如果您的应用程序需要协调多个线程写入或读取集合,您就必须依靠 Java 语言的序列化和并发功能。

请注意 songs 集合如何被保存为一个被称为 catalog 的数组,作为两个 DBRef

现在的限制是引用的对象必须先被保存,然后其他对象才能引用它们。这解释了为什么我先保存 song1song2,然后将它们添加到 band

现在我将删除 song2

datastore.delete(song2);

查询 songs 集合应该说明没有了 song2。但是如果您查看 band,您将看到该歌曲仍在那里。更糟糕的是,试图加载 band 实体会导致异常:

Caused by: com.google.code.morphia.mapping.MappingException: The 
reference({ "$ref" : "songs", "$id" : "4cf7d249c25eae25038ae5be" }) could not be 
fetched for com.bandmanager.model.Band.songs

现在,要避免此错误,您需要在删除歌曲以前手动删除对它的引用。


查询

到目前为止,通过其 ID 加载实体只能得到实体的信息。最终我希望能够查询 Mongo 并得到我想要的实体。

我将通过名称查询 band,而不是通过其 ID 加载它。为此,我通过创建 Query 对象并指定筛选器来获得我希望的结果:

Query query = datastore.createQuery(Band.class).filter("name = ","Love Burger");

我指定了想要查询的类,即 Band,和针对 createQuery() 方法的筛选器。一旦我定义了查询,我就可以使用 asList() 方法来访问结果:

Band band = (Band) query.asList().get(0);

Morphia 的筛选运算符紧密地映射到用于 MongoDB 查询的查询运算符。例如,我在上面查询中使用的 = 运算符就类似于 MongoDB 中的 $eq 运算符。有关筛选运算符的全部细节都在 Morphia 在线文档中(参见 参考资料)。

作为筛选查询的替代,Morphia 为构建查询提供了更好的接口。例如,以下接口查询等同于以前的筛选查询:

Query query = datastore.createQuery(Band.class).field("name").equal("Love Burger");

您可以使用“点注释”来查询嵌入的对象。下面是使用点注释和接口的查询,用于选择位于 Brooklyn 的所有乐队:

Query query = datastore.createQuery(Band.class).field("info.city").equal("Brooklyn");

您可以进一步定义查询结果集。我将修改以前的查询以便根据名称来对乐队排序并将结果限制为 100:

Query query = 
datastore.createQuery(Band.class).field("info.city").equal
("Brooklyn").order("name").limit(100);

索引

您将注意到随着您的集合增长查询性能将会降低。Mongo 集合(非常像关系数据库表)需要正确进行索引以便确保合理的查询性能。

通过 @Indexed 注释对属性进行注释会对该字段应用索引。这里,我对 Bandgenre 属性创建了一个名为 genreName 的升序索引:

@Indexed(value = IndexDirection.ASC, name = "genreName")
String genre;

要应用索引,Morphia 需要知道映射哪些类。您需要以稍微不同的方式实例化 Morphia 以便确保应用索引。您可以按如下所示执行:

Morphia morphia = new Morphia();
morphia.mapPackage("com.bandmanager.model");
datastore = morphia.createDatastore(mongo, "bandmanager");
datastore.ensureIndexes();

最终的 ensureIndexes() 调用可以指示数据存储创建所需且不存在的索引。

索引还可用于避免将重复项插入到集合中。例如,通过在 band 名称的 @Indexed 注释上设置 unique 属性,我可以确保在该集合中只有一个具有给定名称的 band

@Indexed(value = IndexDirection.ASC, name = "bandName", unique = true)
String name;

随后同名的 band 将被丢弃。


结束语

Morphia 是与 MongoDB 进行交互的强大工具。它允许对 MongoDB 文档进行类型安全的、惯用的访问。本文涵盖了使用 Morphia 的主要方面,但排除了一些功能。要获得有关其数据访问对象(Data Access Object,DAO)支持、验证和手动映射功能的信息,我鼓励您查看 Morphia Google Code 项目。


下载

描述名字大小
本文样例代码j-morphia.zip17.2KB

参考资料

学习

获得产品和技术

讨论

条评论

developerWorks: 登录

标有星(*)号的字段是必填字段。


需要一个 IBM ID?
忘记 IBM ID?


忘记密码?
更改您的密码

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件

 


在您首次登录 developerWorks 时,会为您创建一份个人概要。您的个人概要中的信息(您的姓名、国家/地区,以及公司名称)是公开显示的,而且会随着您发布的任何内容一起显示,除非您选择隐藏您的公司名称。您可以随时更新您的 IBM 帐户。

所有提交的信息确保安全。

选择您的昵称



当您初次登录到 developerWorks 时,将会为您创建一份概要信息,您需要指定一个昵称。您的昵称将和您在 developerWorks 发布的内容显示在一起。

昵称长度在 3 至 31 个字符之间。 您的昵称在 developerWorks 社区中必须是唯一的,并且出于隐私保护的原因,不能是您的电子邮件地址。

标有星(*)号的字段是必填字段。

(昵称长度在 3 至 31 个字符之间)

单击提交则表示您同意developerWorks 的条款和条件。 查看条款和条件.

 


所有提交的信息确保安全。


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=10
Zone=Java technology, Open source
ArticleID=680328
ArticleTitle=使用 Morphia 和 MongoDB 实现域模型持久性
publish-date=06132011