Vite+Vue3+TypeScript

2021年最新最完整Vite+Vue3+TypeScript基础知识案例<一>

1、学习背景

随着前端web应用的需求不断发展和变化,vue生态圈也紧跟开发者步伐,不断演化。尽管vue2.0已经很完善了,很多人掌握的vue2.0,感觉实在学不动了,意料之外的是尤先生继续更新vue到3.0版本,以补充vue2.0的不足之处。随着vue3.0问世,vite2.5.1也油然而生,vue始终没有放弃对项目响应速度和编译速度的追求,vite的到来,对于前端开发者而言,简直不要太幸福了。vue3.0不仅全面支持TypeScript语法,还对生命周期钩子进行了优化和剔除,加上工具setup的语法糖,vue单页面多个根元素的扩展,代码精简不说,还很有条理,vue3.0的出现再次提升了开发者的编码体验和幸福感。另外vue3整合typescript语言是前端未来发展的必然趋势,而生为vue家族的新成员vite也是前端技术爱好者的学习目标,赢在起点,从学习新技术开始。活到老,学到老,是一个合格前端开发者的毕生信仰。

2、vite简介

vite诞生是为了提升web项目运行性能,以更快的速度将应用页面展示给用户。Vite 以 原生 ESM 方式提供源码。这实际上是让浏览器接管了打包程序的部分工作:Vite 只需要在浏览器请求源码时进行转换并按需提供源码。根据情景动态导入代码,即只在当前屏幕上实际使用时才会被处理。

提供的驱动力:

2.1、优化缓慢的服务器启动(冷启动开发服务器和正式环境响应速度);

2.2、优化缓慢的项目更新(vite服务器);

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-znQlBkN0-1642383363135)(E:\vue_project\javascript-demo\前端知识点\vite+vue3最新技术栈\vue3.1.png)]

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Nro6Ko6e-1642383363136)(E:\vue_project\javascript-demo\前端知识点\vite+vue3最新技术栈\vue3.2.png)]

3、vite创建项目

兼容性注意:

Vite 需要 Node.js 版本 >= 12.0.0。

必须安装Volar插件,用vscode编辑器

// 安装vite
1、npm init vite@latest

// 安装vite同时创建vite项目
2、npm init vite@latest my-vue-app --template vue
{
  "scripts": {
    "dev": "vite", // 启动开发服务器
    "build": "vite build", // 为生产环境构建产物
    "serve": "vite preview" // 本地预览生产构建产物
  }
}

4、版本依赖兼容和项目目录介绍

package.json版本依赖说明, 这里是整个项目依赖版本配置,相关安装指令后面视频中会逐个教大家如何安装。

注意:vuex和router都是4.0及以上版本的,否则用vue3时,找不到暴露的api

{
    "name": "vite-ts-vue3-plus-demo",
    "version": "0.0.0",
    "scripts": {
        "dev": "vite",
        "build": "vue-tsc --noEmit && vite build",
        "serve": "vite preview"
    },
    "dependencies": {
        "@element-plus/icons": "0.0.11",
        "dotenv": "^10.0.0",
        "element-plus": "^1.1.0-beta.7",
        "vue": "^3.0.5",
        "vue-router": "^4.0.11",
        "vuex": "^4.0.2"
    },
    "devDependencies": {
        "@types/node": "^16.7.1",
        "@vitejs/plugin-vue": "^1.3.0",
        "@vue/compiler-sfc": "^3.0.5",
        "node-sass": "^6.0.1",
        "sass": "^1.38.1",
        "sass-loader": "^12.1.0",
        "typescript": "^4.3.2",
        "vite": "^2.4.4",
        "vue-tsc": "^0.2.2"
    }
}

5、setup语法糖使用

5.1 setup前身组合式API(基础用法)

注意:在setup()中不能用this

`setup` 中你应该避免使用 `this`,因为它不会找到组件实例。`setup` 的调用发生在 `data` property、`computed` property 或 `methods` 被解析之前,所以它们无法在 `setup` 中被获取,这也是为了避免setup()和其他选项式API混淆。
/* 参数说明
 * props 是响应式的,当传入新的 prop 时,它将被更新
 * context 是一个普通的上下文JavaScript对象,它暴露组件的三个 property(包括属性,插槽,方法),
 * 如下示例1所示 
 */
// 示例1

5.2 setup后世(高级用法),推荐用法

注意:defineProps不需要引入,vue单文件内部自动暴露的API

<script setup lang="ts"><script>是在单文件组件(SFC)中使用组合式API的编译时的语法糖。相比普通的语法,它具有更多优势:
- 更少的样板内容,更简洁的代码,比如:省略了组件的注册声明,对象暴露return,methods,- 能够使用纯 Typescript 声明 props 和发出事件。
- 更好的运行时性能 (其模板会被编译成与其同一作用域的渲染函数,没有任何的中间代理)- 更好的 IDE 类型推断性能 (减少语言服务器从代码中抽离类型的工作)

注意点:

1、在setup语法糖中导入组件不需要注册声明,直接在视图中使用即可;

2、vue文件结构发生改变,js默认放到页面顶部,而视图template放到js下面,style放到页面底部;

3、导入vue文件必须写上文件后缀名.vue, 否则ts无法识别vue文件。

示例对比:

// 基础用法

// 高级用法

6、defineProps 和 defineEmits

注意:definePropsdefineEmits 都是只在

6.2 、父组件vue



温馨提示:这里介绍一哈volar插件小图标在vue文件里的作用:

点击这个三角形图标,会将文件归类显示,方便编写代码;

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EbrgSaUR-1642383363137)(E:\vue_project\demos\vite-vue3-ts-volar\vite+vue3最新技术栈文档\volar.png)]

