一个项目学会vue全家桶+axios实现登陆、拦截、登出功能,以及利用axios的http拦截器拦截请求和响应。javascript
该项目是利用了Github 提供的personal token做为登陆token,经过token访问你的Repository List。经过这个项目学习如何实现一个前端项目中所须要的
登陆及拦截、登出、token失效的拦截及对应 axios 拦截器的使用。css
准备
你须要先生成本身的 Github Personal Token(生成Token)。
Token 生成后 访问 Demo,便可查看你的Repository List。html
.
├── README.md
├── dist // 打包构建后的文件夹
│ ├── build.js
│ └── build.js.map
├── index.html
├── package.json
├── src
│ ├── App.vue
│ ├── assets
│ │ ├── css.css
│ │ ├── icon.css
│ │ └── logo.png
│ ├── constant
│ │ └── api.js // 配置api接口文件
│ ├── http.js // 封装fetch、post请求及http 拦截器配置文件
│ ├── index.vue
│ ├── login.vue
│ ├── main.js
│ ├── repository.vue
│ ├── router.js // 路由配置文件
│ └── store
│ ├── store.js
│ └── types.js // vuex types
└── webpack.config.js
首先在定义路由的时候就须要多添加一个自定义字段requireAuth
,用于判断该路由的访问是否须要登陆。若是用户已经登陆,则顺利进入路由,
不然就进入登陆页面。前端
const routes = [
{
path: '/',
name: '/',
component: Index
},
{
path: '/repository',
name: 'repository',
meta: {
requireAuth: true, // 添加该字段,表示进入这个路由是须要登陆的
},
component: Repository
},
{
path: '/login',
name: 'login',
component: Login
}
];
定义完路由后,咱们主要是利用vue-router
提供的钩子函数beforeEach()
对路由进行判断。vue
router.beforeEach((to, from, next) => {
if (to.meta.requireAuth) { // 判断该路由是否须要登陆权限
if (store.state.token) { // 经过vuex state获取当前的token是否存在
next();
}
else {
next({
path: '/login',
query: {redirect: to.fullPath} // 将跳转的路由path做为参数,登陆成功后跳转到该路由
})
}
}
else {
next();
}
})
每一个钩子方法接收三个参数:
* to: Route: 即将要进入的目标 路由对象
* from: Route: 当前导航正要离开的路由
* next: Function: 必定要调用该方法来 resolve 这个钩子。执行效果依赖 next 方法的调用参数。
* next(): 进行管道中的下一个钩子。若是所有钩子执行完了,则导航的状态就是 confirmed (确认的)。
* next(false): 中断当前的导航。若是浏览器的 URL 改变了(多是用户手动或者浏览器后退按钮),那么 URL 地址会重置到 from 路由对应的地址。
* next(‘/’) 或者 next({ path: ‘/’ }): 跳转到一个不一样的地址。当前的导航被中断,而后进行一个新的导航。java
确保要调用 next 方法,不然钩子就不会被 resolved。webpack
完整的方法见
/src/router.js
ios
其中,to.meta
中是咱们自定义的数据,其中就包括咱们刚刚定义的requireAuth
字段。经过这个字段来判断该路由是否须要登陆权限。须要的话,同时当前应用不存在token,则跳转到登陆页面,进行登陆。登陆成功后跳转到目标路由。git
登陆拦截到这里就结束了吗?并无。这种方式只是简单的前端路由控制,并不能真正阻止用户访问须要登陆权限的路由。还有一种状况即是:当前token失效了,可是token依然保存在本地。这时候你去访问须要登陆权限的路由时,实际上应该让用户从新登陆。
这时候就须要结合 http 拦截器 + 后端接口返回的http 状态码来判断。github
要想统一处理全部http请求和响应,就得用上 axios 的拦截器。经过配置http response inteceptor
,当后端接口返回401 Unauthorized(未受权)
,让用户从新登陆。
// http request 拦截器
axios.interceptors.request.use(
config => {
if (store.state.token) { // 判断是否存在token,若是存在的话,则每一个http header都加上token
config.headers.Authorization = `token ${store.state.token}`;
}
return config;
},
err => {
return Promise.reject(err);
});
// http response 拦截器
axios.interceptors.response.use(
response => {
return response;
},
error => {
if (error.response) {
switch (error.response.status) {
case 401:
// 返回 401 清除token信息并跳转到登陆页面
store.commit(types.LOGOUT);
router.replace({
path: 'login',
query: {redirect: router.currentRoute.fullPath}
})
}
}
return Promise.reject(error.response.data) // 返回接口返回的错误信息
});
完整的方法见
/src/http.js
.
经过上面这两步,就能够在前端实现登陆拦截了。登出
功能也就很简单,只须要把当前token清除,再跳转到首页便可。
对于axios,不少刚开始学习vue的人都以为文档比较难以看懂。我刚开始也是这么以为的。但经过这么一个项目下来后,发现axios并不难理解。建议在学习axios的时带着下面的目的去看文档会更高效。由于掌握了下面这些内容,基本上就能够无障碍得在项目中使用axios了。
* 发起http请求的方法
* http 请求成功时返回的数据及其类型
* http请求失败的处理
* 拦截器的使用
* http的配置
# install dependencies
npm install
# serve with hot reload at localhost:8080
npm run dev
# build for production with minification
npm run build
项目地址:https://github.com/superman66/vue-axios-github 欢迎star + issues.