四个优秀实践,引导你写出高质量JavaScript模块

使用 ES2015 模块,您可以将应用程序代码分成可重用的、封装的、专注于单一任务的模块。

这很好,但是如何构造模块呢?一个模块应该有多少个函数和类?

这篇文章介绍了有关如何更好地组织 JavaScript 模块的4种优秀实践。

1.优先使用命名导出

当我开始使用 JavaScript 模块时,我使用默认的语法来导出模块定义的单个块,不管是类还是函数。

例如,这是一个将模块 Greeter 导出为默认值的模块程序:

随着时间的推移,我注意到了重构默认导出的类(或函数)的困难。在重命名原始类时,使用者模块中的类名没有改变。

更糟糕的是,编辑器没有提供有关要导入的类名的自动完成建议。

我的结论是,默认的导出并没有带来明显的好处。然后我转向了命名导出。

让我们将 Greeter 命名为出口,然后看看好处:

使用命名导出,编辑器可以更好地进行重命名:每次更改原始类名时,所有使用者模块也会更改类名。

自动完成功能还会建议导入的类:

所以,这是我的建议:

"支持命名模块导出,以受益于重命名重构和代码自动完成功能。"

2.导入期间不进行繁重的计算工作

模块级别范围定义了函数、类、对象和变量。该模块可以导出其中一些组件,就像这样。

模块级范围不应该进行繁重的计算,比如解析 JSON、发出 HTTP 请求、读取本地存储等等。

例如,下面的模块配置解析来自全局变量 bigJsonString 的配置:

这是一个问题,因为bigJsonString的解析是在模块级范围内完成的。bigJsonString的解析实际上是在导入配置模块时发生的:

在更高的级别上,模块级范围的作用是定义模块组件、导入依赖项和导出公共组件:这是依赖项解析过程。它应该与运行时分离:解析JSON、发出请求、处理事件。

让我们重构配置模块来执行延迟解析:

因为 data 属性被定义为一个 getter,所以只有在使用者访问 configuration.data 时才解析bigJsonString。

消费者更清楚什么时候进行大的操作,使用者可能决定在浏览器空闲时执行该操作。或者,使用者可能会导入模块,但是出于某种原因不使用它。

这为更深层的性能优化提供了机会:减少交互时间,很大程度地减少主线程工作。

导入时,模块不应该执行任何繁重的工作。相反,使用者应该决定何时执行运行时操作。

3.尽可能的使用高内聚模块

内聚性描述了模块内部各个组件在一起的程度。

高内聚模块的函数、类或变量是密切相关的,他们专注于单个任务。

formatDate 模块具有很高的内聚性,因为它的功能密切相关,并且侧重于日期格式化:

formatDate()、ensureDateInstance() 和 MONTHS 彼此密切相关。删除 MONTHS 或ensureDateInstance() 会破坏 formatDate():这是高内聚的标志。

4.避免较长的相对路径

我发现很难理解一个模块的路径包含一个,甚至更多的父文件夹:

而有一个父选择器 ../ 通常不是问题,拥有 2 个或更多通常很难掌握。

这就是为什么我建议避免使用父文件夹,而使用绝对路径:

尽管有时写入绝对路径的时间更长,但是使用绝对路径可以使导入的模块的位置清晰明了。

为了减少冗长的绝对路径,可以引入新的根目录。例如,这可以使用 babel-plugin-module-resolver实现。

使用绝对路径而不是较长的相对路径。

每天都会有更新看过的朋友可以关注一波,Java学习路线和优质资源评论或点击“java”获取

5.结论

JavaScript 模块非常适合将您的应用程序逻辑拆分为多个独立的小块。

通过使用命名的导出而不是默认的导出,可以在导入命名组件时更轻松地重命名重构和编辑器自动完成帮助。

使用 import {myFunc} from 'myModule' 的唯一目的就是导入 myFunc 组件,仅此而已。myModule的模块级范围应该只定义包含少量内容的类、函数或变量。

一个组件应该有多少个函数或类,这些组件应该如何与每个组件相关联?支持高内聚的模块:它的组件应该紧密相关并执行一个共同的任务。

包含许多父文件夹 ../ 的长相对路径很难理解,将它们重构为绝对路径。

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

推荐阅读更多精彩内容