目前,Rogue 仅适用于Lift 的 MongoDB-Record系统。
它提供完整类型安全的部分原因是它为 Lift-Record 使用了一个强大的、定义良好的对象结构。由于您拥有完整的结构,因此您执行“自由形式”查询的能力要少得多。这就是我为最近的 Scala 网络研讨会所做的 Lift-Record + Rogue 演示的意思。自从我这样做以来,Lift & Rogue 中的一些东西发生了变化,所以代码可能有点过时,但仍然具有代表性。这是 MongoDB 的 Lift-Record 模型:
object LiftRecordDemo extends Application {
// We'll use enums for Type and Subtype
object EventType extends Enumeration {
type EventType = Value
val Conference, Webinar = Value
}
object EventSubType extends Enumeration {
type EventSubType = Value
val FullDay = Value("Full Day")
val HalfDay = Value("Half Day")
}
class MongoEvent extends MongoRecord[MongoEvent] with MongoId[MongoEvent] {
def meta = MongoEvent
object name extends StringField(this, 255)
object eventType extends EnumField(this, EventType)
object eventSubType extends OptionalEnumField(this, EventSubType)
object location extends JsonObjectField[MongoEvent, EventLocation](this, EventLocation) {
def defaultValue = EventLocation(None, None, None, None, None, None, None)
}
object hashtag extends OptionalStringField(this, 32)
object language extends OptionalStringField(this, 32)
object date extends JsonObjectField[MongoEvent, EventDate](this, EventDate) {
def defaultValue = EventDate(new DateTime, None)
}
object url extends OptionalStringField(this, 255)
object presenter extends OptionalStringField(this, 255)
}
object MongoEvent extends MongoEvent with MongoMetaRecord[MongoEvent] {
override def collectionName = "mongoEvents"
override def formats = super.formats + new EnumSerializer(EventType) + new EnumSerializer(EventSubType)
}
case class EventLocation(val venueName: Option[String], val url: Option[String], val address: Option[String], val city: Option[String], val state: Option[String], val zip: Option[String], val country: Option[String]) extends JsonObject[EventLocation] {
def meta = EventLocation
}
object EventLocation extends JsonObjectMeta[EventLocation]
case class EventDate(start: DateTime, end: Option[DateTime]) extends JsonObject[EventDate] {
def meta = EventDate
}
object EventDate extends JsonObjectMeta[EventDate]
}
如您所见,您需要提前定义 MongoDB 数据模型,以便获得强类型、安全查询的好处…… Rogue 在编译时强制执行大部分操作。以下是一些针对此模型的 Rogue 示例:
// Tell Lift about our DB
val mongoAddr = MongoAddress(MongoHost("127.0.0.1", 27017), "scalaWebinar")
MongoDB.defineDb(DefaultMongoIdentifier, mongoAddr)
// Rogue gives us a saner approach, although still hobbled by some
// of Lift-MongoDB-Record's limits on embedded docs
val q = MongoEvent where (_.eventType eqs EventType.Webinar)
println("Rogue created a Query '%s'\n\n".format(q))
for (x <- MongoEvent where (_.eventType eqs EventType.Webinar)) {
println("Name: %s Presenter: %s\n".format(x.name, x.presenter))
}
// Rogue can also do sorting for you, which is useful
println("\n\n\n")
for (x <- MongoEvent where (_.eventType eqs EventType.Conference)
orderAsc(_.language) andDesc(_.name)) {
println("Name: %s Language: %s\n".format(x.name, x.language))
}
val start = new DateTime(2011, 2, 1, 0, 0, 0, 0)
val end = new DateTime(2011, 3, 1, 0, 0, 0, 0)
/** The following would be nice but unfortunately,
doesn't work because of lift's current embedded doc
implementation
*/
//val dateQ = MongoEvent where (_.date.start after start)
//and (_.date.end before end)
请注意,我并不是说 Rogue 和 Lift-Record 不好,只是它们使用了一个强定义的编译时数据模型。
相反,如果您想在 Casbah 中使用类似的上下文,我们确实有一个内置的 DSL,它旨在尽可能地模仿 MongoDB 的内置查询模型。它适用于任何任意底层模型,但会在可能的情况下执行很多类型安全级别。这是一个 Casbah 查询的示例(与同一演示文稿中的内容略有不同):
// What about querying? Lets find all the non-US events
for (x <- mongo.find(MongoDBObject("location.country" ->
MongoDBObject("$ne" -> "USA")))) println(x)
/* There's a problem here: We got back the Webinars too because
They don't have a country at all, so they aren't "USA"
*/
println("\n\nTesting for existence of Location.Country:")
for (x <- mongo.find(MongoDBObject("location.country" -> MongoDBObject(
"$ne" -> "USA",
"$exists" -> true
)))) println(x)
// This is getting a bit unwieldy. Thankfully, Casbah offers a DSL
val q = $or ("location.country" -> "USA", "location.country" -> "Japan")
println("\n Created a DBObject: %s".format(q))
println("\n Querying using DSL Object...")
for (x <- mongo.find(q)) println(x)
// It's possible to construct more complex queries too.
// Lets find everything in February
println("\n February Events...")
val start = new DateTime(2011, 2, 1, 0, 0, 0, 0)
val end = new DateTime(2011, 3, 1, 0, 0, 0, 0)
val dateQ = "date.start" $gte start $lt end
println("\n Date Query: %s".format(dateQ))
for (x <- mongo.find(dateQ, MongoDBObject("name" -> true, "date" -> true))) println(x)
值得注意的是,我们正在查询自由形式的模型,但使用 DSL 运算符而不是嵌套的 MongoDB 定义。有许多奇妙的运算符映射,一直到 $type 运算符,用于使用类清单测试类型以确保编译时安全:
"Casbah's $type operator" should {
"Accept raw Byte indicators (e.g. from org.bson.BSON)" in {
// Don't need to test every value here since it's just a byte
val typeOper = "foo" $type org.bson.BSON.NUMBER_LONG
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.NUMBER_LONG))
}
"Accept manifested Type arguments" in {
"Doubles" in {
val typeOper = "foo".$type[Double]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.NUMBER))
}
"Strings" in {
val typeOper = "foo".$type[String]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.STRING))
}
"Object" in {
"via BSONObject" in {
val typeOper = "foo".$type[org.bson.BSONObject]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.OBJECT))
}
"via DBObject" in {
val typeOper = "foo".$type[DBObject]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.OBJECT))
}
}
"Array" in {
"via BasicDBList" in {
val typeOper = "foo".$type[BasicDBList]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.ARRAY))
}
"via BasicBSONList" in {
val typeOper = "foo".$type[org.bson.types.BasicBSONList]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.ARRAY))
}
}
"OID" in {
val typeOper = "foo".$type[ObjectId]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.OID))
}
"Boolean" in {
val typeOper = "foo".$type[Boolean]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.BOOLEAN))
}
"Date" in {
"via JDKDate" in {
val typeOper = "foo".$type[java.util.Date]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.DATE))
}
"via Joda DateTime" in {
val typeOper = "foo".$type[org.joda.time.DateTime]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.DATE))
}
}
"None (null)" in {
// For some reason you can't use NONE
val typeOper = "foo".$type[Option[Nothing]]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.NULL))
}
"Regex" in {
"Scala Regex" in {
val typeOper = "foo".$type[scala.util.matching.Regex]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.REGEX))
}
}
"Symbol" in {
val typeOper = "foo".$type[Symbol]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.SYMBOL))
}
"Number (integer)" in {
val typeOper = "foo".$type[Int]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.NUMBER_INT))
}
"Number (Long)" in {
val typeOper = "foo".$type[Long]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.NUMBER_LONG))
}
"Timestamp" in {
val typeOper = "foo".$type[java.sql.Timestamp]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.TIMESTAMP))
}
"Binary" in {
val typeOper = "foo".$type[Array[Byte]]
typeOper must notBeNull
typeOper.toString must notBeNull
typeOper must haveSuperClass[DBObject]
typeOper must beEqualTo(nonDSL("foo", "$type", org.bson.BSON.BINARY))
}
}
(注意:您需要将 casbah-query 包及其相关导入导入您的代码,或者使用预模块化的默认 'casbah' 导入)。Casbah 规范目前已全面覆盖每个 DSL 运营商;文档目前落后,但规范很好地介绍了它们的用法。请注意,Casbah 中有两种运算符,就像 MongoDB 中一样。
裸字运算符,其中语句的最左边部分是$ 运算符。这方面的示例是$set
,$rename
等。有关更多信息,请参阅裸字运算符的规范。
“核心”运算符,是存在于语句右侧的运算符,例如$type
. 有关更多信息,请参阅核心运算符规范。
我知道这是一个相当详细的答案,但我想确保您了解您的选择,以及这两种解决方案的局限性。Casbah 将为您提供一个与 MongoDB 紧密映射的 DSL,并删除一些语法上的杂乱无章(请记住,Casbah 还提供了一种getAs[T]
方法来从人们经常忽略的特定类型DBObject
中请求一个值);许多用户在寻找一些东西来做内置的东西之前并不知道 DSL 的存在。然而DBObject
, Casbah 的 Query DSL 在某些人看来也有点“粗鲁”......作为它的作者,我更喜欢它的简单和优雅,因为我只需要记住 **MONGODB* 查询语法,而不是 MongoDB 和另一个 DSL . 它还基于自由形式的查询,不提供与 Rogue 相同的结构化、编译时类型安全和感知工具。
相比之下,Rogue 还需要一个完全定义的 Record 模型来对抗它,这并不适合每个应用程序。
但是,如果您的需求有一个“中间地带”,而这两种产品都不能很好地满足,我很想听听这两种产品在哪里可以改进。