Vite2 + Vue3 + TypeScript + Pinia 搭建一套企業(yè)級(jí)的開發(fā)腳手架

搭建前準(zhǔn)備

  1. Vscode:前端人必備寫碼神器
  2. Chrome:對(duì)開發(fā)者非常友好的瀏覽器(反正我是很依賴它的)
  3. Nodejs&npm:配置本地開發(fā)環(huán)境,安裝 Node 后你會(huì)發(fā)現(xiàn) npm 也會(huì)一起安裝下來
  4. Vue.js devtools:瀏覽器調(diào)試插件
  5. Vue Language Features (Volar):Vscode 開發(fā) vue3 必備插件,提供語法高亮提示,非常好用
  6. Vue 3 Snippets:vue3 快捷輸入

Vue2 與 Vue3 的區(qū)別

Vue3由于完全由TS進(jìn)行重寫,在應(yīng)用中對(duì)類型判斷的定義和使用有很強(qiáng)的表現(xiàn)。同一對(duì)象的多個(gè)鍵返回值必須通過定義對(duì)應(yīng)的接口(interface)來進(jìn)行類型定義。要不然在 ESLint 時(shí)都會(huì)報(bào)錯(cuò)。

vue2 的雙向數(shù)據(jù)綁定是利用 ES5 的一個(gè) API Object.definePropert()對(duì)數(shù)據(jù)進(jìn)行劫持 結(jié)合 發(fā)布訂閱模式的方式來實(shí)現(xiàn)的。Vue3 中使用了 es6 的 ProxyAPI 對(duì)數(shù)據(jù)代理。

Vue3支持碎片(Fragments)

Vue2 與 Vue3 最大的區(qū)別: Vue2 使用Options API而 Vue3 使用的Composition API

生命周期鉤子變化:

Vue2 ~~~~~~~~~~~ vue3
beforeCreate  -> setup()
created       -> setup()
beforeMount   -> onBeforeMount
mounted       -> onMounted
beforeUpdate  -> onBeforeUpdate
updated       -> onUpdated
beforeDestroy -> onBeforeUnmount
destroyed     -> onUnmounted
activated     -> onActivated
deactivated   -> onDeactivated

介紹 vite

Vite:下一代前端開發(fā)與構(gòu)建工具

  • 極速的開發(fā)服務(wù)器啟動(dòng)
  • 輕量快速的熱模塊重載(HMR)
  • 豐富的功能
  • 自帶優(yōu)化的構(gòu)建
  • 通用的插件接口
  • 完全類型化的 API

Vite (法語意為 “迅速”,發(fā)音 /vit/)是一種全新的前端構(gòu)建工具,它極大地改善了前端開發(fā)體驗(yàn)。

它主要由兩部分組成:

  • 一個(gè)開發(fā)服務(wù)器,它基于 原生 ES 模塊 提供了 豐富的內(nèi)建功能,如速度快到驚人的 模塊熱更新(HMR)。
  • 一套構(gòu)建指令,它使用 Rollup 打包你的代碼,并且它是預(yù)配置的,可以輸出用于生產(chǎn)環(huán)境的優(yōu)化過的靜態(tài)資源。
  • Vite 意在提供開箱即用的配置,同時(shí)它的 插件 API 和 JavaScript API 帶來了高度的可擴(kuò)展性,并有完整的類型支持。

使用 vite 快速創(chuàng)建腳手架

兼容性注意:Vite 需要 Node.js 版本 >= 12.0.0。

  1. 第一步: 在需要?jiǎng)?chuàng)建項(xiàng)目文件目錄下打開 cmd 運(yùn)行以下命令
# npm 6.x
npm init @vitejs/app vite_vue3_ts --template

# npm 7+, 需要額外的雙橫線:
npm init @vitejs/app vite_vue3_ts -- --template

# yarn
yarn create @vitejs/app vite_vue3_ts --template 

這里我采用 yarn 來安裝

  1. 第二步: 選擇 vue回車 => vue-ts回車
  2. 第三步: cd 到項(xiàng)目文件夾,安裝依賴,啟動(dòng)項(xiàng)目
# 進(jìn)入項(xiàng)目文件夾
cd vite_vue3_ts
# 安裝依賴
yarn
# 啟動(dòng)
yarn dev

約束代碼風(fēng)格

Eslint 支持

