Express框架之connect-flash详解
第一步:我们首先来看看这个插件的使用
varflash=require('connect-flash'); app.use(flash());//Express使用这个插件
第二步:我们看看其内部是如何实现的
varformat=require('util').format; varisArray=require('util').isArray;
依赖的模块为node.js的核心模块util
module.exports=functionflash(options){ options=options||{}; //如果用户没有指定unsafe参数,那么safe就是true;否则如果用户指定了unsafe为false那么safe就是true //也就是说这个插件只能指定一个配置项就是unsafe,默认不指定为就是安全的! varsafe=(options.unsafe===undefined)?true:!options.unsafe; returnfunction(req,res,next){ //如果req.flash存在,同时是safe的那么直接调用下面一个插件,这个插件就不执行了 if(req.flash&&safe){returnnext();} //如果上面的条件不满足那么为req指定flash属性,其值为下面的_flash函数 req.flash=_flash; next(); } }
很显然,我们看到可以传入options参数,如果没有指定unsafe那么unsafe就是true,此时safe就是false。如果用户明确指定了unsafe为false那么safe为true,如果明确指定了unsafe为false那么safe就是true。如果safe为true那么直接调用下面一个中间件。
我们现在看看req对象的flash方法是怎么样的:
function_flash(type,msg){ //如果当前req对象没有session域,那么抛出错误 if(this.session===undefined)throwError('req.flash()requiressessions'); //为req.session.flash指定一个域,默认为空对象 varmsgs=this.session.flash=this.session.flash||{}; if(type&&msg){ //util.formatisavailableinNode.js0.6+ //如果当前是Node.js0.6+以上的环境,同时传入的参数有两个以上 if(arguments.length>2&&format){ varargs=Array.prototype.slice.call(arguments,1); //获取第二个参数以后的数组 msg=format.apply(undefined,args); //msg保存的是第二个参数以后的值,并对这个值进行了format处理 }elseif(isArray(msg)){ msg.forEach(function(val){ (msgs[type]=msgs[type]||[]).push(val); }); returnmsgs[type].length; //如果传入的第二个参数是一个数组,那么全部把数据绑定到req.session.flash域里面,其中数据类型为{'info':['school','home']} //然后返回的是特定的长度 } //如果参数不多于2,同时msg也不是数组,那么把msg添加到req.session.flash中然后返回 return(msgs[type]=msgs[type]||[]).push(msg); }elseif(type){ //如果没有指定msg,仅仅指定了type,这时候我们获取到req.session.flash中特定类型的数据,同时把数据从req.session.flash中删除 vararr=msgs[type]; deletemsgs[type]; returnarr||[]; }else{ //如果调用方式如flash()也就是不传入任何参数,这时候直接清空了req.session.flash中的数据 this.session.flash={}; returnmsgs; } }
(1)如果传入的参数多于两个,那么首先获取第二个以及以后的参数,然后对第二个以后的参数进行format操作,最后把数据封装到req.session.flash中,同时返回。
req.flash('info','emailhasbeensentto%s.',userName);
(2)如果传入的第二个参数是一个数组,那么把这个数组每一个元素封装到req.session.flash中,然后返回特定type的数据的长度
(3)否则如果仅仅传入了type表示获取指定类型的数据然后返回,并把数据从req.session.flash中删除(这样只要我们调用这个方法获取了数据那么就从session中删除了)
req.flash('info','emailsent'); req.flash('error','emaildeliveryfailed'); req.flash('info','emailre-sent'); req.flash('info'); //=>['emailsent','emailre-sent'] req.flash('info'); //=>[]这时候info已经清空了
(4)如果用户没有传入任何参数那么清空req.session.flash域,但是返回的是原来的局部变量保存到的req.session.flash对象
else{ //如果调用方式如flash()也就是不传入任何参数,这时候直接清空了req.session.flash中的数据 this.session.flash={}; returnmsgs; }
这个插件一般和redirect一起使用,保证在渲染下一个页面的时候数据可用。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。