7、正确使用defineExpose

使用

7.2、父组件调用子组件方法和属性



7.3 在setup如何定义变量(字符串,对象,数组)



8、Watch和WatchEffect

1、基本使用方法:



  

2、watch与 watchEffect 比较,推荐watch监听

watch: 页面更新后不会立即执行,而watchEffect 它会执行;

如果要实现:watch在页面更新之后就执行,需要增加立即执行的属性;

watch([count,originData.user], (n, o)=> {console.log(n[0],n[1].name)}, {deep: true, immediate: true})
1、watch和watchEffect都懒执行副作用,不过watchEffect比较频繁,在vue组件更新之前执行;
2、watch更具体地说明什么状态应该触发侦听器重新运行,watchEffect就没有这么友好;
3、watch访问侦听状态变化前后的值。

9、在setup中的生命周期钩子

因为 setup 是围绕 beforeCreatecreated 生命周期钩子运行的,所以不需要显式地定义它们。换句话说,在这些钩子中编写的任何代码都应该直接在 setup 函数中编写。

下表包含如何在 setup () 内部调用生命周期钩子:

选项式 API Hook inside setup
beforeCreate Not needed* 不需要
created Not needed* 不需要
beforeMount onBeforeMount 挂载之前
mounted onMounted 页面加载完成时执行
beforeUpdate onBeforeUpdate
updated onUpdated
beforeUnmount onBeforeUnmount
unmounted onUnmounted 页面销毁时执行
errorCaptured onErrorCaptured
renderTracked onRenderTracked
renderTriggered onRenderTriggered
activated onActivated
deactivated onDeactivated
<script setup lang="ts">
import { onMounted, onActivated, onUnmounted, onUpdated, onDeactivated } from 'vue';
// 读取环境变量
const mode = import.meta.env;
//   import HeadMenu from '@/components/head-menu/index.vue';
 onMounted(() => {
 console.log("组件挂载")
 })

 onUnmounted(() => {
 console.log("组件卸载")
 })

 onUpdated(() => {
 console.log("组件更新")
 })
 onActivated(() => {
 console.log("keepAlive 组件 激活")
 })

 onDeactivated(() => {
 console.log("keepAlive 组件 非激活")
 })
</script>

10、用Ts限制define(Emits|Props)参数类型

注意:

1、在setup语法糖中引入组件不需要注册声明就可以直接用了

2、ts 限制组件传参类型,默认是必须传值的,否则控制台出现警告, 引入组件的地方会出现红色提醒,不想必传在绑定参数后加?即可

3、ts传参支持多种类型校验,一个参数可以传字符串,数组,Boolean等

4、用ts方式限制defineEmits和defineProps参数类型

1、子组件



2、父组件






11、递归组件

一个单文件组件可以通过它的文件名被其自己所引用。例如:名为 FooBar.vue 的组件可以在其模板中用 引用它自己。

请注意这种方式相比于 import 导入的组件优先级更低。如果有命名的 import 导入和组件的推断名冲突了,可以使用 import 别名导入:

import { FooBar as FooBarChild } from './components'

注意:这里有小问题,当单文件引入单文件时会出现内存溢出现象

12、component动态组件

由于组件被引用为变量而不是作为字符串键来注册的,在

13、ts限制普通函数/箭头函数参数类型

13.1 普通函数


13.2 箭头函数,推荐用法


14、引入vuex配置和使用

14.1 创建项目时我们已经引入了vuex4.0版本,接下来我们就开始配置vuex4.0并测试。

// 注意必须安装vuex4.0版本及以上
npm install vuex@next --save
#or
yarn add vuex@next --save

14.2 在src目录下创建store文件夹,新建文件index.ts, index.ts内容如下所示:

import { InjectionKey } from 'vue'
/**
 * 引入 InjectionKey 并将其传入 useStore 使用过的任何地方,
 * 很快就会成为一项重复性的工作。为了简化问题,可以定义自己
 * 的组合式函数来检索类型化的 store 
 */
// 未简化useStore版
// import { createStore, Store } from 'vuex'
// 简化useStore版
import { useStore as baseUseStore, createStore, Store} from 'vuex'

// 为 store state 声明类型
export interface State {
    username: string,
    count: number
}

// 定义 injection key
export const key: InjectionKey<Store<State>> = Symbol()

// 导出store模块
export const store = createStore<State>({
    state: {
        username: "测试store",
        count: 0
    },
    getters:{
        getName: state =>{
            return state.username
        }
    },
    mutations: {
        // 重置名称
        SET_NAME(state, params:string) {
            state.username = params
        }
    },
    actions:{}
})

// 定义自己的 `useStore` 组合式函数
export function useStore () {
    return baseUseStore(key)
}

14.3 在根目录下新建vuex-d.ts文件,内容如下所示:

// 一个声明文件来声明 Vue 的自定义类型 ComponentCustomProperties
import { ComponentCustomProperties } from 'vue';
import { Store } from 'vuex';

declare module '@vue/runtime-core' {
    // 声明自己的 store state
    interface State {
        count: number,
        username: string
    }
    // 为 `this.$store` 提供类型声明
    interface ComponentCustomProperties {
        $store: Store<State>
    }
}

14.4 在main.ts中注入store模块

import { createApp } from 'vue';
import App from './App.vue';
// 导入store模块, 传入 injection key
import { store, key } from '@/store';
const app = createApp(App)
app.use(store, key)
app.mount('#app')

14.5 引用测试vuex配置是否正确

点击修改名称

15、router配置以及使用详解

15.1 安装

创建项目时我们已经引入了router4.0版本,接下来我们就开始配置router4.0并测试。