# eslint 安裝
yarn add eslint --dev
# eslint 插件安裝
yarn add eslint-plugin-vue --dev

yarn add @typescript-eslint/eslint-plugin --dev

yarn add eslint-plugin-prettier --dev

# typescript parser
yarn add @typescript-eslint/parser --dev

注意: 如果 eslint 安裝報(bào)錯(cuò):
可以嘗試運(yùn)行以下命令:

yarn config set ignore-engines true

運(yùn)行成功后再次執(zhí)行 eslint 安裝命令

項(xiàng)目下新建 .eslintrc.js

配置 eslint 校驗(yàn)規(guī)則:

module.exports = {
  root: true,
  env: {
    browser: true,
    node: true,
    es2021: true,
  },
  parser: 'vue-eslint-parser',
  extends: [
    'eslint:recommended',
    'plugin:vue/vue3-recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:prettier/recommended',
    // eslint-config-prettier 的縮寫
    'prettier',
  ],
  parserOptions: {
    ecmaVersion: 12,
    parser: '@typescript-eslint/parser',
    sourceType: 'module',
    ecmaFeatures: {
      jsx: true,
    },
  },
  // eslint-plugin-vue @typescript-eslint/eslint-plugin eslint-plugin-prettier的縮寫
  plugins: ['vue', '@typescript-eslint', 'prettier'],
  rules: {
    '@typescript-eslint/ban-ts-ignore': 'off',
    '@typescript-eslint/no-unused-vars': 'off',
    '@typescript-eslint/explicit-function-return-type': 'off',
    '@typescript-eslint/no-explicit-any': 'off',
    '@typescript-eslint/no-var-requires': 'off',
    '@typescript-eslint/no-empty-function': 'off',
    '@typescript-eslint/no-use-before-define': 'off',
    '@typescript-eslint/ban-ts-comment': 'off',
    '@typescript-eslint/ban-types': 'off',
    '@typescript-eslint/no-non-null-assertion': 'off',
    '@typescript-eslint/explicit-module-boundary-types': 'off',
    'no-var': 'error',
    'prettier/prettier': 'error',
    // 禁止出現(xiàn)console
    'no-console': 'warn',
    // 禁用debugger
    'no-debugger': 'warn',
    // 禁止出現(xiàn)重復(fù)的 case 標(biāo)簽
    'no-duplicate-case': 'warn',
    // 禁止出現(xiàn)空語句塊
    'no-empty': 'warn',
    // 禁止不必要的括號(hào)
    'no-extra-parens': 'off',
    // 禁止對(duì) function 聲明重新賦值
    'no-func-assign': 'warn',
    // 禁止在 return、throw、continue 和 break 語句之后出現(xiàn)不可達(dá)代碼
    'no-unreachable': 'warn',
    // 強(qiáng)制所有控制語句使用一致的括號(hào)風(fēng)格
    curly: 'warn',
    // 要求 switch 語句中有 default 分支
    'default-case': 'warn',
    // 強(qiáng)制盡可能地使用點(diǎn)號(hào)
    'dot-notation': 'warn',
    // 要求使用 === 和 !==
    eqeqeq: 'warn',
    // 禁止 if 語句中 return 語句之后有 else 塊
    'no-else-return': 'warn',
    // 禁止出現(xiàn)空函數(shù)
    'no-empty-function': 'warn',
    // 禁用不必要的嵌套塊
    'no-lone-blocks': 'warn',
    // 禁止使用多個(gè)空格
    'no-multi-spaces': 'warn',
    // 禁止多次聲明同一變量
    'no-redeclare': 'warn',
    // 禁止在 return 語句中使用賦值語句
    'no-return-assign': 'warn',
    // 禁用不必要的 return await
    'no-return-await': 'warn',
    // 禁止自我賦值
    'no-self-assign': 'warn',
    // 禁止自身比較
    'no-self-compare': 'warn',
    // 禁止不必要的 catch 子句
    'no-useless-catch': 'warn',
    // 禁止多余的 return 語句
    'no-useless-return': 'warn',
    // 禁止變量聲明與外層作用域的變量同名
    'no-shadow': 'off',
    // 允許delete變量
    'no-delete-var': 'off',
    // 強(qiáng)制數(shù)組方括號(hào)中使用一致的空格
    'array-bracket-spacing': 'warn',
    // 強(qiáng)制在代碼塊中使用一致的大括號(hào)風(fēng)格
    'brace-style': 'warn',
    // 強(qiáng)制使用駱駝拼寫法命名約定
    camelcase: 'warn',
    // 強(qiáng)制使用一致的縮進(jìn)
    indent: 'off',
    // 強(qiáng)制在 JSX 屬性中一致地使用雙引號(hào)或單引號(hào)
    // 'jsx-quotes': 'warn',
    // 強(qiáng)制可嵌套的塊的最大深度4
    'max-depth': 'warn',
    // 強(qiáng)制最大行數(shù) 300
    // "max-lines": ["warn", { "max": 1200 }],
    // 強(qiáng)制函數(shù)最大代碼行數(shù) 50
    // 'max-lines-per-function': ['warn', { max: 70 }],
    // 強(qiáng)制函數(shù)塊最多允許的的語句數(shù)量20
    'max-statements': ['warn', 100],
    // 強(qiáng)制回調(diào)函數(shù)最大嵌套深度
    'max-nested-callbacks': ['warn', 3],
    // 強(qiáng)制函數(shù)定義中最多允許的參數(shù)數(shù)量
    'max-params': ['warn', 3],
    // 強(qiáng)制每一行中所允許的最大語句數(shù)量
    'max-statements-per-line': ['warn', { max: 1 }],
    // 要求方法鏈中每個(gè)調(diào)用都有一個(gè)換行符
    'newline-per-chained-call': ['warn', { ignoreChainWithDepth: 3 }],
    // 禁止 if 作為唯一的語句出現(xiàn)在 else 語句中
    'no-lonely-if': 'warn',
    // 禁止空格和 tab 的混合縮進(jìn)
    'no-mixed-spaces-and-tabs': 'warn',
    // 禁止出現(xiàn)多行空行
    'no-multiple-empty-lines': 'warn',
    // 禁止出現(xiàn);
    semi: ['warn', 'never'],
    // 強(qiáng)制在塊之前使用一致的空格
    'space-before-blocks': 'warn',
    // 強(qiáng)制在 function的左括號(hào)之前使用一致的空格
    // 'space-before-function-paren': ['warn', 'never'],
    // 強(qiáng)制在圓括號(hào)內(nèi)使用一致的空格
    'space-in-parens': 'warn',
    // 要求操作符周圍有空格
    'space-infix-ops': 'warn',
    // 強(qiáng)制在一元操作符前后使用一致的空格
    'space-unary-ops': 'warn',
    // 強(qiáng)制在注釋中 // 或 /* 使用一致的空格
    // "spaced-comment": "warn",
    // 強(qiáng)制在 switch 的冒號(hào)左右有空格
    'switch-colon-spacing': 'warn',
    // 強(qiáng)制箭頭函數(shù)的箭頭前后使用一致的空格
    'arrow-spacing': 'warn',
    'no-var': 'warn',
    'prefer-const': 'warn',
    'prefer-rest-params': 'warn',
    'no-useless-escape': 'warn',
    'no-irregular-whitespace': 'warn',
    'no-prototype-builtins': 'warn',
    'no-fallthrough': 'warn',
    'no-extra-boolean-cast': 'warn',
    'no-case-declarations': 'warn',
    'no-async-promise-executor': 'warn',
  },
  globals: {
    defineProps: 'readonly',
    defineEmits: 'readonly',
    defineExpose: 'readonly',
    withDefaults: 'readonly',
  },
}

