当前位置:
  1. 魔豆IT网
  2. 系统教程
  3. 百度新闻app
  4. 正文

使用React框架重构百度新闻webapp前端 fis3作为构建工具

在进行React重构优化的过程中,构建对项目的优化作用必不可少。现在2016年8月,web前端技术这几年变化太快,因此一些信息的时效性非常重要,还是把时间写上比较好。

百度新闻的 webapp 有两个途径可以访问。第一个是用手机浏览器访问 m.baidu.com 点击搜索框下面的“新闻”链接,第二个是下载手机百度app,搜索框下面有个“新闻”链接。每天平均的PV,大概接近1亿。

为何要重构?

重构一个项目需要很多条件的支持,但是最终的目的,是为了:第一减少维护和二次开发的成本、第二提高产品的用户体验或完善功能,两者至少要符合一个,否则没必要重构。不是为了重构而重构,为了技术而重构。

要重构一个项目,特别是一个比较复杂的项目,是需要一些条件的,否则一般都会维护现有版本的产品。比如好多公司的app、网站做的很炫很漂亮,而公司内部的erp、oa、cms等系统都用着10多年前的代码。新闻webapp虽然看似就是一个很简单的新闻列表、新闻分类、新闻内容页,但是详细分析起来还是蛮复杂的。总结起来,重构新闻webapp的条件有这么几个:

目前代码比较混乱、代码之间耦合太多,从2011年做完这一版开始,经历了好几个人维护;

框架比较老(backbone + zepto),已经落伍,使得维护人员很没有认同感;

那段时间产品经理的需求不是很多,开发人员正好有大量的时间;

以上原因中,第三个是最重要的,否则大家都每天加班很晚,谁会再去考虑重构这事儿?既然有时间,那就做吧!我就主动跟我们组长提出了这个事儿,得到他的赞同之后,我们就就开始了下面的内容。

选择靠谱的技术框架

重构的第一步就是选择一个比较靠谱的前端框架。现阶段你如果要做一个webapp,再说什么框架都不用,就用zepto.js,那就out了。这并不是为了炫耀技术或者为了用而用,选用一个靠谱的框架,真的会从设计、开发、维护这几个方面都会增加效率降低成本。

现阶段前端框架可选的有以下几个:

angular

vue

react

angular我们一开始就直接放弃了。第一,因为它自己太过于强大,什么事儿都自个干了,不利于配置和扩展;第二,它的学习成本相对于其他两个算最高的了,代码毕竟不是自己一个人写,而且写完了也不一定后期谁维护呢,学习成本尽量越低越好;第三,它都快升级2.0版本了,当时2.0没有正式发布,不是已经有beta版本,而且使用了typescript,学习成本就更高了。

下面,就到了vue和react的选择了。这两者我当时都是了解各大概,做过一些demo,但是都没有在项目中实际用过。于是我花了大概一周多的时间做了一个调研,即分别用vue和React做了一个很粗糙的、简化版的新闻webapp的demo,然后两者做了一下对比。后来没有发现两者有太多的悬殊,可能有些细节的习惯上仁者见仁,无论是使用React还是Vue都能很高效、清晰的完成既定功能,学习成本也都不高。

关于React和Vue的入门教程,介绍两个很不错的视频教程《 vuejs入门基础》、《React入门》《React实战–打造画廊应用》

但是,最后还是选择了React,理由就是React生态更大。确切的说,应该是选择了React + React-router + Redux的技术框架,与之对应的是Vue + Vue-router + Vuex

做技术,框架的生态很重要。选择对了,以后的升级就顺风顺水,选择错了,就会很纠结很难受。果不其然,没过多久,手机百度的app团队就成了研究React Native的技术小组,由于我当时早早的熟悉了React,还给他们当了几次老师[偷笑]。

验证技术框架的性能问题

选择完技术框架之后,还有两个重要的问题有待于验证。

低版本android是否流畅

拿我们之前用React做的那个demo,在未经过优化的情况下,使用一些低版本的手机进行验证,结果发现浏览器运行的效果还算是流畅,最后优化之后的流畅度会好一些。但是中途遇到两个其他问题,就此记录一下。

flex兼容性问题:本来利用flex布局,结果如果要使用flex-wrap做换行的话,有些浏览器就不支持了,最典型的就是android的UC浏览器;

fetch 的兼容性问题:高级浏览器默认支持fetch了,但是低版本(如 ios6)还不支持,需要借助npm install es6-promise这个库来做兼容。

React比Vue重,如何让首屏更“轻”

