GraphQL适配MongoDB User记录:id与_id的正确实现方式
解决GraphQL与MongoDB用户ID字段映射问题
我来帮你捋清楚这个问题,这确实是很多刚把GraphQL和MongoDB结合起来用的开发者都会碰到的小困惑~
先给你明确几个核心结论:
- 你一开始定义的
type User { id: ID! name: String! email: String! }是完全符合GraphQL最佳实践的,不需要自己手动填充id字段,我们只需要在数据流转的环节做个字段映射就行。 - 完全没必要放弃MongoDB原生的
_id去自己生成ID,它本身就是全局唯一、可靠的标识符,我们只需要把它转成GraphQL里的id字段返回给客户端。
具体实现方案分两种情况:
1. 手动在GraphQL解析器里转换字段
不管你用原生MongoDB驱动还是Mongoose,都可以在查询/创建用户后,手动把_id的值转成字符串(因为MongoDB的_id是ObjectId类型,GraphQL的ID字段通常用字符串更友好),赋值给id字段再返回。
举个用Mongoose的例子:
// Mongoose用户模型定义 const User = mongoose.model('User', new mongoose.Schema({ name: { type: String, required: true }, email: { type: String, required: true } })); // GraphQL解析器 const resolvers = { Query: { getUser: async (_, { id }) => { // 用_id去MongoDB查询,因为数据库里存的是这个字段 const userDoc = await User.findById(id); // 转换字段后返回 return { id: userDoc._id.toString(), name: userDoc.name, email: userDoc.email }; } }, Mutation: { createUser: async (_, { name, email }) => { const newUser = new User({ name, email }); await newUser.save(); // 同样转换字段返回 return { id: newUser._id.toString(), name: newUser.name, email: newUser.email }; } } };
这样客户端查询的时候,就可以正常请求id字段了:
query { getUser(id: "60d21b4667d0d8992e610c85") { id name email } }
2. 用Mongoose虚拟字段自动处理(更优雅)
如果你用Mongoose,可以给模型添加一个虚拟字段id,让它自动映射_id,并且在返回JSON时自动去掉原生的_id,这样解析器里就不用每次手动转换了:
const userSchema = new mongoose.Schema({ name: { type: String, required: true }, email: { type: String, required: true } }); // 添加虚拟字段id,自动返回_id的字符串形式 userSchema.virtual('id').get(function() { return this._id.toString(); }); // 配置toJSON选项,让虚拟字段被包含,同时去掉多余字段 userSchema.set('toJSON', { virtuals: true, // 包含虚拟字段 versionKey: false, // 去掉__v版本字段 transform: function(doc, ret) { delete ret._id; // 删除原生的_id字段 } }); const User = mongoose.model('User', userSchema);
之后在解析器里直接返回查询到的用户文档就行,Mongoose会自动帮你处理好id字段:
const resolvers = { Query: { getUser: async (_, { id }) => { return await User.findById(id); } } };
关于直接用_id的选项
如果你非要在GraphQL里直接暴露_id字段,那你需要在类型定义里明确声明它:
type User { _id: ID! name: String! email: String! }
这样客户端就能查询_id了,但这种方式不符合GraphQL的通用字段命名规范,不推荐在生产API里这么做,会让客户端的使用体验不一致。
总结
最优雅的方案就是保持GraphQL的id字段定义,利用解析器或者Mongoose虚拟字段来完成MongoDB_id到GraphQLid的转换,完全不需要自己手动生成和填充ID,MongoDB的_id已经足够可靠了。
内容的提问来源于stack exchange,提问作者Sam
相关产品推荐
相关产品推荐

