NuxtJS Web 开发实用指南(五)
原文:
zh.annas-archive.org/md5/95454EEF6B1A13DFE0FAD028BE716A19译者:飞龙
第四部分:中间件和安全性
在本节中,我们将学习有关中间件的知识 - 更具体地说,是路由中间件和服务器中间件。然后,我们将学习如何使用中间件添加身份验证,以创建用户登录会话。
本节包括以下章节:
-
第十一章,编写路由中间件和服务器中间件
-
第十二章,创建用户登录和 API 身份验证
编写路由中间件和服务器中间件
还记得在第八章中使用 Koa 在服务器端创建中间件吗?中间件非常有用且强大,正如你在 Koa 应用程序中注意到的那样,你可以预测和控制整个应用程序的流程。那么在 Nuxt 中呢?嗯,在 Nuxt 中有两种类型的中间件:路由中间件和服务器中间件。在本章中,您将学习如何区分它们,并在进入下一章关于身份验证的章节之前创建一些基本的中间件,那里中间件是非常需要的。我们还将在接下来的章节中使用中间件。因此,在本章中,就像在许多以前的章节中一样,您将在 Vue 应用程序中创建一些带有导航守卫的中间件,以便在创建 Nuxt 应用程序中的路由中间件和服务器中间件之前掌握 Vue/Nuxt 系统中的中间件机制。
在这一章中,我们将涵盖以下主题:
-
使用 Vue Router 编写中间件
-
介绍 Vue CLI
-
在 Nuxt 中编写路由中间件
-
编写 Nuxt 服务器中间件
第十一章:使用 Vue Router 编写中间件
在学习 Nuxt 应用程序中的中间件如何工作之前,我们应该了解它在标准 Vue 应用程序中是如何工作的。此外,在 Vue 应用程序中创建中间件之前,让我们先了解它们是什么。
什么是中间件?
简而言之,中间件是位于两个或多个软件之间的软件层。这是软件开发中的一个古老概念。中间件是一个自 1968 年以来就一直在使用的术语。它在 1980 年代作为将新应用程序链接到旧的遗留系统的解决方案而变得流行。对于它有许多定义,例如(来自Google 字典)“[中间件是]在操作系统或数据库与应用程序之间充当桥梁的软件,尤其是在网络上。”
在 Web 开发世界中,服务器端软件或应用程序(如 Koa 和 Express)接收请求并输出响应。中间件是在接收请求后执行的程序或函数,它们产生的输出可以是最终输出,也可以被下一个中间件使用,直到循环完成。这也意味着我们可以有多个中间件,并且它们将按照声明的顺序执行:
此外,中间件不仅限于服务器端技术。当您的应用程序中有路由时,在客户端中也非常常见。Vue.js 的 Vue Router 就是使用这种中间件概念的一个很好的例子。我们已经在第四章 添加视图、路由和过渡中学习和使用了 Vue Router,为我们的 Vue 应用程序创建了路由器。现在,让我们深入了解 Vue Router 的高级用法 - 导航守卫。
安装 Vue Router
如果您从本书的开头开始就已经跟着章节走了,那么您应该已经知道如何从第四章 添加视图、路由和过渡中安装 Vue Router。然而,这里是一个快速回顾。
按照以下步骤直接下载 Vue Router:
- 单击以下链接并下载源代码:
https://unpkg.com/vue-router/dist/vue-router.js
- 在 Vue 之后包含路由器,这样它就可以自动安装:
<script src="/path/to/vue.js"></script>
<script src="/path/to/vue-router.js"></script>
或者,您可以通过 npm 安装 Vue Router:
- 使用 npm 将路由器安装到您的项目中:
$ npm i vue-router
- 使用
use方法显式注册路由器:
import Vue from 'vue'
import VueRouter from 'vue-router'
Vue.use(VueRouter)
- 一旦你安装好了路由器,你就可以开始使用 Vue Router 提供的导航守卫来创建中间件:
const router = new VueRouter({ ... })
router.beforeEach((to, from, next) => {
// ...
})
在前面的示例中,beforeEach导航守卫是一个全局导航守卫,当导航到任何路由时都会被调用。除了全局守卫,还有特定路由的导航守卫,我们将在下一节中更详细地探讨这一点。所以,让我们开始吧!
如果您想了解更多关于 Vue Router 的信息,请访问router.vuejs.org/。
使用导航守卫
导航守卫用于保护应用程序中的导航。这些守卫允许我们在进入、更新和离开路由之前调用函数。当某些条件不满足时,它们可以重定向或取消路由。有几种方式可以连接到路由导航过程中:全局、每个路由或在组件中。让我们在下一节中探索全局守卫。
请注意,您可以在我们的 GitHub 存储库的/chapter-11/vue/non-sfc/中找到以下所有示例。
创建全局守卫
Vue Router 提供了两种全局守卫 - 全局前置守卫和全局后置守卫。让我们学习如何在应用程序中应用它们之前先了解如何使用它们:
- 全局前置守卫:全局前置守卫在路由进入时调用。它们按特定顺序调用,并且可以是异步的。导航总是等待直到所有守卫都被解析。我们可以使用 Vue Router 的
beforeEach方法注册这些守卫,如下所示:
const router = new VueRouter({ ... })
router.beforeEach((to, from, next) => { ... })
- 全局后置守卫:全局后置守卫在路由进入后调用。与全局前置守卫不同,全局后置守卫没有
next函数,因此它们不会影响导航。我们可以使用 Vue Router 的afterEach方法注册这些守卫,如下所示:
const router = new VueRouter({ ... })
router.afterEach((to, from) => { ... })
让我们创建一个 Vue 应用程序,使用一个简单的 HTML 页面,并在以下步骤中使用这些守卫:
- 使用
<router-link>元素创建两个路由,如下所示:
<div id="app">
<p>
<router-link to="/page1">Page 1</router-link>
<router-link to="/page2">Page 2</router-link>
</p>
<router-view></router-view>
</div>
- 为路由定义组件(
Page1和Page2),并将它们传递给<script>块中的路由实例:
const Page1 = { template: '<div>Page 1</div>' }
const Page2 = { template: '<div>Page 2</div>' }
const routes = [
{ path: '/page1', component: Page1 },
{ path: '/page2', component: Page2 }
]
const router = new VueRouter({
routes
})
- 在路由实例之后声明全局前置守卫和全局后置守卫,如下所示:
router.beforeEach((to, from, next) => {
console.log('global before hook')
next()
})
router.afterEach((to, from,) => {
console.log('global after hook')
})
- 在守卫之后挂载根实例并运行我们的应用程序:
const app = new Vue({
router
}).$mount('#app')
- 在浏览器中运行应用程序,当您在路由之间切换时,您应该在浏览器控制台中获得以下日志:
global before hook
global after hook
全局守卫在你想要应用到所有路由的共同内容时非常有用。然而,有时我们只需要特定路由的特定内容。为此,您应该使用每个路由的守卫。让我们在下一节中学习如何部署它们。
创建每个路由的守卫
我们可以通过在路由的配置对象上直接使用beforeEnter方法或属性来创建每个路由的守卫。例如,看一下以下示例:
beforeEnter: (to, from, next) => { ... }
// or:
beforeEnter (to, from, next) { ... }
让我们复制我们之前的 Vue 应用程序,并更改路由配置以使用这些每个路由的守卫,如下所示:
const routes = [
{
path: '/page1',
component: Page1,
beforeEnter: (to, from, next) => {
console.log('before entering page 1')
next()
}
},
{
path: '/page2',
component: Page2,
beforeEnter (to, from, next) {
console.log('before entering page 2')
next()
}
}
]
当您导航到/page1时,您应该在浏览器控制台上获得“进入页面 1 之前”的日志,当您在/page2上时,您应该获得“进入页面 2 之前”的日志。因此,我们可以将守卫应用于页面的路由,那么将守卫应用于路由组件本身呢?答案是肯定的,我们可以。让我们继续下一节,学习如何使用组件内守卫来保护特定组件。
创建组件内守卫
我们可以在路由组件内部单独或一起使用以下方法来创建特定组件的导航守卫。
beforeRouteEnter 守卫:
就像在全局前置守卫和beforeEnter每个路由守卫中一样,beforeRouteEnter守卫在路由渲染组件之前调用,但它适用于组件本身。我们可以使用beforeRouteEnter方法注册这种类型的守卫,如下所示:
beforeRouteEnter (to, from, next) { ... }
因为它在组件实例之前被调用,所以无法通过this关键字访问 Vue 组件。但可以通过将 Vue 组件的回调传递给next参数来解决这个问题:
beforeRouteEnter (to, from, next) {
next(vueComponent => { ... })
}
beforeRouteLeave 守卫:
相比之下,当由路由渲染的组件即将从中导航离开时,将调用beforeRouteLeave守卫。由于它在 Vue 组件渲染时被调用,因此可以通过this关键字访问 Vue 组件。我们可以使用beforeRouteLeave方法注册这种类型的守卫,如下所示:
beforeRouteLeave (to, from, next) { ... }
通常,这种类型的守卫最适合用于防止用户意外离开路由。因此,可以通过调用next(false)来取消导航:
beforeRouteLeave (to, from, next) {
const confirmed = window.confirm('Are you sure you want to leave?')
if (confirmed) {
next()
} else {
next(false)
}
}
beforeRouteUpdate 守卫:
当由路由渲染的组件已更改但组件在新路由中被重用时,将调用beforeRouteUpdate守卫;例如,如果您有使用相同路由组件的子路由组件:/page1/foo和/page1/bar。因此,从/page1/foo导航到/page1/bar将触发此方法。由于它在组件渲染时被调用,因此可以通过this关键字访问 Vue 组件。我们可以使用beforeRouteUpdate方法注册这种类型的守卫:
beforeRouteUpdate (to, from, next) { ... }
请注意,beforeRouteEnter方法是唯一支持在next方法中使用回调的守卫。在调用beforeRouteUpdate和beforeRouteLeave方法之前,Vue 组件已经可用。因此,在这两种情况下在next方法中使用回调是不受支持的,因为这是不必要的。因此,如果要访问 Vue 组件,只需使用this关键字:
beforeRouteUpdate (to, from, next) {
this.name = to.params.name
next()
}
现在,让我们使用以下守卫创建一个带有简单 HTML 页面的 Vue 应用:
- 创建一个页面组件,其中包含
beforeRouteEnter、beforeRouteUpdate和beforeRouteLeave方法,如下所示:
const Page1 = {
template: '<div>Page 1 {{ $route.params.slug }}</div>',
beforeRouteEnter (to, from, next) {
console.log('before entering page 1')
next(vueComponent => {
console.log('before entering page 1: ',
vueComponent.$route.path)
})
},
beforeRouteUpdate (to, from, next) {
console.log('before updating page 1: ', this.$route.path)
next()
},
beforeRouteLeave (to, from, next) {
console.log('before leaving page 1: ', this.$route.path)
next()
}
}
- 创建另一个页面组件,只包含
beforeRouteEnter和beforeRouteLeave方法,如下所示:
const Page2 = {
template: '<div>Page 2</div>',
beforeRouteEnter (to, from, next) {
console.log('before entering page 2')
next(vueComponent => {
console.log('before entering page 2: ',
vueComponent.$route.path)
})
},
beforeRouteLeave (to, from, next) {
console.log('before leaving page 2: ', this.$route.path)
next()
}
}
- 在初始化路由器实例之前定义主路由和子路由,如下所示:
const routes = [
{
path: '/page1',
component: Page1,
children: [
{
path: ':slug'
}
]
},
{
path: '/page2',
component: Page2
}
]
- 使用
<router-link>Vue 组件创建导航链接,如下所示:
<div id="app">
<ul>
<li><router-link to="/">Home</router-link></li>
<li><router-link to="/page1">Page 1</router-link></li>
<li><router-link to="/page1/foo">Page 1: foo</router-link></li>
<li><router-link to="/page1/bar">Page 1: bar</router-link></li>
<li><router-link to="/page2">Page 2</router-link></li>
</ul>
<router-view></router-view>
</div>
- 在浏览器中运行应用程序,当在路由之间切换时,你应该在浏览器控制台中得到以下日志:
- 当从
/导航到/page1时,你应该看到以下内容:
before entering page 1
before entering page 1: /page1
- 当从
/page1导航到/page2时,你应该看到以下内容:
before leaving page 1: /page1
before entering page 2
before entering page 2: /page2
- 当从
/page2导航到/page1/foo时,你应该看到以下内容:
before leaving page 2: /page2
before entering page 1
before entering page 1: /page1/foo
- 当从
/page1/foo导航到/page1/bar时,你应该看到以下内容:
before updating page 1: /page1/foo
- 当从
/page1/bar导航到/时,你应该看到以下内容:
before leaving page 1: /page1/bar
正如你所看到的,Vue 中的导航守卫只是允许我们创建中间件的 JavaScript 函数,带有一些默认参数。现在,让我们在下一节更仔细地看看每个守卫方法得到的参数(to、from和next)。
理解导航守卫的参数:to、from 和 next
你已经在前面的部分中看到了这些参数在导航守卫中的使用,但我们还没有向你详细介绍它们。所有守卫,除了afterEach全局守卫,都使用这三个参数:to、from和next。
to参数:
这个参数是你要导航到的路由对象(因此被称为to参数)。这个对象保存了 URL 和路由的解析信息:
| namemetapathhash | queryparamsfullPathmatched |
|---|
如果你想了解每个这些对象属性的更多信息,请访问router.vuejs.org/api/the-route-object。
from参数:
这个参数是你从中导航的当前路由对象。同样,这个对象保存了 URL 和路由的解析信息:
| namemetapathhash | queryparamsfullPathmatched |
|---|
next参数:
这个参数是一个函数,你必须调用它才能继续到队列中的下一个守卫(中间件)。如果你想中止当前的导航,你可以向这个函数传递一个false布尔值:
next(false)
如果你想重定向到不同的位置,你可以使用以下代码:
next('/')
// or
next({ path: '/' })
如果你想用Error的实例中止导航,你可以使用以下代码:
const error = new Error('An error occurred!')
next(error)
然后,你可以从根目录捕获错误:
router.onError(err
=> { ... })
现在,让我们创建一个带有简单 HTML 页面的 Vue 应用程序,并在以下步骤中尝试使用 next 函数:
- 按照以下方式创建带有
beforeRouteEnter方法的页面组件:
const Page1 = {
template: '<div>Page 1</div>',
beforeRouteEnter (to, from, next) {
const error = new Error('An error occurred!')
error.statusCode = 500
console.log('before entering page 1')
next(error)
}
}
const Page2 = {
template: '<div>Page 2</div>',
beforeRouteEnter (to, from, next) {
console.log('before entering page 2')
next({ path: '/' })
}
}
在上述代码中,我们将Error实例传递给Page1的下一个函数,同时将路由重定向到Page2的主页。
- 在初始化路由实例之前定义路由,如下所示:
const routes = [
{
path: '/page1',
component: Page1
},
{
path: '/page2',
component: Page2
}
]
- 创建路由实例并使用
onError方法监听错误:
const router = new VueRouter({
routes
})
router.onError(err => {
console.error('Handling this error: ', err.message)
console.log(err.statusCode)
})
- 使用
<router-link>Vue 组件创建以下导航链接:
<div id="app">
<ul>
<li><router-link to="/">Home</router-link></li>
<li><router-link to="/page1">Page 1</router-link></li>
<li><router-link to="/page2">Page 2</router-link></li>
</ul>
<router-view></router-view>
</div>
- 在浏览器中运行应用程序,当在路由之间切换时,你应该在浏览器控制台中看到以下日志:
- 当从
/导航到/page1时,你应该看到以下内容:
before entering page 1
Handling this error: An error occurred!
500
- 从
/page1导航到/page2时,你应该看到以下内容:
before entering page 2
当从/page1导航到/page2时,你也会注意到被重定向到/,因为有这行代码:next({ path: '/' })。
到目前为止,我们在单个 HTML 页面中创建了中间件。然而,在实际项目中,我们应该尝试使用你在之前章节中学到的 Vue 单文件组件(SFC)来创建它们。因此,在下一节中,你将学习如何使用 Vue CLI 在 Vue SFC 中创建中间件,而不是你到目前为止学到的自定义 webpack 构建过程。所以,让我们开始吧。
介绍 Vue CLI
我们在第五章中使用 webpack 创建了我们的自定义 Vue SFC 应用程序,添加 Vue 组件。作为开发人员,了解如何查看复杂事物的机制非常有用,我们还必须了解如何使用常见和标准模式与他人合作。因此,这些天,我们倾向于使用框架。Vue CLI 是 Vue 应用程序开发的标准工具。它可以执行我们的 webpack 自定义工具以及更多操作。如果你不想创建自己的 Vue SFC 开发工具,Vue CLI 是一个很好的选择。它支持 Babel、ESLint、TypeScript、PostCSS、PWA、单元测试和端到端测试。要了解更多关于 Vue CLI 的信息,请访问cli.vuejs.org/。
安装 Vue CLI
使用 Vue CLI 非常容易入门。执行以下步骤:
- 使用 npm 全局安装它:
$ npm i -g @vue/cli
- 在你想要的时候创建一个项目:
$ vue create my-project
- 您将被提示选择预设 -
default或手动选择功能,如下所示:
Vue CLI v4.4.6
? Please pick a preset: (Use arrow keys)
> default (babel, eslint)
Manually select features
- 选择
default预设,因为我们可以随后手动安装所需的内容。当安装完成时,你应该在终端中看到类似以下输出的最后部分:
Successfully created project my-project.
Get started with the following commands:
**$ cd my-project**
**$ npm run serve**
- 将目录更改为
my-project并开始开发过程:
$ npm run serve
你应该得到类似于这样的东西:
DONE Compiled successfully in 3469ms
App running at:
- Local: http://localhost:8080/
- Network: http://199.188.0.44:8080/
Note that the development build is not optimized.
To create a production build, run npm run build.
在接下来的几节中,我们将把你在前几节中学到的导航守卫转换成使用 Vue CLI 的适当中间件。这意味着我们将把所有的钩子和守卫分开成单独的.js文件,并将它们保存在一个名为middlewares的常见文件夹中。然而,在我们这样做之前,我们应该先了解 Vue CLI 为我们生成的项目目录结构,然后添加我们自己需要的目录。让我们开始吧。
理解 Vue CLI 的项目结构
使用 Vue CLI 创建项目后,如果你查看项目目录,你会发现它为我们提供了一个基本的结构,如下所示:
├── package.json
├── babel.config.js
├── README.md
├── public
│ ├── index.html
│ └── favicon.ico
└── src
├── App.vue
├── main.js
├── router.js
├── components
│ └── HelloWorld.vue
└── assets
└── logo.png
从这个基本结构开始,我们可以构建和发展我们的应用程序。因此,让我们在/src/目录中开发我们的应用程序,并使用路由文件添加以下目录:
└── src
├── middlewares/
├── store/
├── routes/
└── router.js
我们将创建两个路由组件,登录和安全,作为 SFC 页面,并将安全页面设置为 403 受保护页面,这将要求用户登录以提供其姓名和年龄以访问页面。以下是我们这个简单的 Vue 应用程序所需的/src/目录中的文件和结构:
└── src
├── App.vue
├── main.js
├── router.js
├── components
│ ├── secured.vue
│ └── login.vue
├── assets
│ └── ...
├── middlewares
│ ├── isLoggedIn.js
│ └── isAdult.js
├── store
│ ├── index.js
│ ├── mutations.js
│ └── actions.js
└── routes
├── index.js
├── secured.js
└── login.js
现在我们知道了我们的应用程序需要哪些目录和文件。接下来,我们将继续编写这些文件的代码。
使用 Vue CLI 编写中间件和 Vuex 存储
如果你看一下package.json,你会发现 Vue CLI 默认的依赖项非常基本和最小:
// package.json
"dependencies": {
"core-js": "².6.5",
"vue": "².6.10"
}
因此,我们将安装我们项目的依赖项,并按以下步骤编写我们需要的代码:
- 通过 npm 安装以下软件包:
$ npm i vuex
$ npm i vue-router
$ npm i vue-router-multiguard
请注意,Vue 不支持每个路由多个守卫。因此,如果您想为一个路由创建多个守卫,Vue Router Multiguard 允许您这样做。有关此软件包的更多信息,请访问github.com/atanas-dev/vue-router-multiguard。
- 创建状态、操作和变异以在 Vuex 存储中存储经过身份验证的用户详细信息,以便任何组件都可以访问这些详细信息:
// src/store/index.js
import Vue from 'vue'
import Vuex from 'vuex'
import actions from './actions'
import mutations from './mutations'
Vue.use(Vuex)
export default new Vuex.Store({
state: { user: null },
actions,
mutations
})
为了可读性和简单性,我们将把存储的操作分成一个单独的文件,如下所示:
// src/store/actions.js
const actions = {
async login({ commit }, { name, age }) {
if (!name || !age) {
throw new Error('Bad credentials')
}
const data = {
name: name,
age: age
}
commit('setUser', data)
},
async logout({ commit }) {
commit('setUser', null)
}
}
export default actions
我们还将把存储的变异分成一个单独的文件,如下所示:
// src/store/mutations.js
const mutations = {
setUser (state, user) {
state.user = user
}
}
export default mutations
- 创建一个中间件来确保用户已登录:
// src/middlewares/isLoggedIn.js
import store from '../store'
export default (to, from, next) => {
if (!store.state.user) {
const err = new Error('You are not connected')
err.statusCode = 403
next(err)
} else {
next()
}
}
- 创建另一个中间件来确保用户年满 18 岁:
// src/middlewares/isAdult.js
import store from '../store'
export default (to, from, next) => {
if (store.state.user.age < 18) {
const err = new Error('You must be over 18')
err.statusCode = 403
next(err)
} else {
next()
}
}
- 通过使用
vue-router-multiguard在beforeEnter中插入多个中间件,将这两个中间件导入到 secured 路由中:
// src/routes/secured.js
import multiguard from 'vue-router-multiguard'
import secured from '../components/secured.vue'
import isLoggedIn from '../middlewares/isLoggedIn'
import isAdult from '../middlewares/isAdult'
export default {
name: 'secured',
path: '/secured',
component: secured,
beforeEnter: multiguard([isLoggedIn, isAdult])
}
- 创建一个简单的登录页面进行客户端身份验证。以下是我们需要的
login和logout方法的基本输入字段:
// src/components/login.vue
<form @submit.prevent="login">
<p>Name: <input v-model="name" type="text" name="name"></p>
<p>Age: <input v-model="age" type="number" name="age"></p>
<button type="submit">Submit</button>
</form>
export default {
data() {
return {
error: null,
name: '',
age: ''
}
},
methods: {
async login() { ... },
async logout() { ... }
}
}
- 通过在
try和catch块中分派login和logout动作方法来完成上述login和logout方法,如下所示:
async login() {
try {
await this.$store.dispatch('login', {
name: this.name,
age: this.age
})
this.name = ''
this.age = ''
this.error = null
} catch (e) {
this.error = e.message
}
},
async logout() {
try {
await this.$store.dispatch('logout')
} catch (e) {
this.error = e.message
}
}
- 将完成的
login组件导入到登录路由中,如下所示:
// src/routes/login.js
import Login from '../components/login.vue'
export default {
name: 'login',
path: '/',
component: Login
}
请注意,我们将此路由命名为login,因为我们稍后需要此名称来在前面的中间件中从导航路由重定向时使用。
- 将
login和secured路由导入到索引路由中,如下所示:
// src/routes/index.js
import login from './login'
import secured from './secured'
const routes = [
login,
secured
]
export default routes
- 将前面的索引路由导入到 Vue Router 实例中,并使用
router.onError捕获路由错误,如下所示:
// src/router.js
import Vue from 'vue'
import VueRouter from 'vue-router'
import Routes from './routes'
Vue.use(VueRouter)
const router = new VueRouter({
routes: Routes
})
router.onError(err => {
alert(err.message)
router.push({ name: 'login' })
})
export default router
在这一步中,我们使用router.onError来处理从中间件传递的Error对象,并使用router.push在不满足身份验证条件时将导航路由重定向到登录页面。对象的名称必须与步骤 7中的登录路由名称相同,即login。
- 在
main文件中导入路由并存储:
// src/main.js
import Vue from 'vue'
import App from './App.vue'
import router from './router'
import store from './store'
new Vue({
router,
store,
render: h => h(App),
}).$mount('#app')
- 使用
npm run serve运行项目,您应该看到该应用程序加载在localhost:8080上。如果您在主页的输入字段中输入一个名称和小于 18 的数字,然后点击登录按钮,您应该会收到一个警告,指出“您必须年满 18 岁”当尝试访问 secured 页面时。另一方面,如果您输入一个大于 18 的数字,您应该会在 secured 页面上看到名称和数字。
Name: John
Age: 20
您可以在我们的 GitHub 存储库的/chapter-11/vue/vue-cli/basic/中找到此应用程序的完整代码。您还可以在/chapter-11/vue/webpack/中找到具有自定义 webpack 的应用程序。
干得好!您已经成功完成了关于 Vue 项目中间件的所有章节。现在,让我们在接下来的章节中应用您刚刚学到的关于 Nuxt 项目的知识。
在 Nuxt 中编写路由中间件
理解了 Vue 中间件的工作原理后,就更容易在 Nuxt 中使用它,因为 Nuxt 已经为我们处理了 Vue Router。在接下来的章节中,我们将学习如何在 Nuxt 应用程序中使用全局和每个路由的中间件。
在 Nuxt 中,所有中间件都应该保存在/middleware/目录中,中间件的文件名将是中间件的名称。例如,/middleware/user.js是用户中间件。中间件将 Nuxt 上下文作为其第一个参数:
export default (context) => { ... }
此外,中间件可以是异步的。
export default async (context) => {
const { data } = await axios.get('/api/path')
}
在通用模式中,中间件在服务器端只调用一次(例如,当首次请求 Nuxt 应用程序或刷新页面时),然后在客户端导航到其他路由时再次调用。另一方面,无论您是首次请求应用程序还是在首次请求后导航到更多路由时,中间件始终在客户端调用。中间件首先在 Nuxt 配置文件中执行,然后在布局中执行,最后在页面中执行。我们现在将在下一节开始编写一些全局中间件。
编写全局中间件
添加全局中间件非常简单;您只需在config文件的“路由器”选项中的“中间件”键中声明它们。例如,看一下以下内容:
// nuxt.config.js
export default {
router: {
middleware: 'auth'
}
}
现在,让我们按照以下步骤创建一些全局中间件。在这个练习中,我们想要从 HTTP 请求头中获取用户代理的信息,并跟踪用户正在导航到的路由:
- 在
/middleware/目录中创建两个中间件,一个用于获取用户代理信息,另一个用于获取用户正在导航到的路由路径信息:
// middleware/user-agent.js
export default (context) => {
context.userAgent = process.server ? context.req.headers[
'user-agent'] : navigator.userAgent
}
// middleware/visits.js
export default ({ store, route, redirect }) => {
store.commit('addVisit', route.path)
}
- 在“路由器”选项中的“中间件”键中声明前面的中间件,如下所示:
// nuxt.config.js
module.exports = {
router: {
middleware: ['visits', 'user-agent']
}
}
请注意,在 Nuxt 中,我们不需要像在 Vue 应用程序中那样调用多个守卫的第三方包。
- 创建存储访问路由的存储器状态和变化:
// store/state.js
export default () => ({
visits: []
})
// store/mutations.js
export default {
addVisit (state, path) {
state.visits.push({
path,
date: new Date().toJSON()
})
}
}
- 在
about页面中使用user-agent中间件:
// pages/about.vue
<p>{{ userAgent }}</p>
export default {
asyncData ({ userAgent }) {
return {
userAgent
}
}
}
- 至于
visits中间件,我们希望在组件上使用它,然后将该组件注入到我们的布局中,即default.vue布局。首先,在/components/目录中创建visits组件:
// components/visits.vue
<li v-for="(visit, index) in visits" :key="index">
<i>{{ visit.date | dates }} | {{ visit.date | times }}</i> - {{
visit.path }}
</li>
export default {
filters: {
dates(date) {
return date.split('T')[0]
},
times(date) {
return date.split('T')[1].split('.')[0]
}
},
computed: {
visits() {
return this.$store.state.visits.slice().reverse()
}
}
}
因此,我们在此组件中创建了两个过滤器。date过滤器用于从字符串中获取日期。例如,我们将从2019-05-24T21:55:44.673Z中获得2019-05-24。相比之下,time过滤器用于从字符串中获取时间。例如,我们将从2019-05-24T21:55:44.673Z中获得21:55:44。
- 将
visits组件导入到我们的布局中:
// layouts/default.vue
<template>
<Visits />
</template>
import Visits from '~/components/visits.vue'
export default {
components: {
Visits
}
}
当我们在路由之间导航时,我们应该在浏览器中获得以下结果:
2019-06-06 | 01:55:44 - /contact
2019-06-06 | 01:55:37 - /about
2019-06-06 | 01:55:30 - /
此外,当您在关于页面时,应该从请求头中获取用户代理的信息:
Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/73.0.3683.75 Safari/537.36
您可以在我们的 GitHub 存储库中的/chapter-11/nuxt-universal/route-middleware/global/中找到上述源代码。
全局中间件就介绍到这里。现在,让我们继续下一节的路由中间件。
编写路由中间件
添加路由中间件也非常简单;您只需在特定布局或页面的middleware键中声明它们。例如,看一下以下内容:
// pages/index.vue or layouts/default.vue
export default {
middleware: 'auth'
}
因此,在接下来的步骤中,让我们创建一些路由中间件。在这个练习中,我们将使用会话和 JSON Web Tokens(JWT)来访问受限页面或受保护的 API。虽然在现实生活中,我们可以只使用会话或令牌进行身份验证系统,但我们将在练习中同时使用两者,以便了解如何将它们一起用于潜在更复杂的生产系统。在我们的练习中,我们希望用户登录并从服务器获取令牌。当令牌过期或无效时,用户将无法访问受保护的路由。
此外,当会话时间结束时,用户将被注销:
- 创建一个
auth中间件来检查我们存储中是否有任何数据的状态。如果没有经过身份验证的数据,则我们使用 Nuxt 上下文中的error函数将错误发送到前端:
// middleware/auth.js
export default function ({ store, error }) {
if (!store.state.auth) {
error({
message: 'You are not connected',
statusCode: 403
})
}
}
- 创建一个
token中间件来确保令牌在存储中;否则,它将错误发送到前端。如果存储中存在令牌,我们将使用令牌将Authorization设置为默认的axios标头:
// middleware/token.js
export default async ({ store, error }) => {
if (!store.state.auth.token) {
error({
message: 'No token',
statusCode: 403
})
}
axios.defaults.headers.common['Authorization'] = `Bearer: ${store.state.auth.token}`
}
- 将这两个前置中间件添加到受保护页面的
middleware键上:
// pages/secured.vue
<p>{{ greeting }}</p>
export default {
async asyncData ({ redirect }) {
try {
const { data } = await axios.get('/api/private')
return {
greeting: data.data.message
}
} catch (error) {
if(process.browser){
alert(error.response.data.message)
}
return redirect('/login')
}
},
middleware: ['auth', 'token']
}
在请求头中设置带有 JWT 的Authorization标头后,我们可以访问受保护的 API 路由,这些路由由服务器端中间件保护(我们将在第十二章中了解更多,创建用户登录和 API 身份验证)。我们将从受保护的 API 路由获取我们想要访问的数据,并且如果令牌不正确或已过期,将收到错误消息提示。
- 在
/store/目录中创建存储的状态、mutations 和 actions 以存储经过身份验证的数据:
// store/state.js
export default () => ({
auth: null
})
// store/mutations.js
export default {
setAuth (state, data) {
state.auth = data
}
}
// store/actions.js
export default {
async login({ commit }, { username, password }) {
try {
const { data } = await axios.post('/api/public/users/login',
{ username, password })
commit('setAuth', data.data)
} catch (error) {
// handle error
}
},
async logout({ commit }) {
await axios.post('/api/public/users/logout')
commit('setAuth', null)
}
}
已知并且预期的行为是,当页面刷新时,存储的状态会重置为默认值。如果我们想要保持状态,有一些解决方案可以使用:
-
localStorage
-
sessionStorage
-
vuex-persistedstate(一个 Vuex 插件)
然而,在我们的情况下,由于我们使用会话来存储认证信息,我们实际上可以通过以下方式从会话中重新获取我们的数据:
-
req.ctx.session(Koa)或 req.session(Express)
-
req.headers.cookie
一旦我们决定要选择哪种解决方案或选项(比如 req.headers.cookie),然后我们可以按照以下方式重新填充状态:
// store/index.js
const cookie = process.server ? require('cookie') : undefined
export const actions = {
nuxtServerInit({ commit }, { req }) {
var session = null
var auth = null
if (req.headers.cookie && req.headers.cookie.indexOf('koa:sess') > -1) {
session = cookie.parse(req.headers.cookie)['koa:sess']
}
if (session) {
auth = JSON.parse(Buffer.from(session, 'base64'))
commit('setAuth', auth)
}
}
}
您可以在我们的 GitHub 存储库中的 /chapter-11/nuxt-universal/route-middleware/per-route/ 中找到前面的源代码。
当所有前面的步骤都遵循并且中间件已经创建好后,我们可以通过 npm run dev 来运行这个简单的认证应用程序,看看它是如何工作的。我们将在下一章中介绍服务器端认证。现在,我们只需要专注于中间件并理解它的工作原理,这将有助于我们在下一章中。现在,让我们继续本章的最后一部分 - 服务器中间件。
编写 Nuxt 服务器中间件
简而言之,服务器中间件是在 Nuxt 中用作中间件的服务器端应用程序。自从第八章以来,我们一直在使用像 Koa 这样的服务器端框架来运行我们的 Nuxt 应用程序,添加服务器端框架。如果您使用 Express,这是您 package.json 文件中的 scripts 对象:
// package.json
"scripts": {
"dev": "cross-env NODE_ENV=development nodemon server/index.js --watch
server",
"build": "nuxt build",
"start": "cross-env NODE_ENV=production node server/index.js",
"generate": "nuxt generate"
}
在这个 npm 脚本中,dev 和 start 脚本指示服务器从 /server/index.js 运行您的应用程序。这可能不是理想的,因为我们将 Nuxt 和服务器端框架紧密耦合在一起,这会导致在配置中额外的工作。但是,我们可以告诉 Nuxt 不要附加到 /server/index.js 中的服务器端框架配置,并保持我们原始的 Nuxt 运行脚本如下所示:
// package.json
"scripts": {
"dev": "nuxt",
"build": "nuxt build",
"start": "nuxt start",
"generate": "nuxt generate"
}
相反,我们可以在 Nuxt 配置文件中使用 serverMiddleware 属性,使服务器端框架在 Nuxt 下运行。例如,看一下以下内容:
// nuxt.config.js
export default {
serverMiddleware: [
'~/api'
]
}
与路由中间件不同,路由中间件在客户端每个路由之前调用,而服务器中间件总是在 vue-server-renderer 之前在服务器端调用。因此,服务器中间件可以用于服务器特定的任务,就像我们在之前的章节中使用 Koa 或 Express 一样。因此,让我们在接下来的章节中探讨如何在 Express 和 Koa 中使用作为我们的服务器中间件。
使用 Express 作为 Nuxt 的服务器中间件
让我们使用 Express 作为 Nuxt 的服务器中间件来创建一个简单的身份验证应用程序。我们将继续使用身份验证练习中的客户端代码,以及你在前一节中学到的每个路由中间件,其中用户需要提供用户名和密码才能访问受保护的页面。此外,我们将使用 Vuex 存储来集中存储认证用户数据,就像以前一样。这个练习的主要区别在于,我们的 Nuxt 应用程序将作为中间件移出服务器端应用程序,而服务器端应用程序将作为中间件移入Nuxt 应用程序。所以,让我们按照以下步骤开始:
- 安装
cookie-session和body-parser作为服务器中间件,并在 Nuxt 的config文件中添加它们之后的 API 路径,如下所示:
// nuxt.config.js
import bodyParser from 'body-parser'
import cookieSession from 'cookie-session'
export default {
serverMiddleware: [
bodyParser.json(),
cookieSession({
name: 'express:sess',
secret: 'super-secret-key',
maxAge: 60000
}),
'~/api'
]
}
请注意,cookie-session 是 Express 的基于 cookie 的会话中间件,它将会话存储在客户端的 cookie 中。相比之下,body-parser 是 Express 的一个用于解析请求体的中间件,就像你在第八章中学到的 Koa 的koa-bodyparser一样。
有关 Express 的cookie-session和body-parser的更多信息,请访问github.com/expressjs/cookie-session和github.com/expressjs/body-parser。
- 使用
index.js文件创建一个/api/目录,在其中导入 Express 并将其导出为另一个服务器中间件:
// api/index.js
import express from 'express'
const app = express()
app.get('/', (req, res) => res.send('Hello World!'))
// Export the server middleware
export default {
path: '/api',
handler: app
}
-
使用
npm run dev运行应用程序,你应该在localhost:3000/api中收到“Hello World!”消息。 -
按照以下步骤在
/api/index.js中添加login和logout的 post 方法:
// api/index.js
app.post('/login', (req, res) => {
if (req.body.username === 'demo' && req.body.password === 'demo') {
req.session.auth = { username: 'demo' }
return res.json({ username: 'demo' })
}
res.status(401).json({ message: 'Bad credentials' })
})
app.post('/logout', (req, res) => {
delete req.session.auth
res.json({ ok: true })
})
在上述代码中,当用户成功登录时,我们将认证有效载荷存储到 Express 会话中作为 HTTP 请求对象中的auth。然后,当用户注销时,我们将通过删除它来清除auth会话。
- 创建一个包含
state.js和mutations.js的存储,就像你为编写每个路由中间件所做的那样,如下所示:
// store/state.js
export default () => ({
auth: null,
})
// store/mutations.js
export default {
setAuth (state, data) {
state.auth = data
}
}
- 就像编写每个路由中间件一样,在存储中的
actions.js文件中创建login和logout动作方法,如下所示:
// store/actions.js
import axios from 'axios'
export default {
async login({ commit }, { username, password }) {
try {
const { data } = await axios.post('/api/login', { username,
password })
commit('setAuth', data)
} catch (error) {
// handle error...
}
},
async logout({ commit }) {
await axios.post('/api/logout')
commit('setAuth', null)
}
}
- 在存储的
index.js中添加一个nuxtServerInit动作,以便在刷新页面时从 Express 会话中重新填充状态到 HTTP 请求对象中:
// store/index.js
export const actions = {
nuxtServerInit({ commit }, { req }) {
if (req.session && req.session.auth) {
commit('setAuth', req.session.auth)
}
}
}
- 最后,就像在逐路由中间件身份验证中一样,在
/pages/目录中创建一个登录页面,并使用相同的login和logout方法来调度存储中的login和logout操作方法:
// pages/index.vue
<form v-if="!$store.state.auth" @submit.prevent="login">
<p v-if="error" class="error">{{ error }}</p>
<p>Username: <input v-model="username" type="text"
name="username"></p>
<p>Password: <input v-model="password" type="password"
name="password"></p>
<button type="submit">Login</button>
</form>
export default {
data () {
return {
error: null,
username: '',
password: ''
}
},
methods: {
async login () { ... },
async logout () { ... }
}
}
- 使用
npm run dev运行应用程序。您应该有一个与以前一样工作的身份验证应用程序,但它不再是从/server/index.js运行的。
你可以在我们的 GitHub 存储库的/chapter-11/nuxt-universal/server-middleware/express/中找到前面的源代码。
使用serverMiddleware属性使我们的 Nuxt 应用程序看起来整洁,感觉轻盈,不是吗?通过这种方法,我们也可以使其更加灵活,因为我们可以使用任何服务器端框架或应用程序。例如,我们可以使用 Koa,而不是使用 Express,我们将在下一节中讨论。
使用 Koa 作为 Nuxt 的服务器中间件
就像 Koa 和 Express 一样,Connect 是一个简单的框架,用于粘合各种中间件来处理 HTTP 请求。Nuxt 在内部使用 Connect 作为服务器,因此大多数 Express 中间件都可以与 Nuxt 的服务器中间件一起使用。相比之下,Koa 中间件要作为 Nuxt 的服务器中间件工作要困难一些,因为在 Koa 中,req和res对象被隐藏并保存在ctx中。我们可以通过一个简单的“Hello World”消息来比较这三个框架,如下所示:
// Connect
const connect = require('connect')
const app = connect()
app.use((req, res, next) => res.end('Hello World'))
// Express
const express = require('express')
const app = express()
app.get('/', (req, res, next) => res.send('Hello World'))
// Koa
const Koa = require('koa')
const app = new Koa()
app.use(async (ctx, next) => ctx.body = 'Hello World')
请注意,req是一个 Node.js HTTP 请求对象,而res是一个 Node.js HTTP 响应对象。它们可以被命名为任何你喜欢的东西,例如,request而不是req和response而不是res。从前面的比较中,你可以看到 Koa 如何与其他框架不同地处理这两个对象。因此,我们不能像在 Express 中那样将 Koa 用作 Nuxt 的服务器中间件,也不能在serverMiddleware属性中定义任何 Koa 中间件,而只能添加 Koa API 所在目录的路径。请放心,让它们作为 Nuxt 应用程序中的中间件工作并不困难。让我们继续以下步骤:
- 添加我们想要使用 Koa 创建 API 的路径,如下所示:
// nuxt.config.js
export default {
serverMiddleware: [
'~/api'
]
}
- 导入
koa和koa-router,使用路由创建一个Hello World!消息,然后将它们导出到/api/目录中的index.js文件中:
// api/index.js
import Koa from 'koa'
import Router from 'koa-router'
router.get('/', async (ctx, next) => {
ctx.type = 'json'
ctx.body = {
message: 'Hello World!'
}
})
app.use(router.routes())
app.use(router.allowedMethods())
// Export the server middleware
export default {
path: '/api',
handler: app.listen()
}
- 导入
koa-bodyparser和koa-session,并在/api/index.js文件中将它们注册为中间件,如下所示:
// api/index.js
import bodyParser from 'koa-bodyparser'
import session from 'koa-session'
const CONFIG = {
key: 'koa:sess',
maxAge: 60000,
}
app.use(session(CONFIG, app))
app.use(bodyParser())
- 使用 Koa 路由创建
login和logout路由,如下所示:
// api/index.js
router.post('/login', async (ctx, next) => {
let request = ctx.request.body || {}
if (request.username === 'demo' && request.password === 'demo') {
ctx.session.auth = { username: 'demo' }
ctx.body = {
username: 'demo'
}
} else {
ctx.throw(401, 'Bad credentials')
}
})
router.post('/logout', async (ctx, next) => {
ctx.session = null
ctx.body = { ok: true }
})
在上述代码中,就像在上一节中的 Express 示例中一样,当用户成功登录时,我们将经过身份验证的有效负载存储到 Koa 会话中的auth中。然后,当用户注销时,我们将通过将会话设置为null来清除auth会话。
- 创建一个带有状态、变异和操作的存储,就像您在 Express 示例中所做的那样。此外,在存储中的
index.js文件中创建nuxtServerInit,就像您在编写每个路由中间件时所做的那样:
// store/index.js
export const actions = {
nuxtServerInit({ commit }, { req }) {
// ...
}
}
- 就像以前一样,在
/pages/目录中创建login和logout方法来调度存储中的操作方法:
// pages/index.vue
<form v-if="!$store.state.auth" @submit.prevent="login">
//...
</form>
export default {
methods: {
async login () { ... },
async logout () { ... }
}
}
- 使用
npm run dev运行应用程序。您应该有一个身份验证应用程序,其工作方式与上一节中 Express 中的应用程序相同,但它不再是从/server/index.js运行的。
您可以在我们的 GitHub 存储库的/chapter-11/nuxt-universal/server-middleware/koa/中找到此示例的整个源代码。
根据您的喜好,您可以在下一个项目中使用 Express 或 Koa 作为 Nuxt 的服务器中间件。在本书中,我们主要使用 Koa 因为它简单易用。您甚至可以创建自定义服务器中间件,而无需使用它们中的任何一个。让我们在下一节中看看如何创建自定义服务器中间件。
创建自定义服务器中间件
由于 Nuxt 在内部使用 Connect 作为服务器,因此我们可以添加自定义中间件,而无需外部服务器,如 Koa 或 Express。您可以开发一个复杂的 Nuxt 服务器中间件,就像我们在前几节中使用 Koa 和 Express 一样。但是,让我们不要无休止地重复我们已经做过的事情。让我们创建一个非常基本的自定义中间件,以打印“Hello World”消息来确认从基本中间件构建复杂中间件的可行性:
- 添加我们想要创建自定义中间件的路径:
// nuxt.config.js
serverMiddleware: [
{ path: '/api', handler: '~/api/index.js' }
]
- 将 API 路由添加到
/api/目录中的index.js文件中:
// api/index.js
export default function (req, res, next) {
res.end('Hello world!')
}
- 使用
npm run dev运行应用程序,并导航到localhost:3000/api。您应该在屏幕上看到打印的“Hello World!”消息。
您可以在github.com/senchalabs/connect上查找 Connect 文档以获取更多信息。此外,您可以在我们的 GitHub 存储库的/chapter-11/nuxt-universal/server-middleware/custom/中找到此示例的源代码。
干得好! 你已经成功完成了 Nuxt 的另一个重要章节。在继续下一章之前,让我们总结一下你到目前为止学到的东西。
总结
在本章中,你学到了路由中间件和服务器中间件之间的区别。你使用了 Vue Router 的导航守卫来为 Vue 应用程序创建中间件。你还使用了 Vue CLI 来开发一个简单的 Vue 身份验证应用程序。根据你对 Vue 应用程序的学习,你在 Nuxt 应用程序中使用了全局和每个路由的中间件来实现相同的概念(路由中间件)。之后,你学习了 Nuxt 的服务器中间件以及如何使用 Express 和 Koa 作为服务器中间件。中间件对于身份验证和安全非常重要和有用。我们已经制作了一些身份验证应用程序,并将在下一章中更详细地研究和理解它们。
在下一章中,你将详细学习有关开发用户登录和身份验证 API 的内容,以改进你在本章中创建的身份验证应用程序。我们将为你介绍基于会话的身份验证和基于令牌的身份验证。虽然你已经使用这两种技术创建了身份验证应用程序,但我们还没有解释它们是什么。但请放心,你将在下一章更好地理解它们。除此之外,你还将学习如何为你的 Nuxt 应用程序创建后端和前端身份验证,并使用 Google OAuth 进行登录。所以,请继续关注!
创建用户登录和 API 身份验证
在过去的两章中,我们开始在 Nuxt 应用程序中使用会话和 JSON Web Token(JWT)进行身份验证。我们在第十章中使用会话进行身份验证,添加 Vuex Store,以练习nuxtServerInit。然后我们在第十一章中使用会话和令牌一起进行身份验证,编写路由中间件和服务器中间件,以练习按路由中间件,例如:
// store/index.js
nuxtServerInit({ commit }, { req }) {
if (req.ctx.session && req.ctx.session.authUser) {
commit('setUser', req.ctx.session.authUser)
}
}
// middleware/token.js
export default async ({ store, error }) => {
if (!store.state.auth.token) {
// handle error
}
axios.defaults.headers.common['Authorization'] = Bearer: ${store.state.auth.token}
}
如果您是新手,它们可能会让人感到不知所措,但不用担心。简而言之,身份验证是验证您是谁的过程。身份验证系统允许您在您的凭据与数据库或数据身份验证服务器中的凭据匹配时访问资源。有几种身份验证方法。基于会话和基于令牌的身份验证是最常见的,或者这两种的组合。所以,让我们深入了解它们。
本章我们将涵盖以下主题:
-
理解基于会话的身份验证
-
理解基于令牌的身份验证
-
创建后端身份验证
-
创建前端身份验证
-
使用 Google OAuth 进行登录
第十二章:理解基于会话的身份验证
超文本传输协议(HTTP)是无状态的。因此,所有 HTTP 请求都是无状态的。这意味着它不记住任何我们已经验证过的东西或任何用户,我们的应用程序也不知道它是否是上一个请求的同一个人。因此,我们将不得不在下一个请求上再次进行身份验证。这并不理想。
因此,基于会话和基于 Cookie 的身份验证(通常仅称为基于会话的身份验证)被引入以在 HTTP 请求之间存储用户数据,以消除 HTTP 请求的无状态性质。它们使身份验证过程“有状态”。这意味着经过身份验证的记录或会话存储在服务器和客户端两侧。服务器可以将活动会话保存在数据库或服务器内存中,因此它被称为基于会话的身份验证。客户端可以创建一个 Cookie 来保存会话标识符(会话 ID),因此它被称为基于 Cookie 的身份验证。
但是会话和 Cookie 到底是什么?让我们在接下来的章节中深入了解它们。
什么是会话和 Cookie?
会话是在两个或多个通信设备之间,或者在计算机和用户之间交换的临时信息片段。它在特定时间建立,然后在将来的某个时间到期。当用户关闭浏览器或离开网站时,会话也会到期。建立会话时,在服务器的临时目录(或数据库或服务器内存)中创建一个文件,用于存储注册的会话值。然后在整个访问期间,这些数据都可用,并且浏览器会接收一个会话 ID,该 ID 将通过 cookie 或GET变量发送回服务器进行验证。
简而言之,cookie 和会话只是数据。Cookie 仅存储在客户端机器上,而会话既存储在客户端又存储在服务器上。会话被认为比 cookie 更安全,因为数据可以仅保存在服务器上。当会话建立时通常会创建 cookie,并且它们保存在客户端计算机上。它们可以是经过身份验证的用户的名称、年龄或 ID,并且由浏览器发送回服务器以识别用户。让我们在下一节通过示例流程来看看它们是如何工作的。
会话身份验证流程
基于会话和基于 cookie 的身份验证可以通过以下示例身份验证流程来理解:
-
用户从其浏览器上的客户端应用程序发送其凭据,例如用户名和密码,到服务器。
-
服务器检查凭据并向客户端发送一个唯一的令牌(会话 ID)。此令牌还将保存在服务器端的数据库或内存中。
-
客户端应用程序将令牌存储在客户端的 cookie 中,并在每个 HTTP 请求中使用它并发送回服务器。
-
服务器接收令牌并对用户进行身份验证,然后将请求的数据返回给客户端应用程序。
-
客户端应用程序在用户注销时销毁令牌。在注销之前,客户端还可以向服务器发送请求以删除会话,或者会话将根据设置的到期时间自行结束。
在基于会话的身份验证中,服务器承担了所有繁重的工作。它是有状态的。它将会话标识符与用户账户关联起来(例如,在数据库中)。基于会话的身份验证的缺点是,在大量用户同时使用系统时,可伸缩性会受到影响,因为会话存储在服务器的内存中,因此涉及大量的内存使用。此外,cookie 在单个域或子域上运行良好,但通常在跨域共享(跨域资源共享)时被浏览器禁用。因此,当客户端从不同的域中进行 API 请求时,这会给客户端造成问题。但是,这个问题可以通过基于令牌的身份验证来解决,我们将在下一节中详细介绍。
理解基于令牌的身份验证
基于令牌的身份验证更简单。有一些令牌的实现,但是 JSON Web Tokens 是最常见的一种。基于令牌的身份验证是无状态的。这意味着服务器端不会保留任何会话,因为状态存储在客户端的令牌中。服务器的责任只是使用秘钥创建一个 JWT 并将其发送给客户端。客户端将 JWT 存储在本地存储中,或者客户端的 cookie 中,并在发出请求时将其包含在标头中。服务器然后验证 JWT 并发送响应。
但是 JWT 是什么,它是如何工作的?让我们在下一节中找出答案。
什么是 JSON Web Tokens?
要理解 JWT 的工作原理,我们首先应该了解它是什么。简而言之,JWT 是一个由标头、有效载荷和签名组成的哈希 JSON 对象的字符串。JWT 的生成格式如下:
header.payload.signature
标头通常由两部分组成:类型和算法。类型是 JWT,算法可以是 HMAC、SHA256 或 RSA,这是一种使用秘钥对令牌进行签名的哈希算法,例如:
{
"typ": "JWT",
"alg": "HS256"
}
有效载荷是 JWT 中存储信息(或声明)的部分,例如:
{
"userId": "b08f86af-35da-48f2-8fab-cef3904660bd",
"name": "Jane Doe"
}
在这个例子中,我们在有效载荷中只包括了两个声明。您可以放置任意多个声明。您包含的声明越多,JWT 的大小就越大,这可能会影响性能。还有其他可选的声明,比如iss(发行者)、sub(主题)和exp(过期时间)。
如果您想了解有关 JWT 标准字段的更多详细信息,请访问tools.ietf.org/html/rfc7519。
签名是使用编码的标头、编码的有效负载、一个密钥和标头中指定的算法计算的。无论您在标头部分选择了什么算法,您必须使用该算法来加密 JWT 的前两部分:base64(header) + '.' + base64(payload),例如,在这个伪代码中:
// signature algorithm
data = base64urlEncode(header) + '.' + base64urlEncode(payload)
hashedData = hash(data, secret)
signature = base64urlEncode(hashedData)
签名是 JWT 中唯一不公开可读的部分,因为它是用一个秘钥加密的。除非有人有秘钥,否则他们无法解密这些信息。因此,前面伪代码的示例输出是由三个由点分隔的 Base64-URL 字符串,可以在 HTTP 请求中轻松传递。
// JWT Token
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VySWQiOiJiMDhmODZhZi0zNWRhLTQ4ZjItOGZhYi1jZWYzOTA0NjYwYmQifQ.-xN_h82PHVTCMA9vdoHrcZxH-x5mb11y1537t3rGzcM
让我们在下一节看看这个令牌认证是如何工作的,附带一个示例流程。
令牌认证流程
基于令牌的认证可以通过以下示例认证流程来理解:
-
用户从他们的浏览器上的客户端应用发送他们的凭据,例如用户名和密码,到服务器。
-
服务器检查用户名和密码,如果凭据正确,则返回一个签名令牌(JWT)。
-
这个令牌存储在客户端。它可以存储在本地存储、会话存储或者 cookie 中。
-
客户端应用通常会在任何后续请求到服务器时将该令牌作为附加标头包含进去。
-
服务器接收并解码 JWT,然后如果令牌有效就允许请求访问。
-
当用户注销并且不再需要与服务器进行进一步交互时,令牌将在客户端销毁。
在基于令牌的认证中,通常不应在有效负载中包含任何敏感信息,并且令牌不应保留太长时间。您用于包含令牌的附加标头应该是这种格式:
Authorization: Bearer <token>
基于令牌的认证中的可扩展性不是一个问题,因为令牌存储在客户端。跨域共享也不是一个问题,因为 JWT 是一个包含所有必要信息的字符串,包含在请求标头中,由服务器检查每个客户端发出的请求。在 Node.js 应用中,我们可以使用 Node.js 模块之一,比如jsonwebtoken,来为我们生成令牌。让我们在下一节看看我们如何使用这个 Node.js 模块。
使用 Node.js 模块进行 JWT
正如我们之前提到的,jsonwebtoken可以用于在服务器端生成 JWT。您可以在以下简化的步骤中同步或异步地使用这个模块:
- 通过 npm 安装
jsonwebtoken:
$ npm i jsonwebtoken
- 在服务器端导入并签署令牌:
import jwt from 'jsonwebtoken'
var token = jwt.sign({ name: 'john' }, 'secret', { expiresIn: '1h' })
- 在服务器端异步验证来自客户端的令牌:
try {
var verified = jwt.verify(token, 'secret')
} catch(err) {
// handle error
}
如果您想了解有关此模块的更多信息,请访问github.com/brianloveswords/node-jws。
所以,现在您对基于会话和基于令牌的身份验证有了基本的了解,我们将指导您如何在使用 Koa 和 Nuxt 的服务器端和客户端应用程序中应用它们。在本章中,我们将使用基于令牌的身份验证在我们的应用程序中创建两种身份验证选项:本地身份验证和 Google OAuth 身份验证。本地身份验证是我们在应用程序内部和本地验证用户的选项,而 Google OAuth 身份验证是我们使用 Google OAuth 验证用户的选项。所以,让我们在接下来的章节中找出来!
创建后端身份验证
在第十章和第十一章中的先前练习,添加 Vuex 存储和编写路由中间件和服务器中间件,我们在后端身份验证中使用了一个虚拟用户,特别是在/chapter-11/nuxt-universal/route-middleware/per-route/中用于每个路由中间件的虚拟用户,例如:
// server/modules/public/user/_routes/login.js
router.post('/login', async (ctx, next) => {
let request = ctx.request.body || {}
if (request.username === 'demo' && request.password === 'demo') {
let payload = { id: 1, name: 'Alexandre', username: 'demo' }
let token = jwt.sign(payload, config.JWT_SECRET, { expiresIn: 1 * 60 })
//...
}
})
但在本章中,我们将使用一个带有一些用户数据的数据库进行身份验证。此外,在第九章中,添加服务器端数据库,我们使用 MongoDB 作为我们的数据库服务器。但这一次,让我们尝试一种不同的数据库系统,以增加多样性 – MySQL。所以,让我们开始吧。
使用 MySQL 作为服务器数据库
确保您的本地计算机上安装了 MySQL 服务器。在撰写本书时,最新的 MySQL 版本是 5.7。根据您使用的操作系统,您可以在dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/installing.html找到系统的具体指南。如果您使用的是 Linux,您可以在dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/linux-installation.html找到 Linux 发行版的安装指南。如果您使用的是 Linux Ubuntu 并且使用 APT 存储库,您可以按照dev.mysql.com/doc/mysql-apt-repo-quick-guide/en/apt-repo-fresh-install中的指南操作。
或者,您可以安装 MariaDB 服务器,而不是 MySQL 服务器,以在项目中使用关系数据库管理系统(DBMS)。同样,根据您使用的操作系统,您可以在mariadb.com/downloads/找到系统的具体指南。如果您使用的是 Linux,您可以在downloads.mariadb.org/mariadb/repositories/找到特定 Linux 发行版的指南。如果您使用的是 Linux Ubuntu 19.10,您可以按照downloads.mariadb.org/mariadb/repositories/#distro=Ubuntu&distro_release=eoan--ubuntu_eoan&mirror=bme&version=10.4中的指南操作。
无论您选择哪种方式,都很方便在浏览器中使用管理工具来管理您的 MySQL 数据库。您可以使用 phpMyAdmin 或 Adminer(www.adminer.org/latest.php);两者都需要在您的计算机上安装 PHP。如果您对 PHP 不熟悉,可以在第十六章中使用安装指南,为 Nuxt 创建一个与框架无关的 PHP API。本书中更倾向于使用 Adminer。您可以在www.phpmyadmin.net/downloads/下载该程序。如果您想使用 phpMyAdmin,请访问www.phpmyadmin.net/了解更多信息。一旦您有了管理工具,请按照以下步骤设置我们在本章中将需要的数据库:
-
使用 Adminer 创建一个名为“nuxt-auth”的数据库。
-
在数据库中插入以下表格和示例数据:
DROP TABLE IF EXISTS users;
CREATE TABLE users (
id int(11) NOT NULL AUTO_INCREMENT,
name varchar(255) NOT NULL,
email varchar(255) NOT NULL,
username varchar(255) NOT NULL,
password varchar(255) NOT NULL,
created_on datetime NOT NULL,
last_on datetime NOT NULL,
PRIMARY KEY (id),
UNIQUE KEY email (email),
UNIQUE KEY username (username)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
INSERT INTO users (id, name, email, username, password, created_on, last_on) VALUES
(1, 'Alexandre', 'demo@gmail.com', 'demo', '$2a$10$pyMYtPfIvE.PAboF3cIx9.IsyW73voMIRxFINohzgeV0I2BxwnrEu', '2019-06-17 00:00:00', '2019-01-21 23:32:58');
前面示例数据中的用户密码是123123,并且以$2a$10$pyMYtPfIvE.PAboF3cIx9.IsyW73voMIRxFINohzgeV0I2BxwnrEu的形式进行了 bcrypt 加密。我们将安装并使用bcryptjs Node.js 模块来在服务器端对此密码进行哈希和验证。但在跳转到bcryptjs之前,让我们先看一下我们将在下一节中创建的应用程序的结构。
您可以在我们的 GitHub 存储库的/chapter-12/中找到我们导出的数据库副本nuxt-auth.sql。
跨域应用目录结构
我们一直在为单个域制作 Nuxt 应用程序。自从第八章以来,我们的服务器端 API 与 Nuxt 紧密耦合,添加服务器端框架,在这一章中,我们使用 Koa 作为处理和为 Nuxt 应用程序提供数据的服务器端框架和 API。如果你回顾一下我们在 GitHub 存储库中的/chapter-8/nuxt-universal/koa-nuxt/,你应该记得我们将服务器端程序和文件保存在/server/目录中。我们还将我们的包/模块依赖项保存在一个package.json文件中,并在同一个/node_modules/目录中安装它们。当我们的应用程序变得更大时,混合两个框架(Nuxt 和 Koa)的模块依赖项在同一个package.json文件中可能会令人困惑。这也可能使调试过程变得更加困难。因此,将由 Nuxt 和 Koa(或其他服务器端框架,如 Express)制作的单个应用程序分开可能更有利于可扩展性和维护。现在,是时候制作一个跨域 Nuxt 应用程序了。我们将重用并重组我们在第八章中制作的 Nuxt 应用程序,添加服务器端框架。让我们称我们的 Nuxt 应用程序为前端应用程序,Koa 应用程序为后端应用程序。随着我们的进展,我们将分别在这两个应用程序中添加新的模块。
后端应用程序将进行后端身份验证,而前端应用程序将分别进行前端身份验证,但最终它们将作为一个整体。为了使您更容易学习和重组这个过程,我们将仅使用 JWT 进行身份验证。因此,让我们按照以下步骤创建我们的新工作目录:
- 创建一个项目目录,并以您喜欢的任何名称命名,其中包含两个子目录。一个称为
frontend,另一个称为backend,如下所示:
<project-name>
├── frontend
└── backend
- 使用脚手架工具
create-nuxt-app在/frontend/目录中安装 Nuxt 应用程序,以便获得您已经熟悉的 Nuxt 目录,如下所示:
frontend
├── package.json
├── nuxt.config.js
├── store
│ ├── index.js
│ └── ...
└── pages
├── index.vue
└── ...
- 在
/backend/目录中创建一个package.json文件,一个backpack.config.js文件,一个/static/文件夹和一个/src/文件夹,然后在/src/文件夹中按照以下方式添加其他文件和子文件夹(我们将在接下来的部分中更详细地介绍它们):
backend
├── package.json
├── backpack.config.js
├── assets
│ └── ...
├── static
│ └── ...
└── src
├── index.js
├── ...
├── modules
│ └── ...
└── core
└── ...
后端目录是我们的 API 所在的地方,可以使用 Express 或 Koa 来创建。我们仍然会使用 Koa,这是您已经熟悉的。我们将在这个目录中安装服务器端的依赖,比如mysql、bcryptjs和jsonwebtoken,这样它们就不会与 Nuxt 应用的前端模块混在一起。
正如您所看到的,在这种新的结构中,我们成功地完全分离和解耦了我们的 API 和 Nuxt 应用。这对于调试和开发有好处。从技术上讲,我们现在将一次开发和测试一个应用。在单个环境中开发两个应用可能会令人困惑,当应用变得更大时,协作可能会变得困难,就像我们之前提到的那样。
在深入研究如何在服务器端使用 JWT 之前,让我们首先在下一节深入研究如何在/src/目录中结构化 API 路由和模块。
创建 API 公共/私有路由及其模块
请注意,在本书中,不是强制遵循此处建议的目录结构。关于如何使用 Koa 来构建应用程序的官方或任意规则是没有的。Koa 社区提供了一些骨架、样板和框架,您可以访问github.com/koajs/koa/wiki了解更多信息。现在让我们更仔细地看一下/src/目录中的目录结构,在接下来的步骤中,我们将在这里开发我们的 API 源代码。
- 按照以下方式在
/src/目录中创建以下文件夹和空的.js文件:
└── src
├── index.js
├── middlewares.js
├── routes-private.js
├── routes-public.js
├── config
│ └── index.js
├── core
│ └── database
├── middlewares
│ ├── authenticate.js
│ ├── errorHandler.js
│ └── ...
└── modules
└── ...
在/src/目录中,/middlewares/目录是存放所有中间件的地方,比如authenticate.js,我们希望将其注册到 Kao 的app.use方法中,而/modules/目录是存放所有 API 端点组的地方,比如home、user和login。
- 创建两个主要目录,
private和public,每个目录中都有子目录,如下所示:
└── modules
├── private
│ └── home
└── public
├── home
├── user
└── login
/public/目录用于无需 JWT 的公共访问,例如登录路由,而/private/目录用于需要 JWT 保护模块的访问。正如你所看到的,我们已将 API 路由分为两个主要组,因此/private/组将在routes-private.js中处理,而/public/组将在routes-public.js中处理。我们有/config/目录来保存所有配置文件,以及/core/目录来保存可以在整个应用程序中共享和使用的抽象程序或模块,例如你将在本章后面发现的 mysql 连接池。因此,从前面的目录树中,我们将在我们的 API 中使用这些公共模块:home,user,login,以及一个私有模块:home。
- 在每个模块中,例如
user模块,创建一个/_routes/目录来配置属于该特定模块(或组)的所有路由(或端点):
└── user
├── index.js
└── _routes
├── index.js
└── fetch-user.js
在user模块中,/user/index.js文件是该模块的所有路由被组装和分组的地方,例如:
// src/modules/public/user/index.js
import Router from 'koa-router'
import fetchUsers from './_routes'
import fetchUser from './_routes/fetch-user'
const router = new Router({
prefix: '/users'
})
const routes = [fetchUsers, fetchUser]
for (var route of routes) {
router.use(route.routes(), route.allowedMethods())
}
prefix键设置为/users是该用户模块的模块路由。在每个导入的子路由内部是我们开发代码的地方,例如登录路由的代码。
- 在每个模块的每个
.js文件中,例如user模块,添加以下用于在后期构建我们的代码的基本代码结构:
// src/modules/public/user/_routes/index.js
import Router from 'koa-router'
import pool from 'core/database/mysql'
const router = new Router()
router.get('/', async (ctx, next) => {
// code goes here....
})
export default router
- 让我们创建
home模块,它将返回一个包含'Hello World!'消息的响应。
// src/modules/public/home/_routes/index.js
import Router from 'koa-router'
const router = new Router()
router.get('/', async (ctx, next) => {
ctx.type = 'json'
ctx.body = {
message: 'Hello World!'
}
})
export default router
home模块只有一个路由,但我们仍然需要在该模块的index.js文件中组装此路由,以便我们的代码与其他模块保持一致,如下所示:
// src/modules/public/home/index.js
import Router from 'koa-router'
import index from './_routes'
const router = new Router() // no prefix
const routes = [index]
for (var route of routes) {
router.use(route.routes(), route.allowedMethods())
}
export default router
请注意,此home模块未添加前缀,因此我们可以直接在localhost:4000/public上访问其唯一路由。
- 在
/src/目录中创建routes-public.js文件,并从/modules/目录中的公共模块导入所有公共路由,如下所示:
// src/routes-public.js
import Router from 'koa-router'
import home from './modules/public/home'
import user from './modules/public/user'
import login from './modules/public/login'
const router = new Router({ prefix: '/public' })
const modules = [home, user, login]
for (var module of modules) {
router.use(module.routes(), module.allowedMethods())
}
export default router
正如你所看到的,我们导入了刚刚创建的home模块。我们将在接下来的部分中创建user和login模块。导入这些模块后,我们应该将它们的路由注册到路由器,然后导出路由器。请注意,这些路由都添加了前缀/public。还要注意,每个路由都使用纯 JavaScript 的for循环函数进行循环注册到路由器。
- 在
/src/目录中创建routes-private.js文件,并从/modules/目录中导入所有私有模块中的私有路由,如下所示:
// src/routes-private.js
import Router from 'koa-router'
import home from './modules/private/home'
import authenticate from './middlewares/authenticate'
const router = new Router({ prefix: '/private' })
const modules = [home]
for (var module of modules) {
router.use(authenticate, module.routes(), module.allowedMethods())
}
export default router
在这个文件中,你可以看到我们将在接下来的章节中只创建一个私有home模块。此外,这个文件中导入了一个authenticate中间件,并将其添加到私有路由中,以便保护私有模块。之后,我们应该导出带有路由的私有路由,并用/private前缀。我们也将在接下来的章节中创建这个authenticate中间件。现在,让我们用 Backpack 配置我们的模块文件路径,并安装我们的 API 基本依赖的 Node.js 模块。
- 通过 Backpack 配置文件向 webpack 配置中添加以下额外的文件路径(
./src,./src/core, 和./src/modules):
// backpack.config.js
module.exports = {
webpack: (config, options, webpack) => {
config.resolve.modules = ['./src', './src/core',
'./src/modules']
return config
}
}
有了这些额外的文件路径,我们可以简单地用import pool from 'core/database/mysql'导入我们的模块,而不是以下方式:
import pool from '../../../../core/database/mysql'
有关使用 webpack 中的modules选项解析模块的更多信息,请访问webpack.js.org/configuration/resolve/#resolvemodules。
- 现在我们应该在我们的项目中安装 Backpack,以及其他基本和必要的 Node.js 模块,以便开发这个后端应用程序:
$ npm i backpack-core
$ npm i cross-env
$ npm i koa
$ npm i koa-bodyparser
$ npm i koa-favicon
$ npm i koa-router
$ npm i koa-static
你应该熟悉这些模块,因为你已经在第八章中学习过它们并安装了它们,添加服务器端框架,你可以在我们的 GitHub 存储库的/chapter-8/nuxt-universal/koa-nuxt/中重新访问它,还有第十章,添加 Vuex Store,在/chapter-10/nuxt-universal/nuxtServerInit/,以及第十一章,编写路由中间件和服务器中间件,在/chapter-11/nuxt-universal/route-middleware/per-route/。
- 在
/backend/目录中的package.json中添加以下运行脚本:
// package.json
{
"scripts": {
"dev": "backpack",
"build": "backpack build",
"start": "cross-env NODE_ENV=production node build/main.js"
}
}
因此,"dev"运行脚本用于开发我们的 API,"build"运行脚本用于在完成时构建我们的 API,"start"脚本用于构建后为 API 提供服务。
- 在
/config/目录中的index.js文件中添加以下服务器配置:
// src/config/index.js
export default {
server: {
port: 4000
},
}
这个配置文件只有一个非常简单的配置,即服务器配置为在端口4000上运行。
- 导入您刚刚安装的以下模块,并在
/src/目录中的middlewares.js文件中注册它们如下:
// src/middlewares.js
import serve from 'koa-static'
import favicon from 'koa-favicon'
import bodyParser from 'koa-bodyparser'
export default (app) => {
app.use(serve('assets'))
app.use(favicon('static/favicon.ico'))
app.use(bodyParser())
}
- 在
/middlewares/目录中创建一个处理具有200HTTP 状态的 HTTP 响应的中间件:
// src/middlewares/okOutput.js
export default async (ctx, next) => {
await next()
if (ctx.status === 200) {
ctx.body = {
status: 200,
data: ctx.body
}
}
}
如果响应正常,我们将获得以下 JSON 输出:
{"status":200,"data":{"message":"Hello World!"}}
- 创建一个处理 HTTP 错误状态(例如
400、404和500)的中间件:
export default async (ctx, next) => {
try {
await next()
} catch (err) {
ctx.status = err.status || 500
ctx.type = 'json'
ctx.body = {
status: ctx.status,
message: err.message
}
ctx.app.emit('error', err, ctx)
}
}
对于400错误响应,您将获得以下 JSON 响应:
{"status":400,"message":"username param is required."}
- 创建一个专门处理 HTTP 404 响应的中间件,通过抛出一个'Not found'消息:
// src/middlewares/notFound.js
export default async (ctx, next) => {
await next()
if (ctx.status === 404) {
ctx.throw(404, 'Not found')
}
}
对于未知路由,我们将获得以下 JSON 输出:
{"status":404,"message":"Not found"}
- 将这三个中间件导入
middlewares.js并像其他中间件一样注册到 Koa 实例中:
// src/middlewares.js
import errorHandler from './middlewares/errorHandler'
import notFound from './middlewares/notFound'
import okOutput from './middlewares/okOutput'
export default (app) => {
app.use(errorHandler)
app.use(notFound)
app.use(okOutput)
}
请注意我们如何按顺序安排这些中间件 - 即使errorHandler中间件首先注册,但如果 HTTP 响应中出现错误,它将是最后一个重新执行的中间件。如果 HTTP 响应状态为200,上游级联将在okOutput中间件处停止。还要注意,这些中间件必须在static、favicon和bodyparser中间件之后注册,这些中间件必须首先在下游级联中调用和公开服务。
- 从
routes-public.js和routes-private.js导入公共和私有路由,并在前述中间件之后注册它们如下:
// Import custom local middlewares.
import routesPublic from './routes-public'
import routesPrivate from './routes-private'
export default (app) => {
app.use(routesPublic.routes(), routesPublic.allowedMethods())
app.use(routesPrivate.routes(), routesPrivate.allowedMethods())
}
- 在
/config/目录中的index.js文件中导入 Koa、middlewares.js文件中的所有中间件和服务器配置,实例化一个 Koa 实例并将其传递给middlewares.js文件,然后使用这个 Koa 实例启动服务器:
// index.js
import Koa from 'koa'
import config from './config'
import middlewares from './middlewares'
const app = new Koa()
const host = process.env.HOST || '127.0.0.1'
const port = process.env.PORT || config.server.port
middlewares(app)
app.listen(port, host)
- 使用
npm run dev运行此 API,您应该在localhost:4000上在浏览器中看到应用程序正在运行。当您在localhost:4000上时,您应该在浏览器中获得以下输出:
{"status":404,"message":"Not found"}
这是因为在/上不再设置路由 - 我们已经将所有路由前缀设置为/public或/private。但是,如果您导航到localhost:4000/public,您将获得以下 JSON 输出:
{"status":200,"data":{"message":"Hello World!"}}
这是我们刚刚在前面步骤中创建的home模块的响应。此外,您应该看到您的网站图标和资源在localhost:4000上正确提供 - 如果您将它们放在/static/和/assets/目录中的任何一个,例如:
localhost:4000/sample-asset.jpg
localhost:4000/favicon.ico
您可以在localhost:4000这两个目录中看到您的文件。这是因为static和favicon中间件已安装并注册为在 Koa 中进行下游级联时首先执行的中间件堆栈。
干得好!现在您已经准备好了新的工作目录,并且基本的 API 正在运行,就像第八章中一样,添加服务器端框架。接下来,您需要在/backend/目录中安装其他服务器端依赖项,并开始向公共user和login模块以及私有home模块的路由添加代码。让我们从下一节开始使用bcryptjs。
您可以在我们的 GitHub 存储库中的/chapter-12/nuxt-universal/cross-domain/jwt/axios-module/backend/中找到具有前述结构的示例应用程序。
使用 Node.js 的 bcryptjs 模块
如前所述,bcryptjs用于对密码进行哈希和验证。请查看有关如何在我们的应用程序中使用此模块的进一步建议的简化步骤:
- 通过 npm 安装
bcryptjs模块:
$ npm i bcryptjs
- 通过在请求体(请求)中添加
salt与来自客户端的密码一起对密码进行哈希处理,例如,在user模块中进行新用户创建时:
// src/modules/public/user/_routes/create-user.js
import bcrypt from 'bcryptjs'
const saltRounds = 10
const salt = bcrypt.genSaltSync(saltRounds)
const hashed = bcrypt.hashSync(request.password, salt)
请注意,在本章中为了加快我们的身份验证课程,我们跳过了创建新用户的过程。但在更完整的 CRUD 中,您可以使用此步骤来对用户提供的密码进行哈希处理。
- 通过将来自客户端的密码(请求)与数据库中存储的密码进行比较来验证密码,例如,在
login模块中进行登录验证过程如下:
// src/modules/public/login/_routes/local.js
import bcrypt from 'bcryptjs'
const isMatched = bcrypt.compareSync(request.password,
user.password)
if (isMatched === false) { ... }
请注意,您可以在我们的 GitHub 存储库中的/chapter-12/nuxt-universal/cross-domain/jwt/axios-module/backend/src/modules/public/login/_routes/local.js中找到此步骤在我们后端应用程序中的应用方式。
我们将向您展示如何在接下来的部分中使用bcryptjs来验证来自客户端的密码。但在对客户端的密码进行哈希和验证之前,首先,我们需要连接到我们的 MySQL 数据库,以确定是要注入新用户还是查询现有用户。为此,我们将需要在我们的应用程序中使用下一个 Node.js 模块:mysql - 一个 MySQL 客户端。所以让我们继续前进到下一部分,看看您如何安装和使用它。
如果您想找到关于这个模块和一些异步示例的更多信息,请访问github.com/dcodeIO/bcrypt.js。
使用 Node.js 的 mysql 模块
我们有在上一节中安装的 MySQL 服务器。现在我们需要一个 MySQL 客户端,我们可以连接到 MySQL 服务器并从服务器端程序执行 SQL 查询。mysql 是标准的 MySQL Node.js 模块,实现了 MySQL 协议,因此我们可以使用这个模块来处理 MySQL 连接和 SQL 查询,无论你是在 MySQL 服务器还是 MariaDB 服务器上。所以,让我们按照以下步骤开始:
- 通过 npm 安装
mysql模块:
$ npm i mysql
- 在
/src/目录的子目录中,使用你的 MySQL 连接详细信息在mysql.js文件中创建 MySQL 连接实例,如下所示:
// src/core/database/mysql.js
import util from 'util'
import mysql from 'mysql'
const pool = mysql.createPool({
connectionLimit: 10,
host : 'localhost',
user : '<username>',
password : '<password>',
database : '<database>'
})
pool.getConnection((err, connection) => {
if (error) {
// Handle errors ...
}
// Release the connection to the pool if no error.
if (connection) {
connection.release()
}
return
})
pool.query = util.promisify(pool.query)
export default pool
让我们在以下笔记中浏览我们刚刚创建的代码:
- mysql 不支持
async/await,所以我们使用了 Node.js 的promisify实用程序来包装 MySQL 的pool.query。pool.query是 mysql 中处理我们的 SQL 查询的函数,它通过回调返回结果,例如:
connection.query('SELECT ...', function (error, results, fields) {
if (error) {
throw error
}
// Do something ...
})
通过 promisify 实用程序,我们已经消除了回调,现在我们可以使用async/await,如下所示:
let result = null
try {
result = await pool.query('SELECT ...')
} catch (error) {
// Handle errors ...
}
pool.query是这三个函数的快捷方式,pool.getConnection、connection.query和connection.release,我们应该一起使用它们在 mysql 模块的连接池中执行 SQL 查询。通过使用pool.query,当你完成时,连接会自动释放回连接池。这是pool.query函数的基本底层结构:
import mysql from 'mysql'
const pool = mysql.createPool(...)
pool.getConnection(function(error, connection) {
if (error) { throw error }
connection.query('SELECT ...', function (error, results,
fields) {
connection.release()
if (error) { throw error }
})
})
- 在这个 mysql 模块中,我们可以使用
mysql.createPool进行连接池,而不是通过mysql.createConnection逐个创建和管理 MySQL 连接,这可能是一个昂贵的操作。连接池是一个可重用的数据库连接缓存,用于减少每次连接到数据库时建立新连接的成本。有关连接池的更多信息,请访问github.com/mysqljs/mysqlpooling-connections。
- 所以,我们已经将 MySQL 连接抽象成了
/core/目录中的前述文件。现在我们可以使用它来获取user模块中用户列表,如下所示:
// backend/src/modules/public/user/_routes/index.js
import Router from 'koa-router'
import pool from 'core/database/mysql'
const router = new Router()
router.get('/', async (ctx, next) => {
try {
var users = await pool.query(
'SELECT `id`, `name`, `created_on`
FROM `users`'
)
} catch (err) { ... }
ctx.type = 'json'
ctx.body = users
})
export default router
您可以看到,我们使用了与前一节中所述的相同代码结构,通过 MySQL 连接池将我们的请求发送到 MySQL 服务器。在我们发送的查询中,我们告诉 MySQL 服务器仅为我们从users表中返回id、name和created_on字段的结果。
- 如果您访问
localhost:4000/public/users上的用户路由,您应该在屏幕上看到以下输出:
{"status":200,"data":[{"id":1,"name":"Alexandre","created_on":"2019-06-16T22:00:00.000Z"}]}
现在我们有了用于连接到 MySQL 服务器和数据库的 mysql 模块,以及用于对客户端密码进行哈希和验证的 bcryptjs 模块,因此我们可以重构和改进我们在上一章中粗略创建的登录代码。让我们在下一节中找出如何做。
如果您想了解更多关于 mysql 模块的信息,请访问github.com/mysqljs/mysql。
在服务器端重构登录代码
我们已经在前几节中收集了所有必要的要素,一旦我们创建了 MySQL 连接池,我们就可以重构和改进我们的登录代码,从第十章 添加一个 Vuex Store 和第十一章 编写路由中间件和服务器中间件,按照以下步骤进行:
- 导入所有依赖项,如
koa-router、jsonwebtoken、bcryptjs和 MySQL 连接池,用于登录路由如下:
// src/modules/public/login/_routes/local.js
import Router from 'koa-router'
import jwt from 'jsonwebtoken'
import bcrypt from 'bcrypt'
import pool from 'core/database/mysql'
import config from 'config'
const router = new Router()
router.post('/login', async (ctx, next) => {
let request = ctx.request.body || {}
//...
})
export default router
我们在这里导入了配置文件,用于 API 的配置选项,其中包含了 MySQL 数据库连接详细信息、服务器和静态目录的选项,以及我们稍后需要用于签署令牌的 JWT 的秘密代码。
- 在登录路由的
post方法中验证用户输入,以确保它们已定义且不为空:
if (request.username === undefined) {
ctx.throw(400, 'username param is required.')
}
if (request.password === undefined) {
ctx.throw(400, 'password param is required.')
}
if (request.username === '') {
ctx.throw(400, 'username is required.')
}
if (request.password === '') {
ctx.throw(400, 'password is required.')
}
- 当它们通过验证时,将用户名和密码分配给变量以查询数据库:
let username = request.username
let password = request.password
let users = []
try {
users = await pool.query('SELECT FROM users WHERE
username = ?', [username])
} catch(err) {
ctx.throw(400, err.sqlMessage)
}
if (users.length === 0) {
ctx.throw(404, 'no user found')
}
- 如果从 MySQL 查询中有结果,就使用 bcryptjs 比较存储的密码和用户输入的密码:
let user = users[0]
let match = false
try {
match = await bcrypt.compare(password, user.password)
} catch(err) {
ctx.throw(401, err)
}
if (match === false) {
ctx.throw(401, 'invalid password')
}
- 如果用户通过了所有先前的步骤和验证,就对 JWT 进行签名并将其发送给客户端:
let payload = { name: user.name, email: user.email }
let token = jwt.sign(payload, config.JWT_SECRET, { expiresIn:
1 * 60 })
ctx.body = {
user: payload,
message: 'logged in ok',
token: token
}
- 使用
npm run dev运行 API,并在终端上手动使用curl测试上一个路由,如下所示:
$ curl -X POST -d "username=demo&password=123123" -H "Content-Type: application/x-www-form-urlencoded" http://localhost:4000/public/login/local
如果您成功登录,您应该得到以下结果:
{"status":200,"data":{"user":{"name":"Alexandre","email":"thiamkok.lau@gmail.com"},"message":"logged in ok","token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiQWxleGFuZHJlIiwiZW1haWwiOiJ0aGlhbWtvay5sYXVAZ21haWwuY29tIiwiaWF0IjoxNTgwMDExNzAwLCJleHAiOjE1ODAwMTE3NjB9.Lhd78jokSGALup6DUYAqWAjl7C-8dLhXjEba-KAxy4k"}}
当然,每当成功签署时,您将在前面的响应中获得不同的令牌。现在,您已经成功地重构和改进了登录代码。接下来,我们将看一下如何在下一节中验证前面的令牌,该令牌将从客户端以请求头的形式发送回来。所以,请继续阅读!
在服务器端验证传入的令牌
我们成功地签署了一个令牌,并在凭据与我们在数据库中存储的内容匹配时将其返回给客户端。但这只是故事的一半。每次客户端使用令牌进行请求时,我们都应该验证这个令牌,以便访问服务器端中间件保护的所有受保护路由。
因此,让我们按照以下步骤创建中间件和受保护的路由:
- 在
/src/目录内的/middlewares/目录中创建一个中间件文件,并使用以下代码:
// src/middlewares/authenticate.js
import jwt from 'jsonwebtoken'
import config from 'config'
export default async (ctx, next) => {
if (!ctx.headers.authorization) {
ctx.throw(401, 'Protected resource, use Authorization header
to get access')
}
const token = ctx.headers.authorization.split(' ')[1]
try {
ctx.state.jwtPayload = jwt.verify(token, config.JWT_SECRET)
} catch (err) {
// handle error.
}
await next()
}
if条件!ctx.headers.authorization用于确保客户端已在请求头中包含了令牌。由于authorization以Bearer: [token]的格式带有值,其中有一个单个空格,我们通过该空格拆分值,并仅在try和catch块中获取[token]进行验证。如果令牌有效,则我们允许请求通过到下一个路由,使用await next()。
- 导入并注入此中间件到我们想要用 JWT 保护的路由组中:
// src/routes-private.js
import Router from 'koa-router'
import home from './modules/private/home'
import authenticate from './middlewares/authenticate'
const router = new Router({ prefix: '/private' })
const modules = [home]
for (var module of modules) {
router.use(authenticate, module.routes(), module.allowedMethods())
}
在这个 API 中,我们希望保护所有属于/private路由的路由。因此,我们将在这个文件中导入我们想要保护的任何路由,例如前面的/home路由。因此,当您使用/private/home请求此路由时,您必须在请求头中包含令牌以访问此路由。
就是这样。你已经成功地在服务器端创建并验证了 JWT。接下来,我们应该看一下如何在下一节中使用 Nuxt 在客户端完成 JWT 认证。让我们开始吧!
创建前端身份验证
你会发现这一部分很容易和熟悉,因为在前两章中你已经用虚拟后端身份验证构建了一些认证 Nuxt 应用。本章的不同之处在于我们正在制作跨域应用,而不是像前两章那样的单域应用。你可以在/chapter-10/nuxt-universal/nuxtServerInit/和/chapter-11/nuxt-universal/route-middleware/per-route/中重新访问这些单域 Nuxt 应用。
此外,我们将再次使用我们在第六章中已经介绍过的 Nuxt 模块:@nuxtjs/axios和@nuxtjs/proxy。你可以在/chapter-6/nuxt-universal/module-snippets/top-level/中查看采用这两个模块的 Nuxt 应用。但现在,让我们安装并配置它们用于这个 Nuxt 应用,我们将在接下来的步骤中重构它,以创建客户端身份验证:
- 通过 npm 安装
@nuxtjs/axios和@nuxtjs/proxy:
$ npm i @nuxtjs/axios
$ npm i @nuxtjs/proxy
- 在 Nuxt 配置文件中配置这两个模块如下:
// nuxt.config.js
module.exports = {
modules: [
'@nuxtjs/axios',
],
axios: {
proxy: true
},
proxy: {
'/api/': { target: 'http://localhost:4000/', pathRewrite:
{'^/api/': ''} },
}
}
由于我们知道我们在之前章节中创建的远程 API 服务器运行在localhost:4000,在这个配置中,我们将这个 API 地址分配给proxy选项中的/api/键。
- 移除我们之前用来导入 axios Node.js 模块的任何
import语句;例如,在安全页面上:
// pages/secured.vue
import axios from '~/plugins/axios'
这是因为我们现在使用@nuxtjs/axios(Nuxt Axios 模块)了,我们将不再需要直接在我们的代码中导入原始的 axios Node.js 模块。
- 通过使用
$axios调用 Nuxt Axios 模块,并替换我们之前在我们的代码中用于 HTTP 请求的原始 axios Node.js 模块中的axios;例如,在安全页面上:
// pages/secured.vue
async asyncData ({ $axios, redirect }) {
const { data } = await $axios.$get('/api/private')
}
Nuxt Axios 模块通过Nuxt 配置文件中的步骤 2 加载到我们的 Nuxt 应用中,所以我们可以通过 Nuxt 上下文或this来使用$axios访问它。
我们还应该使用这两个 Nuxt 模块@nuxtjs/axios和@nuxtjs/proxy以及 cookies、Node.js 模块(客户端和服务器端)来重构这个应用中存储和中间件的其余代码。所以让我们在以下部分开始吧。
在(Nuxt)客户端使用 cookies
在这个应用中,我们不再使用会话来“记住”认证数据。相反,我们将使用js-cookie Node.js 模块来创建 cookies 来存储来自远程服务器的数据。
使用这个 Node.js 模块非常容易创建一个在整个站点上都存在的 cookie;例如:
- 使用以下格式设置 cookie:
Cookies.set(<name>, <value>)
以下是如果你想创建一个 30 天后过期的 cookie 的代码:
Cookies.set(<name>, <value>, { expires: 30 })
- 使用以下格式读取 cookie:
Cookies.get(<name>)
使用这个 Node.js 模块是多么容易 - 你只需要使用set和get方法在客户端设置和检索你的 cookies。所以,让我们按照以下步骤重构我们存储中的代码:
- 只有在 Nuxt 应用程序在客户端处理时,才使用
if三元条件来导入 js-cookie Node.js 模块:
// store/actions.js
const cookies = process.client ? require('js-cookie') : undefined
- 使用 js-cookie 的
set函数将服务器端的数据存储为auth,在login操作中如下所示:
// store/actions.js
export default {
async login(context, { username, password }) {
const { data } = await
this.$axios.$post('/api/public/login/local',
{ username, password })
cookies.set('auth', data)
context.commit('setAuth', data)
}
}
- 使用 js-cookie 的
remove函数在logout操作中删除authcookie,如下所示:
// store/actions.js
export default {
logout({ commit }) {
cookies.remove('auth')
commit('setAuth', null)
}
}
这很简单,不是吗?但是,你可能会问:我们用这个auth cookie 做什么,以及如何使用?让我们在下一节中了解如何在 Nuxt 服务器端使用 cookie。
有关 Node.js 模块的更多信息和代码示例,请访问github.com/js-cookie/js-cookie。
在(Nuxt)服务器端使用 cookie
由于我们使用 JWT 进行身份验证的数据已经被js-cookie以auth的形式哈希并存储在 cookie 中,因此我们需要在需要时读取和解析此 cookie。这就是 Node.js 模块cookie的用武之地。同样,我们在过去的章节中使用了这个 Node.js 模块,但我们还没有讨论过它。
cookie Node.js 模块是用于 HTTP 服务器的 HTTP cookie 解析器和序列化程序。它用于在服务器端解析 cookie 标头。让我们看看如何在以下步骤中在auth cookie 上使用它:
- 只有在 Nuxt 应用程序在服务器端处理时,才使用
if三元条件来导入 cookie Node.js 模块:
// store/index.js
const cookie = process.server ? require('cookie') : undefined
- 使用 cookie Node.js 模块的
parse函数来解析nuxtServerInit操作中 HTTP 请求头中的authcookie,如下所示:
// store/index.js
export const actions = {
nuxtServerInit({ commit }, { req }) {
if (req.headers.cookie && req.headers.cookie.indexOf('auth') >
-1) {
let auth = cookie.parse(req.headers.cookie)['auth']
commit('setAuth', JSON.parse(auth))
}
}
}
- 通过
$axios使用 Nuxt Axios 模块的setHeader函数将令牌(JWT)包含在远程服务器上的令牌中间件的 HTTP 标头中,以访问私有 API 路由,如下所示:
// middleware/token.js
export default async ({ store, error, $axios }) => {
if (!store.state.auth.token) {
// handle error
}
$axios.setHeader('Authorization', Bearer: ${store.state.auth.token})
}
- 使用
npm run dev运行 Nuxt 应用程序。您应该在localhost:3000上的浏览器中运行该应用程序。您可以使用登录页面上的凭据登录,然后访问受 JWT 保护的受限安全页面。
干得好!您已经完成了基于令牌的本地身份验证。您已经重构了存储和中间件中的代码,使得js-cookie和cookie Node.js 模块可以在 Nuxt 应用程序的前端身份验证中完美地在客户端和服务器端协同工作并相互补充。此外,您已成功将 Nuxt 应用程序与跨域方法解耦 API。
正如您所看到的,使用js-cookie和cookie Node.js 模块进行前端身份验证非常简单且非常好。但是也可以通过 Google OAuth 实现,我们将在下一节中进行讨论。将 Google OAuth 添加到前端身份验证可以为用户提供额外的登录选项。所以,让我们开始吧。
您可以在我们的 GitHub 存储库的/chapter-12/nuxt-universal/cross-domain/jwt/axios-module/frontend/中找到此 Nuxt 应用程序的源代码。
有关cookie Node.js 模块的更多信息和代码示例,请访问github.com/jshttp/cookie。
有关助手的更多信息,例如 Nuxt Axios 模块中的setHeader助手,请访问axios.nuxtjs.org/helpers。
使用 Google OAuth 登录
OAuth 是一种开放的委托授权协议,允许网站或应用程序之间进行访问,而不会将用户密码暴露给已被授予访问权限的各方。它是许多公司和网站用来识别用户的常见访问委托。让我们让我们的用户使用 Google OAuth 登录我们的应用程序。此选项需要来自 Google 开发者控制台的客户端 ID 和客户端密钥。可以通过以下步骤获得它们:
-
在
console.developers.google.com/的谷歌开发者控制台中创建一个新项目。 -
在 OAuth 同意屏幕选项卡上选择 External。
-
在凭据选项卡上的“创建凭据”下拉选项中选择 OAuth 客户端 ID,然后选择 Web 应用程序作为应用程序类型。
-
在“名称”字段中提供您的 OAuth 客户端 ID 的名称,在“授权重定向 URI”字段中提供重定向 URI,以便谷歌在用户在谷歌同意页面上进行身份验证后重定向用户。
-
在库选项卡中启用 Google People API,该 API 提供对 API 库中有关配置文件和联系人的信息的访问权限。
一旦您设置了开发者帐户并按照上述步骤创建了客户端 ID和客户端密钥,您就可以准备在下一节中将 Google OAuth 添加到后端身份验证中。让我们开始吧。
将 Google OAuth 添加到后端身份验证
为了让某人登录谷歌,我们需要将他们发送到谷歌登录页面。从那里,他们将登录他们的账户,并将被重定向到我们的应用程序,并携带他们的谷歌登录详细信息,我们将提取谷歌代码并将其发送回谷歌以获取我们可以在应用程序中使用的用户数据。这个过程需要googleapis Node.js 模块,这是一个用于使用谷歌 API 的客户端库。
让我们按照以下步骤在我们的代码中安装并采用它:
- 通过 npm 安装
googleapisNode.js 模块:
$ npm i googleapis
- 创建一个文件,包含你的凭证,这样谷歌就知道是谁在发出请求。
// backend/src/config/google.js
export default {
clientId: '<client ID>',
clientSecret: '<client secret>',
redirect: 'http://localhost:3000/login'
}
请注意,您必须用从谷歌开发者控制台获得的 ID 和密钥替换上述的<client ID>和<client secret>值。另外,请注意redirect选项中的 URL 必须与您的谷歌应用 API 设置中的授权重定向 URI 中的重定向 URI 匹配。
- 使用 Google OAuth 生成 Google 身份验证 URL,将用户发送到谷歌同意页面,以获取用户检索访问令牌的权限,如下所示:
// backend/src/modules/public/login/_routes/google/url.js
import Router from 'koa-router'
import { google } from 'googleapis'
import googleConfig from 'config/google'
const router = new Router()
router.get('/google/url', async (ctx, next) => {
const oauth = new google.auth.OAuth2(
googleConfig.clientId,
googleConfig.clientSecret,
googleConfig.redirect
)
const scopes = [
'https://www.googleapis.com/auth/userinfo.email',
'https://www.googleapis.com/auth/userinfo.profile',
]
const url = oauth.generateAuthUrl({
access_type: 'offline',
prompt: 'consent',
scope: scopes
})
ctx.body = url
})
当用户登录并生成 URL 时,范围决定了我们在用户登录时需要什么信息和权限。在我们的情况下,我们希望获得检索用户电子邮件和个人资料信息的权限:userinfo.email和userinfo.profile。用户在谷歌同意页面上进行了身份验证后,谷歌将用户重定向回我们的应用程序,并携带了一堆经过身份验证的数据和用于访问用户数据的授权代码。
- 从谷歌在上一步返回的 URL 中附加的经过身份验证的数据中提取
code参数中的值。我们将在下一节中回到 Node.js 模块,它可以帮助我们从 URL 查询中提取code参数。现在,让我们假设我们已经提取了code值,并将其发送到服务器端,以请求使用 Google OAuth2 实例的令牌,如下所示:
// backend/src/modules/public/login/_routes/google/me.js
import Router from 'koa-router'
import { google } from 'googleapis'
import jwt from 'jsonwebtoken'
import pool from 'core/database/mysql'
import config from 'config'
import googleConfig from 'config/google'
const router = new Router()
router.get('/google/me', async (ctx, next) => {
// Get the code from url query.
const code = ctx.query.code
// Create a new google oauth2 client instance.
const oauth2 = new google.auth.OAuth2(
googleConfig.clientId,
googleConfig.clientSecret,
googleConfig.redirect
)
//...
})
- 使用我们刚刚提取的代码从谷歌获取令牌,并将它们传递给 Google People,
google.people,使用get方法获取用户数据,并指定在personFields查询参数中需要返回的与人相关的字段。
// backend/src/modules/public/login/_routes/google/me.js
...
const {tokens} = await oauth2.getToken(code)
oauth.setCredentials(tokens)
const people = google.people({
version: 'v1',
auth: oauth2,
})
const me = await people.people.get({
resourceName: 'people/me',
personFields: 'names,emailAddresses'
})
您可以看到我们在前面的代码中只想要与 Google 中的人相关的两个字段,即names和emailAddresses。您可以在developers.google.com/people/api/rest/v1/people/get上找到您想要从 Google 获取的与人相关的其他字段。如果访问成功,我们应该从 Google 以 JSON 格式获取用户数据,然后我们可以从该数据中提取电子邮件,以确保它将在下一步中与我们数据库中的用户匹配。
- 仅从 Google 人员数据中检索第一个电子邮件,并查询我们的数据库,以查看是否已经有任何使用该电子邮件的用户:
// backend/src/modules/public/login/_routes/google/me.js
...
let email = me.data.emailAddresses[0].value
let users = []
try {
users = await pool.query('SELECT FROM users WHERE email = ?',
[email])
} catch(err) {
ctx.throw(400, err.sqlMessage)
}
- 如果没有该电子邮件的用户,请向客户端发送来自 Google 的用户数据的
'signup required'消息,并要求用户在我们的应用程序中注册帐户:
// backend/src/modules/public/login/_routes/google/me.js
...
if (users.length === 0) {
ctx.body = {
user: me.data,
message: 'signup required'
}
return
}
let user = users[0]
- 如果匹配,则使用有效载荷和 JWT 密钥签署 JWT,然后将令牌(JWT)发送到客户端:
// backend/src/modules/public/login/_routes/google/me.js
...
let payload = { name: user.name, email: user.email }
let token = jwt.sign(payload, config.JWT_SECRET, { expiresIn: 1 * 60 })
ctx.body = {
user: payload,
message: 'logged in ok',
token: token
}
就是这样。在前面的几个步骤中,您已经成功在服务器端添加了 Google OAuth。接下来,我们应该看看如何在下一节中使用 Nuxt 完成 Google OAuth 的客户端身份验证。让我们开始吧。
有关 googleapis Node.js 模块的更多信息,请访问github.com/googleapis/google-api-nodejs-client。
为 Google OAuth 创建前端身份验证
当 Google 将用户重定向回我们的应用程序时,我们将在重定向 URL 上获得大量数据,例如:
http://localhost:3000/login?code=4%2F1QGpS37E21TcgQhhIvJZlK1cG4M1jpPJ0I_XPQgrFjvKUFUJQ3aYuO1zYsqPmKgNb4Wfd8ito88yDjUTD6CKD3E&scope=email%20profile%20https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email%20https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.profile%20openid&authuser=1&prompt=consent
当您第一次看到它时,它很难阅读和解密,但它只是一个带有参数附加到我们重定向 URL 的查询字符串:
<redirect URL>?
code=4/1QFvWYDSrW...
&scope=email profile...
&authuser=1
&prompt=consent
我们可以使用 Node.js 模块query-string来解析 URL 中的查询字符串,例如:
const queryString = require('query-string')
const parsed = queryString.parse(location.search)
console.log(parsed)
然后您将在浏览器控制台中获得以下 JavaScript 对象:
{authuser: "1", code: "4/1QFvWYDSrWLklhIgRfVR0LJy6Pk0gn5TkjTKWKlRr9pdZveGAHV_pMrxBhicy7Zd6d9nfz0IQrcLl-VGS-Gu9Xk", prompt: "consent", scope: "email profile https://www.googleapis.com/auth/user…//www.googleapis.com/auth/userinfo.profile openid"}
在前面的重定向 URL 中,code参数是我们最感兴趣的,因为我们需要将其发送到服务器端,以便通过 googleapis Node.js 模块获取 Google 用户数据,正如您在上一节中学到的。因此,让我们安装query-string并在接下来的步骤中在我们的 Nuxt 应用程序中创建前端身份验证:
- 通过 npm 安装
query-stringNode.js 模块:
$ npm i query-string
- 在登录页面上创建一个按钮,并绑定一个名为
loginWithGoogle的方法,以调度存储中的getGoogleUrl方法,如下所示:
// frontend/pages/login.vue
<button v-on:click="loginWithGoogle">Google Login</button>
export default {
methods: {
async loginWithGoogle() {
try {
await this.$store.dispatch('getGoogleUrl')
} catch (error) {
let errorData = error.response.data
this.formError = errorData.message
}
}
}
}
- 在 API 中调用
/api/public/login/google/url路由,在getGoogleUrl方法中如下所示:
// frontend/store/actions.js
export default {
async getGoogleUrl(context) {
const { data } = await this.$axios.$get('/api/public/login/
google/url')
window.location.replace(data)
}
}
/api/public/login/google/url路由将返回一个 Google URL,然后我们可以使用它将用户重定向到 Google 登录页面。从那里,用户将决定要登录到哪个 Google 帐户(如果有多个)。
- 从返回的 URL 中提取查询部分,并在 Google 将用户重定向回登录页面时将其发送到 store 中的
loginWithGoogle方法中,如下所示:
// frontend/pages/login.vue
export default {
async mounted () {
let query = window.location.search
if (query) {
try {
await this.$store.dispatch('loginWithGoogle', query)
} catch (error) {
// handle error
}
}
}
}
- 使用
query-string从前面的查询部分中提取code参数的代码,并使用$axios将其发送到我们的 API/api/public/login/google/me,如下所示:
// frontend/store/actions.js
import queryString from 'query-string'
export default {
async loginWithGoogle (context, query) {
const parsed = queryString.parse(query)
const { data } = await this.$axios.$get('/api/public/login/
google/me', {
params: {
code: parsed.code
}
})
if (data.message === 'signup required') {
localStorage.setItem('user', JSON.stringify(data.user))
this.$router.push({ name: 'signup'})
} else {
cookies.set('auth', data)
context.commit('setAuth', data)
}
}
}
当我们从服务器收到'signup required'消息时,我们将用户重定向到注册页面。但是,如果我们收到带有 JWT 的消息,那么我们可以将 cookie 和经过身份验证的数据设置到 store 状态中。我们将留下注册页面让您自己想象和努力,因为这是一个用于收集用户数据以存储在数据库中的表单。
- 最后,使用
npm run dev运行 Nuxt 应用程序。您应该可以在localhost:3000上在浏览器中运行该应用程序。您可以使用 Google 登录,然后访问受 JWT 保护的受限页面,就像本地认证一样。
所以,这就是你使用 Google OAuth API 登录用户的基本步骤。这一点并不难,是吗?我们还可以使用 Nuxt Auth 模块来实现几乎与我们在这里完成的相同的功能。使用此模块,您可以使用 Auth0、Facebook、GitHub、Laravel Passport 和 Google 登录用户。如果您正在寻找 Nuxt 的快速、简单和零样板认证支持,这可能是您项目的一个不错的选择。有关此 Nuxt 模块的更多信息,请访问auth.nuxtjs.org/。现在让我们在下一节总结一下您在本章中学到的内容。
您可以在我们的 GitHub 存储库中的/chapter-12/nuxt-universal/cross-domain/jwt/axios-module/中找到前面使用 Google OAuth 的登录选项。
有关query-string Node.js 模块的使用信息,请访问www.npmjs.com/package/query-string。
摘要
干得好!您已经走了这么远。毕竟,在网页身份验证上工作并不难。在本章中,您已经了解了基于会话的身份验证和基于令牌的身份验证,特别是关于 JSON Web Token(JWT)。您现在应该知道它们之间的区别以及 JWT 的组成部分,以及如何使用jsonwebtoken Node.js 模块生成 JWT。我们还介绍了 MySQL Node.js 模块,并将其用作我们身份验证系统的一部分。您还集成了 Google OAuth 以便用户登录,然后使用 Nuxt 创建了前端身份验证。
在下一章中,您将学习如何在您的 Nuxt 应用程序中编写端到端测试。您将了解可以安装和使用的用于编写端到端测试的工具,特别是 AVA 和 Nightwatch。除此之外,您还将学习如何使用一个 Node.js 模块,即jsdom,使您的端到端测试在服务器端成为可能。这是因为 Nuxt 在技术上是一种服务器端技术,并在服务器端呈现我们的 HTML 页面,但在服务器端没有 DOM,因此我们可以利用jsdom来实现。但请放心,我们将引导您完成设置所有这些工具并编写您的测试的步骤。所以,请继续关注!