connect-flash 用法详解

转自：http://yunkus.com/connect-flash-usage/

前言

说到 connect-flash ,估计也有很多朋友像我一样被它虐了好一阵子，很多朋友可能都会遇到过这个问题：Express4.x 中的 connect-flash 为什么不起作用？或者 connect-flash 怎么用？诸如此类的问题，在这里我就给大家戳破 connect-flash 的神秘面纱！

官方解释

The flash is a special area of the session used for storing messages. Messages are written to the flash and cleared after being displayed to the user. The flash is typically used in combination with redirects, ensuring that the message is available to the next page that is to be rendered.

大概的意思就是 flash 是 session 中一个用于存储信息的特殊区域。消息写入到 flash 中，在跳转目标页中显示该消息。flash 是配置 redirect 一同使用的，以确保消息在目标页面中可用。

flash 可用于一次性的消息提示，比如注册，登录页面，当你再次刷新时，flash就没有提示消息了。

connect-flash安装

工欲善其事,必先利其器，所以我们先来看看怎么安装 connect-flash。其实它的安装跟其它的模块安装是一样的，所以你很轻易的就可以把它安装好，切换到项目目录，运行如下命令行：

1. $ npm install connect-flash

安装完之后，你还需要安装一个 express-session 模块，因为 connect-flash 是需要存储在 session 模块，运行如下命令行：

1. $ npm install express-session

注意

安装connect-flash和express-session这两个模块时不要在命令行中添加-g（全局安装），因为安装到全局后，可以在你收入这两个模块时就会出现路径的问题，为了尽可能地减少繁琐的操作，我们直接安装到当前项目目录即可！

配置

 配置 app.js 文件

安装完以上两个模块后，我们需要对相应的文件进行配置，打开app.js 添加如下代码：

1. var settings = require('./settings'); //配置信息
2. var flash = require('connect-flash');
3. var session = require('express-session');
5. app.use(session({
6. secret: settings.cookieSecret, //加密
7. key: settings.db, //cookie nam
8. cookie: {maxAge: 60000},
9. resave: false,
10. saveUninitialized: true,
11. }));
12. app.use(flash());
14. // set flash
15. app.use(function (req, res, next) {
16. res.locals.errors = req.flash('error');
17. res.locals.infos = req.flash('info');
18. next();
19. });

代码中的settings.cookieSecret、settings.db是两个变量，它们的值已经事先写到了一个settings.js文件里了。

1. module.exports = {
2. cookieSecret: 'orders',
3. db: 'ordersdb',
4. host: 'localhost',
5. port: 27017
6. }

如果你觉得麻烦，你可以不使用变量的方式，直接给 secret ，key 写值。

如何使用

1. // 登录
2. router.get('/login', function(req, res, next) {
3. res.render('login', { title: '欢迎登录' });
4. });
5. router.post('/login', function(req, res, next) {
6. User.get(req.body.username,function(err,user){
7. if(!user || user.name === ''){
8. req.flash('error','用户不存在');
9. return res.redirect('login');
10. }
11. if(req.body.password != user.password){
12. req.flash('error','密码不对');
13. return res.redirect('login');
14. }
15. req.flash('info','登录成功');
16. res.redirect('login');
17. })
18. });

上面我以登录的路由代码作为例子，一看就懂，只需要在要显示信息的地方添加形如：req.flash('error','用户不存在');的代码就可以了。那怎么才能在页面中调用这些提示信息呢？我们接着往下看。下面是一个简单的调用例子，但也足以把问题说明白了。

1. <div class="wrap">
2. <div class="wrap-left">
3. <ul>
4. <li><a href="/">主页</a></li>
5. <li><a href="/login">登录</a></li>
6. <li><a href="/reg">注册</a></li>
7. </ul>
8. </div>
9. <div class="wrap-right">
10. <h1><%= title %></h1>
11. <div class="wrap-content">
12. <form method="post">
13. <ul>
14. <li>用户名：<input type="text" name="username"></li>
15. <li>密码：<input type="text" name="password"></li>
16. <li><button>登录</button></li>
17. <li><%= errors %></li>
18. </ul>
19. </form>
20. </div>
21. </div>
22. </div>

代码中的<%= errors %>就是调用相应的信息的方法，为什么要这样写呢？为什么里面的一个 errors，而不是 我们在 index.js 中写的req.flash('error','用户不存在');中的 error 变量呢？这个你看看我们一开始在 app.js 中的配置代码你就明白了。我们已经把req.flash('error');的提示信息赋值给了res.locals.errors，而我们如果要调用locals 中的 errors 变量，不需要写成locals.errors，而是直接写变量名 errors 就可以了。

conncet-flash 模块的用法就给大家分享到这里了，这里只给你一个实现的思路，并不会给你一个面包，但你可以通过这个思路做一个美味的面包。人人都讨厌伸手党，总想着天上掉面包，不如自己去做面包，人必自救，而后人救之。