使用vue3搭建後臺系統的詳細步驟

2022-08-22 22:01:44

一、設定vite

在vite.config.ts檔案中設定專案的服務資料，設定如下：

  // 此處設定專案服務引數
  server: {
    host: "0.0.0.0", // 專案執行地址，此處代表localhost
    port: 8888, // 專案執行埠
    open: true, //編譯之後是否自動開啟頁面
    hmr: true, // 是否開啟熱載入
  },

之後server下方接著設定src的別名@，設定如下

  // 設定src的別名@
  resolve: {
    alias: {
      "@": resolve(__dirname, "./src"),
    },
  },

此外還需在ts的組態檔tsconfig.json中加入以下設定：

    "baseUrl": "./",                                // 設定路徑解析的起點
    "paths": {                                      // 設定src別名
      "@/*": ["src/*"]                              // 當我們輸入@/時會被對映成src/
    }

二、router路由

1、安裝router路由

npm install vue-router@latest
yarn add vue-router@latest

2、設定router路由

在src下新建router資料夾，同時建立index.ts並設定如下

import { createRouter, createWebHistory, RouteRecordRaw} from 'vue-router';
import Layout from '@/components/HelloWorld.vue'
 
// 定義路由，此處為Array陣列，資料型別為RouteRecordRaw
const routes: Array<RouteRecordRaw> = [
    {
        path: '/home',
        name: 'home',
        component: Layout
    }
]
 
// 建立路由
const router = createRouter({
    history: createWebHistory(),
    routes      // 將定義的路由傳入
})
 
// 將建立的router路由暴露，使其在其他地方可以被參照
export default router

3、註冊router路由

在main.ts中先通過 import router from '@/router/index' 引入路由，然後使用use函數註冊路由，具體如下：

import { createApp } from 'vue'
import './style.css'
import App from './App.vue'
// 此處引入定義的路由
import router from '@/router/index'
 
// createApp(App).mount('#app')
// 此處將鏈式建立拆解，從中註冊路由
const app = createApp(App);
// 註冊路由
app.use(router)
app.mount('#app')

4、使用router路由

註冊完成之後，在程式入口App.vue中通過 <router-view></router-view> 使用路由，具體如下：

<template>
  <!-- <div>
    <a href="https://vitejs.dev" rel="external nofollow"  target="_blank">
      <img src="/vite.svg" class="logo" alt="Vite logo" />
    </a>
    <a href="https://vuejs.org/" rel="external nofollow"  target="_blank">
      <img src="@/assets/vue.svg" class="logo vue" alt="Vue logo" />
    </a>
  </div> -->
  <!-- 在App的入口程式使用路由,會將我們註冊的路由全部引入到App入口,通過路由的路徑確定跳轉的頁面 -->
  <router-view></router-view>
</template>

三、安裝element plus等其他依賴

# 選擇一個你喜歡的包管理器
 
// 安裝element-plus
npm install element-plus --save
 
yarn add element-plus
 
pnpm install element-plus
 
// 安裝element-plus的圖示庫元件
npm install @element-plus/icons-vue
 
yarn add @element-plus/icons-vue
 
pnpm install @element-plus/icons-vue

1、註冊element plus並設定圖示

和router一樣都是在main.ts中註冊，設定如下：

import { createApp } from "vue";
import "./style.css";
import App from "./App.vue";
// 次數引入定義的路由
import router from "@/router/index";
// 引入element-plus
import ElementPlus from "element-plus";
import "element-plus/dist/index.css";
// 引入element-plus的圖示庫
import * as ElementPlusIconsVue from "@element-plus/icons-vue";
 
// createApp(App).mount('#app')
// 此處將鏈式建立拆解，從中註冊路由
 
const app = createApp(App);
// 註冊路由、element-plus等
app.use(router).use(ElementPlus);
// 將所有設定掛載到index.html的id為app的容器上
app.mount("#app");
 
// 此處參考官網，意為將圖示庫中的每個圖示都註冊成元件
for (const [key, component] of Object.entries(ElementPlusIconsVue)) {
  app.component(key, component);
}

四、pinia使用

