使用vue重构资讯页面的实例代码解析

Z时代
2024-01-10
分类：IT

从我接手到将这个页面代码重构前，一直都还是使用angular1的代码去做的，需求来了也是用angular去实现；作为一个憧憬新技术的前端，怎么忍受得了现在还在使用这么有历史感的框架，所以，以前就一直在酝酿着如何将angular重构成vue。

代码结构设计

这个资讯项目代码整体都是使用angular.js来去实现的，而此次想重构的资讯详情页面只是其中的一个页面，所以新建了一个文件夹 /newApp 、作为以后新技术的文件夹，以后使用vue技术的都放在这个文件夹下，区别于原先文件夹 /app 。

在旧的angular1的js文件中，由于页面功能丰富，所有的功能代码全都挤在了同一个js中，这就导致主要的js一共有1500+行的代码。每次打开看到长长的一摞代码、还要在里面找到对应的功能代码，就不禁吐槽其中的不合理。。

所以这次重构，我按照页面中的每个模块、每个功能，来将页面拆分成不同的.vue组件模块，以后想要去维护、或者新增功能时，可以直接去对应的模块文件中修改或者是新增一个vue文件。

components

存放着vue的组件代码

base

这个文件夹下，存放着一些可以被复用的组件

commentInput.vue -- 评论输入框

commentList.vue -- 评论列表

replyBar.vue -- 固定悬浮于底部的评论条、提示用户可以评论

report.vue -- 对评论进行举报会弹出的举报信息框

photoswipe.vue

资讯里面的图片浏览组件、在app内会调用客户端的浏览器组件能力、端外使用第三方组件库photoSwipe的来实现点击浏览大图。

adImg.vue -- 广告展示模块

audioBar.vue -- 语音播放功能模块

bannerTop.vue -- 站外显示的顶部拉新banner模块

comments.vue -- 评论列表功能模块

fontconfig.vue -- 设置字体大小功能模块

footBar.vue -- 展示点赞人数和浏览人数模块

hotRecommend.vue -- 热点推荐模块

mask.vue -- 页面蒙版

relatedStock.vue -- 相关个股模块

relatedTopic.vue -- 关联专题模块

shareBar.vue -- 文末快速分享模块

detailBusiness

在这个文件夹下放着一些资讯的业务js

detailSensor.js -- 引入神策统计的sdk

drawTimeline.js -- 画出股票的行情线图

i18n

语言包

sass

资讯页面用到的sass文件、不过由于node-sass的安装有点麻烦（在技术选型时未考虑此情况），后面可能会重构成使用less来做css的预处理器。

utils

一些公用的函数被抽成单独的文件放在这里

allCommentsMain.js

评论列表页面主js

commentDetailMain.js

评论详情页面主js

eventBus.js --

使用eventBus来实现页面的通信

i18n.js

使用vue-i18n来实现页面的多语言

Main.js

资讯详情页面主js

mixin.js

混入

shareInfoSettingMain.js

将分享的逻辑单独抽取成一个js。这里单独抽成一个js是因为，在安卓的webview加载h5时，会等js文件执行完毕之后才渲染出页面（即用户看到东西），所以页面的主js是进行了延迟加载的，但是分享这一逻辑是希望还是能提前加载，所以单独将这一功能抽取成一个js，让页面按照顺序正常去加载。

组件间通信

因为将页面按照功能拆分成了很多小的模块，在不同的模块之间的通信就需要想方法实现，这些模块之间大多是一种兄弟组件的关系。

我们首先能想到的vue中父子组件的通信功能的实现，但是父子组件的场景不适合现在的多个兄弟组件之间的通信，或者说实现起来很啰嗦。

所以考虑另外两种方法实现：eventBus和vuex。考虑到资讯详情页只有一个单页面，引入vuex的话可能会太重了，使代码体积增加不少，因而使用了EventBus事件总线这一方法来实现。

事件总线

在Vue中可以使用 EventBus来作为沟通桥梁的概念，就像是所有组件共用相同的事件中心，可以向该中心注册发送事件或接收事件，所有组件都可以上下平行地通知其他组件。

