graphql+mongoose查询MongoDB时只返回需要的字段(field)

在进行数据库MongoDB的查找时,mongoose有个很方便的函数是Model.find(), 但是它在查找时会返回所有的字段,这样不需要的字段依然占据了内存,影响perfoemance, 因此,要想办法只返回graphql中要求的field。

问题一: 如何获取graphql中要求的fieldName

graphql提供了一个参数info, 在info中包含了当前query包含的所有field 信息。graphql中info的定义为

export type GraphQLResolveInfo = {
  fieldName: string;
  fieldNodes: Array<FieldNode>;
  returnType: GraphQLOutputType;
  parentType: GraphQLCompositeType;
  path: ResponsePath;
  schema: GraphQLSchema;
  fragments: { [fragmentName: string]: FragmentDefinitionNode };
  rootValue: mixed;
  operation: OperationDefinitionNode;
  variableValues: { [variableName: string]: mixed };
};

只需要取其中的fieldName信息。
在此使用graphql-fields这个库来获取fieldsName信息。可通过npm安装此库。

npm i graphql-fields --save

使用参考方法如下(这里使用了mongoose的pluginquery helper):

mongoose.plugin(schema => {
  schema.query.forGraphql = function(info) {
    let fieldsName = [];
    const fields = graphqlFields(info);
    for (const key of Object.keys(fields)) {
       fieldsName.push(key);
    }
    // select 函数用来向数据库请求相应的fields
    return this.select(fieldsName.join(' '));
  };
});

问题二:如何在查找时,将fieldName传递给mongoose 的Model.find()函数

  • 如果只是针对单个函数的话,完全可以利用Model.find()自带的projection参数,使用的参考方法如下, 其中的'name friends'即request的fields。
// name LIKE john and only selecting the "name" and "friends" fields, executing immediately
MyModel.find({ name: /john/i }, 'name friends', function (err, docs) { })
  • 如果是要应用于多个query函数,就可以利用mongoose的Query helper, 参考用法如下:
  animalSchema.query.byName = function(name) {
    return this.where({ name: new RegExp(name, 'i') });
  };

  var Animal = mongoose.model('Animal', animalSchema);

  Animal.find().byName('fido').exec(function(err, animals) {
    console.log(animals);
  });

  Animal.findOne().byName('fido').exec(function(err, animal) {
    console.log(animal);
  });

如果要应用到多个schema的话,可以利用mongoose的plugin, 参考用法如下:

// lastMod.js
module.exports = exports = function lastModifiedPlugin (schema, options) {
  schema.add({ lastMod: Date });

  schema.pre('save', function (next) {
    this.lastMod = new Date();
    next();
  });

  if (options && options.index) {
    schema.path('lastMod').index(options.index);
  }
}

// game-schema.js
var lastMod = require('./lastMod');
var Game = new Schema({ ... });
Game.plugin(lastMod, { index: true });

// player-schema.js
var lastMod = require('./lastMod');
var Player = new Schema({ ... });
Player.plugin(lastMod);
    原文作者:夏liao夏天
    原文地址: https://www.jianshu.com/p/a1b3ea5ece0c
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