pinia官網

1、安裝pinia

yarn add pinia
# 或者使用 npm
npm install pinia

2、註冊pinia

// 從pinia中引入建立範例的函數
import { createPinia } from 'pinia'
 
// 使用createPinia函數建立一個pinia範例並註冊
app.use(createPinia())

3、設定pinia

在src下面新建store資料夾並新建index.ts檔案,並設定如下：

// 從pinia中引入defineStore函數來定義store
import { defineStore } from "pinia";
 
// 定義一個store並取名為useStore
// defineStore第一個引數是應用程式中store的唯一標識，也就是在定義其他store時該標識不能相同
// 此處可以類比為java中的實體類，useStore就是類名，state裡的屬性是成員屬性，getters裡的函數是getter方法，actions裡的函數是setter方法
export const useStore = defineStore("useStore", {
  // 定義state
  // 推薦使用 完整型別推斷的箭頭函數
  state: () => {
    return {
      // 所有這些屬性都將自動推斷其型別
      count: 0,
      name: "Eduardo",
      isAdmin: true,
    };
  },
 
  // 定義getters,裡面定義一些對state值的取值操作
  // 指向箭頭函數定義的時候所處的物件，而不是其所使用的時候所處的物件，預設指向父級的this
  // 普通函數中的this指向它的呼叫者，如果沒有呼叫者則預設指向window
  getters: {
    doubleCount: (state) => state.count * 2,
    doubleCountOne(state) {
      return state.count * 2;
    },
    doublePlusOne(): number {
      return this.count * 2 + 1;
    },
  },
 
  // 定義actions,裡面定義一些對state的賦值操作
  actions: {
    setCounter(count:number){
        this.count = count
    }
  }
});
 
// 1、只有一個引數的時候，引數可以不加小括號，沒有引數或2個及以上引數的，必須加上小括號
// 2、返回語句只有一條的時候可以不寫{}和return，會自動加上return的，返回多條語句時必須加上{}和return
// 3、箭頭函數在返回物件的時候必須在物件外面加上小括號
// 在vue中定義函數時，我們儘量都指明函數返回值型別以及引數的資料型別

4、測試pinia

<template>
  <!-- 測試element-plus -->
  <el-button type="primary">Primary</el-button>
 
  <!-- 測試element-plus圖示 -->
  <div style="font-size: 20px">
    <Edit style="width: 1em; height: 1em; margin-right: 8px" />
    <Share style="width: 1em; height: 1em; margin-right: 8px" />
    <Delete style="width: 1em; height: 1em; margin-right: 8px" />
    <Search style="width: 1em; height: 1em; margin-right: 8px" />
  </div>
 
  <h2>方式一、直接通過store.count++</h2>
  <!-- 測試pinia -->
  <h3>直接從store取值並測試pinia:{{ count }}</h3>
  <el-button type="primary" @click="addCount">增加</el-button>
 
  <h3>使用storeToRefs函數解析store後測試pinia:{{ count1 }}</h3>
  <el-button type="primary" @click="addCount1">增加</el-button>
 
    <h2>方式二、通過呼叫store中的函數</h2>
   <h3>通過store中的函數並測試pinia:{{ count1 }}</h3>
  <el-button type="primary" @click="addCount2">增加</el-button> 
</template>
 
<script setup lang="ts">
import { useStore } from "@/store/index";
import { storeToRefs } from "pinia"; // 解析store中的資料，如成員屬性、方法
 
// 建立了一個useStore範例物件
const store = useStore();
// 增加成員屬性count的值，方式一、直接通過store.count++
 
// 拿到成員屬性count,但這樣取值會失去響應性，也就是不能實時同步，當我們點選增加按鈕後，雖然操作已經完成，count也增加了，但展示有延遲
// 這個取值過程可能涉及解析資料，從而導致函數執行完後資料沒有變化
const count = store.count;
const addCount = () => {
  store.count++;
};
// 通過pinia中的storeToRefs函數將store中的資料都進行解析
const count1 = storeToRefs(store).count;
const addCount1 = () => {
  store.count++;
};
 
