Overview
在本指南中,您可以学习如何将您的 数据类 属性直接与 Kotlin 同步 驱动程序中提供的构建者类一起使用。
Kotlin 同步驱动程序实现了扩展,允许您在使用构建者方法(而不是使用 string 字段名称)时引用数据类属性。您可以通过这种方式构建代码,从而提高代码的类型安全性,并提高应用程序的Kotlin互操作性。
扩展库还允许使用中缀表示法构造查询、更新文档和写入其他语句。要学习;了解有关此表示法的更多信息,请参阅Kotlin参考文档中的中缀表示法。
注意
本页提供了有限数量的代码示例来演示此功能。要学习;了解有关使用构建器类的更多信息,请参阅使用构建器 Code Pattern指南。
为项目添加Kotlin扩展
要实现此功能,您必须将 mongodb-driver-kotlin-extensions 依赖项添加到依赖项列表中。
提示
物料清单
我们建议将Java虚拟机(JVM)驱动程序物料清单 (BOM) 添加到您的应用程序中,以管理驱动程序工件的版本。这删除了为 BOM 涵盖的任何单个包指定版本的需要,从而简化了依赖项管理。要学习;了解更多信息,请参阅入门指南中的“添加驱动程序物料清单”步骤。
从以下标签页中进行选择,查看如何使用 Gradle 和 Maven包管理器将扩展依赖项添加到项目中:
安装扩展依赖项后,可以通过从 com.mongodb.kotlin.client.model 路径导入类和方法来使用扩展方法。 您可以在同一应用程序中混合使用这些方法和标准构建器方法,如本指南中的聚合示例所示。
构建器示例
本节包含的示例演示如何将数据类属性直接与扩展包中的构建器类方法一起使用。
提示
数据类注解
当您使用数据类的扩展构建器类方法时,这些方法会遵循 bson-kotlin 和 bson-kotlinx 包中的数据类注解。 要学习;了解有关注解的更多信息,请参阅《文档数据格式:数据类》指南中的使用注解指定组件转换部分。
样本数据
本部分中的示例使用 students集合中描述学校学生的文档。students集合中的文档由以下Kotlin数据类进行建模:
data class Student( val name: String, val teachers: List<String>, val gradeAverage: Double)筛选器
您可以使用 Filters构建者类中的助手来查询数据类属性。
以下代码展示了使用 Filters 扩展方法对 Student 数据类执行查询的不同方法:
import com.mongodb.kotlin.client.model.Filters.eqimport com.mongodb.kotlin.client.model.Filters.allval student = Student( "Sandra Nook", listOf("Alvarez", "Gruber"), 85.7)
// Equivalent equality queriesStudent::name.eq(student.name)eq(Student::name, student.name)Student::name eq student.name // Infix notation
// Equivalent array queriesall(Student::teachers, student.teachers)Student::teachers.all(student.teachers)Student::teachers all student.teachers // Infix notation索引
您可以使用 Indexes构建者类中的助手为数据类属性创建索引。
以下代码展示了使用 Indexes 扩展方法在 Student 数据类上创建索引的不同方法:
import com.mongodb.kotlin.client.model.Indexes.ascendingimport com.mongodb.kotlin.client.model.Indexes.descendingval ascendingIdx = Indexes.ascending(Student::name)val descendingIdx = Indexes.descending(Student::teachers)
val ascIdxName = collection.createIndex(ascendingIdx)val descIdxName = collection.createIndex(descendingIdx)投影
您可以使用 Projections构建者类中的助手为数据类属性创建投影。
以下代码展示了如何使用 Projections 扩展方法在 Student 数据类上创建投影:
import com.mongodb.kotlin.client.model.Projections.excludeIdimport com.mongodb.kotlin.client.model.Projections.fieldsimport com.mongodb.kotlin.client.model.Projections.includeval combinedProj = fields( include(Student::name, Student::gradeAverage), excludeId())
collection.find().projection(combinedProj)排序
您可以使用 Sorts构建者类中的助手对数据类属性进行排序。
以下代码演示如何使用 Sorts 扩展方法对 Student 数据类创建不同的排序:
import com.mongodb.client.model.Sorts.orderByimport com.mongodb.kotlin.client.model.Sortsval sort = orderBy( Sorts.descending(Student::gradeAverage), Sorts.ascending(Student::name))
collection.find().sort(sort)更新
您可以使用 Updates构建者类中的助手,通过数据类属性执行更新。
以下代码演示如何使用 Sorts 扩展方法对 Student 数据类创建不同的排序:
import com.mongodb.kotlin.client.model.Filters.gteimport com.mongodb.kotlin.client.model.Updates.addToSetimport com.mongodb.kotlin.client.model.Updates.combineimport com.mongodb.kotlin.client.model.Updates.maxval filter = Student::gradeAverage gte 85.0val update = combine( addToSet(Student::teachers, "Soto"), Student::gradeAverage.max(90.0))collection.updateMany(filter, update)聚合
您可以使用 Aggregates 和 Accumulators构建者类中的助手,通过数据类属性来执行聚合。
以下代码展示了如何使用 Accumulators 扩展方法和 Aggregates 辅助方法对 Student 数据类执行聚合:
import com.mongodb.client.model.Aggregates.groupimport com.mongodb.client.model.Aggregates.limitimport com.mongodb.client.model.Aggregates.sortimport com.mongodb.kotlin.client.model.Accumulators.avg// Data class to store aggregation resultdata class Summary ( val average: Double )
val pipeline = listOf( // Sorts grades from high to low sort(Sorts.descending(Student::gradeAverage)), // Selects the top 3 students limit(3), // Calculates the average of their grades and stores value in a Summary instance group(null, avg(Summary::average, "\$${Student::gradeAverage.name}")))
val result = collection.aggregate<Summary>(pipeline)