Express框架之connect-flash詳解

var flash = require('connect-flash'); 
app.use(flash());//Express使用這個(gè)插件 

var format = require('util').format; 
var isArray = require('util').isArray; 

module.exports = function flash(options) { 
 options = options || {}; 
 //如果用戶沒有指定unsafe參數(shù)，那么safe就是true；否則如果用戶指定了unsafe為false那么safe就是true 
 //也就是說這個(gè)插件只能指定一個(gè)配置項(xiàng)就是unsafe，默認(rèn)不指定為就是安全的! 
 var safe = (options.unsafe === undefined) ? true : !options.unsafe; 
 return function(req, res, next) { 
  //如果req.flash存在，同時(shí)是safe的那么直接調(diào)用下面一個(gè)插件，這個(gè)插件就不執(zhí)行了 
  if (req.flash && safe) { return next(); } 
  //如果上面的條件不滿足那么為req指定flash屬性，其值為下面的_flash函數(shù) 
  req.flash = _flash; 
  next(); 
 } 
} 

function _flash(type, msg) { 
 //如果當(dāng)前req對(duì)象沒有session域，那么拋出錯(cuò)誤 
 if (this.session === undefined) throw Error('req.flash() requires sessions'); 
 //為req.session.flash指定一個(gè)域，默認(rèn)為空對(duì)象 
 var msgs = this.session.flash = this.session.flash || {}; 
 if (type && msg) { 
  // util.format is available in Node.js 0.6+ 
  //如果當(dāng)前是Node.js 0.6+以上的環(huán)境，同時(shí)傳入的參數(shù)有兩個(gè)以上 
  if (arguments.length > 2 && format) { 
   var args = Array.prototype.slice.call(arguments, 1); 
   //獲取第二個(gè)參數(shù)以后的數(shù)組 
   msg = format.apply(undefined, args); 
   //msg保存的是第二個(gè)參數(shù)以后的值，并對(duì)這個(gè)值進(jìn)行了format處理 
  } else if (isArray(msg)) { 
   msg.forEach(function(val){ 
    (msgs[type] = msgs[type] || []).push(val); 
   }); 
   return msgs[type].length; 
   //如果傳入的第二個(gè)參數(shù)是一個(gè)數(shù)組，那么全部把數(shù)據(jù)綁定到req.session.flash域里面，其中數(shù)據(jù)類型為{'info':['school','home']} 
   //然后返回的是特定的長度 
  } 
  //如果參數(shù)不多于2，同時(shí)msg也不是數(shù)組，那么把msg添加到req.session.flash中然后返回 
  return (msgs[type] = msgs[type] || []).push(msg); 
 } else if (type) { 
  //如果沒有指定msg，僅僅指定了type，這時(shí)候我們獲取到req.session.flash中特定類型的數(shù)據(jù)，同時(shí)把數(shù)據(jù)從req.session.flash中刪除 
  var arr = msgs[type]; 
  delete msgs[type]; 
  return arr || []; 
 } else { 
  //如果調(diào)用方式如flash()也就是不傳入任何參數(shù)，這時(shí)候直接清空了req.session.flash中的數(shù)據(jù) 
  this.session.flash = {}; 
  return msgs; 
 } 
} 

req.flash('info', 'email has been sent to %s.', userName); 

req.flash('info', 'email sent'); 
 req.flash('error', 'email delivery failed'); 
 req.flash('info', 'email re-sent'); 
req.flash('info'); 
// => ['email sent', 'email re-sent'] 
req.flash('info'); 
// => []這時(shí)候info已經(jīng)清空了 

else { 
  //如果調(diào)用方式如flash()也就是不傳入任何參數(shù)，這時(shí)候直接清空了req.session.flash中的數(shù)據(jù) 
  this.session.flash = {}; 
  return msgs; 
 }