// 方式二、通過呼叫store中的函數
const addCount2 = () => {
  store.setCounter(++store.count)
};
</script>
 
<style scoped>
.read-the-docs {
  color: #888;
}
</style>

五、layout佈局

在設定layout之前，我們還需要對一些標籤做初始化的樣式設定，比如：html、body等，具體如下

在專案的index.html檔案下新增樣式設定

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <link rel="icon" type="image/svg+xml" href="/vite.svg" rel="external nofollow"  />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Vite + Vue + TS</title>
  </head>
  <body>
    <!-- 此處為程式的最終入口,會引入App.vue 並將相應的設定掛載到id為app <div id="app"></div> 上 -->
    <div id="app"></div>
    <script type="module" src="/src/main.ts"></script>
  </body>
</html>
 
<!-- 這裡對html、body、掛載容器div做樣式的初始化設定，去除原有的設定 -->
<style lang="less">
  html,body,#app {
    padding: 0px;
    margin: 0px;
    height: 100%;
    box-sizing: border-box;
  }
  #app {
    width: 100%;
    max-width: 100%;
  }
</style>

之後在src下新建layout資料夾並新建index.vue檔案，設定如下：

整個el-container為layout佈局的整體，其下又可以按照佈局的不同劃分出不同的區塊，但總結起來可以劃分為：1、側邊選單欄；2、頭部區；3、內容展示區；4、尾部區，我們根據自己的需要進行選擇組合，這些劃分出來的區塊涉及到不同的設定和處理，因此，我們可以將這些大的區塊從layout整體佈局中抽離成元件，讓程式碼擁有更好的可讀性；此外，每個抽離的元件自己本身也可能存在需要拆分的問題。我們通過拆分，可以很好的將一個問題化繁為簡，從而很輕鬆的解決。

<template>
  <el-container class="container">
    <!-- layout佈局左側選單區 -->
    <el-aside width="200px" class="aside">
      <!-- 選單項，通過元件的形式引入 -->
      <Menu></Menu>
    </el-aside>
    <!-- layout佈局內容區 -->
    <el-container>
      <!-- 內容區頭部 -->
      <el-header class="header">
        <!-- 頭部元件，抽離成元件形式 -->
        <Header></Header>
      </el-header>
      <!-- 內容區的主體，用於資料展示 -->
      <el-main class="content">Main</el-main>
    </el-container>
  </el-container>
</template>
 
<script setup lang="ts">
// vue3中元件引入後不需要使用conponents註冊，可以直接使用
import Header from '@/layout/header/Header.vue'
import Menu from '@/layout/menu/Menu.vue'
 
</script>
 
<style scoped lang="less">
.container {
  height: 100%;
  .aside {
    background-color: antiquewhite;
  }
  .header {
    background-color: aquamarine;
  }
  .content {
    background-color: pink
  }
}
</style>

從layout佈局抽離的選單欄元件：

<template>
  <el-menu
    default-active="2"
    class="el-menu-vertical-demo"
    :unique-opened='uniqueOpenedFlag'
  >
    <!-- 在為el-menu設定unique-opened屬性時必須要確保el-sub-menu、el-menu-item中index的唯一性，如果index不唯一則不生效 -->
    <!-- 本元件作為父元件向子元件傳遞資料menuList，子元件需要定義menuList屬性以確保可以接受該資料 -->
    <menu-item :menuList="menuList"></menu-item>
  </el-menu>
</template>
 
<script setup lang="ts">
import { ref, reactive } from "vue";
import MenuItem from "@/layout/menu/item/MenuItem.vue";
 
