一個(gè)項(xiàng)目學(xué)會(huì)vue全家桶+axios實(shí)現(xiàn)登錄、攔截、登出功能,以及利用axios的http攔截器攔截請(qǐng)求和響應(yīng)。
前言
該項(xiàng)目是利用了Github 提供的personal token作為登錄token,通過token訪問你的Repository List。通過這個(gè)項(xiàng)目學(xué)習(xí)如何實(shí)現(xiàn)一個(gè)前端項(xiàng)目中所需要的
登錄及攔截、登出、token失效的攔截及對(duì)應(yīng) axios 攔截器的使用。
準(zhǔn)備
你需要先生成自己的 Github Personal Token(生成Token)。
Token 生成后 訪問 Demo,即可查看你的Repository List。
項(xiàng)目結(jié)構(gòu)
.
├── README.md
├── dist? // 打包構(gòu)建后的文件夾
│? ├── 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請(qǐng)求及http 攔截器配置文件
│? ├── index.vue
│? ├── login.vue
│? ├── main.js
│? ├── repository.vue
│? ├── router.js // 路由配置文件
│? └── store
│? ? ? ├── store.js?
│? ? ? └── types.js? // vuex types
└── webpack.config.js
技術(shù)棧
Vue 2.0
vue-router
vuex
axios
vue-material
登錄攔截邏輯
第一步:路由攔截
首先在定義路由的時(shí)候就需要多添加一個(gè)自定義字段requireAuth,用于判斷該路由的訪問是否需要登錄。如果用戶已經(jīng)登錄,則順利進(jìn)入路由,
否則就進(jìn)入登錄頁(yè)面。
const?routes?=?[
????????{
??????????path:?"/",
??????????name:?"/",
??????????component:?Index
????????},
????????{
??????????path:?"/repository",
??????????name:?"repository",
??????????meta:?{
????????????requireAuth:?true?//?添加該字段,表示進(jìn)入這個(gè)路由是需要登錄的
??????????},
??????????component:?Repository
????????},
????????{
??????????path:?"/login",
??????????name:?"login",
??????????component:?Login
????????}
??????];
定義完路由后,我們主要是利用vue-router提供的鉤子函數(shù)beforeEach()對(duì)路由進(jìn)行判斷。
router.beforeEach((to, from, next) => {
? ? if (to.meta.requireAuth) {? // 判斷該路由是否需要登錄權(quán)限
? ? ? ? if (store.state.token) {? // 通過vuex state獲取當(dāng)前的token是否存在
? ? ? ? ? ? next();
? ? ? ? }
? ? ? ? else {
? ? ? ? ? ? next({
? ? ? ? ? ? ? ? path: '/login',
? ? ? ? ? ? ? ? query: {redirect: to.fullPath}? // 將跳轉(zhuǎn)的路由path作為參數(shù),登錄成功后跳轉(zhuǎn)到該路由
? ? ? ? ? ? })
? ? ? ? }
? ? }
? ? else {
? ? ? ? next();
? ? }
})
每個(gè)鉤子方法接收三個(gè)參數(shù):
* to: Route: 即將要進(jìn)入的目標(biāo) 路由對(duì)象
* from: Route: 當(dāng)前導(dǎo)航正要離開的路由
* next: Function: 一定要調(diào)用該方法來 resolve 這個(gè)鉤子。執(zhí)行效果依賴 next 方法的調(diào)用參數(shù)。
* next(): 進(jìn)行管道中的下一個(gè)鉤子。如果全部鉤子執(zhí)行完了,則導(dǎo)航的狀態(tài)就是 confirmed (確認(rèn)的)。
* next(false): 中斷當(dāng)前的導(dǎo)航。如果瀏覽器的 URL 改變了(可能是用戶手動(dòng)或者瀏覽器后退按鈕),那么 URL 地址會(huì)重置到 from 路由對(duì)應(yīng)的地址。
* next(‘/’) 或者 next({ path: ‘/’ }): 跳轉(zhuǎn)到一個(gè)不同的地址。當(dāng)前的導(dǎo)航被中斷,然后進(jìn)行一個(gè)新的導(dǎo)航。
確保要調(diào)用 next 方法,否則鉤子就不會(huì)被 resolved。
完整的方法見/src/router.js
其中,to.meta中是我們自定義的數(shù)據(jù),其中就包括我們剛剛定義的requireAuth字段。通過這個(gè)字段來判斷該路由是否需要登錄權(quán)限。需要的話,同時(shí)當(dāng)前應(yīng)用不存在token,則跳轉(zhuǎn)到登錄頁(yè)面,進(jìn)行登錄。登錄成功后跳轉(zhuǎn)到目標(biāo)路由。
登錄攔截到這里就結(jié)束了嗎?并沒有。這種方式只是簡(jiǎn)單的前端路由控制,并不能真正阻止用戶訪問需要登錄權(quán)限的路由。還有一種情況便是:當(dāng)前token失效了,但是token依然保存在本地。這時(shí)候你去訪問需要登錄權(quán)限的路由時(shí),實(shí)際上應(yīng)該讓用戶重新登錄。
這時(shí)候就需要結(jié)合 http 攔截器 + 后端接口返回的http 狀態(tài)碼來判斷。
第二步:攔截器
要想統(tǒng)一處理所有http請(qǐng)求和響應(yīng),就得用上 axios 的攔截器。通過配置http response inteceptor,當(dāng)后端接口返回401 Unauthorized(未授權(quán)),讓用戶重新登錄。
// http request 攔截器
axios.interceptors.request.use(
? ? config => {
? ? ? ? if (store.state.token) {? // 判斷是否存在token,如果存在的話,則每個(gè)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信息并跳轉(zhuǎn)到登錄頁(yè)面
? ? ? ? ? ? ? ? ? ? store.commit(types.LOGOUT);
? ? ? ? ? ? ? ? ? ? router.replace({
? ? ? ? ? ? ? ? ? ? ? ? path: 'login',
? ? ? ? ? ? ? ? ? ? ? ? query: {redirect: router.currentRoute.fullPath}
? ? ? ? ? ? ? ? ? ? })
? ? ? ? ? ? }
? ? ? ? }
? ? ? ? return Promise.reject(error.response.data)? // 返回接口返回的錯(cuò)誤信息
? ? });
完整的方法見/src/http.js.
通過上面這兩步,就可以在前端實(shí)現(xiàn)登錄攔截了。登出功能也就很簡(jiǎn)單,只需要把當(dāng)前token清除,再跳轉(zhuǎn)到首頁(yè)即可。
關(guān)于axios
對(duì)于axios,很多剛開始學(xué)習(xí)vue的人都覺得文檔比較難以看懂。我剛開始也是這么覺得的。但通過這么一個(gè)項(xiàng)目下來后,發(fā)現(xiàn)axios并不難理解。建議在學(xué)習(xí)axios的時(shí)帶著下面的目的去看文檔會(huì)更高效。因?yàn)檎莆樟讼旅孢@些內(nèi)容,基本上就可以無障礙得在項(xiàng)目中使用axios了。
* 發(fā)起http請(qǐng)求的方法
* http 請(qǐng)求成功時(shí)返回的數(shù)據(jù)及其類型
* http請(qǐng)求失敗的處理
* 攔截器的使用
* http的配置
運(yùn)行及構(gòu)建
# install dependencies
npm install
# serve with hot reload at localhost:8080
npm run dev
# build for production with minification
npm run build