一个对注册登录由浅至深,注释详尽的 Vue + Express 项目

阅读 3489
收藏 97
2017-04-05
原文链接:github.com

项目介绍

  • 采用vue-cli 构建初始项目目录
  • 使用vue2vue-router2Element-uiexpresswebpack2gulp构建项目开发环境
  • 前端采用Vue、Element-ui搭建页面以及Vuex进行数据处理,后端采用express完成注册、登录、登出、登录状态查询的restful API
  • 目前分为session登录和token登录
  • 页面为注册页,登录页,主页

目录及文件的改动,均含详细备注

  1. package.json中的'dependencies'包含的是增加的npm包
  2. config/index.js 中设置了请求端口代理,能够跨域访问服务器端口(8080 => 3000)
  3. server 主要是服务端的路由以,api接口,mongodb的配置操作
  4. src 为vue应用的主要文件,包含路由,component...
  5. gulpfile.js 增加服务器重启和浏览器刷新任务
  6. server.js 服务端启动文件

项目区分

  1. session登录的前后端对应src和server
  2. token登录的前后端对应src-token和server-token
  3. 主要是通过express设置当前目录为静态资源位置,通过根目录下的index.html进入不同的src下的index.html,从而实现项目区分

操作指令

npm install 安装依赖

npm run dev 使用webpack开启前端资源的打包编译

npm run server  启动服务端并开启浏览器

这里需要双开两个命令行窗口,一个负责前端的编译,一个负责服务端的任务流

环境搭建的详细解决思路

前端热更新,后端服务重启,浏览器自动刷新

  • 实现了基本登录 cookie && session
  • 独立系统登录 token
  • 第三方登录 access_token

详谈注册/登录/登出

一. 登录功能实现的原理 二. 登录功能实现的几种方式 三. 基本登录 cookie && session 详解 四. token登录 详解

一. 登录功能实现的原理

浏览器用户提交表单后与服务器产生会话,传递给服务器一个识别信息,同时服务器这边有相应的数据,因此能够对其进行比较,然后识别是否为正确的用户,而且一般需要设定此数据的存储时长,也就是用户认证的时长,过了这个时间段,则会失效,需要重新登录,因此这里需要有四个关键点,浏览器的信息服务器的信息两个信息的对比时效设定

二. 登录功能实现的几种方式

1. 基本登录 cookie && session

浏览器提交用户表单后,服务器接受表单中的用户信息,将其存在session表中(session表存在内存,数据库,缓存等),然后以cookie的方式(cookie中存有sessionId及对应值)传回给浏览器,这样只要服务端设置的cookie没有失效,则在这段时间内,服务端便能正确识别用户信息,不用重复登录(sessionID是在服务端销毁的)

  • 服务器端的产生Session ID
  • 服务器端和客户端存储Session ID
  • 从HTTP Header中提取Session ID
  • 根据Session ID从服务器端的Hash中获取请求者身份信息
  1. token(JSON Web Token)

    参考资料:

    JSON Web Token详情

    八幅漫画理解使用JSON Web Token设计单点登录系统

    用户提交其信息表单(比如包含username,password),服务端收到后,将username转为userId存储在JWT的payload(负荷)中,与头部进行Base64编码拼接后进行签名,于是形成了JWT,在cookie中保存返回给浏览器并设置时效,在失效之前浏览器每次请求时都会携带有JWT的cookie,因此服务端可以对JWT进行解密,与数据库中的user进行比较,确认无误后,便返回请求。

    • cookie&&session 需要服务端提供独立机制来存储sessionId(内存,数据库等)
    • cookie&&token 不需要服务端进行额外存储,但增加了加密,解密,编码等操作

    单点登录(一个站点登录,其余站点皆可登录)

    • cookie&&session sessionId是需要存储在服务器上的,因此多个域名下的服务器都需要同步sessionId
    • JWT是通过cookie传递的,并且不需要额外存储,只需要将含有JWT的cookie的域名设置为顶级域名,则旗下的域名皆可访问到此cookie以及其中包含的JWT
  2. 第三方:access_token

