我们将使用 MongoDB Java Driver 4.0+，这是目前的主流版本，其 API 与旧版本（3.x）有显著不同,更加现代化和类型安全。

目录

1. 前置准备
2. 核心概念：MongoCollection 和 IndexOptions
3. 创建索引
   • 创建单字段索引
   • 创建复合索引
   • 创建唯一索引
   • 创建稀疏索引
   • 创建 TTL (Time-To-Live) 索引（用于自动过期数据）
   • 创建部分索引
4. 查看和管理索引
   • 列出集合的所有索引
   • 获取特定索引信息
   • 删除索引
5. 高级索引操作
   • 后台创建索引
   • 在已有索引上构建
   • 索引使用情况分析 (explain())
6. **最佳实践与注意事项

前置准备

确保你已经添加了 MongoDB Java Driver 的依赖，如果你使用 Maven，在 pom.xml 中添加：

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>mongodb-driver-sync</artifactId>
    <version>4.11.1</version> <!-- 请使用最新版本 -->
</dependency>

建立一个与 MongoDB 的连接：

import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import com.mongodb.client.MongoDatabase;
import com.mongodb.client.MongoCollection;
// 连接字符串
String uri = "mongodb://localhost:27017";
// 创建 MongoClient
try (MongoClient mongoClient = MongoClients.create(uri)) {
    // 获取数据库
    MongoDatabase database = mongoClient.getDatabase("testDB");
    // 获取集合
    MongoCollection<Document> collection = database.getCollection("users");
    // ... 后续的索引操作都在这里进行 ...
} // try-with-resources 会自动关闭 MongoClient

核心概念：MongoCollection 和 IndexOptions

• MongoCollection<Document>: 这是 Java Driver 中代表 MongoDB 集合的核心接口,所有的索引操作都通过这个对象的方法来执行。
• IndexOptions: 这是一个配置类，用于在创建索引时指定各种选项，
  • unique(): 是否唯一。
  • sparse(): 是否稀疏。
  • name(): 索引名称。
  • expireAfter(): TTL 索引的过期时间。
  • background(): 是否在后台创建。
• Indexes: 这是一个工具类，提供了创建索引键（IndexModel）的静态方法,非常方便。

创建索引

创建索引的核心方法是 createIndex()，它需要一个 IndexModel 对象作为参数，该对象包含了索引的键（字段和排序方向）和选项。

1 创建单字段索引

假设 users 集合经常按 username 字段查询,我们可以为它创建一个升序索引。

// 创建一个升序索引
collection.createIndex(Indexes.ascending("username"));
// 创建一个降序索引
collection.createIndex(Indexes.descending("age"));

2 创建复合索引

当查询涉及多个字段时，复合索引非常有效，我们经常按 status 和 createdDate 进行查询。

// 创建一个复合索引：status 升序，createdDate 降序
collection.createIndex(Indexes.compoundIndex(
    Indexes.ascending("status"),
    Indexes.descending("createdDate")
));

3 创建唯一索引

唯一索引确保集合中所有文档在指定字段上的值都是唯一的，常用于邮箱、用户名等字段。

IndexOptions options = new IndexOptions().unique(true);
collection.createIndex(Indexes.ascending("email"), options);

4 创建稀疏索引

稀疏索引只包含具有索引字段的文档的条目，这对于包含大量缺失字段的集合非常有用，可以避免为这些缺失字段存储 null 值,从而节省空间。

IndexOptions options = new IndexOptions().sparse(true);
collection.createIndex(Indexes.ascending("optional_field"), options);

5 创建 TTL (Time-To-Live) 索引

TTL 索引可以让 MongoDB 自动在指定时间后删除文档，通常用于存储会话日志、事件数据等。

重要限制:

• TTL 索引必须建立在 日期类型 (Date 或 BSONTimestamp) 的字段上。
• 一个集合只能有一个 TTL 索引。

// 假设每个文档都有一个 "lastAccessedAt" 字段，类型为 Date
// 30分钟后自动删除该文档
IndexOptions options = new IndexOptions().expireAfter(30L, TimeUnit.MINUTES);
collection.createIndex(Indexes.ascending("lastAccessedAt"), options);

6 创建部分索引

部分索引是比稀疏索引更灵活的一种索引，它只对满足指定筛选条件的文档建立索引,这可以极大地减少索引的大小和内存占用。

