• 售前

  • 售后

热门帖子
入门百科

mongoDB使用投影剔除‘额外’字段的操作过程

[复制链接]
海田1 显示全部楼层 发表于 2021-8-14 14:57:07 |阅读模式 打印 上一主题 下一主题
目录


  • 简介
  • 1  "额外"字段是什么

    • 1.1 "额外"是指与业务无关
    • 1.2 产生缘故起因

  • 2 额外字段的分类

    • 2.1 _id、__v字段
    • 2.2 createdAt、updatedAt字段
    • 2.3 is_deleted字段

  • 3 额外字段相关使用

    • 3.1 额外字段天生
    • 3.2 额外字段清算

      • 3.2.1 投影
      • 3.2.2 过滤


  • 4 总结

简介


实际开发过程中,为便于开发人员定位标题,常存在多个额外的字段。例如:增加createdAt、updatedAt字段以查察数据的创建和更改时间。而对于客户端而言,无需知道其存在。针对以上环境,本文详细介绍了“额外”字段的用途以及处置惩罚过程。
技能栈
      
  • mongodb 4.0.20  
  • mongoose 5.10.7

1  "额外"字段是什么


1.1 "额外"是指与业务无关


mongodb中,collection中存储的字段并不仅仅有业务字段。有些环境下,会存储多余的字段,以便于开发人员定位标题、扩展集合等。
额外的寄义是指 和业务无关、和开发相关的字段。这些字段不必要被用户所相识,但是在开发过程中是至关紧张的。

1.2 产生缘故起因


产生额外字段的缘故起因是多种多样的。
      
  • 如使用mongoose插件向db中插入数据时,会默认的天生_id、__v字段  
  • 如软删除,则是通过控制is_deleted实现..

2 额外字段的分类


额外字段的产生缘故起因有很多,可以以此进行分类。

2.1 _id、__v字段


产生缘故起因:以mongoose为例,通过schema->model->entity向mongodb中插入数据时,该数据会默认的增加_id、__v字段。
_id字段是由mongodb默认天生的,用于文档的唯一索引。范例是ObjectID。mongoDB文档定义如下:
  1. MongoDB creates a unique index on the _id field during the creation of a collection. The _id index prevents clients from inserting two documents with the same value for the _id field. You cannot drop this index on the _id field.<
复制代码
__v字段是由mongoose初次创建时默认天生,体现该条doc的内部版本号。
  1. The versionKey is a property set on each document when first created by Mongoose. This keys value contains the internal revision of the document. The versionKey option is a string that represents the path to use for versioning. The default is __v.
复制代码
2.2 createdAt、updatedAt字段


createdAt、updatedAt字段是通过timestamp选项指定的,范例为Date。
  1. The timestamps option tells mongoose to assign createdAt and updatedAt fields to your schema. The type assigned is Date.By default, the names of the fields are createdAt and updatedAt. Customize the field names by setting timestamps.createdAt and timestamps.updatedAt.
复制代码
2.3 is_deleted字段


is_deleted字段是实现软删除一种常用的方式。在实际业务中,出于各种缘故起因(如删除后用户要求再次规复等),通常接纳的软删除,而非物理删除。
因此,is_deleted字段生存当前doc的状态。is_deleted字段为true时,体现当前记录有效。is_deleted字段为false时,体现当前记录已被删除。

3 额外字段相关使用


3.1 额外字段天生


_id字段是必选项;__v、createdAt、updatedAt字段是可配置的;status字段直接加在s对应的chema中。相关的schema代码如下:
  1. isdeleted: {
  2. type: String,
  3. default:true,
  4. enum: [true, false],
  5. },
  6. id: {
  7. type: String,
  8. index: true,
  9. unqiue: true,
  10. default:uuid.v4(),
  11. }},
  12. {timestamps:{createdAt:'docCreatedAt',updatedAt:"docUpdatedAt"},versionKey:false});
复制代码
通过配置schema中的timestamps选项,可以将createdAt和updatedAt字段到场到doc中。在创建和更新doc时,这两个字段无需传入,就会自动厘革。

3.2 额外字段清算


通过3.1可以明白的产生若干额外字段,但是客户端调用接口并返回时,这些字段是无需得知的。因此需对额外字段进行清算。清算方式分为投影和过滤。
以query、update接口为例。其中query接口用于:1、查询指定字段 2、查询全部字段 3、分页排序查询。update接口用于更新并返回更新后的数据。
根据是否必要指定字段、和collection中有无内嵌的环境分别,一共有4类。接着针对这4种环境进行分析。
1、有指定字段、无内嵌
2、无指定字段、无内嵌
3、有指定字段、有内嵌
4、无指定字段、有内嵌

3.2.1 投影


有指定字段是指在查询时指定查询字段,而无需全部返回。mongo中实现指定的方式是投影 (project) 。mongo官方文档中定义如下:
  1. The $project takes a document that can specify the inclusion of fields, the suppression of the _id field, the addition of new fields, and the resetting of the values of existing fields. Alternatively, you may specify the exclusion of fields.
