vite+vue3項目最佳起始點（保姆級）

来源:https://www.cnblogs.com/helong-123/archive/2022/06/15/16377857.html
-Advertisement-
Play Games

一 、通過雲開發平臺快速創建初始化應用 1.創建相關應用模版請參考鏈接：去中心化的前端構建工具 — Vite 2.完成創建後就可以在github中查看到新增的Vite倉庫 二 、 本地編寫 Vite後臺項目最佳起始點 1.將應用模版克隆到本地 首先假定你已經安裝了Git、node，沒有安裝請移步no ...


一 、通過雲開發平臺快速創建初始化應用

1.創建相關應用模版請參考鏈接：去中心化的前端構建工具 — Vite

2.完成創建後就可以在github中查看到新增的Vite倉庫

file

二 、 本地編寫 Vite後臺項目最佳起始點

1.將應用模版克隆到本地

  • 首先假定你已經安裝了Git、node，沒有安裝請移步node官網進行安裝。克隆項目：
git clone + 項目地址
  • 進入項目文件
cd Vite
  • 切換到feature/1.0.0 分支上
git checkout feature/1.0.0
  • 安裝依賴包
npm install
  • 啟動服務
 npm run dev

這裡打開瀏覽器3000埠，並出現預設頁面。

2.路由

  • 安裝 vue-router 4.x
npm i vue-router@next -S

file

  • 路由配置 router/index.js
import { createRouter, createWebHashHistory } from 'vue-router';

const router = createRouter({
  history: createWebHashHistory(),
  routes: [
    { path: '/', component: () => import('views/home.vue') }
  ]
});

export default router
  • 引入 main.js
import router from "@/router";
createApp(App).use(router).mount("#app");

3.狀態管理

  • 安裝 vuex 4.x
npm i vuex@next -S

file

  • Store配置 store/index.js
import {createStore} from 'vuex';

export default createStore({
  state: {
    couter: 0
  }
});
  • 引入 main.js
import store from "@/store";
createApp(App).use(store).mount("#app");

4.樣式組織

  • 安裝 sass
npm i sass -D

styles 目錄保存各種樣式

file

index.scss 作為出口組織這些樣式，同時編寫一些全局樣式

file

最後在main.js導入

5.UI庫

  • 安裝
npm i element3 -S
  • 完整引入 main.js
import element3 from "element3";
import "element3/lib/theme-chalk/index.css";

createApp(App).use(element3)
  • 按需引入 main.js
import "element3/lib/theme-chalk/button.css";
import { ElButton } from "element3"
createApp(App).use(ElButton)

抽取成插件會更好 plugins/element3.js

// 完整引入
import element3 from "element3";
import "element3/lib/theme-chalk/index.css";

// 按需引入
// import { ElButton } from "element3";
// import "element3/lib/theme-chalk/button.css";

export default function (app) {
  // 完整引入
  app.use(element3)

  // 按需引入
  // app.use(ElButton);
}
  • 測試
<el-button>my button</el-button>

6.基礎佈局

我們應用需要一個基本佈局頁，類似下圖，將來每個頁面以佈局頁為父頁面即可：

file

  • 佈局頁面 layout/index.vue
<template>
  <div class="app-wrapper">
    <!-- 側邊欄 -->
    <div class="sidebar-container"></div>
    <!-- 內容容器 -->
    <div class="main-container">
      <!-- 頂部導航欄 -->
      <navbar />
      <!-- 內容區 -->
      <app-main />
    </div>
  </div>
</template>

<script setup>
import AppMain from "./components/AppMain.vue";
import Navbar from "./components/Navbar.vue";
</script>

<style lang="scss" scoped>
@import "../styles/mixin.scss";

.app-wrapper {
  @include clearfix;
  position: relative;
  height: 100%;
  width: 100%;
}
</style>
  • 路由配置 router/index.js
{
  path: "/",
	component: Layout,
  children: [
    {
      path: "",
      component: () => import('views/home.vue'),
      name: "Home",
      meta: { title: "首頁", icon: "el-icon-s-home" },
    },
  ],
},

7.動態導航

  • 側邊導航

根據路由表動態生成側邊導航菜單。

file

首先創建側邊欄組件，遞歸輸出routes中的配置為多級菜單，layout/Sidebar/index.vue