// 注意:安装router必须是4.0及以上
npm install vue-router@4

15.2 页面准备

目录结构

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-O1byer9d-1642383363137)(E:\vue_project\demos\vite-vue3-ts-volar\vite+vue3最新技术栈文档\page.png)]

页面具体内容:

1、layout/index.vue



2、layout/header/index.vue




3、pages/home/index.vue


4、pages/about/index.vue


15.3 在src目录下创建router文件夹,然后创建index.ts文件,内容如下所示:

import { createRouter, createWebHashHistory } from "vue-router";
import LayOut from "../components/layout/index.vue";

const routes = [
    {
        path: '/',
        component: LayOut,
        redirect: '/home',
        children:[
            {
                path: '/home',
                name: 'home',
                component: ()=> import("../pages/home/index.vue"),
                meta:{
                    title: '首页',
                    icon: ''
                }
            },
            {
                path: '/about',
                name: 'about',
                component: ()=> import("../pages/about/index.vue"),
                meta:{
                    title: '关于',
                    icon: ''
                }
            }
        ]
    }
]
const router = createRouter({
    history: createWebHashHistory(),
    routes
})
export default router

15.4 在main.ts中注入router模块, 重新启动项目,访问路由,看是否正确

import { createApp } from 'vue'
import App from './App.vue'
import { store, key } from './store';
import router from './router';

const app = createApp(App);
app.use(store, key);
app.use(router);
app.mount('#app');

15.5 使用路由





16、引入element-plus以及注意事项

16.1 安装

npm install element-plus --save
# or
yarn add element-plus

# 安装icon图标依赖库
npm install @element-plus/icons
# or
yarn add @element-plus/icons

16.2 在main.ts 文件中引入配置

import { createApp } from 'vue'
import App from './App.vue'
import { store, key } from './store';
// 注入路由
import router from './router';

// 引入ui组件
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'

const app = createApp(App);
app.use(store, key);
app.use(router);
app.use(ElementPlus);
app.mount('#app');

16.3 在vue文件中引用ui组件

1、单个图标引用



2、全局注册图标使用

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

import { Edit,Search } from '@element-plus/icons'

const app = createApp(App);
app.component("edit", Edit)
app.component("search", Search)
app.mount('#app');

2、1 使用图标



17、配置vite.config.ts

这里主要配置vite服务器的打包保存地址,打包分解,端口号,是否自动打开浏览器,远程请求地址代理目标,目录别名,全局样式配置等。

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import { loadEnv } from 'vite';
// nodejs写法,获取项目目录
import path from 'path';

// https://vitejs.dev/config/
export default({ command, mode }) => {
    return defineConfig({
        plugins: [vue()],
        server:{
            host: '127.0.0.1',
            port: Number(loadEnv(mode, process.cwd()).VITE_APP_PORT),
            strictPort: true, // 端口被占用直接退出
            https: false,
            open: true,// 在开发服务器启动时自动在浏览器中打开应用程序
            proxy: {
                // 字符串简写写法
                // '/foo': '',
                // 选项写法
                '/api': {
                    target: loadEnv(mode, process.cwd()).VITE_APP_BASE_URL,
                    changeOrigin: true,
                    rewrite: (path) => path.replace(/^\/api/, '')
                },
                // 正则表达式写法
                // '^/fallback/.*': {
                //   target: 'http://jsonplaceholder.typicode.com',
                //   changeOrigin: true,
                //   rewrite: (path) => path.replace(/^\/fallback/, '')
                // },
            },
            hmr:{
                overlay: true // 屏蔽服务器报错
            }
        },
        resolve:{
            alias:{
                '@': path.resolve(__dirname,'./src')
            }
        },
        css:{
            // css预处理器
            preprocessorOptions: {
                // 引入 var.scss 这样就可以在全局中使用 var.scss中预定义的变量了
                // 给导入的路径最后加上 ;
                scss: {
                    additionalData: '@import "@/assets/styles/global.scss";'
                }
            }
        },
        build:{
            chunkSizeWarningLimit: 1500, // 分块打包,分解块,将大块分解成更小的块
            rollupOptions: {
                output:{
                    manualChunks(id) {
                        if (id.includes('node_modules')) {
                            return id.toString().split('node_modules/')[1].split('/')[0].toString();
                        }
                    }
                }
            }
        }
    })   
}

18、tsconfig.json 配置

这是typescript的识别配置文件,也是ts向js转化的中间站,这里配置了许多关于ts的文件类型和策略方法。

{
    "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"]
}

19、shims-vue.d.ts配置, 声明vue文件全局模块

这里是配置声明,比如css,vue等文件,ts不能识别,需要配置声明模块类型。

declare module '*.vue' {
  import { DefineComponent } from 'vue'
  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/ban-types
  const component: DefineComponent<{}, {}, any>
  export default component
}

20、安装scss并配置全局样式文件

// 注意要使用scss,必须安装依赖,否则报错
npm install node-sass sass-loader sass -D

20.1 需要在src目录的assets静态目录新增一个全局global.scss文件,其他样式文件导入到该文件即可全局使用和修改。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-OMnks85U-1642383363138)(E:\vue_project\demos\vite-vue3-ts-volar\vite+vue3最新技术栈文档\csss.png)]

或者在global.scss写一个单独属性测试

$color-primary: #007aff;

vue使用全局样式变量



20.2 在vite.config.ts 文件中配置global.scss

 css:{
     // css预处理器
     preprocessorOptions: {
         // 引入 var.scss 这样就可以在全局中使用 var.scss中预定义的变量了
         // 给导入的路径最后加上 ;
         scss: {
             additionalData: '@import "@/assets/styles/global.scss";'
         }
     }
 }

