个人的中小型项目前端架构浅谈

阳光穿透心脏的1/2处 2022-06-17 09:36 213阅读 0赞

## 0、前注 ##

鉴于作者本人的能力有限（非常有限），并且依然在学习中，因此本文的高度和深度必然有所欠缺。

欢迎（并且非常欢迎）大家来批评指正，如果能详细的说明问题在哪里，如何解决和改正，那么就太感谢了！！！

我最喜欢听有理有据的批评了！！

本人QQ：20004604，邮箱：20004604@qq.com，期待你的交流。

--------------------

## 1、为什么要有一个好的架构 ##

首先明确一点，架构是为需求服务的。

前端架构存在的目的，就我个人理解来说，有以下几点：

> 1、提高代码的可读性。  
> 一个好的架构，代码的可读性一定是很强的。  
> 简单来说，假如有一个新人加入团队，那么他接手这个项目，一定是容易上手的，能简单轻松的了解整个前端部分的相互关系，从而找到自己需要重点关注的点。而不是需要花很多时间去熟悉这个项目的很多细节，才能开始上手做东西。  
> 就文件来说，可以从文件名上，分清哪些是页面、哪些是逻辑、哪些是样式、哪些是可以复用的组件、哪些是图标组、又有哪些是移动端或是PC端专享的样式/逻辑等。  
> 就代码来说，包括统一的命名风格，封装在同一个文件里的代码的相关性足够强等。

> 2、提高代码的可维护性。  
> 一个好的架构，一定是易于维护的，例如在新增需求、更改需求、修正bug，都不会造成意料之外的变化，比如说修改了一个页面组件的内容，却导致另外一个页面组件发生变化（这也太坑了）。  
> 因此，要低耦合，高内聚，以及输入和输出是可预期的。

> 3、提高代码的可扩展性。  
> 一个好的架构，一定扩展性要强，不能写死。  
> 需求变更太TM正常了，新增需求也太TM正常了。因此好的架构，必须要考虑到这些情况的发生，因为他们是一定会发生的。  
> 所以，一定要避免把代码写死。  
> 比如页面组件A里需要有一个日历组件，而这个日历组件引用的是别人的（比如从github上找的）。  
> 那么尽量不要直接在页面组件A里面直接引用这个日历组件，而是将写一个日历组件B，在这个日历组件B里封装你引用的日历组件C，然后通过这个日历组件B来进行操作。  
> 原因很简单，假如某天产品经理说，这个日历组件太丑了，我们换一个吧。如果你直接在页面组件A里内嵌这个引用的日历组件C，你很可能就要改很多代码（因为不同日历组件的使用方法和暴露的接口可能不同）。假如你还在其他多个地方引用了这个日历组件，那就更糟糕了！每个地方都要改。  
> 而若是将引用的日历组件C封装到自己写的日历组件B之中，那么你只需要改日历组件B里的相应代码即可，而因为日历组件B暴露的接口是不变的，那么自然不用修改页面中的代码了。

附图，以日历组件为例，是否考虑到扩展性的结果

**未考虑到扩展性**  
![未考虑到扩展性][SouthEast]  
  
  
  
  
**考虑到扩展性：**  
![考虑到扩展性][SouthEast 1]

> 4、便于协同。  
> 包括前端和后端的协同，前端和前端之间的协同。  
> 具体来说，前后端的协同通常是以ajax为交互，那么应至少有一个用于专门封装了所有ajax请求的文件，所有ajax请求都封装在这里。在开发时，这里封装的方法应该可以模拟发送和接收约定好的交互内容，方便开发联调。  
> 而前端和前端的协同，主要体现在同时在更改代码时，不会影响对方代码的正常运行。因此要求封装、解耦以及低干扰度是必须的。

> 5、自动化  
> 自动打包，压缩，混淆，如果有必要，再加上自动单元测试。

> 总结：  
> 总结来说，一个好的架构的目的是，让前端写代码写的舒服，让后端联调的舒服，让产品经理改需求改的舒服。

--------------------

## 2、我如何设计架构 ##

我不敢说自己的架构是好的架构（显然不是啦），只能分享自己最近做的一个项目，它的架构的如何做的。

#### 首先，确定需求： ####

> 1、一个中小型网站，同时面向移动端和PC端（单端大概15个页面，算上弹窗大约20个）。  
> 2、预算有限（给的钱少），开发时间有限（一个月）。  
> 3、可能存在一定程度上的需求变更（比如增加页面或修改某些页面内容）。  
> 4、客户可能不太在乎优化（但是我自己在乎啊！）  
> 5、要求兼容IE9以上。

#### 其次开始决定： ####