項(xiàng)目下新建 .eslintignore

# eslint 忽略檢查 (根據(jù)項(xiàng)目需要自行添加)
node_modules
dist

prettier 支持

# 安裝 prettier
yarn add prettier --dev

解決 eslint 和 prettier 沖突

解決 ESLint 中的樣式規(guī)范和 prettier 中樣式規(guī)范的沖突,以 prettier 的樣式規(guī)范為準(zhǔn),使 ESLint 中的樣式規(guī)范自動(dòng)失效

# 安裝插件 eslint-config-prettier
yarn add eslint-config-prettier --dev

項(xiàng)目下新建 .prettier.js

配置 prettier 格式化規(guī)則:

module.exports = {
  tabWidth: 2,
  jsxSingleQuote: true,
  jsxBracketSameLine: true,
  printWidth: 100,
  singleQuote: true,
  semi: false,
  overrides: [
    {
      files: '*.json',
      options: {
        printWidth: 200,
      },
    },
  ],
  arrowParens: 'always',
}

項(xiàng)目下新建 .prettierignore

# 忽略格式化文件 (根據(jù)項(xiàng)目需要自行添加)
node_modules
dist

package.json 配置:

{
  "script": {
    "lint": "eslint src --fix --ext .ts,.tsx,.vue,.js,.jsx",
    "prettier": "prettier --write ."
  }
}