<template>
  <el-scrollbar wrap-class="scrollbar-wrapper">
    <el-menu
      :default-active="activeMenu"
      :background-color="variables.menuBg"
      :text-color="variables.menuText"
      :unique-opened="false"
      :active-text-color="variables.menuActiveText"
      mode="vertical"
    >
      <sidebar-item
        v-for="route in routes"
        :key="route.path"
        :item="route"
        :base-path="route.path"
      />
    </el-menu>
  </el-scrollbar>
</template>

<script setup>
import SidebarItem from "./SidebarItem.vue";
import { computed } from "vue";
import { useRoute } from "vue-router";
import { routes } from "@/router";
import variables from "styles/variables.module.scss";

const activeMenu = computed(() => {
  const route = useRoute();
  const { meta, path } = route;
  if (meta.activeMenu) {
    return meta.activeMenu;
  }
  return path;
});
</script>
  • 添加相關樣式：

○ styles/variables.module.scss

○ styles/sidebar.scss

○ styles/index.scss中引入

創建SidebarItem.vue組件，解析當前路由是導航鏈接還是父菜單：

file

8.麵包屑

通過路由匹配數組可以動態生成麵包屑。

麵包屑組件，layouts/components/Breadcrumb.vue

<template>
  <el-breadcrumb class="app-breadcrumb" separator="/">
      <el-breadcrumb-item v-for="(item, index) in levelList" :key="item.path">
        <span
          v-if="item.redirect === 'noRedirect' || index == levelList.length - 1"
          class="no-redirect"
          >{{ item.meta.title }}</span>
        <a v-else @click.prevent="handleLink(item)">{{ item.meta.title }}</a>
      </el-breadcrumb-item>
  </el-breadcrumb>
</template>

<script setup>
import { compile } from "path-to-regexp";
import { reactive, ref, watch } from "vue";
import { useRoute, useRouter } from "vue-router";

const levelList = ref(null);
const router = useRouter();
const route = useRoute();

const getBreadcrumb = () => {
  let matched = route.matched.filter((item) => item.meta && item.meta.title);

  const first = matched[0];
  if (first.path !== "/") {
    matched = [{ path: "/home", meta: { title: "首頁" } }].concat(matched);
  }

  levelList.value = matched.filter(
    (item) => item.meta && item.meta.title && item.meta.breadcrumb !== false
  );
}

const pathCompile = (path) => {  
  var toPath = compile(path);
  return toPath(route.params);
}

const handleLink = (item) => {
  const { redirect, path } = item;
  if (redirect) {
    router.push(redirect);
    return;
  }
  router.push(pathCompile(path));
}

getBreadcrumb();
watch(route, getBreadcrumb)

</script>

<style lang="scss" scoped>
.app-breadcrumb.el-breadcrumb {
  display: inline-block;
  font-size: 14px;
  line-height: 50px;
  margin-left: 8px;

  .no-redirect {
    color: #97a8be;
    cursor: text;
  }
}
</style>

9.數據封裝

統一封裝數據請求服務，有利於解決一下問題：

  • 統一配置請求
  • 請求、響應統一處理

準備工作：

  • 安裝axios:
npm i axios -S

添加配置文件：.env.development

VITE_BASE_API=/api

請求封裝 utils/request.js

import axios from "axios";
import { Message, Msgbox } from "element3";

// 創建axios實例
const service = axios.create({
  // 在請求地址前面加上baseURL
  baseURL: import.meta.env.VITE_BASE_API,
  // 當發送跨域請求時攜帶cookie
  // withCredentials: true,
  timeout: 5000,
});

// 請求攔截
service.interceptors.request.use(
  (config) => {
    // 模擬指定請求令牌
    config.headers["X-Token"] = "my token";
    return config;
  },
  (error) => {
    // 請求錯誤的統一處理
    console.log(error); // for debug
    return Promise.reject(error);
  }
);

// 響應攔截器
service.interceptors.response.use(
  /**
   * 通過判斷狀態碼統一處理響應，根據情況修改
   * 同時也可以通過HTTP狀態碼判斷請求結果
   */
  (response) => {
    const res = response.data;

    // 如果狀態碼不是20000則認為有錯誤
    if (res.code !== 20000) {
      Message.error({
        message: res.message || "Error",
        duration: 5 * 1000,
      });

      // 50008: 非法令牌; 50012: 其他客戶端已登入; 50014: 令牌過期;
      if (res.code === 50008 || res.code === 50012 || res.code === 50014) {
        // 重新登錄
        Msgbox.confirm("您已登出, 請重新登錄", "確認", {
          confirmButtonText: "重新登錄",
          cancelButtonText: "取消",
          type: "warning",
        }).then(() => {
          store.dispatch("user/resetToken").then(() => {
            location.reload();
          });
        });
      }
      return Promise.reject(new Error(res.message || "Error"));
    } else {
      return res;
    }
  },
  (error) => {
    console.log("err" + error); // for debug
    Message({
      message: error.message,
      type: "error",
      duration: 5 * 1000,
    });
    return Promise.reject(error);
  }
);