三. 基本登录 cookie && session 详解

  1. 通过mongoose建立数据模型,以name为主索引并设置其唯一属性,此例中,我们服务端采用内存储存sessionId,也可尝试mongoDB或redis等,均有相应的中间件可以使用。

  2. 登录 POST: /api/login 在前端vue中怎样识别登录状态,当输入用户表单后点击登录,我们向/api/login发起了post请求,/api/login对应的控制器中进行了这样几步流程

  • request中包含的用户信息(用户名,密码),生成mogoose实例

  • 进入mongoDB中查找此用户名的信息(User 的Skema模型中已经设定name为唯一的索引,不能重复的)

  • 没有找到,返回无此用户名,找到则与数据库中的密码与此密码进行比较(在生成mongoose实例时,都将密码进行了sha1加密)

  • 密码匹配正确,返回正确信息,并写入session

    // 用户信息写入 session
    delete user.password;
    req.session.user = user;
    
  • 密码匹配失败,否则返回密码错误的信息

    在其它如/api/register、/api/user中通过判断req.session.user的存在与否,来实现登录登出状态的改变

    checkLogin(req, res, next) {
        if (!req.session.user) {
          return res.json({
             error: '未登录'
          });
        }
        next();
      },
    
      checkNotLogin(req, res, next) {
        if (req.session.user) {
          return res.json({
            error: '已登录'
          });
        }
        next();
      }

至此,当流程跑通之后,我们能够得到返回登录成功的信息,接下来就可以在前端通过vue-router实现跳转,以及将获取的user信息填入localstorage,供其它页面使用其数据。

  1. 注册 POST: /api/register

    注册功能的实现,同样当我们填写完注册表单后, /api/register对应的控制器中将接受我们提交之后的数据。

    • 通过request获取用户名和密码,并将密码加密(此处采用sha1),生成mongoose实例,同时通过objectid-to-timestamp将实例中的objectId转化为时间格式,即为此实例的创建时间,具体可看疑问详解
    • 通过唯一的name属性,进入数据库查询,看该用户名是否已经被注册,返回相应的数据。
  2. 登出 GET:/api/user

    此api的作用是实现登出功能的,当点击登出后,vue通过axios访问此api,api对应的控制器中将执行以下代码

    // delete user session
    req.session.user = null;
    res.json({
      message:'登出成功'
    })
  3. 登录状态判断

使用axios的拦截器,后端通过checkLogin函数判断session是否存在,返回sesssion的状态,在axios的响应拦截器中进行跳转设置,具体代码参见./src/util/interceptor.js

四. token登录 详解

  • 注册登录的实现基本和session相同,除了数据库模型中添加了token属性,然后主要是登录状态的不同

  • 使用token判断登录状态,主要是后端的checkToken,将前端请求中携带的token进行解码,获取其设置的有效时长,从而返回token状态,同样使用axios的拦截器,在请求拦截器中添加头部Authorization的token,在响应拦截器中设置判断

疑问详解

  1. objectid-to-timestamp 包的作用

    首先了解MongoDB中的ObjectId,每一个document(即MySQL中的row每一行数据),均含有一个_id的属性,而其属性值即为ObjectId

    ObjectId 是一个12字节 BSON 类型数据,有以下格式:

    • 前4个字节表示时间戳(数据创建的时间
    • 接下来的3个字节是机器标识码
    • 紧接的两个字节由进程id组成(PID)
    • 最后三个字节是随机数。

    因此它的作用即是将前四个字节转化为时间格式。

  2. 浏览器刷新之后,vuex维护的全局状态全部消失 ​

  • 理解vuex的作用,以及使用本地存储一些状态数据的意义
  • vuex状态管理是为了可维护性和可扩展性,和本地缓存没有任何关系。
  • 详情可看github issue
  1. vue-router中的路由拦截详细介绍
  router.beforeEach((to, from, next) => {
    next({
        path: '/login',
        query: {
            redirect: to.fullPath
        }
    })
  })
  // vue-router 的导航钩子函数beforeEach
  to : 将要进入的 路由对象
  from : 当前导航正要离开的路由
  next : 调用next(), resolve beforeEach这个钩子,即调用后,表示这个钩子函数结束了,同时里面可以设置一些跳转等

  path: 表示将要跳转的路由
  query: 配置路由url的参数
  fullPath: 完成解析后的 URL,包含查询参数和 hash 的完整路径。

  query: {
      redirect: to.fullPath
  }

  这个表示,在当前路由中添加查询参数redirect,以及redirect的值to.fullPathto.fullPath表示跳转之前的路由url
评论