// 只为 status 为 "active" 的用户创建索引
Bson filter = Filters.eq("status", "active");
IndexOptions options = new IndexOptions().partialFilterExpression(filter);
collection.createIndex(Indexes.ascending("username"), options);

查看和管理索引

1 列出集合的所有索引

listIndexes() 方法会返回一个 MongoCursor,遍历它可以获取所有索引的详细信息。

System.out.println("Indexes for 'users' collection:");
try (MongoCursor<Document> cursor = collection.listIndexes()) {
    while (cursor.hasNext()) {
        Document index = cursor.next();
        System.out.println(index.toJson());
    }
}

输出会是一个包含索引元数据的 JSON 数组，

{
    "v": 2, // 索引版本
    "key": { // 索引键
        "_id": 1
    },
    "name": "_id_" // 索引名称
}
{
    "v": 2,
    "key": {
        "username": 1
    },
    "name": "username_1"
}

2 获取特定索引信息

如果你知道索引的名称，可以使用 getIndex() 方法。

String indexName = "username_1";
Document indexInfo = collection.getIndex(indexName);
System.out.println("Details for index '" + indexName + "': " + indexInfo.toJson());

3 删除索引

删除索引可以通过索引名称或索引模型来完成。

// 方法1：通过索引名称删除
String indexNameToDelete = "email_1";
collection.dropIndex(indexNameToDelete);
// 方法2：通过索引模型删除（适用于未命名或动态生成的索引）
// 注意：这里的键必须与创建时完全一致
collection.dropIndex(Indexes.ascending("age"));

高级索引操作

1 后台创建索引

创建大型索引可能会阻塞数据库的其他操作，可以在后台创建索引，这样它就不会阻塞其他读写操作,但创建过程本身可能会更长。

IndexOptions options = new IndexOptions().background(true);
// 为一个可能很大的字段创建后台索引
collection.createIndex(Indexes.ascending("large_data_field"), options);

2 在已有索引上构建

对于非常大的集合，在空集合上创建索引和在已有数据上创建索引的性能差异巨大。createIndex() 默认会阻塞并扫描整个集合来构建索引。

3 索引使用情况分析 (explain())

explain() 是一个极其强大的工具，用于分析查询是否使用了索引，以及使用了哪个索引,这对于性能优化至关重要。

// 1. 创建一个查询
Bson query = Filters.eq("status", "active");
// 2. 创建一个排序
Bson sort = Sorts.descending("createdDate");
// 3. 执行 explain
// queryPlanner 是最常用的模式，显示查询计划
Document explainResult = collection.find(query).sort(sort).explain();
// 打印结果，分析是否使用了我们创建的复合索引
System.out.println("Explain result: " + explainResult.toJson());

如何解读 explain() 结果？ 在输出的 JSON 中，查找 winningPlan 字段。inputStage 中包含 indexName，说明查询使用了该索引。inputStage 的 stage 是 COLLSCAN (Collection Scan)，则说明查询进行了全表扫描，没有使用任何索引,这是性能低下的表现。

最佳实践与注意事项

1. 只为需要的字段创建索引：每个索引都会占用磁盘空间和内存，并且会降低写入（插入、更新、删除）速度，因为每次写入都需要更新所有索引,不要过度索引。
2. 分析查询模式：根据你的应用中最常见的查询（如 find(), sort(), match()）来创建索引，使用 explain() 和 MongoDB Profiler 来监控查询性能。
3. 复合索引的顺序很重要：在 (A, B) 的复合索引中：
   • 它可以高效支持 A 的查询。
   • 它可以高效支持 A 和 B 的组合查询。
   • 但它不能高效支持只包含 B 的查询，将高选择性（区分度高）的、经常用于过滤的字段放在索引前面。
4. 在低峰期创建索引：对于生产环境的大型集合，在业务低峰期使用 background 选项创建索引,以减少对应用性能的影响。
5. 监控索引大小：使用 db.collection.stats() 命令（或在 Java 中通过 runCommand 执行）来监控集合和索引的大小,确保索引没有失控。
6. 命名索引：为重要的索引指定一个清晰的名称，方便日后管理和删除，如果不指定，MongoDB 会自动生成一个（如 fieldname_1）。

   IndexOptions options = new IndexOptions().name("user_status_created_date_idx");
   collection.createIndex(Indexes.compoundIndex(Indexes.ascending("status"), Indexes.descending("createdDate")), options);

   你应该已经掌握了在 Java 应用中全面管理 MongoDB 索引的方法，合理地使用索引是确保 MongoDB 应用高性能的关键。