21、响应式API

21.1 、ref

响应式状态需要明确使用响应式 APIs 来创建。和从 setup() 函数中返回值一样,ref 值在模板中使用的时候会自动解包:




21.2、toRefs

将响应式对象转换为普通对象,其中结果对象的每个 property 都是指向原始对象相应 property 的 ref

当从组合式函数返回响应式对象时,toRefs 非常有用,这样消费组件就可以在不丢失响应性的情况下对返回的对象进行解构/展开:

function useFeatureX() {
  const state = reactive({
    foo: 1,
    bar: 2
  })

  // 操作 state 的逻辑

  // 返回时转换为ref
  return toRefs(state)
}

export default {
  setup() {
    // 可以在不失去响应性的情况下解构
    const { foo, bar } = useFeatureX()

    return {
      foo,
      bar
    }
  }
}

toRefs 只会为源对象中包含的 property 生成 ref。如果要为特定的 property 创建 ref,则应当使用 toRef

21.3、roRef

可以用来为源响应式对象上的某个 property 新创建一个 ref。然后,ref 可以被传递,它会保持对其源 property 的响应式连接。

const state = reactive({
  foo: 1,
  bar: 2
})

const fooRef = toRef(state, 'foo')

fooRef.value++
console.log(state.foo) // 2

state.foo++
console.log(fooRef.value) // 3

即使源 property 不存在,toRef 也会返回一个可用的 ref。这使得它在使用可选 prop 时特别有用,可选 prop 并不会被 toRefs 处理。

22、.env.环境变量配置和读取

环境变量建议放到项目根目录下, 方便vite.config.ts文件读取和使用

.env.production // 生产环境配置文件
.env.development // 开发环境配置文件

22.1 生产和开发环境配置文件内容如下:

写变量时一定要以VITE_开头,才能暴露给外部读取

# 开发环境 / #生产环境
VITE_APP_TITLE = "前端技术栈"
VITE_APP_PORT = 3001

# 请求接口
VITE_APP_BASE_URL = "http://39.12.29.12:8080"

//env.d.ts文件内进行 环境变量智能提示配置
interface ImportMetaEnv {
     VITE_APP_TITLE: string,
     VITE_APP_PORT: string,
     VITE_APP_BASE_URL: string
}

22.2 vite.config.ts 读取配置文件

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import { loadEnv } from 'vite';
// nodejs写法,获取项目目录
import path from 'path';

// https://vitejs.dev/config/
export default({ command, mode }) => {
    // console.log(command, mode, 5555);
    return defineConfig({
        plugins: [vue()],
        server:{
            host: '127.0.0.1',
            port: Number(loadEnv(mode, process.cwd()).VITE_APP_PORT),
            strictPort: true, // 端口被占用直接退出
            https: false,
            open: true,// 在开发服务器启动时自动在浏览器中打开应用程序
            proxy: {
                // 字符串简写写法
                // '/foo': '',
                // 选项写法
                '/api': {
                    target: loadEnv(mode, process.cwd()).VITE_APP_BASE_URL,
                    changeOrigin: true,
                    rewrite: (path) => path.replace(/^\/api/, '')
                },
                // 正则表达式写法
                // '^/fallback/.*': {
                //   target: 'http://jsonplaceholder.typicode.com',
                //   changeOrigin: true,
                //   rewrite: (path) => path.replace(/^\/fallback/, '')
                // },
                // 使用 proxy 实例
                // '/api': {
                //   target: 'http://jsonplaceholder.typicode.com',
                //   changeOrigin: true,
                //   configure: (proxy, options) => {
                //     // proxy 是 'http-proxy' 的实例
                //   },
                // }
            },
            hmr:{
                overlay: true // 屏蔽服务器报错
            }
        },
        resolve:{
            alias:{
                '@': path.resolve(__dirname,'./src')
            }
        },
        css:{
            // css预处理器
            preprocessorOptions: {
                // 引入 var.scss 这样就可以在全局中使用 var.scss中预定义的变量了
                // 给导入的路径最后加上 ;
                scss: {
                    additionalData: '@import "@/assets/styles/global.scss";'
                },
                sass: {
                    additionalData: '@import "@/assets/styles/global.scss";'
                }
            }
        },
        build:{
            chunkSizeWarningLimit: 1500, // 分块打包,分解块,将大块分解成更小的块
            rollupOptions: {
                output:{
                    manualChunks(id) {
                        if (id.includes('node_modules')) {
                            return id.toString().split('node_modules/')[1].split('/')[0].toString();
                        }
                    }
                }
            }
        }
    })   
}

22.3 其他文件读取环境变量



23、【补充】mixin混入模式

vue2.0中的Mixin 提供了一种非常灵活的方式,来分发 Vue 组件中的可复用功能。一个 mixin 对象可以包含任意组件选项。当组件使用 mixin 对象时,所有 mixin 对象的选项将被“混合”进入该组件本身的选项。

Mixin缺点温馨提示:

在 Vue 2 中,mixin 是将部分组件逻辑抽象成可重用块的主要工具。但是,他们有几个问题:

  • Mixin 很容易发生冲突:因为每个 mixin 的 property 都被合并到同一个组件中,所以为了避免 property 名冲突,你仍然需要了解其他每个特性。
  • 可重用性是有限的:我们不能向 mixin 传递任何参数来改变它的逻辑,这降低了它们在抽象逻辑方面的灵活性。

为了解决这些问题,我们添加了一种通过逻辑关注点组织代码的新方法:组合式 API。

换言之: 在vue3.0里是不推荐使用mixin混入开发的,更加推荐使用组合式API,将页面操作数据的功能进行代码拆分,更好的发挥大型项目下共享和复用代码,在代码的可维护性和扩展性得以长存。

