拆解BuildAdmin02：前端架构布局和菜单栏折叠的实现

前言

上一篇主要讲了我学习前端的一个经历，以及为什么选择BuildAdmin作为深入前端学习的原因.同事也大致聊了一下学习前端需要使用哪些技术栈。

本篇文章来拆解一下BuildAdmin的前端代码结构，和布局实现的细节。

前端代码结构

必须先了解项目的结构，才能明确每个功能模块的代码在哪写。BuildAdmin前端目录如下，我只对一级目录进行了粗略的标注，详细的可以去官网看。

在本地需要使用vue-cli脚手架来构建项目，在构建时会有很多选项，包括使用的vue版本和各种插件。

npm install -g @vue/cli
vue create buildadmin

创建之后，基本的目录结构就出来了，后续就可以在各个功能目录添加子目录和模块。

环境安装

在创建好项目之后，还需要安装一些额外的依赖，例如sass、bable等。

1. 安装sass

npm i sass sass-loader

2. 安装babel

babel的主要功能那是将ES语法转换成浏览器识别的js

 npm install --save-dev @babel/core @babel/cli @babel/preset-env @babel/node @babel/polyfill

3. 安装babel，使用可选链?.

在BuildAdmin中，有很多时候都会出现 ?.，这便是防止出现空指针异常的可选链写法，原则就是：有就用，没有就不用。

假设一个对象obj，没有name属性。如果obj.name则会报空指针错误，如果使用obj?.name则输出的是obj。

npm install --save-dev @babel/plugin-proposal-optional-chaining

4. 关闭lint

lint会检查编码中格式的错误，我个人不是很喜欢，所以我会在vue.config.js中关掉。

const { defineConfig } = require('@vue/cli-service')
module.exports = defineConfig({
      transpileDependencies: true,
      lintOnSave: false
})

任何一个vue项目都是从main.ts开始，按照层级开始编写各个组件。而App.vue中作为第一个节点，引入整体的布局组件。

架构布局

BuildAdmin作为一个管理平台，首先要完成布局部分。我们先看BuildAdmin的布局：

可以看到BuildAdmin的整体布局是由：菜单边栏aside、导航header和中心区域main组成的。即ElementPlus中的aside、header、main布局。

这就是官网的代码。

布局实现

从App.vue作为根节点，开始绑定组件。

\<layout>就是定义的整个布局。

上面是我从Element的官网copy的布局代码。BuildAdmin在实现布局时，将aside、header、main都拆分成了单独的组件，如下图所示：

后面我也拆分了的布局代码，将aside、header和main拆分成了三个组件，这样便于阅读、定义css和实现js逻辑等。。

要注意的事，拆分成三个组件之后，在css中需要添加一个flex-direction属性，在拆分之间是没有的。答案在官网中给出来了：如果\<el-container>里如果有el-header元素，则会默认为垂直排列。

后面的拆分，el-header被封装成Header组件了。el-container里面就没有el-header元素了，所以就变成水平分布，这样header就在main的就布局在同一水平线上了，而非上下排列。为了保证上下排列，则必须将此属性设置为column。

实现思路

在将页面拆分成三个部分之后，就需要定义css渲染，来确定各个部分的区域大小和样式。header主要用来渲染面包屑标签，所以暂时先不定义这一块的样式。之后会根据导航标签大小和页面布局调整高和宽，即height和width。

main主要展示各个菜单路由切换后的页面，只要确定height和width即可，这个可以后面实现完路由再调整。所以根据开发需要，可以先实现aside的样式。

aside渲染

aside.vue中此时只有一个\<el-aside>元素，此时我们需要定义它的css样式。

1. css

在style中定义css时，指定sass为css预处理器。

v-bind是vue3中的新用法。其中的menuWidth参数是pinia定义的状态变量，为260px。这里为什么要使用v-bind，而不是直接写260呢？因为aside的宽度是变化的，因为后面菜单折叠需要动态修改宽度，所以这里不能写死。

而且因为菜单栏要放在aside中，且宽度一致，所以直接使用一个变量方便同步控制。那至于为什么定义成260，接着往下看。