// 自定義的假的樹形選單資料
// reactive函數用來處理響應式資料，處理的資料一般是複雜型別資料，如物件型別
// ref函數也可以處理響應式資料，不過資料一般是基本資料型別
const isCollapse = ref(false)
const uniqueOpenedFlag = ref(true)
 
 
const menuList = reactive([
  {
    path: "/system",
    name: "system",
    component: "Layout",
    meta: {
      title: "系統管理",
      icon: "Setting",
      roles: ["sys:manage"],
    },
    children: [
      {
        path: "/worker",
        name: "worker",
        component: "Layout",
        meta: {
          title: "員工管理",
          icon: "Setting",
          roles: ["sys:manage"],
        },
      },
      {
        path: "/happy",
        name: "happy",
        component: "Layout",
        meta: {
          title: "選單管理",
          icon: "Setting",
          roles: ["sys:manage"],
        },
      },
    ],
  },
  {
    path: "/mail",
    name: "mail",
    component: "Layout",
    meta: {
      title: "商場管理",
      icon: "Setting",
      roles: ["sys:manage"],
    },
    children: [
      {
        path: "/worker11",
        name: "worker11",
        component: "Layout",
        meta: {
          title: "員工管理22",
          icon: "Setting",
          roles: ["sys:manage"],
        },
      },
      {
        path: "/happy22",
        name: "happy22",
        component: "Layout",
        meta: {
          title: "選單管理22",
          icon: "Setting",
          roles: ["sys:manage"],
        },
      },
    ],
  },
]);
 
</script>
 
<style lang="less" scoped></style>

從選單欄抽離的選單項元件：

<template>
  <template v-for="item in menuList" :key="item.path">
    <!-- 判斷該選單項是否有子選單 -->
    <el-sub-menu v-if="item.children && item.children.length > 0" :index="item.path" >
      <template #title>
        <el-icon>
          <!-- 通過動態元件展示圖示，因為圖示資料一般是通過後端查資料庫拿到的 -->
          <component :is="item.meta.icon"></component>
        </el-icon>
        <span>{{ item.meta.title }}</span>
      </template>
      <!-- 遞迴呼叫，將子選單傳遞給元件處理 -->
      <menu-item :menuList="item.children"></menu-item>
    </el-sub-menu>
    <el-menu-item v-else :index="item.path">
      <el-icon>
        <!-- 通過動態元件展示圖示 -->
        <component :is="item.meta.icon"></component>
      </el-icon>
      <span>{{ item.meta.title }}</span>
    </el-menu-item>
  </template>
</template>
 
<script setup lang="ts">
import {
  Document,
  Menu as IconMenu,
  Location,
  Setting,
} from "@element-plus/icons-vue";
 
// 子元件接受父元件傳遞的資料
// 本元件為子元件，接受父元件傳過來的資料，此處定義menuList屬性，接受父元件傳遞的menuList資料
defineProps(["menuList"]);
</script>
 
<style lang="less" scoped></style>

六、選單欄logo

首先，將自己準備的logo圖片放到src下的assets資料夾下，然後在layout的menu的logo資料夾下新建MenuLogo.vue檔案，並設定如下：

<template>
  <div class="logo">
    <img :src="Logo" />
    <span class="logo-title">{{ title }}</span>
  </div>
</template>
 
<script setup lang="ts">
import { ref } from "vue";
import Logo from "@/assets/logo.png";
const title = ref("部落格管理系統");
</script>
 
<style lang="less" scoped>
.logo {
  display: flex; // 彈性佈局
  width: 100%;
  height: 60px;
  line-height: 60px;
  background-color: rgb(234, 255, 127);
  text-align: center;
  cursor: pointer; // 滑鼠懸浮在元素上時，滑鼠從箭頭變成小手
  align-items: center;
  img {
    width: 36px;
    height: 36px;
    margin-left: 20px; // 元素的外邊距
    margin-right: 12px;
  }
  .logo-title {
    font-weight: 800; // 800為加粗
    color: black;
    font-size: 20px;
    line-height: 60px; // 元素上下居中
    font-family: FangSong; // 字型型別
  }
}
</style>

最後在選單欄元件中引入選單logo元件並使用

// 在script標籤中引入
import MenuLogo from "@/layout/menu/logo/MenuLogo.vue";
 
// el-menu標籤上方引入使用
<menu-logo></menu-logo>

效果如下：

七、路由和頁面聯動

在src的router的index.ts檔案下新增如下路由設定並在views資料夾下建立對應的檔案