24、【补充】顶层的绑定会被暴露给模板

当使用

25、【补充】teleport传送门

teleport必须是有效的查询选择器或 HTMLElement (如果在浏览器环境中使用)。指定将在其中移动 内容的目标元素,disabled-boolean此可选属性可用于禁用 的功能,这意味着其插槽内容将不会移动到任何位置,而是在你在周围父组件中指定了 的位置渲染。

25.1 创建带传送门的组件


25.2 teleport混合component使用



26、【补充】computed使用

refwatch 类似,也可以使用从 Vue 导入的 computed 函数在 Vue 组件外部创建计算属性。让我们回到 counter 的例子:

import { ref, computed } from 'vue'

const counter = ref(0)
const twiceTheCounter = computed(() => counter.value * 2)

counter.value++
console.log(counter.value) // 1
console.log(twiceTheCounter.value) // 2

注意:

接受一个 getter 函数,并根据 getter 的返回值返回一个不可变的响应式 ref 对象。

// 不能这样使用
twiceTheCounter.value++ //错误用法

Vite+Vue3+Setup+TypeScript布衣博客项目实战<二>

序言:

​ 首先感谢各位前端朋友的支持和鼓励,你们的鼓励和理解是我前进路上的动力源泉。从本项目学到更多的是开发过程中的细节和注意事项。

​ 为把七零八碎的基础知识点串联起来,有一个系统性的认识和了解setup,vite,typescript和vue3,更加贴近网络应用项目,接近实际生活信息化研发需求,进一步从细节剖析各个技术知识点,布衣前端特此出品名为:《布衣博客》的web网页设计。目的是为了更好掌握Vite+Vue3+setup+TypeScript最新的web技术栈,熟练使用它们进行研发出属于自己的或者企业级的应用项目。本博客专门针对setup+ts进行开发,省略传统vue2的api。没有vue2基础知识的朋友,建议看完vue3再来学习效果更佳。

温馨提示: 布衣博客项目是依赖于基础知识案例部分进行改造的,项目的创建和各个依赖的安装,不在赘述和重演,所以没有把基础知识学完的朋友,最好学完后在来浏览项目实战部分。

获取基础知识项目的渠道:

1、看完基础知识案例视频就有了,地址:https://www.bilibili.com/video/BV1QP4y1p748/

2、自己根据vite官网创建项目也可以,不过有些东西需要自己补充,地址:https://cn.vitejs.dev/guide/#scaffolding-your-first-vite-project

1、项目依赖升级

既然项目要玩最新的,依赖当然得更新到最新版

旧版本依赖:

"dependencies": {
    "@element-plus/icons": "0.0.11",
    "element-plus": "^1.1.0-beta.12",
    "vue": "^3.2.11",
    "vue-router": "^4.0.11",
    "vuex": "^4.0.2"
  },
  "devDependencies": {
    "@types/node": "^16.9.2",
    "@vitejs/plugin-vue": "^1.6.0",
    "@vue/compiler-sfc": "^3.2.6",
    "node-sass": "^6.0.1",
    "sass": "^1.41.1",
    "sass-loader": "^12.1.0",
    "typescript": "^4.3.2",
    "vite": "^2.5.2",
    "vue-tsc": "^0.2.2"
  }

新版本依赖:

"dependencies": {
    "@element-plus/icons": "0.0.11",
    "element-plus": "^1.2.0-beta.2", // 原版本1.1.0-beta.12
    "vue": "^3.2.21", // 原版本3.2.11
    "vue-router": "^4.0.12",
    "vuex": "^4.0.2"
  },
  "devDependencies": {
    "@types/node": "^16.9.2",
    "@vitejs/plugin-vue": "^1.6.0",
    "@vue/compiler-sfc": "^3.2.6",
    "node-sass": "^6.0.1",
    "sass": "^1.41.1",
    "sass-loader": "^12.1.0",
    "typescript": "^4.3.2",
    "vite": "^2.6.13", // 原版本2.5.2
    "vue-tsc": "^0.28.10" //原版本0.2.2
  }

2、创建顶部菜单组件

2.1 在组件文件夹layout目录下新建menu文件夹,然后新建menu-bar.vue,完整内容如下。




2.2 在同级menu文件夹下新建style.scss,内容如下:



2.3 在header.vue引入menu-bar.vue




2.4 在assets目录里的styles目录下新增body.scss文件,内容如下

body{
    font-family: Avenir, Helvetica, Arial, sans-serif;
    -webkit-font-smoothing: antialiased;
    -moz-osx-font-smoothing: grayscale;
    color: #2c3e50;
    width: 100%;
    margin: 0;
    padding: 0;
    background-color: #ececec;
}

然后在layout.scss内部导入

@import "./body.scss";

3、修复选中菜单刷新丢失问题

这里采用store状态管理的持久化解决,在index.ts里面新增currentMenu属性

import { InjectionKey } from 'vue';

import { useStore as baseUseStore, createStore, Store} from 'vuex';

interface State{
    username: string,
    currentMenu: string  // 当前菜单
}

export const key: InjectionKey<Store<State>> = Symbol();

export const store = createStore<State>({
    state:{
        username: '张三',
        currentMenu: localStorage.getItem('currentMenu') || '1'
    },
    getters:{
        getName: (state:State)=>{
            return state.username
        },
        getCurrentMenu: (state:State) =>{
            return state.currentMenu || localStorage.getItem('currentMenu')
        }
    },
    mutations:{
        SET_USERNAME(state:State, username: string){
            state.username = username;
        },
        SET_CURRENT_MENU(state:State, params: string){
            localStorage.setItem('currentMenu', params)
            state.currentMenu = params
        }
    },
    actions:{}
})