那么，css中这些var里面的--开头的变量是哪里来的啊？ 这些其实就是el和自定义全局变量，在控制台都可以查看到。

其中--ba开头的，是BuildAdmin在var.scss中自定义的全局变量。

2. 开发技巧

如果不知道组件的css在哪里定义的，就可以在控制台查看。

可以看到aside的样式：margin上下都是16px，所以上下共有32px。32px + height = 100%，所以aside的height就是100vh-32px？同时，也可以看到width是260px。

3. 渲染效果

至此aside就渲染好了。

虽然现在看起来也没什么变化，但是添加完logo和菜单之后，就会大有不同。aside主要是由两个部分组成的：logo和菜单。这里明确一下需求：

1. 实现logo和菜单
2. 在点击图标时，菜单和logo会进行折叠
3. 封装图标组件

logo

logo就是一个div，这个div主要由img、项目名称和图标构成。其中\<Icon>就是需求3中封装的图标组件，后面会讲。

logo.png是实现选好的logo图片，siteName是项目名称。

菜单

菜单的实现ElementUI的menu组件，直接照抄官网的样例代码，然后修改菜单名即可。但是，后面要实现动态路由，菜单的名称根据从后台请求的数据进行渲染，所以这里需要写一写逻辑，后面的动态路由主要讲的就是这一块的实现。

菜单折叠功能

菜单的折叠功能如下图所演示：

在点击logo旁的折叠按钮时，可以观察到4种变化：

1. aside变窄，不再是260px
2. 折叠按钮图标变化
3. logo折叠（消失）
4. 菜单栏折叠，只剩图标

当点击折叠按钮时，logo和menu都需要知道：“我要折叠/展开了”。我们知道logo和menu是两个独立的组件，而vue中的ref响应式变量只能在单组件内使用（不明白的可以看看vue的ref和reactive）。

所以我们就需要维护一个类似全局变量的东西：一个地方修改了一个变量，其他使用这个变量也会立即更新,VueX和Pinia就是干这个的。在BuildAdmin中，使用的是Pinia。stores目录下存放的就是各种各样的全局变量。

其中，config.ts就是pinia维护的menu共享状态变量。

1. 菜单状态变量

pinia定义的变量如下：

当点击折叠按钮时，通过修改menuCollapse就可以通知到logo和menu组件是否折叠。同时我们也看到了menuWidth变量，即菜单栏的宽度为260，那么当折叠之后宽度变为多少呢？

在pinia中定义了 menuWidth() 来计算宽度：当menuCollapse为true，即菜单折叠时，宽度是64；为false不折叠时，宽度为menuWidth，即260。

可以看到，aside的width绑定了menuWidth作为计算属性，当menuCollapse发生变化时，menuWidth()就会被调用计算出新的宽度。

接下来，我们看看logo和menu是如何引用状态变量实现折叠/展开的？

2. logo折叠

使用vue的v-if来控制logo的展示，当menuCollapse为true，则取反为false，即不展示img和div。

再看Icon，绑定了一个名为onMenuCollapse的点击事件，用来修改menuCollapse，从而实现菜单栏的折叠与展开。并且当折叠时，Icon使用fa-indent图标，展开时使用fa-dedent图标，这样就实现了折叠与站看图片的切换。

3. menu折叠实现

menu使用ElementUI自身menu组件的collapse属性来控制折叠和展开。

同样，可以看到collapse属性的值，引用的是pinia定义的menuCollapse变量。

4.构思分析

最后发现，只是通过一个menuCollapse变量，就实现了aside中logo和menu的折叠与展开。提出需求的同时，也可以总结实现思路：

1. 让logo部分消失：用v-if或者v-show
2. 让menu组件折叠：ElementUI提供了collapse属性
3. logo和menu同步折叠和展开：用pinia定义全局状态变量

结语

本篇主要讲了项目的创建和环境变量的安装。后面阐述了边栏aside的设计思路、logo和menu折叠的实现。

同时，本篇文章页提及控制台查看属性的技巧。其中menu后面菜单的渲染、动态路由是BuildAdmin的一个重点，后面会用很大的篇幅去写。下一篇先写<Icon>组件，毕竟后面的很多地方都用到了图标。