前后端分离和模块化-58到家微信首页重构之路-白红宇

前后端分离和模块化-58到家微信首页重构之路

阅读量：5815 次

发布时间：2019-06-18

本文共 6836 字，大约阅读时间需要 22 分钟。

微信钱包内的58到家全新首页已经上线，感兴趣的同学们可以在微信中打开“我的->钱包->58到家”查看。

58到家全新首页提出重构主要是为了解决以下问题：

每个城市开通的服务项目不同，有些内容是写死在tpl中，维护非常头疼；

开通新服务或者某些UI调整（比如更换服务项的图片造成更改雪碧图）时必须走代码上线流程；

原有的前端切图、后端写逻辑的开发模式造成开发周期拉长和上线流程繁琐；

原有配置后台操作复杂，且可配置细节不完善；

首页加载速度太慢，用户体验欠佳。

58到家目前两年左右的发展期，整个技术生态还不完善。以上的问题有的是由于创业初期遗留的历史原因造成，比如代码写死和粗糙的配置后台；而有的问题是由落后的开发模式和协作模式造成的，比如前后端分工不明确、首页加载速度慢。

基于上文提到的问题，重构从以下几方面入手：

完善配置后台，细化可配置项；

数据驱动UI，轻量化tpl，内容更新无需上线流程；

前后端分离，缩短开发周期，简化上线流程；

模块化开发，提高加载速度，同事增强代码的可维护性。

配置后台可以理解为一个简易的CMS系统，配置的内容是一些量化的字段，比如图片地址、链接、价钱等等。此项目中本人并不负责配置后台的开发，所以不再班门弄斧。

下面详细描述重构过程中前端的解决方案。

1. 技术选型

根据上文提到的问题，此项目中前端的技术选型如下：

客户端（浏览器）
- 使用作为渲染框架（数据驱动UI）；
- 图片懒加载使用实现；
- 模块化方案使用CommonJS；
- 因为首页没有很多的用户交互功能，大部分是链接跳转，所以不使用第三方的touch event工具；

开发环境
- 使用58到家前端工程框架作为开发和构建工具；

看到以上的技术选型，可能会有读者疑惑：不就是一个前端模板+模块化方案吗，有什么值得介绍呢？

首先，以上的技术选型的背景如下：

目前58到家FE团队统一使用vue作为开发框架，组件易复用；

此次重构后的58到家首页并非SPA，选用vue的另外一个原因是为了后续的SPA化做预备；

客户端渲染html的缺点是首次进入页面加载较慢，但利用浏览器缓存机制可以另再次进入页面的加载时间大大缩短；

选用CommonJS实现按需加载（load on demand），首屏以外的内容在首屏渲染完成之后加载；

boi是58到家前端工程框架，以webpack为构建内核，选用CommonJS另一个原因是webpack的原生支持。

2. 前后端分离方案

目前58到家的前后端协作模式仍然很原始，本次重构采用的前后端分离方案并非是最优解，只能算是一种折中的过渡方案。总结有以下几点：

初始tpl中包含以下部分：
- js、css引用；
- 页面初始数据；
- vue组件容器；
- 统计用初始数据。

客户端采用vue作为渲染html；

js和css更新时，FE独立部署静态文件，RD需要将url更新时间戳；

下面分别简单描述以上的几点。

2.1 轻量化tpl

tpl的内容如下：

            
            
            58到家

tracker.js、zepto.min.js、vue.min.js是依赖的第三方文件，全局变量bi_params是bi统一用的初始字段；

<app :data="data"></app>是vue组件的容器；

tpl文件由RD维护，以上提到的两点是固定不变的，不需要维护。RD需要维护的包括：
1. main.wx-index.js和main.wx-index.css的时间戳；
2. 全局变量pageData。这是首屏的初始数据，之所以选择以全局变量的方式暴露，而不是请求api，是为了减少一次http请求，尽快渲染首屏。

tpl轻量化是为了减少FE和RD的耦合，当然最佳的方式是tpl交由FE维护，但是目前58到家的开发模式并不适合。所以采用了折中的过渡方案。

使用url query作为js和css文件的缓存策略也并非最优解，理想的方案是使用hash指纹。但是hash指纹需要FE在编译完成之后将hash值告知RD，而时间戳可以任意修改成与当前不同的值即可，减轻了沟通成本和失误率。

2.2 客户端渲染

选择客户端渲染有以下几个优点：

tpl轻量化，前后端解耦；

初始html数据量非常小，能够快速到达客户端。采用一些loading交互尽快给用户视觉反馈；

js文件初次请求之后缓存到本地，只要不更新版本，后续每次进入页面后初次请求的数据就只有少量的html数据；

减小服务器（解析模板）压力；

当然客户端渲染也有一些缺点，比如：

性能比较差的设备执行渲染过程吃力，不过按照目前手机的迭代速度，这一点基本可以忽略不计；

SEO不友好。但是这个项目是微信钱包的服务，并不直接提供外部浏览器入口，SEO可以不考虑。

具体到客户端渲染的技术选型，其实从实现功能上来讲随意选用一种js模板工具即可，比如。最终选择vue的原因有以下几点：

数据驱动UI的方式利于编写清晰的逻辑；

为后续迭代做预备。后期有计划将整站SPA化，vue+vuex是比较不错的技术选型；

58到家FE团队统一使用vue，部分业务组件可复用；

2.3 更新和缓存策略

此次重构采用的缓存策略仍然比较原始，比如前文提到的url加query的方式。这也是后续有待优化的一个重点。

3. 模块化方案

3.1 客户端模块化方案