export function useStore () {
    return baseUseStore(key)
}

注意:在引用@/store目录报错找不到时,请更换项目typeconfig.json文件内容如下

{
  "compilerOptions": {
    "target": "esnext", // 目标语言的版本
    "module": "esnext", // 指定生成代码的模板标准
    "moduleResolution": "node", // node模块解析
    "strict": true, // 启用严格模式
    "jsx": "preserve", // jsx模板解析
    "noImplicitAny": true, // 不允许隐式的 any 类型
    "removeComments": true, // 删除注释 
    "sourceMap": true, // 生成目标文件的sourceMap文件
    "strictNullChecks": true, // 不允许把null、undefined赋值给其他类型的变量
    "resolveJsonModule": true, // 允许导入.json文件
    "esModuleInterop": true,  // 允许导入额外的ts文件支持
    "suppressImplicitAnyIndexErrors": true, // 允许字符串下标表达式
    "lib": ["esnext", "dom"],
    "baseUrl": ".", // 解析非相对模块的基地址,默认是当前目录, 防止引入文件报错
    "paths": {  // 路径映射,相对于baseUrl
        "@/*":["src/*"]
    },
    "skipLibCheck":true // 所有的声明文件(*.d.ts)的类型检查, 解决:打包不报错
  },
  // 指定一个匹配列表(属于自动指定该路径下的所有ts相关文件)
  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
}

4、router.ts的RouteRecordRaw类型校验

为了规范化typescript开发,增加路由对象类型限制,好处:允许在基础路由里面增加开发者自定义属性

import { createRouter, createWebHashHistory, RouteRecordRaw } from 'vue-router';
import LayOut from '@/components/layout/index.vue';

const routes:Array<RouteRecordRaw> = [
    {
        path: "/",
        component: LayOut,
        redirect: "/home",
        hidden: true,
        children:[
            {
                path: "/home",
                name: "home",
                hidden: false,
                meta:{
                    title: '首页',
                    index: '1'
                },
                component:()=> import("@/pages/home/index.vue")
            },
            {
                path: "/about",
                name: "about",
                meta:{
                    title: '关于',
                    index: '2'
                },
                component:()=> import("@/pages/about/index.vue")
            }
        ]
    }
]

const router = createRouter({
    // 指定路由模式
    history: createWebHashHistory(),
    // 路由地址
    routes
})

export default router;

注意:在给路由对象新增类型后,在每个路由对象里新增hidden或者其他属性会报错,解决办法:在src目录下新增一个路由声明文件,扩展基础路由对象属性。

vue-router.d.ts,内容如下:

import { _RouteRecordBase } from 'vue-router';

declare module 'vue-router'{
    interface _RouteRecordBase{
        hidden?: boolean | string | number
    }
}

5、通过beforeEach修改浏览器标题

解决方法:main.ts文件中的router.beforeEach方法里设置即可。

 
router.beforeEach((to, from, next) =>{
    // 设置浏览器标题
    if(to.meta.title){
        document.title = String(to.meta.title)
    }else {
        document.title = "布衣博客"
    }
    // console.log(to, from, router);
    next()
})

注意:router.beforeEach使用时,必须加next()方法,否则路由不会进行跳转和更新。

6、路由导航出错处理

在实际项目开发中,经常遇到路由导航报错或者找不到问题,那么处理这个问题就变得很有必要。解决方法就是在main.ts文件中的router.beforeEach方法里判断即可。

import { createApp } from 'vue'
import App from './App.vue'
import { store, key } from './store';
// 注入路由
import router from './router';

// 注入ui组件库
import ElementPlus,{ElNotification} from 'element-plus'
import 'element-plus/dist/index.css'

import { Edit, Camera } from '@element-plus/icons'

const app = createApp(App);

app.component('edit', Edit);
app.component('camera', Camera);

app.use(ElementPlus);

app.use(store, key);
app.use(router);
app.mount('#app');