> 1、兼容IE9以上说明可以使用主流框架，而无需必须使用jquery。因此我采用了vue，版本是2.0；  
> 2、预算有限，时间有限，因此PC端和移动端共html和js，独立css。  
> 3、页面有限，因此无需将架构层级划分的比较细，只需要按其类型划分即可；  
> 4、根据原型图来看，页面复杂程度有限，复用部分不是很多，因此可以确定哪些东西需要封装复用，哪些比较复杂需要独立封装，哪些比较简单为了简化开发难度可以直接耦合。  
> 5、自己比较熟练单页面网站，因此采用以单页面为主，异步加载其他页面的形式。  
>

于是使用相关配套的东西，比如webpack，vue-router等，另外为了开发和生产的方便性，采用以下模式进行开发。  
![这里写图片描述][SouthEast 2]

--------------------

#### 第三，划分功能。 ####

首先有一个根html，用户需要通过访问它来加载我们的js逻辑，因此js逻辑的代码被写在main.js之中。

在main.js之下，我们的前端代码可以被划分为三部分：

1.  组件树；
2.  功能模块；
3.  各种资源；

如下图：  
![这里写图片描述][SouthEast 3]

功能划分好之后，相同功能的放在同一个文件夹下，命名风格应该类似。

具体来说，组件树相关的东西，通常是以.vue结尾，放置在components文件夹下；  
资源，有图片或者国际化资源等，以.png或者.js或.json结尾，放置在resources文件夹下；  
而功能插件、服务等，因为可能被多处引用，因此为了方便引用，放在src文件夹下，并且该文件夹是components文件夹和resources文件夹的上级文件夹；

--------------------

#### 第四、细化功能模块 ####

功能、组件树以及资源，我们已经明确了有哪些东西，那么接下来，我们要明确这些东西该如何以文件的形式来划分。

如下图：

![这里写图片描述][SouthEast 4]

##### 1、项目构建相关 #####

因为要使用vue.js，也要使用es6语法，因此**babel**是必须的；  
又因为要自动化混淆打包，因此**webpack**也是必须的；  
最后因为要方便多人协同，因此npm的**package.json**的配置，方便不同人可以快速自动化通过npm install来安装依赖，也是必须的；

##### 2、CDN相关 #####

而又因为我们要采用外部字体（需求要求引入非常见字体），因此**CDN加速**是必须的，该字体文件放在html中来配置引用即可；

##### 3、配置和插件 #####

我们需要直接引入一些插件和配置文件；  
为了使用vue，我们需要一个根组件，那么就是**App.vue**；  
使用vue-router，我们需要配置路由文件，因此**router-config.js**这个路由配置也是必须的；  
然后我们还需要以插件形式引入一些功能和服务，因此有了**Plugin-开头的若干个vue插件**，这些都是根据需要封装好的低耦合高内聚方法；

##### 4、需要的npm依赖 #####

当然，要使用vue肯定要引入**vue.js**；  
类似的还有**vue-router.js**和各种兼容性**polyfill**和全局插件；

##### 5、抽离出的功能模块 #####

除了直接引用的这些插件，我们还有一些和项目高度耦合的功能服务，我认为不能作为插件，但依然需要抽离出来封装好，方便使用和修改；  
如封装ajax请求的**ajax.js**，所有的ajax请求都放置其中，只对外暴露接口，方便管理和使用；  
又如实时国际化功能的组件**LanguageManager.js**，他需要引入国际化资源和管理国际化资源的加载；  
又例如实现跨组件通信的**event-bus.js**  
又比如管理用户信息的**user.js**

##### 6、总结 #####

而这些划分，都体现在上图之中。这就是**src目录下的功能模块文件**，我们需要的绝大多数功能都可以包括在其中，我们只需要按照实际开发中的需要，将对应的功能写入在这些文件中并引用即可；

#### 第五、组件树 ####

之前谈了功能模块的划分，接下来是组件树；

因此是中小型页面，因此组件树的层级无需太深，但该抽离出来的依然还是要抽离，尽量保证抽离出来的组件解耦以及一个页面组件的逻辑不要太多；

如下图：

![组件树][SouthEast 5]

##### 0、根组件 #####

所有组件最终往上找，都会找到共同的根组件App.vue，根组件只负责管理他的直接子组件；  
每个组件都只负责管理自己的直接子组件，不跨级管理，并且不依赖于自己的子组件（否则可能因为子组件的未加载或错误而导致父组件错误），做到解耦和内聚；

##### 1、弹窗dialog和弹窗tips #####

因为弹窗dialog和弹窗提示tips可能同时存在，因此将其划分为2个组件，方便管理；

##### 2、未登录页面和登录页面 #####

因为页面存在登录和未登录状态，而为了加载速度考虑，当未登录时，不加载已登录页面，因此需要划分出来，并进行异步加载处理；