用React开发webapp肯定是SPA应用,网页一加载肯定会把系统中用到的所有的js、css都加载下来,但是这样会不会导致首屏时间会很慢?带着这个疑问,我们做了一个使用fis3做异步加载的demo。demo很简单,就一个home页(列表页)、detail页、about也,很简单的一个demo,最关键的是下面的fis-conf.js的配置。

下面这个配置的意思是:根据不同的页面,打包成不同的文件。例如,针对 home页打包成一个home-third.js和home-app.js,针对about页打包成about-third.js和about-app.js……这样,访问哪个页面就动态加载相应的js,暂时访问的不到的页面,其js就先不加载。这样来提高性能。

(以下代码如果看不懂,可以先看下一节介绍fis3配置的内容,那里会有这块的解释)

使用React框架重构百度新闻webapp前端 fis3作为构建工具

后来直到上线,这个分页面加载资源也没用上。原因如下:

配置有点复杂,针对不同router都得配置

经过压缩之后,third.js才80kb,app.js不到50kb,而且third.js一般是强缓存的,文件已经很小了,没必要做分屏加载

选择靠谱的构建工具

在公司内部做项目,当然尽量选用公司自己的框架,而百度的 fis3 那会儿已经基本成熟了,有了400+的插件,支持我们当时的React重构是问题不大了。而且,当时已经有人拿fis3做过构建React的重构,还分享了经验——如何用 fis3 来开发 React?

fis3 是一个很不错的构建工具,至少我们在使用过程中还比较满意。除了基本功能,它的动态假数据模拟、发布到测试机这些功能非常实用,详情请看官网文档。但是它最大的问题是生态、圈子上还没有webpack、gulp大,因此用的人少,用的人越少了生态就越小。

为项目选择打包工具,除了基本功能(打包、压缩、合并、编译less等语法糖、生成md5后缀等等),以下几点是最必须考虑的内容。

编译 React 的 .jsx格式和 ES6 语法

支持 npm 生态,支持js的模块管理

动态引用css和图片(因为要用组件化开发,组件需要的css要在组件中引用)

按需打包js

模拟假数据,运行代码

支持多种编译模式,例如dev模式下不压缩代码、方便调试,而publish模式下压缩代码、压缩资源

下面挨着说明一下,以上几点使用fis3时如何配置的,也权当帮助公司宣传一下国产前端编译神器——fis3

注意:以下所提到的fis3的配置,都要写在./fis-conf.js代码中,这是fis3的规则,可以去查阅官网的文档。另外,以下代码注释中提示要npm install ... --save-dev安装的插件,你都可以在 github.com 上找到。

编译 React 的 .jsx格式和 ES6 语法

一般情况下,编译ES6都用babel,编译jsx也有相应的工具,但是没成想这两个只需要用typescript这一插件就搞定了。速度还要快,不过编译打包,速度慢一点也没关系,不考虑这个因素。但是使用typescript确实很方便。

使用React框架重构百度新闻webapp前端 fis3作为构建工具

支持 npm 生态,支持js的模块管理

以下配置即可是的fis3支持npm生态,并且选择使用commonjs的模块化方案。这样我们使用 npm install react --save 之后,在js代码中,就直接可以使用import * as React from 'react'了,符合目前js的主流写法。

使用React框架重构百度新闻webapp前端 fis3作为构建工具

动态引用css和图片

前端现在都是组件化开发的思路,一个项目中可能需要很多css代码,但是一个组件中,就只引用它自己需要的代码,然后构建工具再将所有组件引用的css文件合并起来,一起给最终的页面——这是组件化中使用css的思路。

使用以下配置,我们可以在js文件中直接引用css和图片文件,跟webpack中使用相似。如果使用ES6语法,引用css时写import './style.css',引用图片时写 import * as url from '../img/abc.png'

使用React框架重构百度新闻webapp前端 fis3作为构建工具

按需打包js

因为是组件化开发,因此项目中所有的图片都是零散的放在各个组件里面的,因此最终打包之后,要将所有的图片都打包到一个统一的目录下,方便管理

使用React框架重构百度新闻webapp前端 fis3作为构建工具

最终打包完成的时候,我们要将项目中用到的所有代码都打包成以下几个文件:

app.js 程序员手写出来的业务代码,后期的二次开发或者维护调整比较频繁,单独打包成一个文件;

third.js 第三方插件的代码,例如 React Redux 等,后期几乎不调整,单独打包成一个文件,可直接使用http强缓存,提高性能;

aio.css 所有的css文件

lib.js 直接以<script>方式写在html页面上的几个js文件,都打包成 lib.js ,减少http请求

具体配置查看如下代码,注释中写的也非常清楚了

