Vue中拆分视图层代码的5点建议
示例代码托管在:http://www.github.com/dashnowords/blogs
博客园地址:
华为云社区地址:
分享一篇尤大大演讲镇楼:「2019 jsconf.asia - 尤雨溪」在框架设计中寻求平衡
一.框架的定位
框架通常只是一种设计模式的实现,它并不意味着你可以在开发中避免所有分层设计工作。
spa
框架几乎都是基于mvc
或mvvm
设计模式而建立起来的,这些模式都只是宏观的分层设计,当代码量开始随着项目增大而增多时,问题就会越来越多。许多企业内部的项目仍然在使用angularjs1.x
,你会发现许多controller
的体积大到令人发指,稍有经验的团队会利用好angularjs1
构建的controller
,service
,filter
以及路由和消息机制来完成基本的拆分和解耦,这已经能让他们的开发能力中等体量的项目,往往只有掌握了angularjs1
玩法精髓——directive
的队伍,才能够在应付大型项目时使代码保持足够的清晰度,当然这只是在代码形态和模块划分上的工作,相当于代码的骨骼,想要让业务逻辑本身更加清晰,就需要更高级的建模设计知识来对业务逻辑进行分层,例如领域驱动模型。如果你仍然在使用angularjs1.x
的版本进行开发,可以参考【如何重构controller】进行基本的分层拆分设计。
有趣的是一些团队认为无法承载大型项目是angularjs1.x
的原罪,与他们的开发水平无关,于是将希望寄托于拥有自动化工具加持的现代化spa
框架,然而如果有机会观察你就会发现,许多项目对新框架的使用方式和之前并没有本质的差别,只不过是把以前臃肿到不行的代码又换了一种形式塞进了前端工程里,然后借着es6
语法和新型框架本身的简洁性,开始沾沾自喜地认为这是自己重构的功劳。
请记住,如果不进行结构设计,即便使用最新版本的最热门的框架,写出来的代码依旧会是一团乱麻。
二. vue开发中的script拆分优化
以vue
框架为例,在工程化工具和vue-loader
的支撑下,主流的开发模式是基于*.vue
这种单文件组件形态的。一个典型的vue
组件包含如下几个部分:
<template> <!--视图模板--> </template> <script> /*编写组件脚本*/ export default { name:'component1' } </script> <style> /*编写组件样式*/ </style>
script
的部分通常包含有交互逻辑,业务逻辑,数据转换以及dom操作,如果不加整理,很容易变得混乱不堪。*.vue
文件的本质是view层代码,它应该尽可能轻量并包含与视图有关的信息,即特性声明和事件分发,其他的代码理论上都应该剥离出去,这样当项目体量增大后,维护起来就更容易聚焦关键信息,下面就如何进行脚本代码拆分提供一些思路,有一些可能是很基本的原则,为尽可能完整就放在一起,你并不需要从最开始就采纳所有的建议。
1.组件划分
这是view层减重的基础,将可共用的视图组件剥离出去,改为消息机制进行通信,甚至直接剥离出包含视图和业务代码的业务逻辑组件,都可以有效地拆分view层,降低代码的复杂度。
2.剥离业务逻辑代码
script
中最大的一部分一般是业务逻辑,首先将业务逻辑代码剥离为独立的[name].business.js
模块,这样做的直观好处就是减轻了view层,另一方面是解除了业务逻辑和页面之间的强绑定关系,如果其他页面也涉及到这块业务逻辑中的个别方法,就可以直接进行复用,最后就是当项目逐渐复杂,你决定引入vuex
来进行状态管理时view层会相对更容易修改。
一段包含基本增删改查逻辑的组件大概是下面的样子:
<script> export default{ name:'xxx', methods:{ handleclickcreate(){}, handleclickedit(){}, handleclickrefresh(){}, handleclickdelete(){}, sendcreate(){}, sendedit(){}, sendgetall(){}, senddelete(){} } } </script>
简易的剥离方式是将交互逻辑保留在视图层,将业务逻辑部分代码放在另一个模块中,然后利用es6
扩展运算符将其加入到组件实例的方法中,如下所示:
<script> import orderbusiness from './order.business.js'; export default{ name:'xxx', methods:{ ...orderbusiness, handleclickcreate(){}, handleclickedit(){}, handleclickrefresh(){}, handleclickdelete(){}, } } </script>
这种方式只是一种形态上的模块化拆分,并没有对业务逻辑本身进行梳理。另一种方式是构建独立的业务逻辑服务,保留在view层中的代码很容易转换为使用vuex
时的编码风格:
<script> import orderbusiness from './order.business.js'; export default{ name:'xxx', methods:{ handleclickcreate(){ orderbusiness.sendcreate(); }, handleclickedit(){ orderbusiness.sendedit(); }, handleclickrefresh(){ orderbusiness.sendgetall(); }, handleclickdelete(){ orderbusiness.senddelete(); } } } </script>
笔者的建议是,前面三个示例随着项目体量的增长可以实现渐进式的修改。
3. 剥离数据转换代码
在前后端分离的开发模式下,前端所需要的数据支持需要从后端请求获得,但请求来的原始数据通常都是无法直接使用的,甚至有可能引发代码报错,例如时间可能是以时间戳形式传过来的,或者你的代码需要取用某个对象属性时,后台同学却在该属性上挂了一个默认值null
等,另一方面,开发过程中的接口改动是无法避免的,所以在代码结构的设计上,应该尽可能将可能变化的部分聚合起来。
比较实用的做法就是为每一个接口建立一个transformer
函数,从后台请求来的数据先经过transformer
函数变换为前台能够流通使用的数据结构,并在必要的属性上添加适当的默认值防止报错,你可以尽情地在此使用lodash.js
等函数工具来加工和重组自己需要的数据,即使最初后台传给你的数据不需要加工,也可以保留一个透传函数或是模块说明以提醒其他协作开发者在面对这种场景时采用类似的做法,它的功能就是为逻辑层提供直接可用的数据。当前端代码越来越重时,transformer
和request
部分可以很方便地移动到中间层。
4. 善用computed和filters处理数据展示
对原始数据的转换并不能覆盖所有场景,这就需要在定制展示的场景中利用computed
和filters
,它们都可以用来在不改变数据的情况下更改展示结果,例如将数据中的0或1转换为未完成
和已完成
,或者是将时间戳和当前时间作比较后改为可读性更高的刚刚
,1分钟前
,1小时前
,1天前
等等,这些开发场景中是不能采用强行赋值来处理的,这是就可以使用计算属性computed
或过滤器filters
来处理,它们的区别是computed
一般用于组件内部,不具有通用性,而filters
一般用于可复用的场景,可以通过下面的形式来定义一个展示效果为首字母大写的全局过滤器:
vue.filter('capitalize', function (value) { if (!value) return ''; value = value.tostring(); return value.charat(0).touppercase() + value.slice(1); })
当项目中使用vuex
来进行状态管理时,computed
通常会等价替换为state
中的getter
。
5. 使用directive处理dom操作
尽管vue
提供了refs
这个接口来实现在逻辑层直接操作dom
,但我们应当尽可能避免将复杂的dom
操作放在这里,有时候页面上dom
变化的场景较多,将每个变化都使用数据驱动的方式显然是不合理的,这时就需要用到指令特性directive
,它常用来补充实现一些业务逻辑无关的dom
变化(业务逻辑相关的变化大都通过数据绑定进行了自动关联)。directive
的基本用法可以直接参考,需要注意的是许多初级开发者都不太在意内存泄漏的问题,在directive
的使用中需要格外注意这一点,通常我们会在bind
事件钩子中绑定事件并使用属性持有这个监听函数,并在unbind
钩子中解除对同一个监听函数的绑定,即使没有使用自定义指令,你也需要建立在必要时解绑监听器的编码习惯:
vue.directive('clickoutside',{ bind:function (el, binding){ //定义监听器 function handler(e) { if (el.contains(e.target)) { return false; } if (binding.expression){ binding.value(e); } } el.__clickoutside__ = handler; document.addeventlistener('click', handler); }, unbind:function (el) { document.removeeventlistener('click',el.__clickoutside__); delete el.__clickoutside__ ; } });
demo
中提供了一个简单的directive
示例,你可以用它来做练习。