具体做法是在eventBus.js这个文件中创建一个vue对象，并且将其export出去。其实就是创建一个vue对象作为eventBus，使用它的 $on 和 $emit 来实现。这种设计模式是发布/订阅模式，即 pub/sub 。


//eventBus.js
import vue from 'Vue';
export default new Vue();

在想要通信的组件中使用 $on 和 $emit 方法。

例如，资讯详情页面有一个接口是去请求几个数据：广告、相关个股等。这个接口其实在页面中只需要在初始化时去请求一次，然后将数据保存下来就好。

所以在Main.js中负责去请求这个接口，然后请求回来了，发布一个 dataReady 的事件，将数据也带出去。而在其他的、需要用到这个初始化数据的组件就去订阅这个事件，拿到初始化的数据后，就将其render到页面中。


// Main.js
_initData() {
 // ****
 //使用eventBus广播这个事件，多个子组件中用到了初始化数据
 EventBus.$emit('dataReady', data);
}
//adImg.vue 广告模块
mounted() {
 EventBus.$on('dataReady', data => {
  // *****
 })
}
//relatedStock.vue 相关个股模块
mounted() {
 Event.$on('dataReady', data => {
  // ****
 })
}

在这里其实有个小优化，可以将直接在Vue的原型上添加一个vue对象实例作为全局的消息总线，就不用每次都去import 一次eventBus.js。


//Main.js
Vue.prototype.$bus = new Vue();
//使用时：
this.$bus.$on('', () => {});

在使用eventbus完成项目之后发现，事件总线这一个机制确实很方便，不同的组件之间可以随意通信，但是由此很容易造成难以管理的灾难。比如，在某个模块中订阅了某个事件，这个事件是从哪里发布的、什么时候发布的，在代码中似乎有点难以搜索发布的时机。

其他特性

资讯详情页面中实现了其他的一些功能，比如多皮肤、多语言这些特性。

多皮肤

多皮肤，使用了css的预处理器sass来实现，用到了sass的变量、混入指令等特性。

首先让视觉给一个不同皮肤下的色彩对照表，然后将其写入sass文件中，用变量来保存对应的颜色值。根据外部的class来使用对应的颜色变量。

面的class则是由后端在渲染html时，将对应的皮肤class添加在最外层的div中，在.vue组件中加入对应的class样式，就能做到随肤、且不闪屏。

不过我一开始在重构时的想法并不是通过三组对皮肤的变量来实现，我一开始的想法是在sass里面，就能拿到对应的皮肤的值，从而在使用时都是只需要知道是要哪个层级的颜色值就可以，而不需要在外部的sass代码里分别写三种。

但是问题在于，无法将js能拿到的皮肤信息传入sass中，这个想了很久也没想到解决方案。如果能在sass中就可以拿到皮肤信息，从而直接赋予元素对应的皮肤值，这样就很方便了。所以这里对sass、less这些语言的局限性也深有感触，它们终究只是一个“预处理器”而已。

多语言

多语言特性，使用了vue-i18n这个插件来实现。

可改进的地方

整合资讯详情页面

其实现在包括资讯详情说是只有一个页面，但由于它具有的评论功能，是可以聚合成一个spa的，包括资讯详情页面(Main.js)、资讯评论列表页面(commentDetailMain.js)、评论详情页面(allCommentsMain.js)。这三个页面用到的技术栈在重构之后非常相似，甚至将公共的组件都已经抽取出来了。但是我在重构时还是把它们三个当成不同的页面拆开了，这一点有待改进。

目前是通过mixin这一特性，将三个页面公共的一些东西抽取在其中，分别在三个页面的js中引入这个mixin，可以避免一些重复的东西。


//mixin.js
// 资讯详情页、资讯评论列表页、资讯评论详情页公用的一些东西
import i18n from './i18n';
import ReplyBar from '**/replyBar.vue';
import BannerTop from '**/bannerTop.vue';
import CommentInput from '**/commentInput.vue';
let mixin = {
 i18n,
 components: {
  ReplyBar, //底部悬浮框
  BannerTop, //顶部的banner条
  CommentInput //评论输入框
 }
}
export default mixin;