使用React框架重构百度新闻webapp前端 fis3作为构建工具

模拟假数据,运行代码

大部分情况下,开发的代码要查看效果都是启用 fis3 server start 然后在本地浏览器打开 127.0.0.1:8080 来自测的,而此时本地是没有服务器端的接口的,例如本地页面中有一个/news?tn=gethotnews这个ajax请求(举例用,实际上根本没有 gethotnews 这个接口名称),默认会请求127.0.0.1/news?tn=gethotnews,是会返回404的。那这时候怎么办呢?

提前你要查阅fis3关于假数据模拟的 文档说明

选择一,你可以为/news?tn=gethotnews这个接口准备一个静态的json文件,文档中说过了。但是新闻webapp的接口实在是太多了,为每个接口都准备一下,耗费很多工作量,而且万一接下来接口返回的数据结构有变化,还得跟着改,麻烦。因此我们选择第二种。

选择二,如果在本地访问有/news?tn=gethotnews,通过借助fis3的一些功能,能直接返回线上m.news.baidu.com/news?tn=gethotnews的数据,这样是不是就一步搞定了!下面说说该如何操作。

首先,新建一个./config/server.conf的文件,内容如下。意思是,只要发出去的网络请求的url符合^\/news.*$这个正则规则,就交给/test/data.js来处理,具体如何处理,往下看。

其次,新建一个./test/data.js的文件,内容我就不能直接粘贴了,意思就是通过nodejs来抓取线上的结果。这样就完成了动态获取线上数据的功能。

此外,fis-conf.js中还需如下配置,意思是./test和./config两个文件夹下的内容,打包时候要按照既定的路径打包。即 ./test/data.js这个路径,打包之后还是./test/data.js这个路径。

支持多种编译模式

这个需求也是我们开发中必须的。例如,我们要为上线打包文件时,需要让js有md5后缀(为了方便缓存),文件要压缩到最小;而我们要自测打包的时候,就无需md5后缀(否则一天下来产生很多冗余文件),文件不要压缩(否则无法在浏览器调试)。

fis3的文档中有介绍,我们可以使用fis.media来满足我们的需求。如下配置,使用fis.media('publish').match配置了js和css的压缩功能,而解析less的时候没有用fis.media

当运行fis3 release的时候,fis3只会匹配没有配置fis.media的配置项,例如解析less功能。当运行fis3 release publish的时候,fis3既会匹配fis.media('publish').match又会匹配fis.match,即less也解析了、js和css也都压缩了。

当然,你还可以自己定义很多media,例如fis.media('test')。但是不要用fis.media('dev'),因为fis3默认的media就是dev,算是个保留字。

是否使用 npm 生态

其实这里不应该是一个问题,不过当时有一个小小的纠结,就顺便在这里记录一下吧。

解决的问题

我们现在主流的开发方式,引用 React 一般都是 npm install react --save,然后在代码中直接 import * as React from 'react'来引用。这就是所谓的“npm 生态”,即使用 npm 来管理依赖。

但是当时就这个用法,出现过一个纠结,即这样依赖,我们打包的third.js文件中,会有很多define语句,都是和React相关的。因为用 npm 安装的 React 也是有好多零散的文件组成的,并不是就一个 React.js。然后,就开始担心这么多“冗余代码”会不会导致代码文件大很多,就开始想其他解决方法(其实最后根本不是问题)

解决方案

最后想出来的解决方法很有意思,就是要下载一个react.min.js然后放在如./lib的一个文件夹中,然后在代码中使用import * as React from '../../lib/react.min.js'这样用。

这样是能解决很多个define的问题了,因为没必要define了,只有一个react.min.js文件,还define个什么劲?

后来

后来,这个解决方案还是被我否决了,当时也没想出什么压倒式的理由,但是有一个原因——没人这么用!大家都在基于npm生态,社区中的写法基本已经固定了,现在却不这么写,自己独创一个写法,那样会越走越窄。哪怕会有那么一点的不完善,我也要按照大家通用的格式来,不要独创。

其实后来想了一下,按照解决方案那种使用react.min.js的方式,也是有很多问题的。例如,开发模式下也用.min.js那样就没有React自带的提示、警告功能了,万一忽略了什么性能问题,没有提示和警告,可就麻烦打了。再例如,这样一来就没有版本管理了,前端框架更新很快,版本管理很重要。

最后,我们发下经过各种压缩,最后的third.js都不到100kb,完全满足我们的要求————这个年代,真的用不着自己去创新。

系统设计(逻辑)