export default service;

10.常見業務處理

  • 結構化數據展

使用el-table展示結構化數據，配合el-pagination做數據分頁。

file

文件組織結構如下：list.vue展示列表，edit.vue和create.vue編輯或創建，內部復用detail.vue處理，model中負責數據業務處理。

file

list.vue中的數據展示

<el-table v-loading="loading" :data="list">
  <el-table-column label="ID" prop="id"></el-table-column>
  <el-table-column label="賬戶名" prop="name"></el-table-column>
  <el-table-column label="年齡" prop="age"></el-table-column>
</el-table>

list和loading數據的獲取邏輯，可以使用compsition-api提取到userModel.js

export function useList() {
  // 列表數據
  const state = reactive({
    loading: true, // 載入狀態
    list: [], // 列表數據
  });

  // 獲取列表
  function getList() {
    state.loading = true;
    return request({
      url: "/getUsers",
      method: "get",
    }).then(({ data, total }) => {
      // 設置列表數據
      state.list = data;
    }).finally(() => {
      state.loading = false;
    });
  }
  
  // 首次獲取數據
  getList();

  return { state, getList };
}

list.vue中使用

import { useList } from "./model/userModel";

const { state, getList } = useList();

分頁處理 list.vue

<pagination
      :total="total"
      v-model:page="listQuery.page"
      v-model:limit="listQuery.limit"
      @pagination="getList"
    ></pagination>

數據也在userModel中處理

const state = reactive({
  total: 0,   // 總條數
  listQuery: {// 分頁查詢參數
    page: 1,  // 當前頁碼
    limit: 5, // 每頁條數
  },
});

request({
  url: "/getUsers",
  method: "get",
  params: state.listQuery, // 在查詢中加入分頁參數
})

11.表單處理

用戶數據新增、編輯使用el-form處理

可用一個組件detail.vue來處理，區別僅在於初始化時是否獲取信息回填到表單。

<el-form ref="form" :model="model" :rules="rules">
  <el-form-item prop="name" label="用戶名">
    <el-input v-model="model.name"></el-input>
  </el-form-item>
  <el-form-item prop="age" label="用戶年齡">
    <el-input v-model.number="model.age"></el-input>
  </el-form-item>
  <el-form-item>
    <el-button @click="submitForm" type="primary">提交</el-button>
  </el-form-item>
</el-form>

數據處理同樣可以提取到userModel中處理。

export function useItem(isEdit, id) {
  const model = ref(Object.assign({}, defaultData));

  // 初始化時，根據isEdit判定是否需要獲取詳情
  onMounted(() => {
    if (isEdit && id) {
      // 獲取詳情
      request({
        url: "/getUser",
        method: "get",
        params: { id },
      }).then(({ data }) => {
        model.value = data;
      });
    }
  });
  return { model };
}

三 、 雲端一鍵部署上線應用

1.上傳代碼

git add . 
git commit -m '添加你的註釋'
git push

2.在日常環境部署

一鍵進行應用部署。在應用詳情頁面點擊日常環境的「部署」按鈕進行一鍵部署，部署狀態變成綠色已部署以後可以點擊訪問部署網站查看效果。

file

3.配置自定義功能變數名稱線上上環境上線

  • 配置線上環境自定義功能變數名稱。在功能開發驗證完成後要線上上環境進行部署，線上上環境的「部署配置」-「自定義功能變數名稱」中填寫自己的功能變數名稱。例如我們添加一個二級功能變數名稱 company.workbench.fun 來綁定我們部署的前端應用。然後複製自定義功能變數名稱下方的API網關地址對添加的二級功能變數名稱進行CNAME配置。

file

  • 配置CNAME地址。複製好 API網關功能變數名稱地址後，來到你自己的功能變數名稱管理平臺（此示例中的功能變數名稱管理是阿裡雲的功能變數名稱管理控制台，請去自己的功能變數名稱控制台操作）。添加記錄的「記錄類型」選擇「CNAME」，在「主機記錄」中輸入你要創建的二級功能變數名稱，這裡我們輸入「company」，在「記錄值」中粘貼我們之前複製的 API網關功能變數名稱地址，「TTL」保留預設值或者設置一個你認為合適的值即可。

