文档概览

本文基于express、express-session实现了简易的登录/登出功能，完整的代码示例可以在这里找到。

环境初始化

首先，初始化项目

  1. express -e

然后，安装依赖。

  1. npm install

接着，安装session相关的包。

  1. npm install --save express-session session-file-store

session相关配置

配置如下，并不复杂，可以见代码注释，或者参考官方文档。

  1. var express = require('express');
  2. var app = express();
  3. var session = require('express-session');
  4. var FileStore = require('session-file-store')(session);
  6. var identityKey = 'skey';
  8. app.use(session({
  9.     name: identityKey,
  10.     secret: 'chyingp',  // 用来对session id相关的cookie进行签名
  11.     store: new FileStore(),  // 本地存储session（文本文件，也可以选择其他store，比如redis的）
  12.     saveUninitialized: false,  // 是否自动保存未初始化的会话，建议false
  13.     resave: false,  // 是否每次都重新保存会话，建议false
  14.     cookie: {
  15.         maxAge: 10 * 1000  // 有效期，单位是毫秒
  16.     }
  17. }));

实现登录/登出接口

创建测试账户数据

首先，在本地创建个文件，来保存可用于登录的账户信息，避免创建链接数据库的繁琐。

  1. // users.js
  2. module.exports = {
  3.     items: [
  4.         {name: 'chyingp', password: '123456'}
  5.     ]
  6. };

登录、登出接口实现

实现登录、登出接口，其中：

  • 登录：如果用户存在，则通过req.regenerate创建session，保存到本地，并通过Set-Cookie将session id保存到用户侧；
  • 登出：销毁session，并清除cookie；
  1. var users = require('./users').items;
  3. var findUser = function(name, password){
  4.     return users.find(function(item){
  5.         return item.name === name && item.password === password;
  6.     });
  7. };
  9. // 登录接口
  10. app.post('/login', function(req, res, next){
  12.     var sess = req.session;
  13.     var user = findUser(req.body.name, req.body.password);
  15.     if(user){
  16.         req.session.regenerate(function(err) {
  17.             if(err){
  18.                 return res.json({ret_code: 2, ret_msg: '登录失败'});                
  19.             }
  21.             req.session.loginUser = user.name;
  22.             res.json({ret_code: 0, ret_msg: '登录成功'});                           
  23.         });
  24.     }else{
  25.         res.json({ret_code: 1, ret_msg: '账号或密码错误'});
  26.     }   
  27. });
  29. // 退出登录
  30. app.get('/logout', function(req, res, next){
  31.     // 备注：这里用的 session-file-store 在destroy 方法里，并没有销毁cookie
  32.     // 所以客户端的 cookie 还是存在，导致的问题 --> 退出登陆后，服务端检测到cookie
  33.     // 然后去查找对应的 session 文件，报错
  34.     // session-file-store 本身的bug    
  36.     req.session.destroy(function(err) {
  37.         if(err){
  38.             res.json({ret_code: 2, ret_msg: '退出登录失败'});
  39.             return;
  40.         }
  42.         // req.session.loginUser = null;
  43.         res.clearCookie(identityKey);
  44.         res.redirect('/');
  45.     });
  46. });

登录态判断

用户访问 http://127.0.0.1:3000 时，判断用户是否登录，如果是，则调到用户详情界面（简陋无比）；如果没有登录，则跳到登录界面；

  1. app.get('/', function(req, res, next){
  2.     var sess = req.session;
  3.     var loginUser = sess.loginUser;
  4.     var isLogined = !!loginUser;
  6.     res.render('index', {
  7.         isLogined: isLogined,
  8.         name: loginUser || ''
  9.     });
  10. });

UI界面

最后，看下登录、登出UI相关的代码。

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4.     <title>会话管理</title>
  5. </head>
  6. <body>
  8. <h1>会话管理</h1>
  10. <% if(isLogined){ %>
  11.     <p>当前登录用户：<%= name %>，<a href="/logout" id="logout">退出登陆</a></p>
  12. <% }else{ %>
  13.     <form method="POST" action="/login">
  14.         <input type="text" id="name" name="name" value="chyingp" />
  15.         <input type="password" id="password" name="password" value="123456" />
  16.         <input type="submit" value="登录" id="login" />
  17.     </form>
  18. <% } %> 
  20. <script type="text/javascript" src="/jquery-3.1.0.min.js"></script>
  21. <script type="text/javascript">
  22.     $('#login').click(function(evt){
  23.         evt.preventDefault();
  25.         $.ajax({
  26.             url: '/login',
  27.             type: 'POST',
  28.             data: {
  29.                 name: $('#name').val(),
  30.                 password: $('#password').val()
  31.             },
  32.             success: function(data){
  33.                 if(data.ret_code === 0){
  34.                     location.reload();
  35.                 }   
  36.             }
  37.         });
  38.     });
  39. </script>
  41. </body>
  42. </html>

相关链接

https://github.com/expressjs/session