摘要：開發時官方推薦使用，在配置這個項目時，由于考慮登錄態的維護，所以對路由配置加了數據，并增加了路由跳轉鉤子函數，進行鑒權控制受登錄態的頁面。

這個項目主要是用vue+vuex實現一個單頁面應用，純粹是熟悉vue全家桶相關開發模式，用于練手非常合適。

著手開發完了之后可以學的東西：

熟悉vue單文件組件開發方式

熟悉如何寫一個vue插件

熟悉如何使用vue-router以及掛載路由鉤子函數

熟悉vuex是如何運作的，模塊化維護應用狀態數據

體驗typescript的開發方式

如果想學vue的不妨進來看看。

vue

vuex

vue-router

typescript

開始之前，還是有必要去vue官網學習一下vue，至少得有個大致的了解，后面在用到vue-router和vuex時，再去對應的倉庫看文檔就可以了。

vue官網地址

vue-router地址

vuex地址

創建項目可以用vue-cli，具體看這里

項目結構一般來說非常重要，定義好的目錄結構，非常利于后續的項目維護，以及別人閱讀理解。下面就是這個項目的結構，應該看一下就知道是干什么的，大致說一下。

項目結構分為靜態資源目錄，api接口請求目錄，組件目錄，插件目錄，路由配置目錄，公共樣式目錄，狀態維護目錄，工具類目錄，頁面視圖目錄。

vue開發一般都是單頁面組件的方式，即一個以vue為后綴的文件就是一個組件，組件里包含了template模版，script腳本，style樣式，組件內的邏輯可以完全封裝在里面，對外可以提供接受的Props數據，可以對外發射一個事件emit，或者將外部組件組合到自己內部的slot里面。

由于在客戶端渲染的單頁面應用，需要在客戶端配置路由，實現頁面間的切換。開發vue時官方推薦使用vue-router，在配置這個項目時，由于考慮登錄態的維護，所以對路由配置加了meta數據，并增加了路由跳轉鉤子函數，進行鑒權控制受登錄態的頁面。

import Vue from "vue";
import Router from "vue-router";
import Sign from "@/views/Sign.vue";
import Me from "@/views/Me.vue";
import { hasLogin } from "@/util/session";

Vue.use(Router);

const router = new Router({
  mode: "history",
  routes: [
    {
      path: "/",
      name: "sign",
      component: Sign,
    },
    {
      path: "/me",
      name: "me",
      component: Me,
      meta: { requiredAuth: true },
    },
  ],
});

router.beforeEach((to, from, next) => {
  if (to.matched.some((record) => record.meta.requiredAuth)) {
    // this route requires auth, check if logged in
    // if not, redirect to login page.
    if (!hasLogin()) {
      next({
        path: "/",
        query: { redirect: to.fullPath },
      });
    } else {
      next();
    }
  } else {
    next(); // 確保一定要調用 next()
  }
});

export default router;

對于那種需要全組件共享，或者全局注入的方法等可以使用vue插件。其實，vue-router和vuex實際就是vue的插件，在入口處，調Vue.use(Router); 就可以了，比如 Vue.use(Router);

一個插件，可以是一個函數，或者一個包含install方法的對象，在調用Vue.use時，會調用install方法。

在插件里，我們可以

添加全局方法或者屬性，

添加全局資源

通過全局 mixin 方法添加一些組件選項

添加 Vue 實例方法

import Vue, { VueConstructor, PluginObject } from "vue";
import Loading from "./Loading.vue";

type ShowFunc = () => () => void;

const plugin: PluginObject<{}> = {
  install(Vue: VueConstructor, options = {}) {
    const CONSTRUCTOR = Vue.extend(Loading);
    let cache: Vue & { show: ShowFunc } | null = null;

    function loading(): () => void {
      const loadingComponent = cache || (cache = new CONSTRUCTOR());
      if (!loadingComponent.$el) {
        const vm = loadingComponent.$mount();
        (document.querySelector("body") as HTMLElement).appendChild(vm.$el);
      }
      return loadingComponent.show();
    }
    Vue.prototype.$loading = loading;
  },
};

export default plugin;

單頁面應用的狀態管理使用vuex，上面提到了，它就是一個vue的插件，會在組件實例上注入$store對象，這個對象就是new Vuex.Store(),相比redux ，我覺得vuex簡單很多。使用需要注意一下幾點就可以了，

改變state，始終是通過commit一個mutation方式進行，mutation函數里必須是同步改變state，不能異步改變state。對應redux中，就是reducer函數的功能了。

對于異步改變state，可以通過dispatch一個action，action里面異步獲取數據之后在commit一個對應的mutation。這個在redux里，是通過中間件處理異步action的。

對于state的過濾篩選，可以定義getter，getter是緩存依賴的。

對于大型復雜的state，可以采用模塊化的方式管理各個模塊的state，這個跟redux的思想是一樣的。

本次項目也是用模塊化的管理狀態的方式，把整個應用的狀態以業務劃分為子狀態，最后在modules中合并

  modules: {
    user,
    list,
    filter,
  },

對于單個模塊的state，按照上面的注意點即可以。

// user模塊的state
import { ActionTree, MutationTree, ActionContext } from "vuex";
import { login, loginOut, LoginInfo } from "@/api/login";
import { getUserInfo, getUserActions } from "@/api/user";
import { User } from "./user";
import { RootState } from "../../rootstate";

const namespaced = true;

/* initial state */
const state = () => ({
  id: null,
  username: null,
  email: null,
  avatar: null,
  likes_count: null,
  goings_count: null,
  past_count: null,
});

/* user actions */
const actions: ActionTree = {
  login({ commit, state }: ActionContext, payload: LoginInfo) {
    return login(payload).then(
      ({ token, user }: { token: string; user: User }) => {
        commit("saveToken", token, { root: true });
        commit("saveUser", user);
      },
    );
  },
  getUserInfo({ commit, state }: ActionContext) {
    return getUserInfo().then((user: User) => {
      commit("saveUser", user);
    });
  },
};

/* user mutations */
const mutations: MutationTree = {
  saveUser(state, user) {
    state.id = user.id;
    state.username = user.username;
    state.email = user.email;
    state.avatar = user.avatar;
    state.likes_count = user.likes_count;
    state.goings_count = user.goings_count;
    state.past_count = user.past_count;
  },
};

export default {
  state,
  actions,
  mutations,
  namespaced,
};