上面配置完成后,可以運(yùn)行以下命令測(cè)試下代碼檢查個(gè)格式化效果:

# eslint 檢查
yarn lint
# prettier 自動(dòng)格式化
yarn prettier

配置 husky + lint-staged

使用husky + lint-staged助力團(tuán)隊(duì)編碼規(guī)范, husky&lint-staged 安裝推薦使用 mrm, 它將根據(jù) package.json 依賴項(xiàng)中的代碼質(zhì)量工具來安裝和配置 husky 和 lint-staged,因此請(qǐng)確保在此之前安裝并配置所有代碼質(zhì)量工具,如 Prettier 和 ESlint

首先安裝 mrm

npm i mrm -D --registry=https://registry.npm.taobao.org

husky 是一個(gè)為 git 客戶端增加 hook 的工具。安裝后,它會(huì)自動(dòng)在倉(cāng)庫中的 .git/ 目錄下增加相應(yīng)的鉤子;比如 pre-commit 鉤子就會(huì)在你執(zhí)行 git commit 的觸發(fā)。

那么我們可以在 pre-commit 中實(shí)現(xiàn)一些比如 lint 檢查、單元測(cè)試、代碼美化等操作。當(dāng)然,pre-commit 階段執(zhí)行的命令當(dāng)然要保證其速度不要太慢,每次 commit 都等很久也不是什么好的體驗(yàn)。

lint-staged,一個(gè)僅僅過濾出 Git 代碼暫存區(qū)文件(被 git add 的文件)的工具;這個(gè)很實(shí)用,因?yàn)槲覀內(nèi)绻麑?duì)整個(gè)項(xiàng)目的代碼做一個(gè)檢查,可能耗時(shí)很長(zhǎng),如果是老項(xiàng)目,要對(duì)之前的代碼做一個(gè)代碼規(guī)范檢查并修改的話,這可能就麻煩了呀,可能導(dǎo)致項(xiàng)目改動(dòng)很大。

所以這個(gè) lint-staged,對(duì)團(tuán)隊(duì)項(xiàng)目和開源項(xiàng)目來說,是一個(gè)很好的工具,它是對(duì)個(gè)人要提交的代碼的一個(gè)規(guī)范和約束

安裝 lint-staged

mrm 安裝 lint-staged 會(huì)自動(dòng)把 husky 一起安裝下來

npx mrm lint-staged

安裝成功后會(huì)發(fā)現(xiàn) package.json 中多了一下幾個(gè)配置:



因?yàn)槲覀円Y(jié)合 prettier 代碼格式化,所以修改一下配置:

"husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,jsx,vue,ts,tsx}": [
      "yarn lint",
      "prettier --write",
      "git add"
    ]
  }

好了,到這里代碼格式化配置基本大功告成了!!!
可以修改部分代碼嘗試 git commit ,你會(huì)發(fā)現(xiàn)代碼將自動(dòng)格式化:
提交前的代碼(發(fā)現(xiàn)編輯器爆紅了):



執(zhí)行 commit 操作,控制臺(tái)可以看到走了哪些流程:



commit 后的代碼,是不是已經(jīng)被格式化了

配置文件引用別名 alias

直接修改 vite.config.ts 文件配置:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import path from 'path'

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [vue()],
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src'),
    },
  },
})

修改 tsconfig.json

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    "strict": true,
    "jsx": "preserve",
    "sourceMap": true,
    "resolveJsonModule": true,
    "esModuleInterop": true,
    "lib": ["esnext", "dom"],
    "baseUrl": ".",
    "paths": {
      "@/*":["src/*"]
    }
  },
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
}

配置 css 預(yù)處理器 scss

雖然 vite 原生支持 less/sass/scss/stylus,但是你必須手動(dòng)安裝他們的預(yù)處理器依賴

