Dexie.js 中索引使用常见问题解析

在使用 Dexie.js 进行 IndexedDB 开发时，索引的正确使用是一个关键点。许多开发者在使用 where() 方法进行数据查询时，经常会遇到"KeyPath is not indexed"的错误提示。本文将深入分析这个问题产生的原因及解决方法。

问题现象

开发者在使用 Dexie.js 进行数据查询时，尝试执行以下代码：

let r = await db.tran.where(["time"]).between(2, 1000, true, true).toArray()

结果系统抛出异常："KeyPath [time] on object store tran is not indexed"。而数据库的定义如下：

let db = new Dexie('db');
db.version(1).stores({
    tran: 'time'
});
db.tran.put({"time":234});

问题分析

这个问题的核心在于对 Dexie.js 索引语法的误解。开发者错误地使用了数组符号 [] 来包裹单个索引字段 time，这实际上是在尝试定义一个复合索引(compound index)，而不是单个字段索引。

在 Dexie.js 中：

1. 单个字段索引应该直接使用字段名作为字符串
2. 复合索引才需要使用数组语法，包含多个字段名

正确解决方案

要解决这个问题，只需移除不必要的数组符号即可：

let r = await db.tran.where("time").between(2, 1000, true, true).toArray()

深入理解

1. 单个字段索引：当只需要对一个字段建立索引时，直接在 where() 方法中传入该字段名的字符串即可。这是最简单也是最常用的索引方式。

2. 复合索引：当需要同时对多个字段建立联合索引时，才需要使用数组语法。例如 where(["firstName", "lastName"]) 表示创建一个由 firstName 和 lastName 组成的复合索引。

3. 索引定义：在定义数据库结构时，单个字段索引和复合索引的语法也有所不同。单个字段可以直接列出，多个字段需要用逗号分隔。

最佳实践

1. 在定义简单索引时，避免不必要的数组语法
2. 确保查询时使用的索引与数据库定义中的索引一致
3. 对于性能关键的应用，合理设计索引策略
4. 在开发过程中，可以使用 Dexie.js 的调试工具检查索引是否正确建立

总结

理解 Dexie.js 中索引的正确使用方式对于开发高效的 IndexedDB 应用至关重要。通过本文的分析，开发者应该能够清楚地认识到单个字段索引和复合索引的区别，并避免在简单场景下错误地使用复合索引语法。正确的索引使用不仅能解决查询错误，还能显著提升应用的数据检索性能。