Egg-passport-local应用入门

Egg是我个人认为最好的Nodejs后端框架，也是我用的最多的框架之一。其最吸引我的一点就是对功能模块的封装——比如鉴权。然而官方的文档并不够详尽，更多的示范代码，可能是文档面向的对象是有一定开发经验的开发者。所以在此对官方文档进行一些基于自己理解的补充，方便初学者入门以及自己日后回顾。

Passport是Egg框架下的一个中间件，毫无疑问它的作用在于鉴权。因为Egg并没有对传统的账号密码是登录进行封装，所以这里是直接使用passport-local。它的执行时序如下：

image

官方文档基于passport-local给出了一段示例代码，但是依然有一些重点没有说明，在此进行解释和扩充。

安装：

1、安装passport-local中间件

$ npm i --save passport-local

2、配置

在这一步开始官方文档就已经没有更多的解释了，而配置正是最关键的一步：

1. 配置文件：app.js

   app.js用于自定义启动时的初始化工作,位于根目录下。此文件为可选项，所以使用simple模板初始化项目并不会创建，需要手动进行创建。

2. 代码配置项：

   // app.js
   const LocalStrategy = require('passport-local').Strategy;
   
   module.exports = app => {
     // 挂载 strategy
     app.passport.use(new LocalStrategy({
     //将请求信息传递到callback界面
     passReqToCallback: true,
     //中间件会自动从username和passport字段读取用户名和密码，如果需要更改：
     //usernameField: 'email',
     //passwordField: 'passwd'
     }, (req, username, password, done) => {
       // format user
       const user = {
         provider: 'local',
         username,
         password,
       };
       debug('%s %s get user: %j', req.method, req.url, user);
       app.passport.doVerify(req, user, done);
     }));
   
     // 处理用户信息
     app.passport.verify(async (ctx, user) => {
       //鉴权核心代码
       //利用之前创建的user对象，查库，可以用service，也可以用Sequelize
       //获得一些用户信息
       if(鉴权成功){
           return 用户信息
       }else{
           return false
       }
   });
     app.passport.serializeUser(async (ctx, user) => {
       //序列化user信息
   });
     app.passport.deserializeUser(async (ctx, user) => {
       //反序列化user信息
   });
   };
   

   第一次看文档时比较困扰我的几点有表格信息从哪里传入，在哪里查库，如何返回等均已注释在代码中。

3. 路由：

   // app/router.js
   module.exports = app => {
     const { router, controller } = app;
     router.get('/', controller.home.index);
   
     // 鉴权成功后的回调页面
     router.get('/authCallback', controller.home.authCallback);
   
     // 渲染登录页面，用户输入账号密码
     router.get('/login', controller.home.login);
     // 登录校验
     router.post('/login', app.passport.authenticate('local', { successRedirect: '/authCallback' }));
   };
   

Q&A:

Q：验证码如何实现？

A:在请求验证码图片时将验证结果写入session，在app.passport.verify()中进行校验。

Q：序列化和反序列化在何时被调用？

A:在鉴权成功后callback之前序列化被调用，获取session信息时反序列化被调用。

Q：callback内应该放置什么？

A：鉴权结果的提示，以及适当的页面跳转。

Q：如何在服务中获得鉴权状态？

A：使用ctx.isAuthenticated() API。

Q：如何登出？

A：使用ctx.logout() API。