安裝

yarn add sass-loader --dev
yarn add dart-sass --dev
yarn add sass --dev

配置全局 scss 樣式文件

在 src/assets 下新增 style 文件夾,用于存放全局樣式文件
新建 main.scss, 設(shè)置一個(gè)用于測(cè)試的顏色變量 :

$test-color: red;

如何將這個(gè)全局樣式文件全局注入到項(xiàng)目中呢?配置 Vite 即可:

css:{
    preprocessorOptions:{
      scss:{
        additionalData:'@import "@/assets/style/mian.scss";'
      }
    }
  },

組件中使用

不需要任何引入可以直接使用全局scss定義的變量

.test{
  color: $test-color;
}

路由

# 安裝路由
yarn add vue-router@4

在 src 文件下新增 router 文件夾 => router.ts 文件,內(nèi)容如下:

import { createRouter, createWebHistory, RouteRecordRaw } from 'vue-router'

const routes: RouteRecordRaw[] = [
  {
    path: '/',
    name: 'Login',
    component: () => import('@/pages/login/Login.vue'), // 注意這里要帶上 文件后綴.vue
  },
]

const router = createRouter({
  history: createWebHistory(),
  routes,
})

export default router

修改入口文件 mian.ts :

import { createApp } from 'vue'
import App from './App.vue'
import router from './router/index'

const app = createApp(App)

app.use(router)

app.mount('#app')

到這里路由的基礎(chǔ)配置已經(jīng)完成了,更多配置信息可以查看 vue-router 官方文檔:
vue-router: https://next.router.vuejs.org/zh/guide/
vue-router4.x 支持 typescript,配置路由的類型是 RouteRecordRaw,這里 meta 可以讓我們有更多的發(fā)揮空間,這里提供一些參考:

  • title:string; 頁面標(biāo)題,通常必選。
  • icon?:string; 圖標(biāo),一般配合菜單使用。
  • auth?:boolean; 是否需要登錄權(quán)限。
  • ignoreAuth?:boolean; 是否忽略權(quán)限。
  • roles?:RoleEnum[]; 可以訪問的角色。
  • keepAlive?:boolean; 是否開啟頁面緩存
  • hideMenu?:boolean; 有些路由我們并不想在菜單中顯示,比如某些編輯頁面。
  • order?:number; 菜單排序。
  • frameUrl?:string; 嵌套外鏈。
    這里只提供一些思路,每個(gè)項(xiàng)目涉及到的業(yè)務(wù)都會(huì)存在些差異,這里就不作詳細(xì)講解了,根據(jù)自己業(yè)務(wù)需求做配置即可。

統(tǒng)一請(qǐng)求封裝

使用過 vue2.x 的同學(xué)應(yīng)該對(duì) axios 很熟悉了,這里我們直接使用 axios 做封裝:

# 安裝 axios
yarn add axios
# 安裝 nprogress 用于請(qǐng)求 loading
# 也可以根據(jù)項(xiàng)目需求自定義其它 loading
yarn add nprogress
# 類型聲明,或者添加一個(gè)包含 `declare module 'nprogress'
yarn add @types/nprogress --dev

實(shí)際使用中可以根據(jù)項(xiàng)目修改,比如RESTful api中可以自行添加put和delete請(qǐng)求,ResType也可以根據(jù)后端的通用返回值動(dòng)態(tài)的去修改

新增 service 文件夾,service 下新增 http.ts 文件以及 api 文件夾:


http.ts : 用于axios封裝

//http.ts
import axios, { AxiosRequestConfig } from 'axios'
import NProgress from 'nprogress'

// 設(shè)置請(qǐng)求頭和請(qǐng)求路徑
axios.defaults.baseURL = '/api'
axios.defaults.timeout = 10000
axios.defaults.headers.post['Content-Type'] = 'application/json;charset=UTF-8'
axios.interceptors.request.use(
  (config): AxiosRequestConfig<any> => {
    const token = window.sessionStorage.getItem('token')
    if (token) {
      //@ts-ignore
      config.headers.token = token
    }
    return config
  },
  (error) => {
    return error
  }
)
// 響應(yīng)攔截
axios.interceptors.response.use((res) => {
  if (res.data.code === 111) {
    sessionStorage.setItem('token', '')
    // token過期操作
  }
  return res
})

