【Vue3+Ts项目】硅谷甄选 — 搭建后台管理系统模板
一、 项目初始化
一个项目要有统一的规范，需要使用eslint+stylelint+prettier来对我们的代码质量做检测和修复，需要使用husky来做commit拦截，需要使用commitlint来统一提交规范（即统一提交信息），需要使用preinstall来统一包管理工具。
PS：
- vue3官方推荐的 IDE 设置是VSCode + Vue 语言功能 (Volar)扩展。
- Volar扩展提供语法突出显示、TypeScript 支持以及模板表达式和组件属性的智能感知。
- 如果你在之前写vue2 项目时安装了Vetur，建议在 Vue 3 项目中禁用它，避免一些冲突及报错。
1.1 环境准备
-
node v16.14.2
-
pnpm 8.0.0
1.2 初始化项目
本项目使用vite进行构建，vite官方中文文档参考：cn.vitejs.dev/guide/
PS：pnpm：performant npm ，意味“高性能的 npm”。pnpm由npm/yarn衍生而来，解决了npm/yarn内部潜在的bug，极大的优化了性能，扩展了使用场景。被誉为“最先进的包管理工具”。
pnpm安装指令：
npm i -g pnpm项目初始化命令：
pnpm create vite运行初始化命令后，需要输入项目名称及选择一些项目的预设配置选项（本项目参考如下）：
- Project name（项目名称）：...project
- Select a framework（项目使用框架）：Vue
- Select a variant（项目使用的语法）：TypeScript
进入到项目根目录pnpm install安装全部依赖，安装完依赖运行程序：pnpm run dev
运行完毕项目跑在http://127.0.0.1:5173/，可以访问你得项目啦
提示开发效率的小Tips①：生成vue3单文件模板的快捷方式！！！
- 安装Vue VSCode Snippets扩展
- 输入“v3ts”，选择项目所需的vue3单文件模板选项即可（本项目选择的是vbase-3-ts-setup）
二、 项目配置
提示开发效率的小Tips②：运行项目时，浏览器自动打开！！！
package.json文件中运行项目脚本加上--open，如下：
"scripts": {
"dev": "vite --open"
},
2.1 eslint配置
eslint中文官网：ESLint - Pluggable JavaScript linter - ESLint中文
eslint 是提供一个插件化的javascript代码检测工具
首先安装 eslint
pnpm i eslint -D生成配置文件：.eslint.cjs
npx eslint --init执行该命令时会有一些提示选择（本项目参考如下）：
- How would you like to use ESlint? ---> To check syntax and find problems
- What type of modules does your project use? ---> JavaScript modules (import/export)
- Which framework does your project use? ---> Vue.js
- Does your project use TypeScript? ---> Yes
- Where does your code run? ---> Browser
- What format do you want your config file to be in? ---> Javascript
- The config that you've selected requires the following dependencies: eslint-plugin-vue@latest @typescript-eslint/eslint-plugin@latest @typescript-eslint/parser@latest? Would you like to install then now? ---> Yes
- Which package manger do you want to use? ---> pnpm
(PS：eslint-plugin-vue@latest：检测vue语法最新版本插件，@typescript-eslint/eslint-plugin@latest：检测ts语法最新版本插件，@typescript-eslint/parser@latest：ts及eslint解析器包)
.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": {
}
}2.1.1 vue3环境代码校验插件
# 让所有与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-parser2.1.2 修改.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', // 防止
PS：在项目中使用element-plus时，如果没有代码提示，可以安装Element Plus Helper插件 (针对使用VsCode开发)
3.2 src别名配置
在开发项目的时候文件与文件关系可能很复杂，为了简化路径、提高可维护性，通常我们会为src设置别名（通常使用 @ 符号）
3.2.1 在vite.config.ts文件中配置src别名
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
// 引入nodejs内置的path模块：用于获取某个文件或者文件夹的路径（包括相对路径/绝对路径）
import path from 'path'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [vue()],
resolve: {
alias: {
"@": path.resolve("./src") // 相对路径别名配置，使用 @ 代替 src
}
}
})PS：关于path相关内容可参考此文章：关于配置src别名中的path.resolve(“./src“)-CSDN博客
3.2.2 TypeScript 编译配置（tsconfig.json文件配置）
{
"compilerOptions": {
--"baseUrl": "./", // 解析非相对模块的基地址，默认是当前目录
--"paths": { //路径映射，相对于baseUrl
"@/*": ["src/*"]
}
}
}PS：具体配置项说明可参考此文章：关于src别名的配置之tsconfig.json配置-CSDN博客
3.3 环境变量配置
项目开发过程中，至少会经历开发环境、测试环境和生产环境(即正式环境)三个阶段。不同阶段请求的状态(如接口地址等)不尽相同，若手动切换接口地址是相当繁琐且易出错的。于是环境变量配置的需求就应运而生，我们只需做简单的配置，把环境状态切换的工作交给代码。
开发环境（development）
顾名思义，开发使用的环境，每位开发人员在自己的dev分支上干活，开发到一定程度，同事会合并代码，进行联调。
测试环境（testing）
测试同事干活的环境啦，一般会由测试同事自己来部署，然后在此环境进行测试。
生产环境（production）
生产环境是指正式提供对外服务的，一般会关掉错误报告，打开错误日志。(正式提供给客户使用的环境。)
PS：一般情况下，一个环境对应一台服务器，也有的公司开发与测试环境是一台服务器！！！
3.3.1 在项目根目录下分别添加开发、生产和测试环境的文件
在根目录下，分别创建 “.env.development”、“.env.production”、“.env.test”文件，分别配置相对应的环境变量，如下：
// .env.development文件配置
NODE_ENV = 'development'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/api'
// .env.production文件配置
NODE_ENV = 'production'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/prod-api'
// .env.test文件配置
NODE_ENV = 'test'
VITE_APP_TITLE = '硅谷甄选运营平台'
VITE_APP_BASE_API = '/test-api'PS：变量必须以 VITE_ 为前缀才能暴露给外部读取！！！！
3.3.2 在package.json文件中配置运行命令
"scripts": {
"build:test": "vue-tsc && vite build --mode test",
"build:pro": "vue-tsc && vite build --mode production"
},3.3.3 通过import.meta.env获取环境变量
// 在任何组件中使用import.meta.env都可以获取环境变量
console.log(import.meta.env)3.4 SVG图标的封装与使用
在开发项目的时候经常会用到svg矢量图，而且我们使用SVG以后，页面上加载的不再是图片资源，这对页面性能来说是个很大的提升，而且我们SVG文件比img要小的很多，放在项目中几乎不占用资源。
3.4.1 安装SVG依赖插件
pnpm install vite-plugin-svg-icons -D3.4.2 在vite.config.ts文件中配置SVG插件
// 引入svg图标插件
import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
export default () => {
return {
plugins: [
createSvgIconsPlugin({
// 指定要缓存的图标文件夹
iconDirs: [path.resolve(process.cwd(), 'src/assets/icons')],
// 指定 symbolId 格式
symbolId: 'icon-[dir]-[name]',
}),
],
}
}3.4.3 在入口文件中引入
入口文件，即main.ts文件。
import 'virtual:svg-icons-register'3.4.4 在src/assets文件夹新建icons文件夹，在此文件夹中存放项目所需的SVG图标（即.svg文件）
PS：可以到阿里图标库找需要的图标 ，直接复制SVG代码粘贴到.svg文件中即可。（自己的练习项目可以用用，如果是公司项目要使用，可能需要考虑版权问题！！）
3.4.5 SVG在组件中使用
在项目各个组件中，通过下面的形式使用SVG图标
到这里就是完整的SVG图标的安装及使用，但是一个项目中可能会有很多模块需要用到SVG图标，一遍遍的书写上面的代码就比较低效，因此，可以把它封装成全局组件。
PS：封装全局组件具体的实现可参考此文章：vue3---自定义插件注册全局对象-CSDN博客
3.5 集成sass
我们目前在组件内部已经可以使用scss语法，因为在配置styleLint工具的时候，项目当中已经安装过sass sass-loader，在使用时需要加上lang="scss"
接下来我们为项目添加一些全局的样式
3.5.1 清除默认样式
在src/styles目录下创建一个index.scss文件（如果没有styles文件夹就创建一个），当然项目中需要用到清除默认样式，因此在index.scss引入reset.scss。
@import './reset.scss'PS：reset.scss样式可以在npm官网中搜索获取（直接复制粘贴code中的reset.scss内容即可）。
参考链接：reset.scss - npm (npmjs.com)reset.scss - npm (npmjs.com)
在入口文件引入
// 引入模板的全局样式
import '@/styles/index.scss'但是你会发现在src/styles/index.scss全局样式文件中没有办法使用变量。因此需要给项目中引入全局变量。
3.5.2 引入全局变量
在src/styles目录下创建一个variable.scss文件，用于书写scss全局变量。
在vite.config.ts文件配置如下:
export default defineConfig((config) => {
css: {
preprocessorOptions: {
scss: {
javascriptEnabled: true,
additionalData: '@import "./src/styles/variable.scss";',
},
},
},
} @import "./src/styles/variable.less";后面的;不要忘记，不然会报错！！！！
preprocessorOptions： 这是一个 Vite 中处理预处理器选项的配置块。
scss： 指定了要使用的预处理器为 SCSS。
javascriptEnabled
:true： 这个选项启用了 SCSS 预处理器中的 JavaScript 表达式功能。（通常，在 SCSS 中，可以使用 JavaScript 表达式，例如在变量中进行计算）。additionnalData
: '@improt"./src/styles/variable.scss";'： 这是一个字符串，它包含额外的 SCSS 代码。在这里，它使用@import引入了位于./src/styles/variable.scss文件中的 SCSS 变量。这意味着这个变量文件的内容将会被包含到每个 SCSS 文件的顶部，以便在整个项目中共享这些变量。
3.6 mock数据
3.6.1 安装依赖
地址：vite-plugin-mock - npm (npmjs.com)
pnpm install -D vite-plugin-mock mockjsPS：直接安装vite-plugin-mock会下载最新版本（即3.0.0），这个版本配置时会有以下错误提示，且运行时也会报错，运行失败。大概就是3.0.0版本viteMockServe配置参数类型定义中没有localEnabled这个属性了，所以报错。具体3.0.0版本要怎么配置暂时没有找到说明文档，所以建议 先使用2.9.6版本。
2.9.6版本安装
pnpm install -D [email protected] mockjs3.6.2 在 vite.config.js 配置文件启用插件
import { UserConfigExport, ConfigEnv } from 'vite'
import { viteMockServe } from 'vite-plugin-mock'
import vue from '@vitejs/plugin-vue'
export default ({ command })=> {
return {
plugins: [
vue(),
viteMockServe({
localEnabled: command === 'serve',
}),
],
}
}3.6.3 创建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} }
},
},
]3.6.4 安装axios
最后安装axios测试一下mock接口
pnpm install axios3.7 axios二次封装
在开发项目的时候避免不了与后端进行交互，因此我们需要使用axios插件实现发送网络请求。在开发项目的时候我们经常会把axios进行二次封装。
目的：
- 使用请求拦截器，可以在请求拦截器中处理一些业务(开始进度条、请求头携带公共参数)
- 使用响应拦截器，可以在响应拦截器中处理一些业务(进度条结束、简化服务器返回的数据、处理http网络错误)
由于测试mock的时候已经安装了axios，这里就不再重复安装步骤了！！
在src目录下创建utils/request.ts，进行axios的二次封装，如下：
// 进行axios二次封装：使用请求与响应拦截器
import axios from "axios";
// 引入element-plus的消息提示组件
import { ElMessage } from "element-plus";
// 第一步：利用axios对象的create方法，去创建axios实例（其他的配置：基础路径、超时的时间）
let request = axios.create({
baseURL: import.meta.env.VITE_APP_BASE_API,
timeout: 5000
});
// 第二步：request实例添加请求与响应拦截器
request.interceptors.request.use((config) => {
// config配置对象，包括hearders属性请求头，经常给服务端携带公共参数
// 返回配置对象
return config;
});
// 第三步：响应拦截器
request.interceptors.response.use((response) => {
// 成功回调
// 简化数据
return response.data
}, (error) => {
let message = ''
let status = error.response.status
switch (status) {
case 401:
message = 'token过期'
break
case 403:
message = '无权访问'
break
case 404:
message = '请求地址错误'
break
case 500:
message = '服务器出现问题'
break
default:
message = '网络出现问题'
break
}
// 提示错误信息
ElMessage({
type: error,
message
})
return Promise.reject(error)
})
// 对外暴露
export default request;
注意点：
- 暴露的是封装好的request而不是axios
- 发请求时不需要再携带/api，因为基础路径里面配置好了
- 任何一次请求都会经过请求拦截器，所以请求拦截器中的配置config可以携带一些东西给服务器，一般是token
- 请求拦截器中必须返回config对象，不然请求都发不出去
3.8 API接口统一管理
在开发项目时，我们通常需要进行API接口的统一管理，这有助于提高项目的结构性、维护性和可读性，使得团队更容易协作开发，减少潜在的问题 。
在src目录下创建api文件夹，api文件夹下分别创建项目各个模块接口的文件夹，比如，如本项目中有user（用户信息）、acl（权限管理）、product（商品管理）等，以下使用user举例：
3.8.1 在src/api/user目录下创建index.ts文件，书写user相关接口：
// 统一管理项目用户相关的接口
import request from "@/utils/request";
import type { loginForm, loginResponseData, userResponseData } from "./type"
// 项目用户相关的请求地址
enum API {
LOGIN_URL = 'user/login',
USERINFO_URL = 'user/info'
}
// 暴露请求函数
// 登录接口方法
export const reqLogin = (data: loginForm) => request.post(API.LOGIN_URL, data)
// 获取用户信息接口方法
export const reqUserInfo = () => request.get(API.USERINFO_URL) 3.8.2 在src/api/user目录下创建type.ts文件，定义接口请求体、响应体及接收数据的类型参数
// 登录接口需要携带参数ts类型
export interface loginForm {
username: string,
password: string
}
interface dataType {
token: string
}
// 登录接口返回的数据类型
export interface loginResponseData {
code: number,
data: dataType
}
interface userInfo {
userId: number,
avatar: string,
username: string,
password: string,
desc: string,
roles: string[],
buttons: string[],
routes: string[],
token: string
}
interface user {
checkUser: userInfo
}
// 定义服务器返回用户信息相关的数据类型
export interface userResponseData {
code: number,
data: user
}PS：关于 import type理解可以参考此文章：关于import type引入的理解-CSDN博客