vue3+ts项目搭建和封装(下篇)

简介: vue3+ts项目搭建和封装(下篇)

配置request.ts



/**
 * axios 二次封装 
 * @auther 何小生。
 * @time 2021/08/05 05:24
*/
import axios from 'axios'   // 引入axios
import { config } from '../config'  // 引入config
import { ElMessage } from 'element-plus'  // 引入element-plus
import router from '../router'  // 由于有些token认证失效等需要用到,所以引入router
import { storage } from './storage'  // 引入storage,用于获取缓存
// 定义初始化状态码
const TOKEN_INVALID = 'Token认证失败, 请重新登录'
const NETWORK_ERROR = '网络请求异常, 请稍后重试'
// 创建axios实例对象, 添加全局配置
const service = axios.create({
    // 初始配置请求头  当环境为mock的时候,请求mockapi,否则请求正式的api
    baseURL: config.mock ? config.mockApi : config.baseApi,
    // 接口持续时间为8秒,否则超时
    timeout: 8000
})
// 请求拦截
service.interceptors.request.use((req) => {
    // TO-DO
    // 获取请求头
    const headers = req.headers
    // 获取token 由于是typescript,所以要做排斥赋值
    const { token = "" } = storage.get('userInfo') || {}
    // 跟后端定义的某个请求头的值用于解析token身份令牌
    if(!headers.Authorization) headers.Authorization = 'xiaohe ' + token
    // 返回请求头
    return req
})
// 响应拦截
service.interceptors.response.use((res) => {
    // 获取后端返回的code,data和提示语
    const { code, data, msg } = res.data
    if(code == 200) return data
    else if(code === 50001) {   // token认证失败
        ElMessage.error(TOKEN_INVALID)   // 给予5001的状态码
        // 并且给予用户 一定的反应时间后,跳转登录页
        setTimeout(() => {
            router.push('/login')
        }, 15000)
        return Promise.reject(TOKEN_INVALID)  // 抛出异常
    } else {
        // 丢出服务器异常
        ElMessage.error(msg || NETWORK_ERROR)
        return Promise.reject(msg || NETWORK_ERROR)
    }
})
/**
 * @param {*} options   请求配置
*/
function request(options: any) {
    options.method = options.method || 'get'
    if(options.method.toLowerCase() === 'get') options.params = options.data
    if(typeof options.mock != 'undefined') config.mock = options.mock
    if(config.env === 'prod') service.defaults.baseURL = config.baseApi
    else service.defaults.baseURL = config.mock ? config.mockApi : config.baseApi
    return service(options)
}
// 轮询接口类型,然后根据对应的类型,给予请求方式
['get', 'post', 'put', 'delete', 'patch'].forEach(item => {
    request[item] = (url: string, data: any, options: string[]) => {
        return request({ url, data, method: item, ...options })
    }
})
// 丢出request
export default request
复制代码


封装storage.ts



此处用到了storage和sessionStorage两种方法做缓存封装


/**
 * 封装操作localstorage本地存储的方法
 * @auther 何小玍。
 * @date 2021/06/28
 */
export const storage = {
    //存储
    set(key: string, value: any) {
        window.localStorage.setItem(key, JSON.stringify(value))
    },
    //取出数据
    get<T>(key: string) {
        const value = window.localStorage.getItem(key)
        if (value && value != "undefined" && value != "null") return <T>JSON.parse(value)
        else return "{}"
    },
    // 删除数据
    remove(key: string) {
        window.localStorage.removeItem(key)
    }
};
/**
 * 封装操作sessionStorage本地存储的方法
 */
export const sessionStorage = {
    //存储
    set(key: string, value: any) {
        window.sessionStorage.setItem(key, JSON.stringify(value))
    },
    //取出数据
    get<T>(key: string) {
        const value = window.sessionStorage.getItem(key);
        if (value && value != "undefined" && value != "null") return JSON.parse(value)
        return null
    },
    // 删除数据
    remove(key: string) {
        window.sessionStorage.removeItem(key)
    }
}
复制代码


配置config.ts



在src目录下创建config文件夹,然后创建index.ts, 用于配置请求的基本配置参数和区分生产环境和开发环境


export interface IConfig {
    env: string // 开发环境
    mock?: boolean // mock数据
    title: string // 项目title
    baseApi?: string // api请求地址
    mockApi?: string // mock地址
}
const dev: IConfig = {
    env: "development",
    mock: false,
    title: "开发",
    baseApi: "/api", // 本地api请求地址,注意:如果你使用了代理,请设置成'/'
    mockApi: "https://www.fastmock.site/mock/4f8c864d98d32e623e4a452a904ca70b/api"
}
const prod: IConfig = {
    env: "production",
    mock: false,
    title: "生产",
    baseApi: "https://www.baidu.com/api", // 正式api请求地址
    mockApi: 'xxx'
}
export const config: IConfig = import.meta.env.MODE == 'development' ? dev : prod
复制代码


配置api封装



在src目录下,创建api文件夹,然后生成user.ts文件,存放登录注册忘记密码等接口


import request from '../utils/request'
interface userState {
    username: string
    password: string
}
export default {
    /**
     * 登录接口
     * @param { string } username       用户名称
     * @param { string } password       用户密码
     */
    login( data: userState ) {
        return request({
            url: '/users/login',
            method: 'post',
            data
        })
    }
}
复制代码


配置router和路由守卫



在src文件夹下创建index.ts、router.config.ts

  • 路由守卫的配置