interface ResType<T> {
  code: number
  data?: T
  msg: string
  err?: string
}
interface Http {
  get<T>(url: string, params?: unknown): Promise<ResType<T>>
  post<T>(url: string, params?: unknown): Promise<ResType<T>>
  upload<T>(url: string, params: unknown): Promise<ResType<T>>
  download(url: string): void
}

const http: Http = {
  get(url, params) {
    return new Promise((resolve, reject) => {
      NProgress.start()
      axios
        .get(url, { params })
        .then((res) => {
          NProgress.done()
          resolve(res.data)
        })
        .catch((err) => {
          NProgress.done()
          reject(err.data)
        })
    })
  },
  post(url, params) {
    return new Promise((resolve, reject) => {
      NProgress.start()
      axios
        .post(url, JSON.stringify(params))
        .then((res) => {
          NProgress.done()
          resolve(res.data)
        })
        .catch((err) => {
          NProgress.done()
          reject(err.data)
        })
    })
  },
  upload(url, file) {
    return new Promise((resolve, reject) => {
      NProgress.start()
      axios
        .post(url, file, {
          headers: { 'Content-Type': 'multipart/form-data' },
        })
        .then((res) => {
          NProgress.done()
          resolve(res.data)
        })
        .catch((err) => {
          NProgress.done()
          reject(err.data)
        })
    })
  },
  download(url) {
    const iframe = document.createElement('iframe')
    iframe.style.display = 'none'
    iframe.src = url
    iframe.onload = function () {
      document.body.removeChild(iframe)
    }
    document.body.appendChild(iframe)
  },
}
export default http

api : 項(xiàng)目中接口做統(tǒng)一管理,按照模塊來劃分
在 api 文件下新增 login 文件夾,用于存放登錄模塊的請(qǐng)求接口,login 文件夾下分別新增 login.ts types.ts :

login.ts:

import http from '@/service/http'
import * as T from './types'

const loginApi: T.ILoginApi = {
    login(params){
        return http.post('/login', params)
    }

}
export default loginApi

types.ts:

export interface ILoginParams {
    userName: string
    passWord: string | number
}
export interface ILoginApi {
    login: (params: ILoginParams)=> Promise<any>
}

至此,一個(gè)簡(jiǎn)單地請(qǐng)求封裝完成了!!!!
除了自己手動(dòng)封裝 axios ,這里還推薦一個(gè) vue3 的請(qǐng)求庫: VueRequest,非常好用,下面來看看 VueRequest有哪些比較好用的功能吧!!!

  • 所有數(shù)據(jù)都具有響應(yīng)式
  • 輪詢請(qǐng)求
  • 自動(dòng)處理錯(cuò)誤重試
  • 內(nèi)置請(qǐng)求緩存
  • 節(jié)流請(qǐng)求與防抖請(qǐng)求
  • 聚焦頁面時(shí)自動(dòng)重新請(qǐng)求
  • 強(qiáng)大的分頁擴(kuò)展以及加載更多擴(kuò)展
  • 完全使用 Typescript 編寫,具有強(qiáng)大的類型提示
  • 兼容 Vite
  • 輕量化
  • 開箱即用

    是不是很強(qiáng)大 ??
    官網(wǎng)鏈接: https://www.attojs.com/

狀態(tài)管理 pinia

由于 vuex 4 對(duì) typescript 的支持讓人感到難過,所以狀態(tài)管理?xiàng)売昧?vuex 而采取了 pinia. pinia 的作者是 Vue 核心團(tuán)隊(duì)成員
尤大好像說 pinia 可能會(huì)代替 vuex,所以請(qǐng)放心使用。

安裝 pinia

Pinia 與 Vuex 的區(qū)別:

  • id 是必要的,它將所使用 store 連接到 devtools。
  • 創(chuàng)建方式:new Vuex.Store(...)(vuex3),createStore(...)(vuex4)。
  • 對(duì)比于 vuex3 ,state 現(xiàn)在是一個(gè)函數(shù)返回對(duì)象。
  • 沒有 mutations,不用擔(dān)心,state 的變化依然記錄在 devtools 中。
# 安裝
yarn add pinia@next

main.ts 中增加

# 引入
import { createPinia } from "pinia"
# 創(chuàng)建根存儲(chǔ)庫并將其傳遞給應(yīng)用程序
app.use(createPinia())