要降低系统设计的复杂度,前端目前最好的方式就是组件化。将系统划分成若干个页面,然后将每个页面都划分成若干个组件,还要抽象出多个页面中都会用到的通用组件,这是第一步。接下来要看组件和组件之间如何传递数据,即数据管理和状态管理该如何做。下面我们就从这两个方面来分先一下新闻webapp该如何设计。

从 router 到 page 再到 component

下图是一个最基本的设计理念,实际项目中也是按照这个来细化、扩展最后落地执行的。即,先给页面划分组件,然后组件构成页面,最后页面匹配路由。如下图:

使用React框架重构百度新闻webapp前端 fis3作为构建工具

将这个落实到页面上,就是这个效果

使用React框架重构百度新闻webapp前端 fis3作为构建工具

但是最后在开发过程中忽略了一个问题,就是一些复杂页面(例如新闻NBA频道页,用浏览器模拟手机查看效果),光这种“页面 - 组件”的形式是不够的,应该在加一个subpage层,这样就扩展性更好一些了。如下图:

总结:一个项目总会遇到个别的比较复杂的页面,因此这种page - subpage - component会更加合理一些,其中的subpage在不需要的时候省略掉就是了。

智能组件 VS 木偶组件

在 React + Redux 结合作为前端框架的时候,提出了一个将组件分为“智能”和“木偶”两种

智能组件:它是数据的所有者,它拥有数据、且拥有操作数据的action,但是它不实现任何具体功能。它会将数据和操作action传递给子组件,让子组件来完成UI或者功能。这就是智能组件,也就是项目中的各个页面。

木偶组件:它就是一个工具,不拥有任何数据、及操作数据的action,给它什么数据它就显示什么数据,给它什么方法,它就调用什么方法,比较傻。这就是木偶组件,即项目中的各个组件。

因此,数据在page层获取、数据的操作和处理在page层定义,组件就是傻傻的知道执行和显示就行了,各操各的心。这种设计也整好符合目前无论是Vue、augular还是React提倡的基于数据驱动的设计理念——程序定义好Model和View的关系,剩下的业余处理只需要关心数据变化,View的变化由框架自动执行,无需像jquery时代再去手动操作DOM。

数据管理

下面看一下数据在系统中是如何传递的。这里的数据分为两种:

第一种可以称之为“系统数据”,和业务无关的,一般任何系统中都会有。例如用户id、用户头像、配置信息等,这个的特点就是符合单例模式,全局共用一套

第二种可以称之为“业务数据”,每个页面都可能不一样。如在娱乐频道需要的是娱乐新闻列表,而到了军事频道就需要军事新闻的列表了,再到新闻详情页就需要新闻的内容了

针对这两种不同的数据,当然要分开处理。针对第一种“系统数据”,系统一初始化就立即获取,然后交给Redux做管理,这也符合Redux的特点。而针对第二种“业务数据”,那就什么时候用,就什么时候获取。

代码架构(物理)

使用React + Redux设计代码结构,目前方式都比较统一,基本都是按照以下方式来设计,这些在github等社区都能找到相似的结构。

以上目录中,app/components和app/container是开发中修改最多的目录。app/container里面定义的都是页面,即智能组件,只关心数据,功能比较单一,因此结构也比较简单

但是针对组件app/components来说,要显示样式,当然就需要css和图片,文件类型比较多。因此,要按照如下方式定义组件

即,用一个文件夹来表示单个组件,里面的index.jsx是业务和模板代码,style.less是样式,img/文件夹放图片文件。这样的话,可以把每个组件都作为一个整体来管理,而且引用的时候也比较方便,例如import LoadMore from '../../app/components/LoadMore'就可以了——目录名即组件的名字。

虽然我没法将源码的目录结构截图出来分享给大家,但是我们实际开发中的目录结构基本是按照这个方式来做的,可能就是细节上因此会因为业务的问题做了特殊处理,但是设计理念上是一样的。

开发 - 如何多人协作开发

上文已经描述了一些基本配置和系统设计的解决方案,接下来即可进入开发。由于不是一个人做,因此必须考虑如何高效率的多人协作开发。其实这不是一个技术问题,这里就简单写一下这方面的心得体会吧。

定义阶段

提前定义好代码结构,统一各个文件夹的作用

提前设计Router规则,以及和页面的对应关系

提前抽象出可能在多个页面中通用的组件,创建文件夹(占位置)

讨论确定每个页面都如何拆分组件,统一设计思路

开发阶段

每人开发不同的页面,遇到页面单独用的组件,即自行开发;

遇到多页面公用的组件,先同步组内开发进度,有则直接用,没有则自己开发;

每装配好一个组件,都提交一次代码,随时开发、随时提交、随时合并;

