映射MongoDB _id字段的幾種常見方式

更新時間：2025年05月22日 09:42:19 作者：冰糖心書房

在 Spring Data MongoDB 中,將 Java POJO 的字段映射到 MongoDB 文檔的 _id 字段非常直接,主要通過 @Id 注解（org.springframework.data.annotation.Id）來完成,本文介紹了映射 MongoDB _id 字段的幾種常見方式和關(guān)鍵點,需要的朋友可以參考下

1、使用 String 類型作為 ID (最常見):

當 @Id 注解的字段類型是 String 時，Spring Data MongoDB 會將其視為 MongoDB ObjectId 的字符串表示形式。
如果在保存新文檔時此 String 字段為 null，MongoDB Java 驅(qū)動程序會自動生成一個新的 ObjectId，然后 Spring Data MongoDB 會將其轉(zhuǎn)換為字符串并賦值給該字段。
這是最推薦和最方便的方式，因為字符串形式的 ID 更容易在 API、URL 和日志中使用。

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "my_entities")
public class MyEntity {

    @Id
    private String id; // 將映射到 MongoDB 的 _id 字段

    private String name;

    // Constructors, getters, setters
    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

當你保存一個新的 MyEntity 實例且 id 字段為 null 時：

MyEntity entity = new MyEntity();
entity.setName("Test Entity");
mongoTemplate.save(entity); // entity.getId() 現(xiàn)在會有一個自動生成的 ObjectId 字符串
System.out.println(entity.getId()); // 例如："60c72b941f4b1a3e4c8e4f3a"

2、使用 org.bson.types.ObjectId 類型作為 ID:

你可以直接使用 MongoDB BSON庫提供的 ObjectId 類型。
同樣，如果在保存新文檔時此 ObjectId 字段為 null，驅(qū)動程序會自動生成一個新的 ObjectId。

import org.bson.types.ObjectId;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "products")
public class Product {

    @Id
    private ObjectId id; // 直接使用 ObjectId 類型

    private String productName;

    // Constructors, getters, setters
    public ObjectId getId() {
        return id;
    }

    public void setId(ObjectId id) {
        this.id = id;
    }

    public String getProductName() {
        return productName;
    }

    public void setProductName(String productName) {
        this.productName = productName;
    }
}

3、使用其他 Java 類型作為 ID (例如 Long, BigInteger):

你也可以使用其他原始類型或?qū)ο箢愋停ㄈ?nbsp;Long, BigInteger）作為 _id。
重要: 如果使用這些類型，MongoDB 不會自動為你生成 ID。你必須在保存文檔之前自己提供一個唯一的 ID 值。如果插入時該字段為 null (對于對象類型) 或默認值 (對于原始類型且你未設(shè)置)，可能會導致錯誤或意外行為，具體取決于驅(qū)動程序和服務(wù)器版本。
這種方式適用于你有外部系統(tǒng)生成 ID，或者 ID 具有特定業(yè)務(wù)含義的情況。

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;
import java.math.BigInteger;

@Document(collection = "items")
public class Item {

    @Id
    private Long itemId; // 使用 Long 類型，需要自己保證唯一性并賦值

    // 或者
    // @Id
    // private BigInteger itemId; // 使用 BigInteger，需要自己保證唯一性并賦值

    private String description;

    // Constructors, getters, setters
    public Long getItemId() {
        return itemId;
    }

    public void setItemId(Long itemId) {
        this.itemId = itemId;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

使用自定義ID時：

Item item = new Item();
item.setItemId(12345L); // 必須手動設(shè)置 ID
item.setDescription("Custom ID Item");
mongoTemplate.save(item);

4、Java 字段名不一定是 “id”:

被 @Id 注解的 Java 字段的名稱可以不是 id。Spring Data MongoDB 依然會將其映射到 MongoDB 文檔中的 _id 字段。

import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "books")
public class Book {

    @Id
    private String bookIsbn; // Java 字段名為 "bookIsbn"，但它映射到 MongoDB 的 _id

    private String title;

    // Getters and setters
    public String getBookIsbn() {
        return bookIsbn;
    }

    public void setBookIsbn(String bookIsbn) {
        this.bookIsbn = bookIsbn;
    }
    // ...
}

關(guān)鍵點總結(jié):

@Id 注解: 是將 Java 字段標記為 MongoDB _id 的核心。
自動生成:
- 僅當 @Id 字段類型為 String 或 org.bson.types.ObjectId，并且在插入新文檔時該字段值為 null 時，ID 才會由 MongoDB 驅(qū)動自動生成。
- 其他類型（如 Long, Integer, BigInteger）需要你在應(yīng)用程序中手動賦值并確保其唯一性。
不可變性: MongoDB 中的 _id 字段一旦設(shè)置，就不能被修改。嘗試更新 _id 會導致操作失敗或創(chuàng)建一個新文檔（取決于操作類型）。
唯一性: _id 在其集合中必須是唯一的。MongoDB 會自動為 _id 字段創(chuàng)建唯一索引。
@Field("_id"): 通常不需要。@Id 注解本身就隱含了該 Java 字段映射到 BSON 文檔的 _id 鍵。顯式使用 @Field("_id") 是多余的。