{
    path: "/",
    component: Layout,      // 每個路由都需要通過component指定歸屬的佈局元件
    redirect: "/index",
    name: "Root",
    children: [
      {
        path: "/index",
        name: "Index",
        component: () => import("@/views/index/index.vue"),
        meta: {
          title: "首頁看板",
          icon: "icon-home",
          affix: true,
          noKeepAlive: true,
        },
      },
    ],
  },
  {
    path: "/comp",
    component: Layout,
    name: "Comp",
    meta: { title: "系統管理", icon: "icon-code" },
    children: [
      {
        path: "/element",
        name: "ElementComp",
        component: () => import("@/views/element/index.vue"),
        meta: {
          title: "選單管理",
          icon: "icon-code",
        },
      },
      {
        path: "/iconPark",
        name: "IconPark",
        component: () => import("@/views/icon/index.vue"),
        meta: {
          title: "路由管理",
          icon: "icon-like",
        },
      },
      {
        path: "/chart",
        name: "Chart",
        component: () => import("@/views/echarts/index.vue"),
        meta: {
          title: "員工管理",
          icon: "icon-chart-line",
        },
        children: [
          {
            path: "/line",
            name: "Line",
            component: () => import("@/views/echarts/line.vue"),
            meta: {
              title: "商品管理",
            },
          },
          {
            path: "/bar",
            name: "Bar",
            component: () => import("@/views/echarts/bar.vue"),
            meta: {
              title: "手機管理",
            },
          },
          {
            path: "/otherChart",
            name: "OtherChart",
            component: () => import("@/views/echarts/other.vue"),
            meta: {
              title: "會員管理",
            },
          },
        ],
      },
    ],
  },
  {
    path: "/errorPage",
    name: "ErrorPage",
    component: Layout,
    meta: {
      title: "使用者管理",
      icon: "icon-link-cloud-faild",
    },
    children: [
      {
        path: "/404Page",
        name: "404Page",
        component: () => import("@/views/errorPage/404.vue"),
        meta: {
          title: "角色管理",
          icon: "icon-link-cloud-faild",
        },
      },
      {
        path: "/401Page",
        name: "401Page",
        component: () => import("@/views/errorPage/401.vue"),
        meta: {
          title: "許可權管理",
          icon: "icon-link-interrupt",
        },
      },
    ],
  },

新增完路由設定之後，建立路由的對應檔案並新增一些描述文字，此時雖然路由和對應的頁面都已經建立完畢並關聯在了一起，但路由並沒有被參照，也就無法在正確的位置展示路由頁面的資料，所以，我們需要將路由參照到layout佈局的main區域，也就是資料展示區，確保當我們存取某個路由時，對應的路由頁面能夠在該區域展示。

1、路由和頁面聯動的注意細節

在選單項元件中，我們給選單項的index屬性繫結了路由的path值，其用意是為了啟用element-plus中提供的一種在啟用導選單時（當我們點選某個選單項時，該選單項就是被啟用的選單）以index作為path進行路由跳轉，所以為了我使用這個功能，我們還需要在選單欄元件的el-menu標籤中新增 router 屬性以開啟該功能，同時再新增 default-active 屬性來指明當前被啟用的選單。用例如下

<template>
  <menu-logo></menu-logo>
  <el-menu
    :default-active="activeIndex"
    class="el-menu-vertical-demo"
    :unique-opened="uniqueOpenedFlag"
    router
  >
    <!-- 在為el-menu設定unique-opened屬性時必須要確保el-sub-menu、el-menu-item中index的唯一性，如果index不唯一則不生效 ，一般我們為index繫結路由的path值 -->
    <!-- 本元件作為父元件向子元件傳遞資料menuList，子元件需要定義menuList屬性以確保可以接受該資料 -->
    <!-- router屬性可以啟用以 index 作為 path 進行路由跳轉 -->
    <!-- default-active屬性用來指明當前被啟用的選單，其值為選單項中index的值，也就是path值 -->
    <menu-item :menuList="menuList"></menu-item>
  </el-menu>
</template>
 
import { useRouter, useRoute } from "vue-router";
 
// 獲取當前點選的路由
const route = useRoute();
// 從路由中獲取path
const activeIndex = computed(() => {
  const { path } = route;
  return path;
});