router.beforeEach((to, from, next) =>{
    // 设置浏览器标题
    if(to.meta.title){
        document.title = String(to.meta.title)
    }else {
        document.title = "布衣博客"
    }

7、用nprogress设置路由加载进度条

我们在打开用vue写的项目时,经常看到顶部有一个页面加载进度条,其实这里是根据路由匹配速度进行设置的进度条,目的增加用户浏览项目体验,这里用的插件是: nprogress,需要在main.ts文件中的router.beforeEach方法里配置即可。

7.1 安装 nprogress:

npm install --save nprogress

7.2 封装nprogress:

// 引入进度条
import NProgress from 'nprogress';
import 'nprogress/nprogress.css';

//全局进度条的配置
NProgress.configure({ 
    easing: 'ease',  // 动画方式    
    speed: 1000,  // 递增进度条的速度    
    showSpinner: false, // 是否显示加载ico    
    trickleSpeed: 200, // 自动递增间隔    
    minimum: 0.3 // 初始化时的最小百分比
})

// 打开进度条
export const start = ()=>{
    NProgress.start()
}

// 关闭进度条
export const close = ()=>{
    NProgress.done()
}

注意:导入nprogress时如果报错,请在env.d.ts文件增加nprogress模块声明或者在src下新建nprogress.d.ts声明文件即可

不管那种方式,内容都是如下:

// 申明进度条依赖模块
declare module 'nprogress';

7.3 使用工具nprogress

需要在main.ts文件中的router.beforeEach方法里配置即可。

8、响应式设计顶部菜单栏

8.1 通用全局样式common.scss, 需要注入global.scss

* {
    -moz-box-sizing: border-box;
    box-sizing: border-box;
}
ul,
li {
	list-style: none;
}
html,
body,
div,
span,
object,
iframe,
h1,
h2,
h3,
h4,
h5,
h6,
p,
blockquote,
pre,
abbr,
address,
cite,
code,
del,
dfn,
em,
img,
ins,
kbd,
q,
samp,
small,
strong,
sub,
sup,
var,
b,
i,
dl,
dt,
dd,
ol,
ul,
li,
fieldset,
form,
label,
legend,
table,
caption,
// tbody,
// tfoot,
// thead,
// tr,
// th,
// td,
article,
aside,
canvas,
details,
figcaption,
figure,
footer,
header,
hgroup,
menu,
nav,
section,
summary,
time,
mark,
audio,
video {
	margin: 0;
	padding: 0;
	// border: 0;
	outline: 0;
	list-style: none;
	vertical-align: baseline;
	// background: transparent;
	font-size: 100%;
	font-weight: normal;
}
.layout-sider-bar{
  &::-webkit-scrollbar {
   display:none;
  }
  /* IE内核 */
  -ms-scroll-chaining: chained;
  -ms-overflow-style: none;
  -ms-content-zooming: zoom;
  -ms-scroll-rails: none;
  -ms-content-zoom-limit-min: 100%;
  -ms-content-zoom-limit-max: 500%;
  -ms-scroll-snap-type: proximity;
  -ms-scroll-snap-points-x: snapList(100%, 200%, 300%, 400%, 500%);
  -ms-overflow-style: none;
}
::-webkit-scrollbar {
width: 6px;
height: 12px;
background:#F7F7F7;
}
 
::-webkit-scrollbar-thumb {
background-color: #ccc;
}

8.2 新增全局布局样式文件layout.scss,需要注入global.scss文件

注意:设置position: fixed;元素固定定位后,会脱离文档流,高度会失效,解决办法,增加父级固定高度。

.set-common-head-fixed-container{
    height:90px;// 预留菜单总高度,后期可能修改
}
// .common-head-fixed-container{
//     position: fixed;
//     top: 0px;
//     left: 0px;
//     width: 100%;
//     z-index: 9;
// }

// 头部菜单做媒体查询,适应所有屏幕大小,自定义宽度和样式变化
// 1、超小屏幕下,小于768px 布局容器的宽度为100%
@media screen and (max-width:767px){
    .show-pc{
        display: none;
    }
    .show-mobile{
        display: block;
        background-color: red;
    }
}
// 2、小屏幕下,大于等于768px 布局容器改为750px
@media screen and (min-width: 750px){
    .show-pc{
        display: none;
    }
    .show-mobile{
        display: block;
        background-color: red;
    }

}
// 3、中等屏幕下, 大于等于992px 布局容器改为970
@media screen and (min-width:992px){
    .show-pc{
        display: block;
        background-color: orange;
    }
    .show-mobile{
        display: none;
    }
}
// 4、大屏幕下,大于等于1200px, 布局容器改为1170px
@media screen and (min-width: 1200px){
    .show-pc{
        display: block;
        background-color: yellow;
    }
    .show-mobile{
        display: none;
    }
}

8.3 在布局组件header的vue文件内


9、新增logo到顶部菜单栏

这个logo大家自行设计,实际上线项目不要用我的logo就行。



10、设计小屏幕下的导航栏

10.1 在header/index.vue进行小屏幕下也设计




注意:使用媒体查询后,样式名称不能又写在页面样式中,否则媒体查询效果失败,需要在全局layout.scss文件中进行修改

// 设置小屏幕下基础样式
.show-mobile{
    display: flex !important;
    justify-content: flex-start;
    padding: 0 5px;
    background-color: #2c3e50;
    .same-cell{
        color: #fff;
    }
}

注意:如果用icon图标大小不生效,可能是其他样式影响的,需要设置全局字体大小来解决,在common.scss

10.2 改造后的菜单MenuBar.vue组件




11、main.ts中批量注入@element-plus/icons图标

import * as ElIcons from '@element-plus/icons';

const app = createApp(App);
Object.keys(ElIcons).forEach(key =>{
    app.component(key, ElIcons[key]);
})

注意:这里的as是另起别名的意思,怕组件名称冲突

12、增加登录,注册按钮到顶部导航栏

在菜单MenuBar.vue组件内进行新增

// vue
登录 注册
// ts

13、Breadcrumb面包屑显示当前路由位置

13、1在layout文件夹下新增bread-crumb文件夹,新增index.vue,内容如下:




13、2 在header/index.vue里面使用面包屑

注意:如果导航节点是父节点,路由是不会跳转,需要设置父节点默认路由即可

举个例子:

{
    path: "/program",
    name: "program",
    redirect: "/program/front",
    meta:{
         title: '编程相关',
         index: '2'
          },
     component:()=> import("@/pages/program/index.vue"),
          children:[
                 {
                      path: "/program/front",
                      name: "program-front",
                      meta:{
                         title: '前端编程',
                         index: '2-1'
                       },
                       component:()=> import("@/pages/program/front/index.vue")
                   },
                   {
                        path: "/program/applet",
                        name: "program-applet",
                        meta:{
                              title: '微信小程序',
                              index: '2-3'
                        },
                        component:()=> import("@/pages/program/applet/index.vue")
                    },
            ]
},

14、测试面包屑导肮是否正确

14、1 准备两个页面,放到pages/program文件夹下behind和front

在program文件夹下新增index.vue路由二级出口,内容如下




// 前端页面vue放front文件夹里




// 后端页面vue 放behind文件夹里




14、2 新增program文件的路由在router.ts

{
    path: "/program",
    name: "program",
    redirect: "/program/front",
    meta:{
         title: '编程相关',
         index: '2'
          },
     component:()=> import("@/pages/program/index.vue"),
          children:[
                 {
                      path: "/program/front",
                      name: "program-front",
                      meta:{
                         title: '前端编程',
                         index: '2-1'
                       },
                       component:()=> import("@/pages/program/front/index.vue")
                   },
                   {
                        path: "/program/behind",
                        name: "program-behind",
                        meta:{
                              title: '后端',
                              index: '2-3'
                        },
                        component:()=> import("@/pages/program/behind/index.vue")
                    },
            ]
},

15、解决关于父菜单箭头错位问题

解决方案:降低element-plust版本

// 之前的版本,菜单箭头错位
"element-plus": "^1.2.0-beta.2"
// 降低的版本,稳定版本
"element-plus": "^1.1.0-beta.20"

16、设计轮播图组件

准备工作:

  • 注释掉App.vue文件的样式
  • 在layout.scss新增通用盒子样式,所有页面父元素基于它
// 设置全局通用盒子基础样式
.common-layout-container{
    padding: 0px 10px 5px;
}

1、新增组件, carousels/index.vue, 内容如下




17、设计文章组件

1、新增组件,article-item/index.vue, 内容如下




2、新增 styles/mixins.scss, 专门放置项目通用样式和函数样式

// 全局通用函数
@mixin common-title($center: center){
    font-weight: bold;
    text-align: $center;
    padding: 5px 0px;
}

/* 单行超出隐藏 */
 @mixin ellipsis() {
     word-wrap: break-word;
     word-break: break-all;
     white-space: nowrap;
     overflow: hidden;
     text-overflow: ellipsis;
 }
 
 /* 多行超出隐藏 */
 @mixin muit-ellipsis($line) {
     word-break: break-all;
     overflow: hidden;
     text-overflow: ellipsis;
     display: -webkit-box;
     -webkit-line-clamp: $line;
     -webkit-box-orient: vertical;
 }

 
 @mixin globalTransition( $time:0.3s) {
     @if $time==0.3s {
         -ms-transition: all 0.3s ease-in;       /* IE 9 */
         -webkit-transition: all 0.3s ease-in;   /* Safari 和 Chrome */
         -moz-transition: all 0.3s ease-in;      /* Firefox */
         -o-transition: all 0.3s ease-in;        /* Opera */
         transition: all 0.3s ease-in;
     }@else{
         -ms-transition: all $time ease-in;       /* IE 9 */
         -webkit-transition: all $time ease-in;   /* Safari 和 Chrome */
         -moz-transition: all $time ease-in;      /* Firefox */
         -o-transition: all $time ease-in;        /* Opera */
         transition: all $time ease-in;
     }
 }

3、文章详情页





19、设计博主信息组件

1、新增组件author-info/index.vue, 内容如下



20、设计版权信息组件

新增组件copyright-info/index.vue,内容如下



21、标签组件



22、网站信息组件



注意:以上作者组件,文章标签组件,网站信息组件是全局注入main.ts的,根据自己的需求使用即可;另外,具体内容布局样式参考实际项目代码样式,这里不做列举了,根据类名搜索就能找到对于样式的哈

完整的main.ts文件内容如下:

import { createApp } from 'vue';
import App from './App.vue';
import { store, key } from './store';
// 注入路由
import router from './router';

// 注入ui组件库
import ElementPlus,{ElNotification} from 'element-plus';
import 'element-plus/dist/index.css';

import 'xe-utils'
import VXETable from 'vxe-table'
import 'vxe-table/lib/style.css'

// 引入font-awesome
import '@/assets/font-awesome/css/font-awesome.css';

import * as ElIcons from '@element-plus/icons';

import { start, close} from "@/script/utils/nprogress";

import AuthorInfo from '@/components/author-info/index.vue';
import ArticleLabel from '@/components/article-label/index.vue';
import WebSiteInfo from '@/components/website-info/index.vue';

// 当前时间格式
import {currentFormat} from '@/script/utils';

const app = createApp(App);

// 批量注入icon图标组件
Object.keys(ElIcons).forEach(key =>{
    app.component( key, ElIcons[key]);
})

app.component('AuthorInfo', AuthorInfo)
app.component('ArticleLabel', ArticleLabel)
app.component('WebSiteInfo', WebSiteInfo)

app.use(ElementPlus);
app.use(VXETable);

app.use(store, key);
app.use(router);
app.mount('#app');

// 挂载方法
app.config.globalProperties.$currentFormat = currentFormat;

// 设置路哟导航
router.beforeEach((to, from, next)=>{
    start();
    // console.log(to, from, next,111);
    if(to.meta.title){
        document.title = String(to.meta.title)
    }else document.title = '布衣博客'

    // 路由出错处理
    if(to.matched.length===0&&!to.name){
        ElNotification({
            title: '错误提示!',
            message: `${to.fullPath}】路径找不到对应页面,默认切换到首页...`,
            type: 'error',
            duration: 3000
        })
        router.push('/home')
    }
    next()
})

// 路由加载结束后执行
router.afterEach(()=>{
    close()
})

总结【重要】

布衣博客案例到此结束了,内容布局部分不涉及任何vue3知识点,纯属前端基础知识部分,所以就没有带领大家一个组件一个组件的敲代码。大家记得关注【布依前端】自家公众号,后期项目获取仓库链接都放这里了哈。布衣前端再次谢谢大家的关注和鼓励。继续努力录制更多优质前端课程,持续关注布衣前端,有惊喜哦。谢谢各位家人赏脸查阅和观看布衣前端的作品,祝大家前程似锦,万事如意。

你可能感兴趣的