file

  • 線上上環境部署上線。回到雲開發平臺的應用詳情頁面，按照部署的操作，點擊線上環境的「部署按鈕」，部署完成以後就在你自定義的功能變數名稱進行了上線。CNAME 生效之後，我們輸入 company.workbench.fun（示例網址） 可以打開部署的頁面。至此，如何部署一個應用到線上環境，如何綁定自己的功能變數名稱來訪問一個線上的應用就完成了，趕緊部署自己的應用到線上環境，用自己的功能變數名稱玩起來吧 ；）

file

4.項目預覽效果

file

一鍵創建Vite應用模版鏈接 ：https://workbench.aliyun.com/application/front/create?fromConfig=27&fromRepo=sol_github_27

參考文獻：https://juejin.cn/post/6926822933721513998#heading-22


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • C#中的CSV文件讀寫
    項目中經常遇到CSV文件的讀寫需求，其中的難點主要是CSV文件的解析。本文會介紹CsvHelper、TextFieldParser、正則表達式三種解析CSV文件的方法，順帶也會介紹一下CSV文件的寫方法。 CSV文件標準 在介紹CSV文件的讀寫方法前，我們需要瞭解一下CSV文件的格式。 文件示例 一 ...
  • 聊聊 C++ 和 C# 中的 lambda 玩法
    這幾天在看 C++ 的 lambda 表達式，挺有意思，這個標準是在 C11標準 加進去的，也就是 2011 年，相比 C# 2007 還晚了個 4 年， Lambda 這東西非常好用，會上癮，今天我們簡單聊一聊。 一：語法定義 首先我們看下 C++ 語法定義格式： [capture] (param ...
  • 在Winform開發中，使用Async-Awati非同步任務處理代替BackgroundWorker
    在Winform開發中有時候我們為了不影響主UI線程的處理，以前我們使用後臺線程BackgroundWorker來處理一些任務操作，不過隨著非同步處理提供的便利性，我們可以使用Async-Awati非同步任務處理替換原來的後臺線程BackgroundWorker處理方式，更加的簡潔明瞭。 ...
  • 【學習筆記】WPF-01：前言
    WPF（Windows Presentation Foundation）是微軟推出的基於Windows 的用戶界面框架，由 .NET Framework 3.0 開始引入，與WCF （Windows Communication Foundation）及 WF（Windows Workflow Fou... ...
  • 基於SqlSugar的開發框架循序漸進介紹（8）-- 在基類函數封裝實現用戶操作日誌記錄
    在我們對數據進行重要修改調整的時候，往往需要跟蹤記錄好用戶操作日誌。一般來說，如對重要表記錄的插入、修改、刪除都需要記錄下來，由於用戶操作日誌會帶來一定的額外消耗，因此我們通過配置的方式來決定記錄那些業務數據的重要調整。本篇隨筆介紹如何在基於SqlSugar的開發框架中，實現對用戶操作日誌記錄的配置... ...
  • 每次開機docker-desktop都啟動失敗了
    目錄 一、前景回顧 二、物理地址、線性地址和虛擬地址 三、記憶體為什麼要分頁 四、一級頁表 五、二級頁表 一、前景回顧 前面我們說到，保護模式下有著三大特點：地址映射、特權級和分時機制。從我的學習角度來說，我認為地址映射這一塊的知識點尤為繁雜，所以會花費相對比較多的時間來講述，話不多說，開整。 二、物 ...
  • Linux Accounting(中文翻譯): Delay Accounting
    Delay accounting 延時統計 任務在執行時等待某個內核資源會意外遇到延遲，例如可運行的任務正在等待空閑CPU。 per-task的延時統計功能測量下列情況下任務經歷的延遲： 正在等待CPU，waiting for a CPU (while being runnable) 同步塊I/O的 ...
  • 嘗鮮少代碼高性能的Svelte框架
    為什麼要使用Svelte Svelte 是一種全新的構建用戶界面的方法。傳統框架（如 React 和 Vue）在瀏覽器中完成大部分工作，而 Svelte 將這些工作轉移到構建應用程式時發生的編譯步驟。 Svelte 沒有使用虛擬 DOM diffing 之類的技術，而是編寫了在應用程式狀態發生變化時 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類