58到家首页的内容非常多，大部分尺寸的手机需要三屏才能加载完成。一次性加载的用户体验肯定不太顺畅，按照主流的手机尺寸，将整站分成三部分：首屏+次屏+尾屏。基本的加载流程如下图：

简单概括如下：

用户进入页面后，客户端发起第一次请求，服务端返回包含首屏json数据的html文档；

main.wx-index.js根据首屏json渲染首屏；

首屏渲染完毕之后或者用户scroll到页面底部触发次屏js文件wx-index.themes.js的加载；

wx-index.themes.js加载成功后发起jsonp请求次屏和尾屏数据；

渲染次屏；

次屏渲染完成之后或者用户scroll到页面底部触发尾屏js文件wx-index.tail.js的加载；

wx-index.tail.js加载成功后渲染尾屏；

至此，流程结束。

次屏的wx-index.themes.js和尾屏的wx-index.tail.js是按需加载的，是为了减少首屏的请求数和数据体积。

按需加载功能使用require.ensureAPI实现。之所以选择使用它有以下几点考虑：

58到家前端工程框架boi构建内核基于webpack，webpack runtime内置require.ensureAPI的支持，不需要额外的模块化工具；

AMD方案（比如require.js）的按需加载模块不能定义模块名称（wx-index.themes.js的themes，wx-index.tail.js的tail），而require.ensure则可以定义模块名称，使文件名更语义化；

下面简单介绍一下如何结合vue和require.ensure实现按需加载和动态组件。

3.1.1 vue结合`require.ensure`实现按需加载和动态组件

回顾上文的tpl代码可以看出，页面整体是一个vue组件。顶层组件是<app></app>。首屏组件是第一级子组件，次屏是第二级子组件，尾屏是第三级子组件。整体结构如下图：

vue实现按需加载动态组件要考虑以下几点：

组件容器位置；

组件数据如何传递。

对比上图可以看出子组件容器的位置：

Themes组件作为第一级子组件App的一个子组件，容器位置如下代码：
<div class="main">  <wx-activity v-if="data_activity" :data="data_activity"></wx-activity>  <wx-nav v-if="data_nav&&data_nav.length!==0" :data="data_nav"></wx-nav>  <wx-headline v-if="data_headline&&data_headline.length!==0" :data="data_headline"></wx-headline>  <wx-service v-if="data_service" :data="data_service" :test="test"></wx-service>  <wx-fresh v-if="data_fresh" :data="data_fresh"></wx-fresh>  <wx-banner v-if="data_banner&&data_banner.length!==0" :data="data_banner"></wx-banner>  <div class="wx-index__themes"> <themes></themes> </div> <wx-footer :notice="data.showReddot"></wx-footer> </div>

Tails组件作为第二级子组件Themes的一个子组件，容器位置如下代码：
<template> <template v-for="theme in data.themes"> <slider v-if="theme.type==='slider'" :data="theme"></slider> <single-slider v-if="theme.type==='singleSlider'" :data="theme"></single-slider> <list v-if="theme.type==='list'" :data="theme"></list> <grid v-if="theme.type==='grid'" :data="theme"></grid> </template> <div class="tail"> <tail></tail> </div> </template>

wx-index.themes.js加载成功，在渲染Themes组件之前需要请求次屏的数据，jsonp请求放在vue组件的activate钩子函数内：

activate: function(done) {        let _this = this;        let _url = '/home/ajaxGetSecondIndexPage';        let _cityId = pageData.cityId||$.fn.cookie('comm_cityid');        let _openId = pageData.openId||'';        $.ajax({            url: _url,            data: {                cityId: _cityId,                openId: _openId            },            dataType: 'jsonp',            success: function(res){                if(!res||!res.data){                    return;                }                _this.data = Object.assign({},res.data);                // 将底部固定模块的数据写入全局变量，以便懒加载所需                window.dj_index_data_tail = Object.assign({},{                    layidle: _this.data.layidle,                    recommend: _this.data.recommend                });            },            complete: function(){                done();            }        });    }

vue组件在activate钩子函数返回done()之后才会继续执行后续工作。

请求成功之后将返回的数据赋值给vue组件的data，然后vue根据data渲染UI。

上述代码有一点需要注意。大家看到代码将一些数据赋值给了全局变量window.dj_index_data_tail，这些数据是尾屏的数据。由于尾屏的数据量比较小，所以与次屏的数据合并成一个API。这个全局变量是为了尾屏的Tail组件渲染使用。这就是上文提到的“组件数据如何传递”。

使用全局变量传递数据的方式固然不是很优雅，但是不失为一个适合快速开发的方案。这也是后续迭代的优化点之一。

次屏渲染完毕之后触发尾屏的加载，这个行为实在Themes组件的ready钩子函数内进行，如下：

ready: function(){    let loadTail = function() {        if(!window.isTailLoaded){            // 主题推荐位渲染完成之后加载底部模块            require.ensure([], function(require) {                require("../../_tail.js");            }, 'tail');            window.isTailLoaded = true;        }    };    loadTail();}

由于之前将Tail组件的数据储存在全局变量中，Tail组件的activate钩子函数内可以直接读取次全局变量：

activate: function(done){    this.data_layidle = window.dj_index_data_tail.layidle&&Object.assign({},window.dj_index_data_tail.layidle);    this.data_rec = window.dj_index_data_tail.layidle&&Object.assign({},window.dj_index_data_tail.recommend);    done();}

以上，便完成了整个页面的按需加载流程。当然，每种方案都不是最优解，但都是适用于目前状态的一种比较好的方案，后续迭代中持续优化。