在 src 文件夾下新增 store 文件夾,接在 store 中新增 main.ts

創(chuàng)建 store, mian.ts :

import { defineStore } from 'pinia'

export const useMainStore = defineStore({
  id: 'mian',
  state: () =>({
    name: '超級(jí)管理員'
  })
})

組建中獲取 store :

<template>
  <div>{{mainStore.name}}</div>
</template>

<script setup lang="ts">
import { useMainStore } from "@/store/mian"

const mainStore = useMainStore()

</script>

getters 用法介紹

Pinia 中的 getter 與 Vuex 中的 getter 、組件中的計(jì)算屬性具有相同的功能
store => mian.ts

import { defineStore } from 'pinia'

export const useMainStore = defineStore({
  id: 'mian',
  state: () => ({
    name: '超級(jí)管理員',
  }),
  // getters
  getters: {
    nameLength: (state) => state.name.length,
  }
})

組件中使用:

<template>
  <div>用戶名:{{ mainStore.name }}<br />長(zhǎng)度:{{ mainStore.nameLength }}</div>
  <hr/>
  <button @click="updateName">修改store中的name</button>
</template>

<script setup lang="ts">
import { useMainStore } from '@/store/mian'

const mainStore = useMainStore()

const updateName = ()=>{
  // $patch 修改 store 中的數(shù)據(jù)
  mainStore.$patch({
    name: '名稱被修改了,nameLength也隨之改變了'
  })
}
</script>

actions

這里與 Vuex 有極大的不同,Pinia 僅提供了一種方法來定義如何更改狀態(tài)的規(guī)則,放棄 mutations 只依靠 Actions,這是一項(xiàng)重大的改變。
Pinia 讓 Actions 更加的靈活:

  • 可以通過組件或其他 action 調(diào)用
  • 可以從其他 store 的 action 中調(diào)用
  • 直接在 store 實(shí)例上調(diào)用
  • 支持同步或異步
  • 有任意數(shù)量的參數(shù)
  • 可以包含有關(guān)如何更改狀態(tài)的邏輯(也就是 vuex 的 mutations 的作用)
  • 可以 $patch 方法直接更改狀態(tài)屬性
import { defineStore } from 'pinia'

export const useMainStore = defineStore({
  id: 'mian',
  state: () => ({
    name: '超級(jí)管理員',
  }),
  getters: {
    nameLength: (state) => state.name.length,
  },
  actions: {
    async insertPost(data:string){
      // 可以做異步
      // await doAjaxRequest(data);
      this.name = data;
    }
  },
})

環(huán)境變量配置

vite 提供了兩種模式:具有開發(fā)服務(wù)器的開發(fā)模式(development)和生產(chǎn)模式(production)
項(xiàng)目根目錄新建:.env.development :

NODE_ENV=development

VITE_APP_WEB_URL= 'YOUR WEB URL'

項(xiàng)目根目錄新建:.env.production :

NODE_ENV=production

VITE_APP_WEB_URL= 'YOUR WEB URL'

組件中使用:

console.log(import.meta.env.VITE_APP_WEB_URL)

配置 package.json:
打包區(qū)分開發(fā)環(huán)境和生產(chǎn)環(huán)境

"build:dev": "vue-tsc --noEmit && vite build --mode development",
"build:pro": "vue-tsc --noEmit && vite build --mode production",

使用組件庫 Naive UI

組件庫選擇,這里我們選擇 Naive UI 至于為什么選擇它?我可以直接說尤大大推薦的嗎?
官方介紹:

  • 一個(gè) Vue 3 組件庫
  • 比較完整,主題可調(diào),使用 TypeScript,不算太慢
  • 有點(diǎn)意思

介紹還是比較謙虛的,既然尤大推薦,肯定有它的優(yōu)勢(shì)了!!!

安裝 Naive UI

# 安裝 組件庫
yarn add naive-ui
# 安裝 字體
yarn add vfonts

如何使用

import { NButton } from "naive-ui"
<n-button>naive-ui</n-button>

全局配置 Config Provider

全局化配置設(shè)置內(nèi)部組件的主題、語言和組件卸載于其他位置的 DOM 的類名。

<n-config-provider :locale="zhCN" :theme="theme">
    <!-- 容器 -->
</n-config-provider>