复制代码
$project可以做3件事:
1.指定包罗的字段、克制_id字段、添加新字段
2.重置已存在字段的值
3.指定扫除的字段
我们只需关注事变1、事变3。接着查察mongoose中对project的阐明:
  1. When using string syntax, prefixing a path with - will flag that path as excluded. When a path does not have the - prefix, it is included. Lastly, if a path is prefixed with +, it forces inclusion of the path, which is useful for paths excluded at the schema level.
  2. A projection must be either inclusive or exclusive. In other words, you must either list the fields to include (which excludes all others), or list the fields to exclude (which implies all other fields are included). The _id field is the only exception because MongoDB includes it by default.
复制代码
注意:此处指query "projection"
mongoose表明:投影要么是全包罗,要么是全剔除。不允许包罗和剔除同时存在。但由于
_id是MongoDB默认包罗的,因此_id是个例外。
select project投影语句组装代码:
  1. /**
  2. * 添加通用筛选条件
  3. * @param {*} stat 已装配的筛选语句
  4. * @param {*} collection collectionName
  5. * @return {*} 组装完成的语句
  6. */
  7. function addCommonSelectCond(stat,collection)
  8. {
  9. if(typeof(stat)!="object") return;
  10. stat["_id"] = 0;
  11. stat["__v"] = 0;
  12. stat["status"] = 0;
  13. stat["docCreatedAt"] = 0;
  14. stat["docUpdatedAt"] = 0;
  15. var embeddedRes = hasEmbedded(collection);
  16. if(embeddedRes["isEmbedded"])
  17. {
  18. for(var item of embeddedRes["embeddedSchema"])
  19. {
  20. stat[item+"._id"] = 0;
  21. stat[item+".__v"] = 0;
  22. stat[item+".status"] = 0;
  23. stat[item+".docCreatedAt"] = 0;
  24. stat[item+".docUpdatedAt"] = 0;
  25. }
  26. }
  27. return stat;
  28. }
复制代码
3.2.2 过滤


通过findOneAndupdate、insert、query等返回的doc对象中(已颠末lean或者toObject处置惩罚),是数据库中真实状态。因此必要对产生的doc进行过滤,包括doc过滤和内嵌文档过滤。
  1. /**
  2. * 处理自身及内嵌的表
  3. * @param {*} collection 查询的表
  4. * @param {*} doc 已查询出的结果
  5. * @returns doc 清理后的结果
  6. */
  7. static clearDoc(collection,doc){
  8. if(doc === undefined || doc === null || typeof doc != "object" ) return null;
  9. doc = this.clearExtraField(doc);
  10. var res = hasEmbedded(collection);
  11. if(res["isEmbedded"])
  12. {
  13. let arr = res["embeddedSchema"];
  14. for(var item of arr){
  15. if(doc[item])
  16. doc[item] = this.clearArray(doc[item]);
  17. }
  18. }
  19. return doc;
  20. }
  21. static clearExtraField(doc){
  22. if(doc === null || typeof doc != "object")
  23. return;
  24. var del = delete doc["docCreatedAt"]&&
  25. delete doc["docUpdatedAt"]&&
  26. delete doc["_id"]&&
  27. delete doc["__v"]&&
  28. delete doc["status"];
  29. if(!del) return new Error("删除额外字段出错");
  30. return doc;
  31. }
  32. static clearArray(arr)
  33. {
  34. if(!Array.isArray(arr)) return;
  35. var clearRes = new Array();
  36. for(var item of arr){
  37. clearRes.push(this.clearExtraField(item));
  38. }
  39. return clearRes;
  40. }
复制代码
细心的读者已经发现了,投影和过滤的字段内容都是额外字段。那什么环境下使用投影,什么环境下使用过滤呢?
关于这个标题,笔者的建议是如果不能确保额外字段被剔撤消,那就采取双重认证:查询前使用投影,查询后使用过滤。

4 总结

本文介绍了实际业务中通常会产生额外字段。而在mongoDB中,"消除"额外字段的本领主要是投影、过滤。
以使用频率最高的查询接口为例,整理如下:
      指定选项      内嵌选项      查询前投影      查询后过滤                  有指定      无内嵌      ×      √              有指定      有内嵌      ×      √              无指定      无内嵌      √      ×              无指定      有内嵌      √      ×   
因此,笔者建议无论schema中是否配置了options,在查询时组装投影语句,查询后进行效果过滤。如许包管十拿九稳,
额外字段才不会漏到客户端**。
到此这篇关于mongoDB使用投影剔除‘额外'字段的文章就介绍到这了,更多相关mongoDB用投影剔除额外字段内容请搜索草根技术分享以前的文章或继承欣赏下面的相关文章希望大家以后多多支持草根技术分享!

帖子地址: 

回复

使用道具 举报

分享
推广
火星云矿 | 预约S19Pro,享500抵1000!
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

草根技术分享(草根吧)是全球知名中文IT技术交流平台,创建于2021年,包含原创博客、精品问答、职业培训、技术社区、资源下载等产品服务,提供原创、优质、完整内容的专业IT技术开发社区。
  • 官方手机版

  • 微信公众号

  • 商务合作