##### 3、未登录页面 #####

未登录页面又分为三种情况：  
1、初始页面：毫无疑问要直接加载  
2、登录弹窗：点击登录时加载（异步）  
3、注册弹窗：点击注册时加载（异步）  
之所以分拆开，是因为根据需求，已登录用户刷新页面，可以直接进入登录后页面，因此无需登录和注册，这种处理可以减少流量消耗，提升加载页面加载速度（特别是注册弹窗需要加载的内容还比较多）；

##### 4、已登录页面 #####

已登录页面有较多页面，采用默认加载初始页，然后异步加载其他页面（访问时）；

##### 5、弹窗dialog #####

由于逻辑较少，代码量不多，因此为了方便管理，统一将其合并在一个vue文件中，共同相同的打开逻辑，根据传递的key决定打开哪一个。  
这样在新增弹窗时，无需再去写弹窗的打开、关闭逻辑。  
假如有较复杂的弹窗，可以以子组件的形式引入到当前vue文件中，如此也方便管理；

##### 6、国际化管理 #####

和页面高耦合，负责加载对应的国际化资源，并进行切换管理；

##### 7、页面组件 #####

可能有子页面和复用的组件，按照正常方式引用即可。

##### 8、样式文件 #####

可以独立写为.css文件，但因为我的公共样式文件比较少，因此我还是将其放在一个.vue文件中，并在App.vue里来引用

##### 8、页面组件起名 #####

通常以.vue为结尾，除了国际化LanguageManager.js因为高耦合度，因此以.js结尾并是一个单独的vue实例，表示他更像是一个功能模块，而不是一个vue的页面组件；

基础页面，如登录和未登录页面，公共组件（并且是header和footer这种），以**base-**开头；  
弹窗统一以**box-**为开头；  
可复用的组件以**extend-**开头；  
引入的外部组件以**import-**开头；  
普通页面组件以**page-**开头（这些页面往往是一个独立的页面，并且挂靠在登录或未登录页面下）；  
注册弹窗因为逻辑比较复杂，并且同类较多，因此以**register-**为开头；

通过以文件名来划分，不同的页面组件之间的区分可以说是一目了然，同时也方便管理；

--------------------

## 3、还没有谈到的内容 ##

想了想，目前还没有谈到的内容有以下几点：

> 1、路由：  
> 以路由为驱动来写页面，似乎是一种不错的选择；  
> 好处是只需要通过查看路由的配置文件router-config.js，就可以了解页面组件的架构；  
> 不过我自己关于vue-router的实践经验比较少，因此就略过不谈了；

> 2、单元测试：  
> 按道理说，单元测试是非常有必要的，因此在进行架构设计时，必须考虑到这一点；  
> 不过作者我目前在的公司关于前端方面都不太正规，实在没这方面的经验，  
> 又因为作者我本人转行做前端的时间也比较短，虽然周周9.12.7，但也没来得及学习这方面的知识（没有需求驱动，这方面动力不足哈哈），  
> 所以只能望有这方面经验的同学，愿意和我交流一下这方面的知识，先谢谢啦。我的QQ是：20004604，邮箱是：20004604@qq.com

> 3、自动化配置：  
> 关于webpack的自动化，是前端架构的重要组成部分，因此配置也是蛮重要的；  
> 不过一是这方面需要很多笔墨的，二是网上也有一些别人分享的文章（肯定比我的好），所以我这里就不细说了；

> 4、一些自动化工具：  
> 依然尴尬，没有大厂经验，路子比较野，所以大厂专有的一些工具是木有的，  
> 而自己找的话又嫌麻烦，所以没有优化到极致，只做到了基本满足目前项目需求的程度，见谅见谅；  
> 等以后有这方面经验的话我再写博客来分享吧~

其他：

听说写原创内容可以获得打赏，我想试试~

觉得我文章不错的，欢迎支付宝打赏一发~

谢谢~~  
![这里写图片描述][SouthEast 6]

[SouthEast]: /images/20220617/a122ffa115a94aeebcbd551db2b9ce73.png
[SouthEast 1]: /images/20220617/5a3a0c7304e542cfa5f7748762864cea.png
[SouthEast 2]: /images/20220617/b0d2faf177d5497f87399c4f1494dc74.png
[SouthEast 3]: /images/20220617/d8cd97722c1240cab3674d516c4e35b7.png
[SouthEast 4]: /images/20220617/0e9138430003480095fd2feaf4c1871c.png
[SouthEast 5]: /images/20220617/48e1ffa9a4bb4bc5bc54d364991311a5.png
[SouthEast 6]: /images/20220617/8008c86b5c7f425b920d1d67c6c9346b.png