上海网站开发招聘,一个网站交互怎么做的,群晖可以做网站服务器,网站如何做担保交易一、 项目初始化
一个项目要有统一的规范#xff0c;需要使用eslintstylelintprettier来对我们的代码质量做检测和修复#xff0c;需要使用husky来做commit拦截#xff0c;需要使用commitlint来统一提交规范#xff08;即统一提交信息#xff09;#xff0c;需要使用pre…一、 项目初始化
一个项目要有统一的规范需要使用eslintstylelintprettier来对我们的代码质量做检测和修复需要使用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/ PSpnpmperformant npm 意味“高性能的 npm”。pnpm由npm/yarn衍生而来解决了npm/yarn内部潜在的bug极大的优化了性能扩展了使用场景。被誉为“最先进的包管理工具”。 pnpm安装指令
npm i -g pnpm
项目初始化命令
pnpm create vite 运行初始化命令后需要输入项目名称及选择一些项目的预设配置选项本项目参考如下 Project name项目名称...projectSelect a framework项目使用框架VueSelect 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 problemsWhat type of modules does your project use? --- JavaScript modules (import/export)Which framework does your project use? --- Vue.jsDoes your project use TypeScript? --- YesWhere does your code run? --- BrowserWhat format do you want your config file to be in? --- JavascriptThe config that youve selected requires the following dependencies: eslint-plugin-vuelatest typescript-eslint/eslint-pluginlatest typescript-eslint/parserlatest? Would you like to install then now? --- YesWhich package manger do you want to use? --- pnpm (PSeslint-plugin-vuelatest检测vue语法最新版本插件typescript-eslint/eslint-pluginlatest检测ts语法最新版本插件typescript-eslint/parserlatestts及eslint解析器包) .eslint.cjs配置文件
module.exports {// 运行环境env: { browser: true,// 浏览器端es2021: true,// es2021},//规则继承extends: [ //全部规则默认是关闭的,这个配置项开启推荐规则,推荐规则参照文档//比如:函数不能重名、对象不能出现重复keyeslint: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-parser 2.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: {// eslinthttps://eslint.bootcss.com/docs/rules/no-var: error, // 要求使用 let 或 const 而不是 varno-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-ignoretypescript-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, // 对模板中的自定义组件强制执行属性命名样式},
} 2.1.3 .eslintignore忽略文件
在根目录下创建 .eslintignore文件配置内容如下
dist
node_modules
2.1.4 运行脚本 package.json 新增两个运行脚本
scripts: {lint: eslint src, //校验src里面文件的语法fix: eslint src --fix, //对不符合规则的语法进行纠正
}
2.2 配置prettier
有了eslint为什么还要有prettiereslint针对的是javascript它是一个检测工具包含js语法以及少部分格式问题在eslint看来语法对了就能保证代码正常运行格式问题属于其次
而prettier属于格式化工具它看不惯格式不统一所以它就把eslint没干好的事接着干另外prettier支持包含js在内的多种语言。
总结起来eslint和prettier这俩兄弟一个保证js代码质量一个保证代码美观。
2.2.1 安装依赖包
pnpm install -D eslint-plugin-prettier prettier eslint-config-prettier
2.2.2 .prettierrc.json添加规则
在根目录下创建 .prettierrc.json文件配置内容如下
{singleQuote: true, // 字符串是否使用单引号semi: false, // 是否使用封号;bracketSpacing: true,htmlWhitespaceSensitivity: ignore,endOfLine: auto,trailingComma: all,tabWidth: 2 // 设置缩进时占几个位置
}2.2.3 .prettierignore忽略文件
在根目录下创建.prettierignore文件配置内容如下
/dist/*
/html/*
.local
/node_modules/**
**/*.svg
**/*.sh
/public/*
通过 pnpm run lint 去检测语法如果出现不规范格式通过 pnpm run fix 修改 2.3 配置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
2.3.1 .stylelintrc.cjs配置文件
官网Home | Stylelint中文文档 | Stylelint中文网
在根目录下创建.stylelintrc.cjs文件配置内容如下
// 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-boxproperty-no-vendor-prefix: null, // 关闭 属性前缀 -webkit-maskselector-pseudo-class-no-unknown: [// 不允许未知的选择器true,{ignorePseudoClasses: [global, v-deep, deep], // 忽略属性修改element默认样式的时候能使用到},],},
} 2.3.2 .stylelintignore忽略文件
在根目录下创建.stylelintignore文件配置内容如下
/node_modules/*
/dist/*
/html/*
/public/* 2.3.3 运行脚本
scripts: {lint:style: stylelint src/**/*.{css,scss,vue} --cache --fix
} 最后配置统一的prettier来格式化我们的js和csshtml代码 scripts: {-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 的时候会把代码直接格式化
2.3 配置husky
在上面我们已经集成好了我们代码校验工具但是需要每次手动的去执行命令才会格式化我们的代码。如果有人没有格式化就提交了远程仓库中那这个规范就没什么用。所以我们需要强制让开发人员按照代码规范来提交。
要做到这件事情就需要利用husky在代码提交之前触发git hook(git在客户端的钩子)然后执行pnpm run format 来自动的格式化我们的代码。
PS关于git hook可参考此文章关于git hooks-CSDN博客 需要先git初始化创建仓库 具体步骤可参考此文章创建git仓库-CSDN博客 安装husky
pnpm install -D husky
执行
npx husky-init 会在根目录下生成个一个.husky目录在这个目录下面会有一个pre-commit文件这个文件里面的命令在我们执行commit的时候就会执行 在 .husky/pre-commit 文件添加如下命令
#!/usr/bin/env sh
. $(dirname -- $0)/_/husky.sh
pnpm run format //运行格式化 当我们对代码进行commit操作的时候就会执行命令对代码进行格式化然后再提交。 2.4 配置commitlint 对于我们的commit信息也是有统一规范的不能随便写要让每个人都按照统一的标准来执行我们可以利用commitlint来实现。
安装依赖
pnpm add commitlint/config-conventional commitlint/cli -D 添加配置文件在根目录下新建commitlint.config.cjs(注意是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
npx husky add .husky/commit-msg 在生成的commit-msg文件中添加下面的命令
#!/usr/bin/env sh
. $(dirname -- $0)/_/husky.sh
pnpm commitlint 我们 commit 提交信息时就不能再随意写了必须是 git commit -m fix: xxx 符合类型的才可以需要注意的是类型的后面需要用英文的 :并且冒号后面是需要空一格的这个是不能省略的
2.5 强制使用pnpm包管理器工具
团队开发项目的时候需要统一包管理器工具,因为不同包管理器工具下载同一个依赖可能版本不一样导致项目出现bug问题,因此包管理器工具需要统一管理
在根目录创建 scripts/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的时候会触发preinstallnpm提供的生命周期钩子这个文件里面的代码。
三、项目集成
3.1 集成 element-plus
官网地址一个 Vue 3 UI 框架 | Element Plus (gitee.io)
PS这里采用的是完整引入 如果不在乎打包后的文件大小可采用这种方式使用起来更方便
3.1.1 使用包管理工具npm、pnpm、yarn安装 element-plus pnpm install element-plus 3.1.2 在入口文件中引入element-plus插件、样式及国际化配置 国际化配置即全局配置支持中文因为Element Plus 组件 默认 使用英语。 入口文件即main.ts文件 // 引入element-plus插件与样式
import ElementPlus from element-plus
import element-plus/dist/index.css// 配置element-plus国际化
// ts-ignore
import zhCn from element-plus/dist/locale/zh-cn.mjs// 安装element-plus插件
app.use(ElementPlus, {locale: zhCn //element-plus国际化配置
}) PS上面代码中由于element-plus缺少TypeScript 类型声明文件配置国际化的代码会标红提示虽然代码可正常运行但在打包时会报错找不到 element-plus/dist/locale/zh-cn.mjs 模块的声明文件.d.ts 文件。
此处使用注释 “// ts-ignore” 的方法直接忽略当前文件ts类型的检测。
也可以通过 ①手动声明模块 或者 ②关闭 TypeScript 的模块解析警告 ①手动声明模块
// 在src目录下创建 element-plus.d.ts 文件进行手动声明
declare module element-plus/dist/locale/zh-cn.mjs {const zhCn: any; // 根据实际情况调整export default zhCn;
}②关闭 TypeScript 的模块解析警告
// 如果你对该模块的类型不感兴趣也可以关闭 TypeScript 中的模块解析警告。
在 tsconfig.json 文件中添加
{compilerOptions: {skipLibCheck: true}
} 3.1.3 安装和使用图标组件库
安装 element-plus组件库在项目中会经常使用到因此需要安装 pnpm install element-plus/icons-vue 使用 templatediv!-- element-plus图标使用,通过 :iconxxx --el-button typeprimary :iconEdit / el-button typeprimary :iconDelete //div
/templatescript setup langts// 引入图标组件库import { Delete, Edit} from element-plus/icons-vue
/scriptstyle scoped/style 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 -D
3.4.2 在vite.config.ts文件中配置SVG插件
// 引入svg图标插件
import { createSvgIconsPlugin } from vite-plugin-svg-iconsexport 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图标外层容器内部需要use标签结合使用 --
svg!-- xlink:href执行用哪一个图标属性值必须加上 #icon-图标名字 --use xlink:href#icon-home fillred/use
/svg
到这里就是完整的SVG图标的安装及使用但是一个项目中可能会有很多模块需要用到SVG图标一遍遍的书写上面的代码就比较低效因此可以把它封装成全局组件。
PS封装全局组件具体的实现可参考此文章vue3---自定义插件注册全局对象-CSDN博客
3.5 集成sass
我们目前在组件内部已经可以使用scss语法因为在配置styleLint工具的时候项目当中已经安装过sass sass-loader在使用时需要加上langscss
style scoped langscss/style
接下来我们为项目添加一些全局的样式
3.5.1 清除默认样式
在src/styles目录下创建一个index.scss文件如果没有styles文件夹就创建一个当然项目中需要用到清除默认样式因此在index.scss引入reset.scss。
import ./reset.scss
PSreset.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 mockjs PS直接安装vite-plugin-mock会下载最新版本即3.0.0这个版本配置时会有以下错误提示且运行时也会报错运行失败。大概就是3.0.0版本viteMockServe配置参数类型定义中没有localEnabled这个属性了所以报错。具体3.0.0版本要怎么配置暂时没有找到说明文档所以建议 先使用2.9.6版本。 2.9.6版本安装
pnpm install -D vite-plugin-mock2.9.6 mockjs 3.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 } checkUserreturn { code: 200, data: { token } }},},// 获取用户信息{url: /api/user/info,method: get,response: (request) {//获取请求头携带tokenconst 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 axios
3.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.statusswitch (status) {case 401:message token过期breakcase 403:message 无权访问breakcase 404:message 请求地址错误breakcase 500:message 服务器出现问题breakdefault: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.postany, loginResponseData(API.LOGIN_URL, data)
// 获取用户信息接口方法
export const reqUserInfo () request.getany, userResponseData(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博客
