WatermelonDB 查询 API 深度解析

WatermelonDB 查询 API 深度解析

WatermelonDB 🍉 Reactive & asynchronous database for powerful React and React Native apps ⚡️ 项目地址: https://gitcode.com/gh_mirrors/wa/WatermelonDB

前言

在现代移动应用开发中，高效的数据查询是保证应用性能的关键。WatermelonDB 作为一个高性能的 React Native/Web 数据库解决方案，提供了强大而灵活的查询 API。本文将深入探讨 WatermelonDB 的查询机制，帮助开发者充分利用其优势构建响应迅速的应用程序。

基础查询

简单关联查询

WatermelonDB 中最基础的查询是通过 @children 装饰器定义的关联查询。这种查询会自动查找与当前模型关联的所有子记录：

class Post extends Model {
  @children('comments') comments
}

这段代码定义了从 Post 到 Comment 的一对多关系，可以轻松获取某篇文章的所有评论。

查询扩展

通过 .extend() 方法，我们可以基于现有查询创建更具体的子查询：

class Post extends Model {
  @lazy verifiedComments = this.comments.extend(
    Q.where('is_verified', true)
}

这里我们创建了一个只返回已验证评论的查询。使用 @lazy 装饰器可以确保查询只在需要时才会被创建，优化性能。

查询执行方式

响应式查询

WatermelonDB 推荐使用响应式方式执行查询，这种方式会自动跟踪数据变化并更新UI：

withObservables(['post'], ({ post }) => ({
  comments: post.comments
}))

直接获取

对于不需要持续观察的场景，可以使用 fetch 和 fetchCount 直接获取当前数据：

const comments = await post.comments.fetch()
const count = await post.verifiedComments.fetchCount()

查询条件详解

基本条件

WatermelonDB 提供了丰富的条件操作符：

Q.where('likes', Q.gt(10)) // 点赞数大于10
Q.where('status', Q.oneOf(['published', 'draft'])) // 状态为已发布或草稿

关联表查询

通过 Q.on 可以在查询中引用关联表：

database.get('comments').query(
  Q.on('posts', 'author_id', john.id)
)

这段代码查询了 John 所写文章下的所有评论。

复合条件

使用 Q.and 和 Q.or 可以构建复杂的逻辑条件：

Q.or(
  Q.where('is_verified', true),
  Q.and(
    Q.where('likes', Q.gt(10)),
    Q.where('dislikes', Q.lt(5))
  )
)

高级查询技巧

排序与分页

Q.sortBy('likes', Q.desc),
Q.skip(20),
Q.take(10)

这种组合非常适合实现分页加载功能。

性能优化

1. 使用 fetchIds() 只获取ID而非完整记录
2. 对长列表使用分页查询
3. 合理使用 @lazy 延迟创建查询

安全注意事项

1. 永远不要直接将用户输入用于查询条件
2. 使用 Q.sanitizeLikeString 处理 LIKE 查询的输入
3. 验证所有传入查询的参数类型

特殊场景处理

NULL 值处理

WatermelonDB 的 NULL 处理遵循 SQLite 语义，与 JavaScript 不同。例如：

Q.where('likes', Q.lt(10)) // 不会包含 likes 为 NULL 的记录

原生查询

在极少数需要复杂查询的场景下，可以使用原生 SQL：

Q.unsafeSqlQuery(`select * from comments where foo is not ?`, ['bar'])

但应尽量避免这种用法，除非确实需要。

总结

WatermelonDB 的查询 API 既强大又灵活，能够满足从简单到复杂的各种数据查询需求。通过合理利用其特性，开发者可以构建出高性能的应用程序，同时保持代码的简洁性和可维护性。记住，大多数情况下应该优先使用声明式查询而非命令式操作，以充分发挥 WatermelonDB 的响应式优势。

对于更高级的使用场景，建议参考官方文档中的性能优化指南，了解如何针对特定用例调整查询策略。

WatermelonDB 🍉 Reactive & asynchronous database for powerful React and React Native apps ⚡️ 项目地址: https://gitcode.com/gh_mirrors/wa/WatermelonDB