一個項目學會vue全家桶+axios實現登陸、攔截、登出功能,以及利用axios的http攔截器攔截請求和響應。javascript
該項目是利用了Github 提供的personal token做爲登陸token,經過token訪問你的Repository List。經過這個項目學習如何實現一個前端項目中所須要的
登陸及攔截、登出、token失效的攔截及對應 axios 攔截器的使用。
準備
你須要先生成本身的 Github Personal Token(生成Token)。
Token 生成後 訪問 Demo,便可查看你的Repository List。css
. ├── 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
Vue 2.0html
vue-router前端
vuexvue
axiosjava
vue-materialwebpack
首先在定義路由的時候就須要多添加一個自定義字段requireAuth
,用於判斷該路由的訪問是否須要登陸。若是用戶已經登陸,則順利進入路由,
不然就進入登陸頁面。ios
const routes = [ { path: '/', name: '/', component: Index }, { path: '/repository', name: 'repository', meta: { requireAuth: true, // 添加該字段,表示進入這個路由是須要登陸的 }, component: Repository }, { path: '/login', name: 'login', component: Login } ];
定義完路由後,咱們主要是利用vue-router
提供的鉤子函數beforeEach()
對路由進行判斷。git
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(); } })
每一個鉤子方法接收三個參數:github
to: Route: 即將要進入的目標 路由對象
from: Route: 當前導航正要離開的路由
next: Function: 必定要調用該方法來 resolve 這個鉤子。執行效果依賴 next 方法的調用參數。
next(): 進行管道中的下一個鉤子。若是所有鉤子執行完了,則導航的狀態就是 confirmed (確認的)。
next(false): 中斷當前的導航。若是瀏覽器的 URL 改變了(多是用戶手動或者瀏覽器後退按鈕),那麼 URL 地址會重置到 from 路由對應的地址。
next('/') 或者 next({ path: '/' }): 跳轉到一個不一樣的地址。當前的導航被中斷,而後進行一個新的導航。
確保要調用 next 方法,不然鉤子就不會被 resolved。
完整的方法見
/src/router.js
其中,to.meta
中是咱們自定義的數據,其中就包括咱們剛剛定義的requireAuth
字段。經過這個字段來判斷該路由是否須要登陸權限。須要的話,同時當前應用不存在token,則跳轉到登陸頁面,進行登陸。登陸成功後跳轉到目標路由。
登陸攔截到這裏就結束了嗎?並無。這種方式只是簡單的前端路由控制,並不能真正阻止用戶訪問須要登陸權限的路由。還有一種狀況即是:當前token失效了,可是token依然保存在本地。這時候你去訪問須要登陸權限的路由時,實際上應該讓用戶從新登陸。
這時候就須要結合 http 攔截器 + 後端接口返回的http 狀態碼來判斷。
要想統一處理全部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.