Vue3+Vite 项目搭建基础依赖安装
简介
使用Vite + Vue3 + TS 开发的项目，在项目搭建初期，需要对项目加入必要的依赖，尤其是企业级开发时，对于项目的标准化工作，起到很重要的作用。
完整项目下载（未包含依赖项）：https://www.tzming.com/wp-content/uploads/2023/filesdown/vue3_admin_template.rar
完成基本后台项目下载：https://www.tzming.com/wp-content/uploads/2023/filesdown/vue3_admin.rar
1.项目初始化
一个项目要有统一的规范，需要使用eslint+stylelint+prettier来对我们的代码质量做检测和修复，需要使用husky来做commit拦截，需要使用commitlint来统一提交规范，需要使用preinstall来统一包管理工具。
环境准备
- node v16.14.2
- pnpm 8.0.0
pnpm安装指令
npm i -g pnpm
项目初始化命令
pnpm create vite
进入到项目根目录pnpm install安装全部依赖.安装完依赖运行程序:
pnpm run dev
运行完毕项目跑在http://127.0.0.1:5173/,可以访问你得项目啦
多环境下process.env的说明
在一个项目中，我们都会有开发环境和生产环境，对于这两个不同的环境，我们可能使用的变量有所不同，例如api请求地址，通常都是根据不同环境不同地址，我们可以预先设置多环境变量，使得它在开发或打包后自动切换不同的环境变量。
process.env 是Node 框架下的定义多环境变量，我们可以通过以下代码来获取当前环境是开发环境还是生产环境：
process.env.NODE_ENV对于Vue项目而言，我们可以通过创建 .env.development 或 .env.production 文件来存储开发或生产环境对应的变量
注意：Vue 中约定变量名必须以 "VUE_APP_" 开头(除了NODE_ENV外)，才可以被访问到，如：
VUE_APP_BASE_API = '/prod-api'
VUE_APP_abc = 'xxx'
2.ESLint
ESLint配置
eslint中文官网:http://eslint.cn/
ESLint最初是由Nicholas C. Zakas 于2013年6月创建的开源项目。它的目标是提供一个插件化的javascript代码检测工具
首先安装eslint
pnpm i eslint -D
生成配置文件:.eslint.cjs
npx eslint --init
.eslint.cjs 的默认配置文件说明
module.exports = {
//运行环境
"env": {
"browser": true,//浏览器端
"es2021": true,//es2021
},
//规则继承
"extends": [
//全部规则默认是关闭的,这个配置项开启推荐规则,推荐规则参照文档
//比如:函数不能重名、对象不能出现重复key
"eslint:recommended",
//vue3语法规则
"plugin:vue/vue3-essential",
//ts语法规则
"plugin:@typescript-eslint/recommended"
],
//要为特定类型的文件指定处理器
"overrides": [
],
//指定解析器:解析器
//Esprima 默认解析器
//Babel-ESLint babel解析器
//@typescript-eslint/parser ts解析器
"parser": "@typescript-eslint/parser",
//指定解析器选项
"parserOptions": {
"ecmaVersion": "latest",//校验ECMA最新版本
"sourceType": "module"//设置为"script"（默认），或者"module"代码在ECMAScript模块中
},
//ESLint支持使用第三方插件。在使用插件之前，您必须使用npm安装它
//该eslint-plugin-前缀可以从插件名称被省略
"plugins": [
"vue",
"@typescript-eslint"
],
//eslint规则
"rules": {
}
}
vue3环境代码校验插件
这是对于Vue3 的 ESLint 代码校验所需要的插件
# 让所有与prettier规则存在冲突的Eslint rules失效，并使用prettier进行代码检查
"eslint-config-prettier": "^8.6.0",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-node": "^11.1.0",
# 运行更漂亮的Eslint，使prettier规则优先级更高，Eslint优先级低
"eslint-plugin-prettier": "^4.2.1",
# vue.js的Eslint插件（查找vue语法错误，发现错误指令，查找违规风格指南
"eslint-plugin-vue": "^9.9.0",
# 该解析器允许使用Eslint校验所有babel code
"@babel/eslint-parser": "^7.19.1",
安装指令
pnpm install -D eslint-plugin-import eslint-plugin-vue eslint-plugin-node eslint-plugin-prettier eslint-config-prettier eslint-plugin-node @babel/eslint-parser
修改.eslintrc.cjs配置文件
// @see https://eslint.bootcss.com/docs/rules/
module.exports = {
env: {
browser: true,
es2021: true,
node: true,
jest: true,
},
/* 指定如何解析语法 */
parser: 'vue-eslint-parser',
/** 优先级低于 parse 的语法解析配置 */
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
parser: '@typescript-eslint/parser',
jsxPragma: 'React',
ecmaFeatures: {
jsx: true,
},
},
/* 继承已有的规则 */
extends: [
'eslint:recommended',
'plugin:vue/vue3-essential',
'plugin:@typescript-eslint/recommended',
'plugin:prettier/recommended',
],
plugins: ['vue', '@typescript-eslint'],
/*
* "off" 或 0 ==> 关闭规则
* "warn" 或 1 ==> 打开的规则作为警告（不影响代码执行）
* "error" 或 2 ==> 规则作为一个错误（代码不能执行，界面报错）
*/
rules: {
// eslint（https://eslint.bootcss.com/docs/rules/）
'no-var': 'error', // 要求使用 let 或 const 而不是 var
'no-multiple-empty-lines': ['warn', { max: 1 }], // 不允许多个空行
'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
'no-unexpected-multiline': 'error', // 禁止空余的多行
'no-useless-escape': 'off', // 禁止不必要的转义字符
// typeScript (https://typescript-eslint.io/rules)
'@typescript-eslint/no-unused-vars': 'error', // 禁止定义未使用的变量
'@typescript-eslint/prefer-ts-expect-error': 'error', // 禁止使用 @ts-ignore
'@typescript-eslint/no-explicit-any': 'off', // 禁止使用 any 类型
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-namespace': 'off', // 禁止使用自定义 TypeScript 模块和命名空间。
'@typescript-eslint/semi': 'off',
// eslint-plugin-vue (https://eslint.vuejs.org/rules/)
'vue/multi-word-component-names': 'off', // 要求组件名称始终为 “-” 链接的单词
'vue/script-setup-uses-vars': 'error', // 防止<script setup>使用的变量<template>被标记为未使用
'vue/no-mutating-props': 'off', // 不允许组件 prop的改变
'vue/attribute-hyphenation': 'off', // 对模板中的自定义组件强制执行属性命名样式
},
}
创建 .eslintignore 忽略文件
在项目根目录下创建文件.eslintignore ，并把不需要ESLint校验的文件或目录写进去
dist
node_modules
添加 ESLint 运行脚本
package.json新增两个运行脚本
"scripts": {
"lint": "eslint src",
"fix": "eslint src --fix",
}
3.Prettier
有了eslint，为什么还要有prettier？eslint针对的是javascript，他是一个检测工具，包含js语法以及少部分格式问题，在eslint看来，语法对了就能保证代码正常运行，格式问题属于其次；
而prettier属于格式化工具，它看不惯格式不统一，所以它就把eslint没干好的事接着干，另外，prettier支持
包含js在内的多种语言。
总结起来，eslint和prettier这俩兄弟一个保证js代码质量，一个保证代码美观。
安装Prettier
pnpm install -D eslint-plugin-prettier prettier eslint-config-prettier
创建prettierrc.json文件并添加规则
{
"singleQuote": true, // 字符串是否格式化为单引号
"semi": false,
"bracketSpacing": true,
"htmlWhitespaceSensitivity": "ignore",
"endOfLine": "auto",
"trailingComma": "all",
"tabWidth": 2 // 代码缩进空格数
}
创建.prettierignore忽略文件
对于不需要格式化代码的目录或文件，需要在项目根目录下创建文件并定义
/dist/*
/html/*
.local
/node_modules/**
**/*.svg
**/*.sh
/public/*通过pnpm run lint去检测语法，如果出现不规范格式,通过pnpm run fix 修改
4.stylelint
stylelint为css的lint工具。可格式化css代码，检查css语法错误与不合理的写法，指定css书写顺序等。
安装SCSS依赖
pnpm add sass sass-loader stylelint postcss postcss-scss postcss-html stylelint-config-prettier stylelint-config-recess-order stylelint-config-recommended-scss stylelint-config-standard stylelint-config-standard-vue stylelint-scss stylelint-order stylelint-config-standard-scss -D
创建 .stylelintrc.cjs 配置文件
详细配置说明官网:https://stylelint.bootcss.com/
// @see https://stylelint.bootcss.com/
module.exports = {
extends: [
'stylelint-config-standard', // 配置stylelint拓展插件
'stylelint-config-html/vue', // 配置 vue 中 template 样式格式化
'stylelint-config-standard-scss', // 配置stylelint scss插件
'stylelint-config-recommended-vue/scss', // 配置 vue 中 scss 样式格式化
'stylelint-config-recess-order', // 配置stylelint css属性书写顺序插件,
'stylelint-config-prettier', // 配置stylelint和prettier兼容
],
overrides: [
{
files: ['**/*.(scss|css|vue|html)'],
customSyntax: 'postcss-scss',
},
{
files: ['**/*.(html|vue)'],
customSyntax: 'postcss-html',
},
],
ignoreFiles: [
'**/*.js',
'**/*.jsx',
'**/*.tsx',
'**/*.ts',
'**/*.json',
'**/*.md',
'**/*.yaml',
],
/**
* null => 关闭该规则
* always => 必须
*/
rules: {
'value-keyword-case': null, // 在 css 中使用 v-bind，不报错
'no-descending-specificity': null, // 禁止在具有较高优先级的选择器后出现被其覆盖的较低优先级的选择器
'function-url-quotes': 'always', // 要求或禁止 URL 的引号 "always(必须加上引号)"|"never(没有引号)"
'no-empty-source': null, // 关闭禁止空源码
'selector-class-pattern': null, // 关闭强制选择器类名的格式
'property-no-unknown': null, // 禁止未知的属性(true 为不允许)
'block-opening-brace-space-before': 'always', //大括号之前必须有一个空格或不能有空白符
'value-no-vendor-prefix': null, // 关闭 属性值前缀 --webkit-box
'property-no-vendor-prefix': null, // 关闭 属性前缀 -webkit-mask
'selector-pseudo-class-no-unknown': [
// 不允许未知的选择器
true,
{
ignorePseudoClasses: ['global', 'v-deep', 'deep'], // 忽略属性，修改element默认样式的时候能使用到
},
],
},
}
创建 .stylelintignore 忽略文件
/node_modules/*
/dist/*
/html/*
/public/*
创建运行脚本
在 package.json 中加入运行命令
"scripts": {
"lint:style": "stylelint src/**/*.{css,scss,vue} --cache --fix"
}最后配置统一的prettier来格式化我们的js和css，html代码
"scripts": {
"dev": "vite --open",
"build": "vue-tsc && vite build",
"preview": "vite preview",
"lint": "eslint src",
"fix": "eslint src --fix",
"format": "prettier --write \"./**/*.{html,vue,ts,js,json,md}\"",
"lint:eslint": "eslint src/**/*.{ts,vue} --cache --fix",
"lint:style": "stylelint src/**/*.{css,scss,vue} --cache --fix"
},
当我们运行pnpm run format 的时候，会把代码直接格式化
5.husky
在上面我们已经集成好了我们代码校验工具，但是需要每次手动的去执行命令才会格式化我们的代码。如果有人没有格式化就提交了远程仓库中，那这个规范就没什么用。所以我们需要强制让开发人员按照代码规范来提交。
要做到这件事情，就需要利用husky在代码提交之前触发git hook(git在客户端的钩子)，然后执行pnpm run format来自动的格式化我们的代码。
安装husky
pnpm install -D husky
执行husky初始化
npx husky-init
初始化后会在根目录下生成个一个.husky目录，在这个目录下面会有一个pre-commit文件，这个文件里面的命令在我们执行commit的时候就会执行
在.husky/pre-commit文件添加如下命令：
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
pnpm run format
当我们对代码进行commit操作的时候，就会执行命令，对代码进行格式化，然后再提交。
6.CommitLint
对于我们的commit信息，也是有统一规范的，不能随便写,要让每个人都按照统一的标准来执行，我们可以利用commitlint来实现。
安装CommitLint
pnpm add @commitlint/config-conventional @commitlint/cli -D
新建 commitlint.config.cjs 文件
在项目根目录下创建文件
module.exports = {
extends: ['@commitlint/config-conventional'],
// 校验规则
rules: {
'type-enum': [
2,
'always',
[
'feat',
'fix',
'docs',
'style',
'refactor',
'perf',
'test',
'chore',
'revert',
'build',
],
],
'type-case': [0],
'type-empty': [0],
'scope-empty': [0],
'scope-case': [0],
'subject-full-stop': [0, 'never'],
'subject-case': [0, 'never'],
'header-max-length': [0, 'always', 72],
},
}
在package.json中配置scripts命令
# 在scrips中添加下面的代码
{
"scripts": {
"commitlint": "commitlint --config commitlint.config.cjs -e -V"
},
}
现在当我们填写commit信息的时候，前面就需要规范带着下面的subject，否则会提交不成功
'feat',//新特性、新功能
'fix',//修改bug
'docs',//文档修改
'style',//代码格式修改, 注意不是 css 修改
'refactor',//代码重构
'perf',//优化相关，比如提升性能、体验
'test',//测试用例修改
'chore',//其他修改, 比如改变构建流程、或者增加依赖库、工具等
'revert',//回滚到上一个版本
'build',//编译相关的修改，例如发布版本、对项目构建或者依赖的改动
配置husky
在husky中创建规则
npx husky add .husky/commit-msg
在生成的commit-msg文件中添加下面的命令
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
pnpm commitlint这样当我们 commit 提交信息时，就不能再随意写了，必须是 git commit -m 'fix: xxx' 符合类型的才可以，需要注意的是类型的后面需要用英文的 :，并且冒号后面是需要空一格的，这个是不能省略的
7.强制使用pnpm包管理器工具
团队开发项目的时候，需要统一包管理器工具,因为不同包管理器工具下载同一个依赖,可能版本不一样,
导致项目出现bug问题,因此包管理器工具需要统一管理！！！
在根目录创建scritps/preinstall.js文件，添加下面的内容
if (!/pnpm/.test(process.env.npm_execpath || '')) {
console.warn(
`\u001b[33mThis repository must using pnpm as the package manager ` +
` for scripts to work properly.\u001b[39m\n`,
)
process.exit(1)
}
配置命令
"scripts": {
"preinstall": "node ./scripts/preinstall.js"
}当我们使用npm或者yarn来安装包的时候，就会报错了。原理就是在install的时候会触发preinstall（npm提供的生命周期钩子）这个文件里面的代码。
8.集成 Element-Plus
UI组件库采用的element-plus，因此需要集成element-plus插件
官网地址:https://element-plus.gitee.io/zh-CN/
安装Element-Plus
pnpm install element-plus @element-plus/icons-vue
配置Element-Plus使用中文环境
入口文件main.ts全局安装element-plus,element-plus默认支持语言英语，因此我们需要引入中文包设置为中文
import ElementPlus from 'element-plus';
import 'element-plus/dist/index.css'
//@ts-ignore忽略当前文件ts类型的检测否则有红色提示(打包会失败)
import zhCn from 'element-plus/dist/locale/zh-cn.mjs'
app.use(ElementPlus, {
locale: zhCn
})
Element Plus全局组件类型声明
// tsconfig.json
{
"compilerOptions": {
// ...
"types": ["element-plus/global"]
}
}配置完毕可以测试element-plus组件与图标的使用
9.Src文件夹别名路径配置
在开发项目的时候文件与文件关系可能很复杂，因此我们需要给src文件夹配置一个别名，在项目的编译过程中，将会按照这个配置进行路径查找，如果不配置，可能会编译路径时存在问题
// vite.config.ts
import {defineConfig} from 'vite'
import vue from '@vitejs/plugin-vue'
import path from 'path'
export default defineConfig({
plugins: [vue()],
resolve: {
alias: {
"@": path.resolve("./src") // 相对路径别名配置，使用 @ 代替 src
}
}
})
TypeScript 编译配置
// tsconfig.json
{
"compilerOptions": {
"baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
"paths": { //路径映射，相对于baseUrl
"@/*": ["src/*"]
}
}
}
10.开发环境的配置
项目开发过程中，至少会经历开发环境、测试环境和生产环境(即正式环境)三个阶段。不同阶段请求的状态(如接口地址等)不尽相同，若手动切换接口地址是相当繁琐且易出错的。于是环境变量配置的需求就应运而生，我们只需做简单的配置，把环境状态切换的工作交给代码。
开发环境（development） 顾名思义，开发使用的环境，每位开发人员在自己的dev分支上干活，开发到一定程度，同事会合并代码，进行联调。
测试环境（testing） 测试同事干活的环境啦，一般会由测试同事自己来部署，然后在此环境进行测试
生产环境（production） 生产环境是指正式提供对外服务的，一般会关掉错误报告，打开错误日志。(正式提供给客户使用的环境。)
注意:一般情况下，一个环境对应一台服务器,也有的公司开发与测试环境是一台服务器！！！
项目根目录分别添加 开发、生产和测试环境的文件!
.env.development
.env.production
.env.test
开发环境下的配置变量
# 变量必须以 VITE_ 为前缀才能暴露给外部读取
NODE_ENV = 'development'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/dev-api'
生产环境下的配置变量
NODE_ENV = 'production'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/prod-api'
测试环境下的配置变量
# 变量必须以 VITE_ 为前缀才能暴露给外部读取
NODE_ENV = 'test'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/test-api'
定义运行脚本
增加运行脚本后，可以通过编译时自动调用对应的环境变量开行编译
"scripts": {
"dev": "vite --open",
"build:test": "vue-tsc && vite build --mode test",
"build:pro": "vue-tsc && vite build --mode production",
"preview": "vite preview"
},
在项目中读取当前环境变量配置中的数据可以通过以下代码获得
console.log(import.meta.env)
11.SVG图标配置
在开发项目的时候经常会用到svg矢量图,而且我们使用SVG以后，页面上加载的不再是图片资源,
这对页面性能来说是个很大的提升，而且我们SVG文件比img要小的很多，放在项目中几乎不占用资源。
安装SVG依赖插件
pnpm install vite-plugin-svg-icons -D
在vite.config.ts中配置插件
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
import path from 'path'
export default () => {
return {
plugins: [
createSvgIconsPlugin({
// 定义SVG图标保存目录
iconDirs: [path.resolve(process.cwd(), 'src/assets/icons')],
// 使用SVG图标时的格式
symbolId: 'icon-[dir]-[name]',
}),
],
}
}
在 main.ts 文件中，引入SVG所需要的注册配置文件
import 'virtual:svg-icons-register'
使用SVG组件（不封装Vue组件）
通过 <svg> 标签创建一个 SVG 图标区域，再使用 <use> 标签载入 SVG 图标
<div>
<svg style="width:16px;height:16px">
<use xlink:href="#icons-svg图标名标" :fill="color"></use>
</svg>
</div>注意：xlink:href 所载入的图标名称格式固定使用 #icons-svg图标名标
如 assets/icons 中保存了图标文件 phone.svg,则在载入图标时应使用如下名称
<div>
<svg style="width:16px;height:16px">
<use xlink:href="#icons-phone" fill="color"></use>
</svg>
</div>设置图标颜色，可以使用 fill 属性设置。
创建全局SVG组件
因为项目很多模块需要使用图标,因此把它封装为全局组件！！！
<template>
<div>
<svg :style="{ width: width, height: height }">
<use :xlink:href="prefix + name" :fill="color"></use>
</svg>
</div>
</template>
<script setup lang="ts">
defineProps({
//xlink:href属性值的前缀
prefix: {
type: String,
default: '#icon-'
},
//svg矢量图的名字
name: String,
//svg图标的颜色
color: {
type: String,
default: ""
},
//svg宽度
width: {
type: String,
default: '16px'
},
//svg高度
height: {
type: String,
default: '16px'
}
})
</script>
<style scoped></style>
12.一次加载所有全局组件
在一个项目中，可能会存在多个全局组件，但如果每次创建一个全局组件就得使用 app.conpoment() 注册全局组件的话，全显得非常繁锁且代码冗余度高。
我们可以利用Vue的自定义插件方法，创建一个自定义插件，Vue在加载自定义插件时的，会首先执行插件中的install()方法，我们可以在 install() 方法中批量注册全局组件。
// 用于批量注册全局组件的方法，如果项目中有很多全局组件
// 那么就要多次引入，可以创建Vue插件来使用批量注册的方式把所有全局组件都引进来
import SvgIcon from "@/components/SvgIcon/SvgIcon.vue";
// 全局组件对象，可以引入并增加多个组件到变量中，在Vue载入插件时对所有全局组件进行循环注册
const allGloablComponent = {SvgIcon};
export default {
install(app){
// 通过循环批量注册全局组件
Object.keys(allGloablComponent).forEach(key=>{
app.component(key,allGloablComponent[key]);
})
}
}
13.集成Sass样式
引入reset.scss清除样式文件
一个项目开始必须要把页面的原有样式给清除掉，可以创建一个style文件夹用于存放全局使用的样式表
reset.scss 清除样式使用了 npm 官方的
*,
*:after,
*:before {
box-sizing: border-box;
outline: none;
}
html,
body,
div,
span,
applet,
object,
iframe,
h1,
h2,
h3,
h4,
h5,
h6,
p,
blockquote,
pre,
a,
abbr,
acronym,
address,
big,
cite,
code,
del,
dfn,
em,
img,
ins,
kbd,
q,
s,
samp,
small,
strike,
strong,
sub,
sup,
tt,
var,
b,
u,
i,
center,
dl,
dt,
dd,
ol,
ul,
li,
fieldset,
form,
label,
legend,
table,
caption,
tbody,
tfoot,
thead,
tr,
th,
td,
article,
aside,
canvas,
details,
embed,
figure,
figcaption,
footer,
header,
hgroup,
menu,
nav,
output,
ruby,
section,
summary,
time,
mark,
audio,
video {
font: inherit;
font-size: 100%;
margin: 0;
padding: 0;
vertical-align: baseline;
border: 0;
}
article,
aside,
details,
figcaption,
figure,
footer,
header,
hgroup,
menu,
nav,
section {
display: block;
}
body {
line-height: 1;
}
ol,
ul {
list-style: none;
}
blockquote,
q {
quotes: none;
&:before,
&:after {
content: '';
content: none;
}
}
sub,
sup {
font-size: 75%;
line-height: 0;
position: relative;
vertical-align: baseline;
}
sup {
top: -.5em;
}
sub {
bottom: -.25em;
}
table {
border-spacing: 0;
border-collapse: collapse;
}
input,
textarea,
button {
font-family: inhert;
font-size: inherit;
color: inherit;
}
select {
text-indent: .01px;
text-overflow: '';
border: 0;
border-radius: 0;
-webkit-appearance: none;
-moz-appearance: none;
}
select::-ms-expand {
display: none;
}
code,
pre {
font-family: monospace, monospace;
font-size: 1em;
}因为项目中类似的全局变量比较多，因此可以创建一个聚合样式文件index.scss进行聚合，main.ts中只需要引用该聚合文件即可
/*
本样式表是用于聚合所有全局样式表文件的被引用文件
*/
@import "reset.scss";main.ts 文件中需要引入 index.scss 全局聚合样式文件
// 引入全局样式表
import "@/style/index.scss"
创建全局Sass样式变量文件
针对项目中可能存在的复用样式的情况，我们可以使用样式变量进行配置，以后我们只需要引用该样式变量就可以使用该样式参数了。
需要在vite.config.ts 中配置全局样式变量文件的位置
export default defineConfig({
plugins: [...],
// 定义路径别名
resolve: {...},
// 定义全局样式变量文件
css: {
preprocessorOptions: {
scss: {
javascriptEnabled: true,
// 配置自动加载样式文件，可在全局中加载，这样就可以不需要导入即可使用自定义样式变量了
additionalData: '
@use "./src/styles/variable.scss" as *;
@use "./src/styles/自定义scss样式文件" as *;
',
},
},
},
})因此，我们可以在 style 中创建一个样式文件 variable.scss 作为全局样式变量使用。
14.集成mock
安装依赖:https://www.npmjs.com/package/vite-plugin-mock
pnpm install -D vite-plugin-mock mockjs在 vite.config.js 配置文件启用插件。
import { viteMockServe } from 'vite-plugin-mock'
import vue from '@vitejs/plugin-vue'
export default ({ command })=> {
return {
plugins: [
vue(),
viteMockServe({
enable: command === 'serve',
}),
],
}
}在根目录创建mock文件夹:去创建我们需要mock数据与接口
创建模拟数据文件
创建mock 文件夹用于存放 mock 使用的假数据文件，在mock文件夹内部创建一个user.ts模拟数据文件
//用户信息数据
function createUserList() {
return [
{
userId: 1,
avatar:
'https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif',
username: 'admin',
password: '111111',
desc: '平台管理员',
roles: ['平台管理员'],
buttons: ['cuser.detail'],
routes: ['home'],
token: 'Admin Token',
},
{
userId: 2,
avatar:
'https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif',
username: 'system',
password: '111111',
desc: '系统管理员',
roles: ['系统管理员'],
buttons: ['cuser.detail', 'cuser.user'],
routes: ['home'],
token: 'System Token',
},
]
}
export default [
// 用户登录接口
{
url: '/api/user/login',//请求地址
method: 'post',//请求方式
response: ({ body }) => {
//获取请求体携带过来的用户名与密码
const { username, password } = body;
//调用获取用户信息函数,用于判断是否有此用户
const checkUser = createUserList().find(
(item) => item.username === username && item.password === password,
)
//没有用户返回失败信息
if (!checkUser) {
return { code: 201, data: { message: '账号或者密码不正确' } }
}
//如果有返回成功信息
const { token } = checkUser
return { code: 200, data: { token } }
},
},
// 获取用户信息
{
url: '/api/user/info',
method: 'get',
response: (request) => {
//获取请求头携带token
const token = request.headers.token;
//查看用户信息是否包含有次token用户
const checkUser = createUserList().find((item) => item.token === token)
//没有返回失败的信息
if (!checkUser) {
return { code: 201, data: { message: '获取用户信息失败' } }
}
//如果有返回成功信息
return { code: 200, data: {checkUser} }
},
},
]
15.集成Axios二次封装
通过对Axios二次封装，可以创建请求拦截器和响应拦截器，提供请求前或响应后的数据过滤
// 二次封装Axios插件
import axios from "axios";
import {ElMessage} from "element-plus";
// 创建axios请求实例对象
const request = axios.create({
// 请求基础路径(从项目全局变量中取得当前环境的请求路径)
baseURL: import.meta.env.VITE_APP_BASE_API,
// 请求超时时间
timeout: 5000,
});
// 配置axios请求拦截器
request.interceptors.request.use((config) => {
// config 配置对象，headers 属性请求头，经常给服务器端携带公共参数
config.headers.token = 'xxxx';
return config;
})
// 配置axios响应拦截器
request.interceptors.response.use(response => {
// 响应成功回调
return response.data;
}, error => {
// 响应失败回调，处理http网络错误
let message = '';
let status = error.response.status;
switch (status) {
case 401:
message = '登陆已过期';
break;
case 403:
message = '未登陆';
break;
case 404:
message = '请求错误';
break;
case 500:
message = '服务器开小差';
break;
default:
message = '未知网络错误';
break;
}
ElMessage({
type:'error',
message,
});
return Promise.reject(error);
})
// 导出经过封装后的 Axios
export default request;
请求API统一管理
针对某个模块有多个请求，因此可以在 api 文件夹下创建对应请求模块的文件，如 api/user 中放置的则是和 user 有关的请求模块，并把所有相关的请求存放在里面予以区分
import request from "@/utils/request";
// 引入TS类型约束
import type {loginForm, loginResponse, loginInfoType} from "@/api/user/type";
// 统一管理接口
enum API {
LOGIN_URL = "/user/login",
USERINFO_URL = "/user/info"
}
// 导出请求函数
export const reqLogin = (data: loginForm) => request.post<any, loginResponse, any>(API.LOGIN_URL, data);
export const reqUserinfo = () => request.get<any, loginInfoType>(API.USERINFO_URL);
针对 TS 的类型语言，可以通过约束请求类型和响应类型
export interface loginForm {
username: string,
password: string
}
export interface loginResponse {
code: number,
data: {
token: string
}
}
export interface loginInfoType {
userId: number,
avatar: string,
username: string,
password: string,
desc: string,
roles: string[],
buttons: string[],
routes: string[],
token: string,
}
16.路由配置
安装路由
pnpm i vue-router
对路由的初步配置
import {createRouter, createWebHashHistory} from "vue-router";
import routes from "@/router/routes";
const router = createRouter({
history: createWebHashHistory(),
routes,
// 页面刷新时，设置页面滚动条
scrollBehavior() {
return {
top: 0,
left: 0
}
}
})
export default router;
对于路由规则，未来项目的路由跳转会非常多，因此可以把一些路由规则移到另一个地方进行管理
// 固定路由页面路由规则
export default [
{
path: "/login",
component: () => import("@/views/login/login.vue"),
name: "login"
},
{
path: "/",
component: () => import("@/views/home/home.vue"),
name: "layout"
},
{
path: "/404",
component: () => import("@/views/404/404.vue"),
name: "404"
},
{
// 针对上面所有路由都不配置的情况下触发
path: "/:pathMatch(.*)*",
redirect: "/404",
name: "Any"
}
];
在main.ts中加载路由
// 引入Vue-Router 路由插件
import router from "@/router/router";
app.use(router);
共有 0 条评论