微信ID: Van1sh1ngAct

Node-RED 存储插件

为了构建Node-RED多租户系统, 我们需要实现一个插件, 将用户的流文件的保存位置从本地磁盘变更到数据库.

目前有许多存储插件, 默认的是保存在本地文件系统中(IBM Cloud中的Node-RED使用CloudantDB插件).

我们将会使用MongoDB作为后端存储, 并用Mongoose包装对数据库的读写访问. 并且, 在后续鉴权插件和Node-RED实例管理中, 也会复用Mongoose的schema定义.

Storage API的定义可以在这里找到. 插件需要提供数个必须实现的方法, 具体如下.

init() - 初始化函数

init()函数被用来初始化插件, 其首先读取本地配置, 之后打开与数据库的链接以进一步获取用户的数据.

init: function(nrSettings) {
  settings = nrSettings.mongodbSettings || {}; 
  if (!settings) {
    var err = Promise.reject("No MongoDB settings for flow storage found");
    err.catch(err => {});
    return err;
  }
 
  appname = settings.appname;
 
  return new Promise(function(resolve, reject){
    mongoose.connect(settings.mongoURI, mongoose_options)
    .then(() => {
      resolve();
    })
    .catch(err => {
      reject(err);
    });
  })
},

getFlows()/saveFlows(flows) - 获取/保存流数据

该函数主要完成保存流数据到数据库或从数据库读取流数据. 如果新用户(第一次创建Node-RED实例)无流数据, 应返回一个空数组[].

getFlows: function() {
  return new Promise(function(resolve, reject) {
    Flows.findOne({appname: appname}, function(err, flows){
      if (err) {
        reject(err);
      } else {
        if (flows){
          resolve(flows.flow);
        } else {
          resolve([]);
        }
      }
    })
  })
},
saveFlows: function(flows) {
  return new Promise(function(resolve, reject) {
    Flows.findOneAndUpdate({appname: appname},{flow: flows}, {upsert: true}, function(err,flow){
      if (err) {
        reject(err)
      } else {
        resolve();
      }
    })
  })
},

传递到 findOneAndUpdatet() 的参数 upsert: true 如果没有存在相匹配的文档将会新建一条.

getCredentials/saveCredentials(credentials) - 获取/保存加密信息

这里我们必须将凭据对象转换为字符串，因为MongoDB对以$开头的根对象键兼容性欠佳(加密的凭据字符串保存在对象的' $_ '项中。)

getCredentials: function() {
  return new Promise(function(resolve, reject) {
    Credentials.findOne({ appname: appname}, function(err, creds){
      if (err) {
        reject(err);
      } else {
        if (creds){
          resolve(JSON.parse(creds.credentials));
        } else {
          resolve({});  
        }
      }
    })
  })
},
saveCredentials: function(credentials) {
  return new Promise(function(resolve, reject) {
    Credentials.findOneAndUpdate(
      { appname: appname},
      { credentials: JSON.stringify(credentials)}, 
      { upsert: true}, 
      function(err,credentials){
        if (err) {
            reject(err)
          } else {
          resolve();
          }
    })
  })
},

getSessions()/saveSessions(sessions)/getSettings()/saveSettings(settings)

因为它们只是存储或检索一个JSON对象, 所以这些函数的实现与getFlows() / saveFlows(flows) 几乎相同.

getLibraryEntry(type,name)/saveLibraryEntry(type,name,meta,body)

saveLibraryEntry(type,name,meta,body)是非常标准的，只是对名称进行了一点处理，使其看起来更像一个文件路径。

getLibraryEntry(type,name,meta,body)需要更多的工作，因为我们需要建立目录结构，并能够返回实际的文件内容。

getLibraryEntry: function(type,name) {
  if (name == "") {
    name = "/"
  } else if (name.substr(0,1) != "/") {
    name = "/" + name
  }
 
  return new Promise(function(resolve,reject) {
    Library.findOne({appname: appname, type: type, name: name}, function(err, file){
      if (err) {
        reject(err);
      } else if (file) {
        resolve(file.body);
      } else {
        var reg = new RegExp('^' + name , "");
        Library.find({appname: appname, type: type, name: reg }, function(err, fileList){
          if (err) {
            reject(err)
          } else {
            var dirs = [];
            var files = [];
            for (var i=0; i<fileList.length; i++) {
              var n = fileList[i].name;
              n = n.replace(name, "");
              if (n.indexOf('/') == -1) {
                var f = fileList[i].meta;
                f.fn = n;
                files.push(f);
              } else {
                n = n.substr(0,n.indexOf('/'))
                dirs.push(n);
              }
            }
            dirs = dirs.concat(files);
            resolve(dirs);
          }
        })
           
      }
    })
  });
},
saveLibraryEntry: function(type,name,meta,body) {
  return new Promise(function(resolve,reject) {
    var p = name.split("/");    // strip multiple slash
    p = p.filter(Boolean);
    name = p.slice(0, p.length).join("/")
    if (name != "" &amp;&amp; name.substr(0, 1) != "/") {
      name = "/" + name;
    }
    Library.findOneAndUpdate({appname: appname, name: name}, 
      {name:name, meta:meta, body:body, type: type},
      {upsert: true, useFindAndModify: false},
      function(err, library){
        if (err) {
          reject(err);
        } else {
          resolve();
        }
      });
  });
}

使用这个插件

要使用该插件，你需要在settings.js文件中包含它。这通常是在userDir中找到的（该文件的位置在Node-RED启动时被记录）。

``storageModule: require(``'node-red-contrib-storage-mongodb'``),
``mongodbSettings: {``  ``mongoURI: ``"mongodb://localhost/nodered"``,``  ``appname: ``"r1"``},``

mongodbSettings对象包含数据库的URI，appname是这个Node-RED实例的唯一标识，允许同一个数据库用于Node-RED的多个实例。