本文详细介绍了如何在 Mongoose 中将 `_id` 字段的数据类型从默认的 `ObjectId` 更改为 `Number`，并实现自动递增的序列号。我们将通过创建自定义 SchemaType 来验证数字 `_id`，并进一步结合预保存钩子和单独的计数器集合，实现 `_id` 字段的原子性自动生成，提供完整的代码示例和最佳实践。
Mongoose 模型默认使用 ObjectId 作为文档的 _id 字段，它是一个 12 字节的唯一标识符，通常能满足大多数应用的需求。然而，在某些特定场景下，开发者可能希望将 _id 字段设置为 Number 类型，例如：
直接在 Schema 中设置 _id: Number 仅仅是定义了其类型，Mongoose 或 MongoDB 并不会为 Number 类型的 _id 自动生成递增值。若不手动赋值，MongoDB 仍会生成 ObjectId。要实现数字类型的 _id 并使其自动递增，我们需要更精细的控制。
Mongoose 允许我们创建自定义的 SchemaType，这对于验证和规范特定字段的数据类型非常有用。我们将创建一个名为 NumberId 的自定义 SchemaType，用于确保 _id 字段始终是正整数。
const mongoose = require('mongoose');
// 1. 定义自定义 SchemaType 构造函数
function NumberId(key, options) {
// 调用父类 SchemaType 的构造函数
mongoose.SchemaType.call(this, key, options, 'NumberId');
}
// 2. 继承 Mongoose.SchemaType
NumberId.prototype = Object.create(mongoose.SchemaType.prototype);
// 3. 实现 `cast()` 方法进行类型转换和验证
// cast 方法负责将传入的值转换为 SchemaType 所期望的类型
NumberId.prototype.cast = function (val) {
if (typeof val !== 'number') {
throw new Error('NumberId: ' + val + ' 不是一个数字');
}
if (val % 1 !== 0) { // 检查是否为整数
throw new Error('NumberId: ' + val + ' 不是一个整数');
}
if (val < 0) { // 检查是否为正数
throw new Error('NumberId: ' + val + ' 是一个负数');
}
return val;
};
// 4. 注册自定义 SchemaType
mongoose.Schema.Types.NumberId = NumberId;代码解释：
注册了自定义 SchemaType 后，我们就可以在模型 Schema 中将其应用于 _id 字段。
// 创建一个新 Schema，使用我们自定义的 SchemaType
const mySchema = new mongoose.Schema(
{
_id: { type: mongoose.Schema.Types.NumberId, required: true, unique: true },
name: String, // 其他字段
// ...
},
{ autoIndex: true } // 建议保留 autoIndex 为 true，除非你手动管理索引
);
// 创建一个模型
const MyModel = mongoose.model('MyModel', mySchema);代码解释：
至此，我们已经成功地将 _id 字段约束为正整数类型。然而，这并没有解决自动生成递增 _id 的问题。如果此时不手动为 _id 赋值，Mongoose 仍然会生成 ObjectId。
Mongoose 或 MongoDB 本身并没有为 Number 类型的 _id 提供内置的自动递增机制（如 SQL 数据库的 AUTO_INCREMENT）。要实现这一点，我们需要采用一种常见的模式：使用一个单独的计数器集合，并在主模型的保存操作前通过钩子（Pre-save Hook）来获取并分配递增的 _id。
解决方案：使用单独的计数器集合和预保存钩子
创建计数器模型 (Counter Model): 我们将创建一个简单的 Counter 模型，用于存储每个集合的下一个可用序列号。
// 计数器 Schema
const CounterSchema = new mongoose.Schema({
_id: { type: String, required: true }, // 集合名称，例如 'my_model_id'
sequence_value: { type: Number, default: 0 }
});
const Counter = mongoose.model('Counter', CounterSchema);实现预保存钩子 (Pre-save Hook): 在主模型 MyModel 的 pre('save') 钩子中，我们将实现逻辑来：
// 修改 MyModel Schema，添加预保存钩子
mySchema.pre('save', async function(next) {
const doc = this;
// 仅当 _id 未设置时（即新文档）才执行自动递增
if (doc.isNew && !doc._id) {
try {
const counter = await Counter.findByIdAndUpdate(
{ _id: 'my_model_id' }, // 这里的 _id 对应计数器集合中的文档 ID，通常是模型名称或自定义标识
{ $inc: { sequence_value: 1 } },
{ new: true, upsert: true } // new: 返回更新后的文档；upsert: 如果不存在则创建
);
doc._id = counter.sequence_value;
next();
} catch (error) {
next(error); // 捕获错误并传递给下一个中间件
}
} else {
next(); // 如果 _id 已经存在或不是新文档，则直接跳过
}
});整合完整代码示例：
const mongoose = require('mongoose');
// --- 第一部分：自定义 NumberId SchemaType ---
function NumberId(key, options) {
mongoose.SchemaType.call(this, key, options, 'NumberId');
}
NumberId.prototype = Object.create(mongoose.SchemaType.prototype);
NumberId.prototype.cast = function (val) {
if (typeof val !== 'number') {
throw new Error('NumberId: ' + val + ' 不是一个数字');
}
if (val % 1 !== 0) {
throw new Error('NumberId: ' + val + ' 不是一个整数');
}
if (val < 0) {
throw new Error('NumberId: ' + val + ' 是一个负数');
}
return val;
};
mongoose.Schema.Types.NumberId = NumberId;
// --- 第二部分：计数器模型 ---
const CounterSchema = new mongoose.Schema({
_id: { type: String, required: true }, // 例如 'my_model_id'
sequence_value: { type: Number, default: 0 }
});
const Counter = mongoose.model('Counter', CounterSchema);
// --- 第三部分：主模型 Schema 及预保存钩子 ---
const mySchema = new mongoose.Schema(
{
_id: { type: mongoose.Schema.Types.NumberId, required: true, unique: true },
name: { type: String, required: true },
// 其他字段
},
{ autoIndex: true }
);
// 定义预保存钩子，实现自动递增 _id
mySchema.pre('save', async function(next) {
const doc = this;
// 只有当文档是新建且 _id 未手动设置时才自动生成
if (doc.isNew && doc._id === undefined) {
try {
// 查找并原子性递增计数器
const counter = await Counter.findByIdAndUpdate(
{ _id: 'my_model_id' }, // 使用一个固定的 ID 来标识这个模型的计数器
{ $inc: { sequence_value: 1 } },
{ new: true, upsert: true, setDefaultsOnInsert: true } // upsert: 不存在则创建
);
doc._id = counter.sequence_value;
next();
} catch (error) {
console.error('生成 _id 失败:', error);
next(error); // 传递错误
}
} else {
next(); // 如果 _id 已存在或不是新文档，则跳过自动生成
}
});
const MyModel = mongoose.model('MyModel', mySchema);
// --- 使用示例 ---
const mongoUri = 'mongodb://localhost:27017/testdb'; // 请替换为你的 MongoDB URI
async function run() {
await mongoose.connect(mongoUri, {
useNewUrlParser: true,
useUnifiedTopology: true,
});
console.log('MongoDB 连接成功');
// 清空集合以便测试
await MyModel.deleteMany({});
await Counter.deleteMany({}); // 清空计数器
// 确保计数器初始化（如果 upsert: true，则首次保存会自动创建并初始化为1）
// 或者可以手动初始化：await Counter.create({ _id: 'my_model_id', sequence_value: 0 });
try {
// 创建一些文档，_id 将自动生成
const doc1 = await MyModel.create({ name: 'Document One' });
console.log('创建文档 1:', doc1); // _id 应该是 1
const doc2 = await MyModel.create({ name: 'Document Two' });
console.log('创建文档 2:', doc2); // _id 应该是 2
const doc3 = await MyModel.create({ name: 'Document Three' });
console.log('创建文档 3:', doc3); // _id 应该是 3
// 尝试手动设置 _id (如果符合 NumberId 规则，则会使用手动设置的值)
const doc4 = await MyModel.create({ _id: 100, name: 'Document Hundred' });
console.log('创建文档 4 (手动 _id):', doc4); // _id 应该是 100
// 尝试创建无效 _id (非数字或负数)
// await MyModel.create({ _id: 'abc', name: 'Invalid ID' }); // 会抛出 NumberId cast 错误
// await MyModel.create({ _id: -5, name: 'Invalid ID' }); // 会抛出 NumberId cast 错误
} catch (err) {
console.error('操作失败:', err.message);
} finally {
await mongoose.disconnect();
console.log('MongoDB 连接关闭');
}
}
run();代码解释：
本文提供了一个全面的教程，指导您如何在 Mongoose 中将 _id 字段从默认的 ObjectId 更改为 Number 类型，并实现自动递增的序列号。我们首先通过自定义 NumberId SchemaType 确保 _id 字段的类型和值约束，然后通过一个独立的计数器模型和 Mongoose 的 pre('save') 钩子，实现了 _id 的原子性自动递增。在实际应用中，请务必根据项目的具体需求和性能考量，权衡选择最合适的 _id 生成策略。
以上就是自定义 Mongoose _id 为数字类型并实现自动递增的详细内容，更多请关注php中文网其它相关文章！
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移，垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是，许多工具可以让 Windows 保持平稳运行。
广告Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号
718
收藏