尤其是主題配置這個(gè)功能,我真的很喜歡 ??
組件庫選擇上不做任何強(qiáng)制,根據(jù)自己的項(xiàng)目需要選擇合適的組件庫即可

Vite 常用基礎(chǔ)配置

基礎(chǔ)配置

運(yùn)行 代理 和 打包 配置

server: {
    host: '0.0.0.0',
    port: 3000,
    open: true,
    https: false,
    proxy: {}
},

生產(chǎn)環(huán)境去除 console debugger

build:{
  ...
  terserOptions: {
      compress: {
        drop_console: true,
        drop_debugger: true
      }
  }
}

生產(chǎn)環(huán)境生成 .gz 文件

開啟 gzip 可以極大的壓縮靜態(tài)資源,對(duì)頁面加載的速度起到了顯著的作用。
使用 vite-plugin-compression 可以 gzip 或 brotli 的方式來壓縮資源,這一步需要服務(wù)器端的配合,vite 只能幫你打包出 .gz 文件。此插件使用簡(jiǎn)單,你甚至無需配置參數(shù),引入即可。

# 安裝
yarn add --dev vite-plugin-compression

plugins 中添加:

import viteCompression from 'vite-plugin-compression'

// gzip壓縮 生產(chǎn)環(huán)境生成 .gz 文件
viteCompression({
      verbose: true,
      disable: false,
      threshold: 10240,
      algorithm: 'gzip',
      ext: '.gz',
    }),

最終 vite.config.ts

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import path from 'path'
//@ts-ignore
import viteCompression from 'vite-plugin-compression'

// https://vitejs.dev/config/
export default defineConfig({
  base: './', //打包路徑
  plugins: [
    vue(),
    // gzip壓縮 生產(chǎn)環(huán)境生成 .gz 文件
    viteCompression({
      verbose: true,
      disable: false,
      threshold: 10240,
      algorithm: 'gzip',
      ext: '.gz',
    }),
  ],
  // 配置別名
  resolve: {
    alias: {
      '@': path.resolve(__dirname, 'src'),
    },
  },
  css:{
    preprocessorOptions:{
      scss:{
        additionalData:'@import "@/assets/style/mian.scss";'
      }
    }
  },
  //啟動(dòng)服務(wù)配置
  server: {
    host: '0.0.0.0',
    port: 8000,
    open: true,
    https: false,
    proxy: {}
  },
  // 生產(chǎn)環(huán)境打包配置
  //去除 console debugger
  build: {
    terserOptions: {
      compress: {
        drop_console: true,
        drop_debugger: true,
      },
    },
  },
})

常用插件

可以查看官方文檔:https://vitejs.cn/plugins/

  • @vitejs/plugin-vue 提供 Vue 3 單文件組件支持
  • @vitejs/plugin-vue-jsx 提供 Vue 3 JSX 支持(通過 專用的 Babel 轉(zhuǎn)換插件)
  • @vitejs/plugin-legacy 為打包后的文件提供傳統(tǒng)瀏覽器兼容性支持
  • unplugin-vue-components 組件的按需自動(dòng)導(dǎo)入
  • vite-plugin-compression 使用 gzip 或者 brotli 來壓縮資源

非常推薦使用的 hooks 庫

因?yàn)関ue3.x和react hooks真的很像,所以就稱為 hooks
VueUse:https://vueuse.org/
看到這個(gè)庫的第一眼,讓我立馬想到了 react 的 ahooks
VueUse 是一個(gè)基于 Composition API 的實(shí)用函數(shù)集合。通俗的來說,這就是一個(gè)工具函數(shù)包,它可以幫助你快速實(shí)現(xiàn)一些常見的功能,免得你自己去寫,解決重復(fù)的工作內(nèi)容。以及進(jìn)行了基于 Composition API 的封裝。讓你在 vue3 中更加得心應(yīng)手

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,461評(píng)論 6 532
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,538評(píng)論 3 417
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,423評(píng)論 0 375
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,991評(píng)論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,761評(píng)論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,207評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,268評(píng)論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,419評(píng)論 0 288
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,959評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,782評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,983評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,528評(píng)論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,222評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,653評(píng)論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,901評(píng)論 1 286
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,678評(píng)論 3 392
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,978評(píng)論 2 374

推薦閱讀更多精彩內(nèi)容