import { createRouter, createWebHistory } from "vue-router"
import { constantRouterMap } from "./router.config"
import { useDocumentTitle } from "@/hooks/useDocumentTitle"
import store from "@/store"
const router = createRouter({
  history: createWebHistory(import.meta.env.BASE_URL),
  // 在按下 后退/前进 按钮时,就会像浏览器的原生表现那样
  scrollBehavior(to, from, savedPosition) {
    if (savedPosition) return savedPosition
    else return { top: 0 }
  },
  routes: constantRouterMap
})
// 路由开始进入
router.beforeEach((to: any, from: any, next) => {
  useDocumentTitle(to.meta.title)
  next()
  return false
})
router.afterEach((to, from, next) => {
  // 保存url
})
export default router
复制代码


  • 路由配置


import { RouteRecordRaw } from "./vue-router"
import Layout from '@/layout/index.vue'
export const constantRouterMap: Array<RouteRecordRaw> = [  
  { path: '/login', name: 'login', component: () => import('@/views/login/login.vue'), meta: { title: '登录' }, hidden: true },
  { path: '/', name: '/', component: Layout, redirect: '/index', meta: { title: '博客', icon: 'el-icon-help' }, children: [
    { path: '/index', name: 'index', component: () => import('@/views/index/index.vue'), meta: { title: '博客', icon: 'el-icon-link' } }
  ] },
  { path: '/404', name: 'page404', component: () => import('@/views/404.vue'), meta: { title: '404' }, hidden: true },
  { path: '/:catchAll(.*)', redirect: '/404', hidden: true }
]
复制代码


main.js配置



最后在main.js里面配置


import { createApp } from 'vue'
import App from './App.vue'
import router from './router'
import store from './store'
import svgIcon from './icons/index.vue'
import { storage, sessionStorage } from './utils/storage'
import ElementPlus from 'element-plus'
import 'element-plus/lib/theme-chalk/index.css'
// 引入全局样式
import "./styles/base.css"
import "./styles/reset.css"
const app = createApp(App)
app.config.globalProperties.storage = storage                   // 全局挂载 缓存方法
app.config.globalProperties.sessionStorage = sessionStorage     // 全局挂载 缓存方法
app
.use(router)
.use(store)
.use(ElementPlus)
.component('svg-icon', svgIcon)
.mount('#app')


相关文章
|
6天前
|
JavaScript 前端开发 开发者
Vue 3中的Proxy
【10月更文挑战第23天】Vue 3中的`Proxy`为响应式系统带来了更强大、更灵活的功能,解决了Vue 2中响应式系统的一些局限性,同时在性能方面也有一定的提升,为开发者提供了更好的开发体验和性能保障。
19 7
|
6天前
|
JavaScript 数据管理 Java
在 Vue 3 中使用 Proxy 实现数据双向绑定的性能如何?
【10月更文挑战第23天】Vue 3中使用Proxy实现数据双向绑定在多个方面都带来了性能的提升,从更高效的响应式追踪、更好的初始化性能、对数组操作的优化到更优的内存管理等,使得Vue 3在处理复杂的应用场景和大量数据时能够更加高效和稳定地运行。
24 1
|
6天前
|
JavaScript 开发者
在 Vue 3 中使用 Proxy 实现数据的双向绑定
【10月更文挑战第23天】Vue 3利用 `Proxy` 实现了数据的双向绑定,无论是使用内置的指令如 `v-model`,还是通过自定义事件或自定义指令,都能够方便地实现数据与视图之间的双向交互,满足不同场景下的开发需求。
25 1
|
10天前
|
数据采集 监控 JavaScript
在 Vue 项目中使用预渲染技术
【10月更文挑战第23天】在 Vue 项目中使用预渲染技术是提升 SEO 效果的有效途径之一。通过选择合适的预渲染工具,正确配置和运行预渲染操作,结合其他 SEO 策略,可以实现更好的搜索引擎优化效果。同时,需要不断地监控和优化预渲染效果,以适应不断变化的搜索引擎环境和用户需求。
|
3天前
|
JavaScript
Vue基础知识总结 4:vue组件化开发
Vue基础知识总结 4:vue组件化开发
|
3天前
|
存储 JavaScript
Vue 状态管理工具vuex
Vue 状态管理工具vuex
|
10天前
|
缓存 JavaScript 搜索推荐
Vue SSR(服务端渲染)预渲染的工作原理
【10月更文挑战第23天】Vue SSR 预渲染通过一系列复杂的步骤和机制,实现了在服务器端生成静态 HTML 页面的目标。它为提升 Vue 应用的性能、SEO 效果以及用户体验提供了有力的支持。随着技术的不断发展,Vue SSR 预渲染技术也将不断完善和创新,以适应不断变化的互联网环境和用户需求。
29 9
|
9天前
|
缓存 JavaScript UED
Vue 中实现组件的懒加载
【10月更文挑战第23天】组件的懒加载是 Vue 应用中提高性能的重要手段之一。通过合理运用动态导入、路由配置等方式,可以实现组件的按需加载,减少资源浪费,提高应用的响应速度和用户体验。在实际应用中,需要根据具体情况选择合适的懒加载方式,并结合性能优化的其他措施,以打造更高效、更优质的 Vue 应用。
|
8天前
|
JavaScript
如何在 Vue 中使用具名插槽
【10月更文挑战第25天】通过使用具名插槽,你可以更好地组织和定制组件的模板结构,使组件更具灵活性和可复用性。同时,具名插槽也有助于提高代码的可读性和可维护性。
13 2
|
8天前
|
JavaScript
Vue 中的插槽
【10月更文挑战第25天】插槽的使用可以大大提高组件的复用性和灵活性,使你能够根据具体需求在组件中插入不同的内容,同时保持组件的结构和样式的一致性。
12 2