职责拆分:gulp相关构建代码的重构方案

今天在读微信小程序项目的代码,主要看了构建的部分,在读这部分代码和画架构图的过程中,发现了一些不是很合理的地方。

我们的小程序构建方案

我们小程序使用的是原生的方案,小程序自带了构建打包的过程,在其上增加额外构建过程是为了使用各种资源的预处理工具,比如使用scss来做css样式的管理,使用babel解析js的es6、7和 flow语法,使用单文件组件(sfc)的形式整合wxml、wxss、js等。构建的最终产物是小程序的原生代码,然后经由小程序开发者工具再次打包和构建。

我们构建使用的是gulp。因为只是几种资源的处理,不涉及到模块解析,所以gulp比webpack更合适。

构建相关代码的结构

我梳理了下构建的代码,主要包括各种任务的定义、自己扩展的gulp插件、配置和工具等通用代码这3部分。项目中对应的文件有5个,根目录下的gulpfile.js和build目录下的compile、util、config等文件。

他们之间的关系如下图:

命令行使用build、dev、qa、sgb等npm scripts会对应的执行build、default的task,两者各自有自己的处理流程。处理过程中会用到我们扩展的解析单文件组件的gulp插件。

图中绿色部分是可复用的utils、config代码,红色部分是task相关的代码,而橙色部分是我们所扩展的gulp插件。他们之间的关系如图所示,但从代码的目录结构中并不能清楚地看出这种关系,需要具体去看代码才能逐步理清。

构建代码重构的想法

其实,理想状态下目录结构应该能清晰地反应流程和所涉及到的概念的关系的,具体看代码的过程只是对这个结构的补充,而不是在读代码过程中梳理结构。

现在的目录结构没有清晰反映出task、plugin等的关系,而且命名也达不到见名知意的要求,于是我有了重构的想法。

我按照之前分析出的代码职责调整了一下目录结构:

tasks
   flow
      compile-sfc.js
      clean-distDir.js
      compile-sass.js
      compile-js.js
      handle-config.js
      copy-otherFiles.js
   production-task.js
   dev-task.js
plugins
  sfc
    index.js
    my-script-compiler.js
config
  index.js
utils
  index.js
index.js

首先拆分出了tasks、plugins这两个目录,config、utils考虑到后来的扩展也改成目录的形式了。tasks下面是production、dev两种环境下的任务,他们的实现流程需要组合flow下的细小步骤实现。plugins下明确封装了解析sfc的gulp插件,包括解析sfc中js代码的部分。

除这些以外,还应该把 gulpfile移到build目录下,因为gulpfile也是build的一部分,放到build下更合理,就像vue cli脚手架生成的代码把webpack.config.js放到build下一样。src下的代码也不应该引用build的代码,应该通过环境变量、全局变量等方式。

这样的重构只是静态代码结构的变更,对代码的运行并没有啥影响,但代码的易理解和易维护性会增强一些。

总结

为了更便捷的开发、更好地代码可维护性,我们使用了scss、babel等预处理工具,使用单文件组件(sfc)的方式整合页面相关的wxml、wxss、js代码,相应的也就需要把这些资源的处理增加到构建流程中。经分析,使用gulp是比较合适的。

读代码结合画代码结构图理清了代码从逻辑上的职责划分,也发现了一些命名方面不太合理的地方,于是也就有了重构的想法。

主要方向是把不同的职责的代码(比如task、flow、plugin)放到不同的文件和目录中去,而不要都堆到一起。于是,按照代码的不同职责分出plugins、tasks和utils、config目录,把gulpfile也放入build目录下,把task的执行中的每一个小流程拆分成单独的文件等。

理想中目录结构是能直接反映出代码整体的结构和相关概念的逻辑关系的,虽然运行时都一样,但是易理解性和可维护性却是差别很大的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 219,589评论 6 508
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,615评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,933评论 0 356
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,976评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,999评论 6 393
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,775评论 1 307
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,474评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,359评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,854评论 1 317
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,007评论 3 338
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,146评论 1 351
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,826评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,484评论 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,029评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,153评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,420评论 3 373
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,107评论 2 356

推荐阅读更多精彩内容