心得:如果你要参与一个重构项目,你只需要按部就班发挥自己的技术能力即可,按照规则编码、测试、提交代码等。但是如果你要自己组织、规划一次系统重构,考虑的事情那就太多了。除了顶住外在的压力之外,还得考虑如何让这件事儿更快、更稳定的运行起来。

开发 - 自测

使用fis3作为构建工具,其实使用fis3 server start即可启动本机的服务,然后进行测试。但是像新闻这种产品,它的任何页面都需要获取数据再展示,因此测试的时候需要一些模拟的或者真实的数据,这个fis3也支持,在上文介绍fis3配置的时候已经说明了。

但是这种本机运行、并用fis3动态假数据模拟的情况有一个问题:它没法模拟登录的情况,http请求中也没有登录状态下的那些cookies信息,这就会影响很多功能的测试。因为新闻的许多功能是需要登录才能运行的,例如个人收藏、订阅频道、评论、点赞等。

最终想到的一个办法是将代码放在公司内部的一台测试机上,然后通过测试机访问,这样就可以获取登录信息。因此这里介绍一下如何使用fis3将代码发布到测试机上。fis-conf.js中做如下配置:

配置完了之后,执行fis3 release remote,它就会执行编译,并且将编译后的文件传上去。然后再在测试机上配置一个服务,支持页面的访问即可。

开发 - 代码检查

代码检查是开发环境中非常重要的一步,其实这块的配置很简单,之所以单独列出来,就是为了体现它在开发过程中(特别是多人协作)的重要性。

项目中使用eslint做检查,其主要配置文件有两个。.eslintignore定义了忽略哪些文件的检查,例如我们要忽略一个第三方插件的代码检查

还有一个.eslintrc.json定义了代码的检查规则,本项目的检查规则相对比较宽松,配置如下。其配置项的意义,在网络上可以轻松查询到。

最后,我们将检查代码的命令封装进package.json中,如下代码。这样,在检查的时候,只需要运行npm run lint这个简单命令即可

目前只是软性的规定,在git commit之前必须做检查,如果开发人员忽略了,也能将代码提交上。接下来将考虑将代码检查强制做到git-hook里面,即git commit之前必须要检查通过,否则无法提交。

打包 提测

上文说过,自测的时候,发布的代码是未经过压缩、也未加md5后缀的,而且直接将代码发布到服务器的目录即可,无需存到指定目录。但是要打包出一个目录,然后将文件提交给测试人员,就和自测不一样了。

首先,打包的文件要压缩、要加md5后缀(上文讲述fis3的配置的时候已经说过);其次,要讲文件打包到指定目录,这里定义将文件打包到./release目录下;第三,fis3的默认release功能还会将开发环境的源文件一起打包了,这些是不需要的(仅仅需要合并出来的代码即可,合并的代码在./release/static目录下)。将以上这些需求一整合,写一个复杂的命令一起放在package.json中

这样,执行npm run publish即可生成一个./release文件夹,里面包含了最终的模板文件、编译之后的js和css、以及处理之后的图片文件。目录结构如下。最终,将这个文件夹提交给测试人员部署即可。每个公司都有自己的提测流程,百度内部流程这里就不说了。

测试过程中,qa可能会有反馈bug,至于如何修复bug,以及如何进行二次开发和维护,我都写了一个说明文档(仅供百度内网访问),规定了每个步骤该如何执行。

上线

测试完了之后要上线,每个公司的上线步骤也都不尽相同,有的高级一些,有的low一些,这里就不管了。

上线之后注意如何及时快速的回滚,这一点很重要。

总结

洋洋洒洒写了好多,最后做一个简单的总结。

系统重构的目的永远都是为了后面减少开发成本、提高系统性能和稳定性,这是公司或部门需要的结果。对于实际执行的个人来说,参与或发起重构项目,是对自己如何掌控一个产品前端设计和架构的一次很好的机会,会对自己有很大的能力提升。重构过程中会遇到一些预想不到的问题,思考在过程中解决这些问题,对自己又是另一方面的能力提升。因此,好的东西,都是双赢的。

待优化

继续压榨性能:无论是通过资源的懒加载,还是使用Immutable.js做不可变数据,都要让性能达到最优

完善一些设计不足的地方:例如目前的page - components 改为到 page - subpage - components的方式

接下来

选择React框架肯定要再试图往两个方向来攻:

服务器端渲染

React Native

最后

现在一言不合就秀配置打包代码~

相关阅读

《使用React框架重构百度新闻webapp前端 fis3作为构建工具》由网友“月色夜”推荐。

转载请注明:http://www.modouwifi.com/jiaocheng/051cQ92021.html