yolov4安装部署并测试图片及视频数据 - 知乎

mikel阅读(858)

来源: yolov4安装部署并测试图片及视频数据 – 知乎

前言:最近参加一个比赛需要用到yolo,安装过程中借鉴了网上众多的指导教程,也很感谢B站一位大佬的视频指导,所以在这里想整理一下给需要安装的yolov4的小伙伴一个借鉴,相关视频指导在文章末尾有链接来观看。

前期准备:进入GitHub找到AlexeyAB/darknet这个项目([项目链接](github.com/AlexeyAB/dar)),根据作者给出的安装条件安装好相应的软件,如下图。

①首先是CMake的安装,点击他给的链接即可下载,选择installer版本,一路默认安装即可:

②:接着是Cuda的安装,点击所给的链接地址进行下载,下载完成之后安装过程中选择精简安装即可。

③接着我们来安装OpenCV,我所安装的是OpenCV—4.3.0版本,安装的时候很简单,一步搞定,直接安装到指定的文件夹中。

==注意:==安装完成之后需要将OpenCV配置到环境变量中,若之前系统变量里面没有OpenCV的变量名,则新建一个,记得命名为OpenCV_DIR,如下图:

④接下来安装cuDNN,这个网站是需要注册才能下载的,然后下载的时候注意要和你所安装的cuda版本相配套

下载完cudnn的安装包解压之后是一个名叫cuda的文件夹,然后把里面的文件全部复制

然后将刚复制的文件全部粘贴到C盘的CUDA目录下,注意路径(我的是 C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.2),直接覆盖粘贴就好。

⑤visual studio的安装,点击链接([link](visualstudio.microsoft.com)),默认的是下载visual studio 2019社区版

安装 过程中需要注意的地方:

==勾选 使用C++的桌面开发,选择这一项即可==

⑥下载安装Git,这个是项目作者所没有要求安装的,我是之前就安装好了,方便接下来可以用Git来从gitee中下载部署项目代码,进官网直接下载即可,安装过程全部默认安装即可

⑦以上我们需要的软件都安装完成啦,接下来就是代码的获取。可以直接在GitHub下载

也可以在gitee中从Github导入仓库,点击右上角的+号,选择从GitHub/Gitlab导入仓库

此时将GitHub项目的下载地址复制下来,粘贴到gitee中,直接带入即可

打开Git Bash

之后需要在命令行中新建文件夹存放代码,并启动下载(我是在C盘下新建一个文件夹github ,进去这个文件夹,然后输入git clone https://github.com/AlexeyAB/darknet.git),下载完成之后会在C盘目录下看到刚刚新建的文件夹

接下来打开Cmake,在上面两栏填上刚刚下载好的darknet地址

然后点击左下角的Configure按钮,选择你所安装的visual studio版本号,并选择 x64

然后点击Finish按钮,经过一段时间运行,显示如下

此时再点击generate按钮(注意若不点击的话是不能Open Project的),显示如下:

接下来就可以点击Open Project啦,会自动打开visual studio,可以看到项目结构

此时需要配置管理器,点击生成按钮即可看到选项

然后选择release,x64,然后点击关闭

接下来我们生成解决方案,在生成按钮下的第一个选项

这是生成成功的界面

接下来进入C盘之前下载的代码文件里,将darknet.exe复制下来

将复制下来的exe文件粘贴到 darknet->build->x64文件夹中

接下来将 yolov4.weights文件(可以在网上自行下载,我就不贴链接啦)也粘贴进darknet->build->x64文件夹中

!!!!!

准备工作都已完成,接下来就是验证啦

进入命令行控制界面,进入C:\houhou\darknet\build\darknet\x64路径,然后将选中的这样一条命令粘贴进去,然后开始运行

在我们的x64目录下项目者提供的有供测试用的图片,直接输入dog.jpg即可

运行结果:

接下来是视频检测的演示:

命令:darknet detector demo cfg/coco.data cfg/yolov4.cfg yolov4.weights ./data/test.mp4 (其中test.mp4文件存放在C:\houhou\darknet\build\darknet\x64\data中的)

如果小伙伴觉得这些图文操作起来很复杂,可以观看链接中的视频来操作(视频指导

智能盘点-钢筋数量AI识别-目标检测实践 - 知乎

mikel阅读(1000)

来源: 智能盘点-钢筋数量AI识别-目标检测实践 – 知乎

003-智能盘点-钢筋数量AI识别-实践

1 背景

在现如今All in AI的背景中,越来越多的传统行业,开始加快数字化、智能化的进程,AI养猪AI养鸡这样接地气的场景,也已经进入到落地、工业化的阶段。
0110日,广联达在DataFountain发布了 智能盘点—钢筋数量AI识别 比赛
比赛地址

  • 在工地现场,对于进场的钢筋车,验收人员需要对车上的钢筋进行现场人工点根,确认数量后钢筋车才能完成进场卸货。目前现场采用人工计数的方式,如图1-1中所示:
  • 上述过程繁琐、消耗人力且速度很慢(一般一车钢筋需要半小时,一次进场盘点需数个小时)。针对上述问题,希望通过:
手机拍照->目标检测计数->人工修改少量误检的方式

2 问题

  • 精度要求高(High precision requirement)
    • 钢筋本身价格较昂贵,且在实际使用中数量很大,误检和漏检都需要人工在大量的标记点中找出,所以需要精度非常高才能保证验收人员的使用体验。需要专门针对此密集目标的检测算法进行优化,另外,还需要处理拍摄角度、光线不完全受控,钢筋存在长短不齐、可能存在遮挡等情况。
  • 钢筋尺寸不一(Various dimensions of rebars)
    • 钢筋的直径变化范围较大(12-32中间很多种类)且截面形状不规则、颜色不一,拍摄的角度、距离也不完全受控,这也导致传统算法在实际使用的过程中效果很难稳定。
  • 边界难以区分(Indistinguishable boundaries )
    • 一辆钢筋车一次会运输很多捆钢筋(如图1-3),如果直接全部处理会存在边缘角度差、遮挡等问题效果不好,目前在用单捆处理+最后合计的流程,这样的处理过程就会需要对捆间进行分割或者对最终结果进行去重,难度较大。

看看实际的场景图片:

希望的结果是这样的,告诉有多少根、并且标记位置供人工验证

3 分析

AI数钢筋 这个问题是一个 object detection 问题,相比于多分类,这里是一个 密集型小物体 单分类定位问题。

目标检测流派,常被分为双阶段检测 和 单阶段检测

  • 双阶段检测、始于2014年 大神RBG 的Rcnn,后续Fast-Rcnn(2015)Faster R-CNN (2016) 是对其的进一步优化。

arxiv.org/abs/1311.2524
论文 2014年 RBG大神

  • 方法流程(Faster Rcnn):
    • 1 通过conv layers 卷积层 获取图像特征信息 feature maps 77512 (VGG为例)
    • 2 RPN层 (softmax) 判断anchors属于foreground或者background 利用bounding box regression修正anchors获得精确的proposals
    • 3 Roi Pooling 该层收集输入的feature maps和proposals,综合这些信息后提取proposal feature maps,送入后续全连接层判定目标类别
    • 4 Classification。利用proposal feature maps计算proposal的类别,同时再次bounding box regression获得检测框最终的精确位置。
  • 单阶段检测、始于2016年的 Joseph Redmon ,之后的 YOLO9000YOLOV3 是对其的进一步优化

arxiv.org/abs/1506.0264
2016年 Joseph Redmon, Santosh Divvala, Ross Girshick, Ali Farhadi
You Only Look Once

YOLO家族区别于两阶段的RCNN家族,取消了RPN层,将proposal和detection放在一级完成。

4 实践

1 双阶段Faster Rcnn

  • 坑1 :

在Faster-Rcnn论文和众多开源项目中,都会使用这样的一组anchors,尺度,在600*800 的标准输入中,最小的也是,128*128 像素,实际在当前场景下,尺度会更小,应该使用更小的anchors来 增加RPN层正样本的命中率和训练收敛速度。

[128, 256, 512]
[1:1,1:2,2:1]
  • 坑2 :

Roi Pooling层前,提取RPN层正负样本,模式是256个(128正,128负),当正样本少于128时,增加负样本个数。当在当前场景中,ground truth 个数最多都有300个左右,适当增加样本采样会更利于训练。

  • 坑3 :

增加num_rois个数,确保检出率。

如下是在250张训练数据下,10轮训练的结果,框定位置不够准确,密集区存在漏检。更重要的是,在Tesla V100下 一轮training的时间是 50-70min。测一轮,一天就过去了。

2 单阶段YOLO

YOLO被称为是目标检测工程化的首选模型。在YOLOv1/2 中 小尺度密集物体的定位效果差,常被诟病,在2018年新出的YOLOv3中,有了很大的改进。

  • yolo3 使用 借鉴resnet的darknet网络作为backbone,多尺度的引入,使得模型的感受野更大,
  • 在默认模型中,yolov3 输出 13 26 52 三个尺度的特征信息。
  • 在416*416尺度下,最小可以感受 8*8 像素的的信息 ,恢复到本场景2000*2000 差不多是40*40 像素,基本满足。
  • 根据K-Means修改先验框,加速模型收敛。(如果用图像增强套路,增强后再进行K-Means更佳)
  • 超参数调整,最大检出框IOU,SCORE-THRESH,这需要更多的尝试

在提交结果到比赛后台时,发现F1 Score 比感受得分低,通过对训练数据predict结果,评价发现,主要原因是官方IOU设置问题,比赛要求IOU>0.7为真;这是一个较为严格的标准(更多比赛在0.5)。比如在测试时发现,在IOU=0.5 时模型mAP=95.81% (P=0.99 R=0.97)时,IOU=0.7时 mAP=83.1%。

  • 所以下面,还需要进一步提高标定框的精度。
  • 1 提高训练ignore_thresh值,该值是确定anchor定框,和真实框在何种阈值下,为正样本的阈值。既然比赛要求是0.7 ,该参数也应该提高。
  • 2 增大input size 默认size为416*416 理论已经满足需求,但是适当提高input size 会有助于提高文本框标定精度。

5 对比

1 评价标准

  • 官方提供了常规的F1指标

2 对比

比较上述两种方法:

  • PS:
    • 如上对比,仅仅是当前测试结果,理论上FRCNN RFCN等两阶方法可以更好,谁让它训练时间太长…
    • YOLO的评分同样可以更好,实际是现在的NO1 已经是无限接近0.99的成绩… 膜拜

yolov4安装部署并测试图片及视频数据 - 知乎

mikel阅读(766)

yolo

来源: yolov4安装部署并测试图片及视频数据 – 知乎

前言:最近参加一个比赛需要用到yolo,安装过程中借鉴了网上众多的指导教程,也很感谢B站一位大佬的视频指导,所以在这里想整理一下给需要安装的yolov4的小伙伴一个借鉴,相关视频指导在文章末尾有链接来观看。

前期准备:进入GitHub找到AlexeyAB/darknet这个项目([项目链接](github.com/AlexeyAB/dar)),根据作者给出的安装条件安装好相应的软件,如下图。

①首先是CMake的安装,点击他给的链接即可下载,选择installer版本,一路默认安装即可:

②:接着是Cuda的安装,点击所给的链接地址进行下载,下载完成之后安装过程中选择精简安装即可。

③接着我们来安装OpenCV,我所安装的是OpenCV—4.3.0版本,安装的时候很简单,一步搞定,直接安装到指定的文件夹中。

==注意:==安装完成之后需要将OpenCV配置到环境变量中,若之前系统变量里面没有OpenCV的变量名,则新建一个,记得命名为OpenCV_DIR,如下图:

④接下来安装cuDNN,这个网站是需要注册才能下载的,然后下载的时候注意要和你所安装的cuda版本相配套

下载完cudnn的安装包解压之后是一个名叫cuda的文件夹,然后把里面的文件全部复制

然后将刚复制的文件全部粘贴到C盘的CUDA目录下,注意路径(我的是 C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v10.2),直接覆盖粘贴就好。

⑤visual studio的安装,点击链接([link](visualstudio.microsoft.com)),默认的是下载visual studio 2019社区版

安装 过程中需要注意的地方:

==勾选 使用C++的桌面开发,选择这一项即可==

⑥下载安装Git,这个是项目作者所没有要求安装的,我是之前就安装好了,方便接下来可以用Git来从gitee中下载部署项目代码,进官网直接下载即可,安装过程全部默认安装即可

⑦以上我们需要的软件都安装完成啦,接下来就是代码的获取。可以直接在GitHub下载

也可以在gitee中从Github导入仓库,点击右上角的+号,选择从GitHub/Gitlab导入仓库

此时将GitHub项目的下载地址复制下来,粘贴到gitee中,直接带入即可

打开Git Bash

之后需要在命令行中新建文件夹存放代码,并启动下载(我是在C盘下新建一个文件夹github ,进去这个文件夹,然后输入git clone https://github.com/AlexeyAB/darknet.git),下载完成之后会在C盘目录下看到刚刚新建的文件夹

接下来打开Cmake,在上面两栏填上刚刚下载好的darknet地址

然后点击左下角的Configure按钮,选择你所安装的visual studio版本号,并选择 x64

然后点击Finish按钮,经过一段时间运行,显示如下

此时再点击generate按钮(注意若不点击的话是不能Open Project的),显示如下:

接下来就可以点击Open Project啦,会自动打开visual studio,可以看到项目结构

此时需要配置管理器,点击生成按钮即可看到选项

然后选择release,x64,然后点击关闭

接下来我们生成解决方案,在生成按钮下的第一个选项

这是生成成功的界面

接下来进入C盘之前下载的代码文件里,将darknet.exe复制下来

将复制下来的exe文件粘贴到 darknet->build->x64文件夹中

接下来将 yolov4.weights文件(可以在网上自行下载,我就不贴链接啦)也粘贴进darknet->build->x64文件夹中

!!!!!

准备工作都已完成,接下来就是验证啦

进入命令行控制界面,进入C:\houhou\darknet\build\darknet\x64路径,然后将选中的这样一条命令粘贴进去,然后开始运行

在我们的x64目录下项目者提供的有供测试用的图片,直接输入dog.jpg即可

运行结果:

接下来是视频检测的演示:

命令:darknet detector demo cfg/coco.data cfg/yolov4.cfg yolov4.weights ./data/test.mp4 (其中test.mp4文件存放在C:\houhou\darknet\build\darknet\x64\data中的)

如果小伙伴觉得这些图文操作起来很复杂,可以观看链接中的视频来操作(视频指导

前端各种模块化方案总结 - 简书

mikel阅读(1664)

来源: 前端各种模块化方案总结 – 简书

大纲:
一、模块化概述
二、CommonJS规范
三、ES6 Module
四、CommonJS与ES6模块的混编
五、Node.js中的模块化
六、循环加载
七、了解:AMD-Require.js和CMD-SeaJS
八、参考链接

因为内容太多,没有大纲不方便阅读,所以也可以跳转 前端各种模块化方案总结 附带大纲 阅读。

文中七成左右篇幅内容都来自于Module的语法和加载实现 — 阮一峰彻底掌握前端模块化 — codewhy几篇文章,结合自己之前掌握的知识,按自己的记忆习惯重新进行了梳理。

一、模块化

1.1 什么是模块化

那么,到底什么是模块化开发呢?

模块:1、在通信、计算机、数据处理控制系统的电路中,可以组合和更换的硬件单元。2、大型软件系统中的一个具有独立功能的部分。

  • 现实生活中模块化的例子:模块化计算机(cpu、内存、显卡、风扇、硬盘、光驱等等模块)、谷歌模块化手机、模块化房屋
  • 代码模块化例子:日期模块、数学计算模块、日志模块等,所有这些模块共同组成了程序软件系统

模块化:

  • 模块化开发就是将程序划分成一个个(互相依赖的)小文件/模块来开发,然后将小模块组合起来
  • 这个模块中编写属于自己的逻辑代码,有自己的作用域,不会影响到其他的结构;
  • 这个模块可以将自己希望暴露的变量、函数、对象等导出给其结构使用;
  • 也可以通过某种方式,导入另外模块中的变量、函数、对象等;

模块化的好处:

  1. 防止命名冲突
  2. 代码复用(非模块化开发时,代码重用时,引入 js 文件的数目可能少了或者引入的顺序不对,会导致一些问题)
  3. 高维护性(模块之间有高耦合低内聚的特点)

1.2 JavaScript设计缺陷

无论你多么喜欢JavaScript,以及它现在发展的有多好,我们都需要承认在Brendan Eich用了10天写出JavaScript的时候,它都有很多的缺陷:

  • 比如var定义的变量作用域问题;
  • 比如JavaScript的面向对象并不能像常规面向对象语言一样使用class;
  • 比如JavaScript没有模块化的问题;

Brendan Eich本人也多次承认过JavaScript设计之初的缺陷,但是随着JavaScript的发展以及标准化,存在的缺陷问题基本都得到了完善。

  • JavaScript目前已经得到了快速的发展,无论是web、移动端、小程序端、服务器端、桌面应用都被广泛的使用;

在网页开发的早期,Brendan Eich开发JavaScript仅仅作为一种脚本语言,做一些简单的表单验证或动画实现等,那个时候代码还是很少的:

  • 这个时候我们只需要讲JavaScript代码写到<script>标签中即可;
  • 并没有必要放到多个文件中来编写;

<button id="btn">按钮</button>

<script>
  document.getElementById("btn").onclick = function() {
    console.log("按钮被点击了");
  }
</script>

但是随着前端和JavaScript的快速发展,JavaScript代码变得越来越复杂了:

  • ajax的出现,前后端开发分离,意味着后端返回数据后,我们需要通过JavaScript进行前端页面的渲染;
  • SPA的出现,前端页面变得更加复杂:包括前端路由、状态管理等等一系列复杂的需求需要通过JavaScript来实现;
  • 包括Node的实现,JavaScript编写复杂的后端程序,没有模块化是致命的硬伤;

所以,模块化已经是JavaScript一个非常迫切的需求。

1.3 没有模块化的JavaScript

1.3.1 技术方案

演变过程:

  • 全局函数
    • ”污染”了全局变量,无法保证不与其它模块发生变量名冲突
    • 没有模块的划分,只能人为的认为它们属于一个模块,但是程序并不能区分哪些函数是同一个模块
  • 将函数封装到对象命名空间下
    • 从代码级别可以明显的区分出哪些函数属于同一个模块
    • 从某种程度上解决了变量命名冲突的问题,但是并不能从根本上解决命名冲突
    • 会暴露所有的模块成员,内部状态可以被外部改写,不安全
    • 命名空间越来越长
  • 立即函数调用表达式(IIFE,Immediately Invoked Function Expression)
    • 将模块封装为立即执行函数形式,将公有方法,通过在函数内部返回值的形式向外暴露
    • 会有人强调职责单一性,不要与程序的其它部分直接交互。比如当使用到第三方依赖时,通过向匿名函数注入依赖项的形式,来保证模块的独立性,还使模块之间的依赖关系变得明显

      var calculator=(function(){
         var add=function(v1,v2){
          return v1+v2;
         }
         return { add:add }
      })()
      
      var calculator=(function(cal,$){
        cal.add2=function(){
            var v1=$('#v1').val();
            var v2= $('#v2').val();
           return (v1-0)+(v2-0);
        }
        return cal;
      })(window.calculator||{},window.$)
      //在这告诉我要jquery
      //依赖注入
      //很牵强的解决文件依赖问题的方法
      
  • IIFE也是有很大缺陷的,见下方代码举例

1.3.2 问题举例

我们先来简单体会一下没有模块化代码的问题。

我们知道,对于一个大型的前端项目,通常是多人开发的(即使一个人开发,也会将代码划分到多个文件夹中):

  • 我们假设有两个人:小明和小丽同时在开发一个项目,并且会将自己的JavaScript代码放在一个单独的js文件中。

// 小明开发了aaa.js文件,代码如下(当然真实代码会复杂的多):
var flag = true;

if (flag) {
  console.log("aaa的flag为true")
}

// 小丽开发了bbb.js文件,代码如下:
var flag = false;

if (!flag) {
  console.log("bbb使用了flag为false");
}

很明显出现了一个问题:

  • 大家都喜欢使用flag来存储一个boolean类型的值;
  • 但是一个人赋值了true,一个人赋值了false;
  • 如果之后都不再使用,那么也没有关系;

但是,小明又开发了ccc.js文件:

if (flag) {
  console.log("使用了aaa的flag");
}

问题来了:小明发现ccc中的flag值不对

  • 对于聪明的你,当然一眼就看出来,是小丽将flag赋值为了false;
  • 但是如果每个文件都有上千甚至更多的代码,而且有上百个文件,你可以一眼看出来flag在哪个地方被修改了吗?

备注:引用路径如下:

<script src="./aaa.js"></script>
<script src="./bbb.js"></script>
<script src="./ccc.js"></script>

所以,没有模块化对于一个大型项目来说是灾难性的。

1.3.3 IIFE的缺陷

使用IIFE解决上面的问题:

// aaa.js
const moduleA = (function () {
  var flag = true;

  if (flag) {
    console.log("aaa的flag为true")
  }

  return { flag: flag }
})();

// bbb.js
const moduleB = (function () {
  var flag = false;

  if (!flag) {
    console.log("bbb使用了flag为false");
  }
})();

// ccc.js
const moduleC = (function() {
  const flag = moduleA.flag;
  if (flag) {
    console.log("使用了aaa的flag");
  }
})();

命名冲突的问题,有没有解决呢?解决了。

但是,我们其实带来了新的问题:

  • 第一,我必须记得每一个模块中返回对象的命名,才能在其他模块使用过程中正确的使用;
  • 第二,代码写起来混乱不堪,每个文件中的代码都需要包裹在一个匿名函数中来编写;
  • 第三,在没有合适的规范情况下,每个人、每个公司都可能会任意命名、甚至出现模块名称相同的情况;

所以,我们会发现,虽然实现了模块化,但是我们的实现过于简单,并且是没有规范的。

  • 我们需要制定一定的规范来约束每个人都按照这个规范去编写模块化的代码;
  • 这个规范中应该包括核心功能:模块本身可以导出暴露的属性,模块又可以导入自己需要的属性;

1.4 JavaScript中模块化方案

历史上,JavaScript 一直没有模块(module)体系,无法将一个大程序拆分成互相依赖的小文件,再用简单的方法拼装起来。其他语言都有这项功能,比如 Ruby 的require、Python 的import,甚至就连 CSS 都有@import。直到ES6(2015)才推出了自己的模块化方案,在此之前,社区制定了一些模块加载方案,最主要的有:

先有规范,后有实现:

二、CommonJS规范

2.1 CommonJS和Node

我们需要知道CommonJS是一个规范,最初提出来是在浏览器意外的地方使用,并且当时被命名为ServerJS,后来为了体现它的广泛性,修改为CommonJS,平时我们也会简称为CJS。

  • Node是CommonJS在服务器端一个具有代表性的实现;
  • Browserify是CommonJS在浏览器中的一种实现;
  • webpack打包工具具备对CommonJS的支持和转换(后面会讲到);

所以,Node中对CommonJS进行了支持和实现,让我们在开发node的过程中可以方便的进行模块化开发:

2.2 Node模块化语法

2.2.1 模块

// bar.js
const name = 'coderwhy';
const age = 18;
function sayHello(name) { console.log("Hello " + name); }

// main.js
console.log(name, age);
sayHello('kobe');

/*
上面的代码会报错:
 - 那么,就意味着别的模块main中不能随便访问另外一个模块bar中的内容;
 - bar需要 导出 自己想要暴露的变量、函数、对象等;main从bar中 导入 自己想要使用的变量、函数、对象等数据之后,才能使用;
 */

在node中每一个文件都是一个独立的模块,有自己的作用域。在一个模块内变量、函数、对象都属于这个模块,对外是封闭的。

为了实现模块的导出,Node中使用的是Module的类(提供了一个Module构造函数),每一个模块都是Module的一个实例,也就是module;

每个模块(文件)中都包括CommonJS规范的核心变量:exports、module、require;

  • module:是一个全局对象,代表当前模块。里面保存了模块的信息路径、父子结构信息、曝露出的对象信息。

    module.id            //带有绝对路径的模块文件名
    module.filename      //模块的文件名,带有绝对路径
    module.loaded        //表示模块是否已经完成加载
    module.parent          //返回一个对象,表示调用该模块的模块。
    module.children      //返回一个数组,表示该模块要用到的其他模块。
    module.exports         //模块对外输出的值。需要打破模块封装性曝露的方法和属性,都要挂载到module.exports上。其它文件加载该模块,实际上就是读取module.exports属性
    
    // 在 /Users/computer/Desktop/ccc/lib.js 文件中 console.log(module);
    Module {
      id: '.',
      path: '/Users/computer/Desktop/ccc',
      exports: { name: 'test' },
      parent: null,
      filename: '/Users/computer/Desktop/ccc/main.js',
      loaded: false,
      children: [
        Module {...}
      ],
      paths: [ //查找路径
        '/Users/computer/Desktop/ccc/node_modules',
        '/Users/computer/Desktop/node_modules',
        '/Users/computer/node_modules',
        '/Users/node_modules',
        '/node_modules'
      ]
    }
    
  • exports是module.exports的引用。一起负责对模块中的内容进行导出;
  • require函数可以帮助我们导入其他模块(自定义模块、系统模块、第三方库模块)中的内容;

在Node.js中,模块分为两类:

  • 第一类,系统核心模块(原生模块),node自带。用名称直接可以加载。
    • fs(file system):与文件系统交互
    • http:提供http服务器功能
    • os:提供了与操作系统相关的实用方法和属性
    • path:处理文件路径
    • querystring:解析url查询字符串
    • url:解析url
    • util:提供一系列实用小工具
    • Buffer
    • 等等很多,见官方文档
    • 核心模块的源码都在Node的lib子目录中。为了提高运行速度,它们安装的时候都会被编译成二进制文件
  • 第二类,文件模块,也称自定义模块。用路径加载。

    有一种特殊的文件模块 — 包,被管理在node_modules文件夹中的包,也可以直接用名字加载。

2.2.2 exports导出

强调:exports是一个对象,我们可以在这个对象中添加很多个属性,添加的属性会导出

// bar.js 导出内容
exports.name = name;
exports.age = age;
exports.sayHello = sayHello;

// main.js 导入内容
const bar = require('./bar');

上面这行代码意味着什么呢?

  • 意味着main中的bar变量等于exports对象;

main中的bar = bar中的exports

所以,我可以编写下面的代码:

const bar = require('./bar');

const name = bar.name;
const age = bar.age;
const sayHello = bar.sayHello;

console.log(name);
console.log(age);

sayHello('kobe');
模块之间的引用关系

为了进一步论证,bar和exports是同一个对象:

  • 所以,bar对象是exports对象的浅拷贝;
  • 浅拷贝的本质就是一种引用的赋值而已;
定时器修改对象

2.2.3 module.exports

但是Node中我们经常导出东西的时候,又是通过module.exports导出的:

  • module.exports和exports有什么关系或者区别呢?

我们追根溯源,通过维基百科中对CommonJS规范的解析:

  • CommonJS中是没有module.exports的概念的;
  • 但是为了实现模块的导出,Node中使用的是Module的类(提供了一个Module构造函数),每一个模块都是Module的一个实例,也就是module;
  • module才是导出的真正实现者;
  • 所以在Node中真正用于导出的其实根本不是exports,而是module.exports。只是为了实现CommonJS的规范,也为了使用方便,Node为每个模块提供了一个exports对象,让其对module.exports有一个引用而已。
  • 相当于在每个模块头部,有这样一行命令:var exports = module.exports;

不能直接给exports、module.exports赋值,这样等于切断了exports和module.exports的联系。最终输出的结果只会是module.exports的值。比如代码这样修改了:

2.2.4 require

1. require的加载原理

前面已经说过,CommonJS 的一个模块,就是一个脚本文件。

  • CommonJS是同步加载。模块加载的顺序,按照其在代码中出现的顺序
  • require命令第一次加载模块时,会执行整个模块(脚本文件)中的js代码,返回该模块的module.exports接口数据。会在内存生成一个该模块对应的module对象。

// aaa.js
const name = 'coderwhy';
console.log("Hello aaa");

setTimeout(() => {
  console.log("setTimeout");
}, 1000);

// main.js
const aaa = require('./aaa'); // aaa.js中的代码在引入时会被运行一次

生成的对象:

{
  id: '...',  // 模块名
  exports: { ... },  // 模块输出的各个接口
  loaded: true,   // 是一个布尔值,为false表示还没有加载,为true表示已经加载完毕。这是保证每个模块只加载、运行一次的关键。
  ...
}
  • 以后需要用到这个模块的时候,就会到exports属性上面取值。
  • 模块被多次引入时(多次执行require命令),CommonJS 模块只会在第一次加载时运行一次,以后再加载,会去缓存中取出第一次加载时生成的module对象并返回module.exports。除非手动清除系统缓存。

// main.js
const aaa = require('./aaa');
const bbb = require('./bbb');

// aaa.js
const ccc = require("./ccc");

// bbb.js
const ccc = require("./ccc");

// ccc.js
console.log('ccc被加载');  // ccc中的代码只会运行一次。
2. require的查找规则

我们现在已经知道,require是一个函数,可以帮助我们引入一个文件(模块)中导入的对象。

那么,require的查找规则是怎么样的呢?官方文档

这里我总结比较常见的查找规则: 导入格式如下:require(X)

  • 情况一:X是一个核心模块,比如path、http。直接返回核心模块,并且停止查找
    • 加载核心模块。传入名字,不需要传入路径。因为Node.js已经将核心模块的文件代码编译到了二进制的可执行文件中了。在加载的过程中,原生的核心模块的优先级是是最高的。
  • 情况二:X是以 ./..//(根目录)开头的
    • 在Linux或者MAc的操作系统中,/表示系统的根路径。在Windows中,/表示当前文件模块所属的根磁盘路径
    • 第一步:将X当做一个文件在对应的目录下查找;
      • 如果有后缀名,按照后缀名的格式查找对应的文件
      • 如果没有后缀名,会按照如下顺序:
        1. 直接查找文件X
        2. 查找X.js文件:当做JavaScript脚本文件解析
        3. 查找X.json文件:以JSON格式解析。
          • 如果是加载json文件模块,最好加上后缀.json,能稍微的提高一点加载的速度。
          • json文件Node.js也是通过fs读文件的形式读取出来的,然后通过JSON.parse()转换成一个对象
        4. 查找X.node文件:以编译后的二进制文件解析。.node文件通常是c/c++写的一些扩展模块
    • 第二步:没有找到对应的文件,将X作为一个目录。查找目录下面的index文件
      1. 查找X/index.js文件
      2. 查找X/index.json文件
      3. 查找X/index.node文件
    • 如果没有找到,那么报错:not found
  • 情况三:直接是一个X(没有路径),并且X不是一个核心模块
    • 比如在/Users/coderwhy/Desktop/Node/TestCode/04_learn_node/05_javascript-module/02_commonjs/main.js中编写 require('why')
    • 查找顺序:从当前 package 的 node_modules 里面找,找不到就到当前 package 目录上层 node_modules 里面取… 一直找到全局 node_modules 目录。
    • 这样找到的往往是文件夹,所以接下来就是处理一个文件目录作为 Node 模块的情况。如果文件目录下有 package.json,就根据它的 main 字段找到 js 文件。如果没有 package.json,那就默认取文件夹下的 index.js

      由于 webpack browsersify 等模块打包工具是兼容 node 的模块系统的,自然也会进行同样的处理流程。不同的是,它们支持更灵活的配置。比如在 webpack 里面,可以通过 alias 和 external 字段配置,实现对默认 import 逻辑的自定义。

    • 如果上面的路径中都没有找到,那么报错:not found

流程图:

  • Node.js会通过同步阻塞的方式看这个路径是否存在。依次尝试,直到找到为止,如果找不到,报错
  • 优先从缓存加载:common.js规范:载后,再次加载时,去缓存中取module.exports 参考文献
3. require的加载顺序

如果有多个模块的引入,那么加载顺序是什么?

如果出现下面模块的引用关系,那么加载顺序是什么呢?

  • 这个其实是一种数据结构:图结构;
  • 图结构在遍历的过程中,有深度优先搜索(DFS, depth first search)和广度优先搜索(BFS, breadth first search);
  • Node采用的是深度优先算法:main -> aaa -> ccc -> ddd -> eee ->bbb

多个模块的引入关系:

2.3 Node的源码解析

Module类

Module.prototype.require函数

Module._load函数

三、ES6 Module

4.1 认识ES6 Module

4.1.1 ES6 Module的优势

ES6 在语言标准的层面上,实现了模块功能,而且实现得相当简单,完全可以取代 CommonJS 和 AMD 规范,成为浏览器和服务器通用的模块解决方案。

ES6 模块的设计思想是尽量的静态化,使得编译时就能确定模块的依赖关系,以及输入和输出的变量。CommonJS 和 AMD 模块,都只能在运行时确定这些东西,导致完全没办法在编译时做“静态优化”。

由于 ES6 模块是编译时加载:

  • 可以在编译时就完成模块加载,效率要比 CommonJS 模块的加载方式高
  • 使得静态分析成为可能。有了它,就能进一步拓宽 JavaScript 的语法,比如引入宏(macro)和类型检验(type system)这些只能靠静态分析实现的功能。

除了静态加载带来的各种好处,ES6 模块还有以下好处。

  • 不再需要UMD模块格式了,将来服务器和浏览器都会支持 ES6 模块格式。目前,通过各种工具库,其实已经做到了这一点。
  • 将来浏览器的新 API 就能用模块格式提供,不再必须做成全局变量或者navigator对象的属性。
  • 不再需要对象作为命名空间(比如Math对象),未来这些功能可以通过模块提供。

4.1.2 自动启动严格模式

ES6 的模块自动采用严格模式,不管你有没有在模块头部加上"use strict";

  • 其中,尤其需要注意this的限制。<font color=red>ES6 模块之中,顶层的this指向undefined,即不应该在顶层代码使用this</font>。
  • 参考链接:

4.1.3 浏览器中加载ES6 Module

1. 加载普通js文件

HTML 网页中,浏览器通过<script>标签加载 JavaScript 脚本。

<!-- 页面内嵌的脚本 -->
<script type="application/javascript"> // code </script>

<!-- 外部脚本 -->
<script type="application/javascript" src="path/to/myModule.js"> //code... </script>
  • 上面代码中,由于浏览器脚本的默认语言是 JavaScript,因此type="application/javascript"可以省略。
  • 默认情况下,浏览器是同步加载 JavaScript 脚本,即渲染引擎遇到<script>标签就会停下来,等到执行完脚本,再继续向下渲染。如果是外部脚本,还必须加入脚本下载的时间。

    如果脚本体积很大,下载和执行的时间就会很长,因此造成浏览器堵塞,用户会感觉到浏览器“卡死”了,没有任何响应。这显然是很不好的体验,所以浏览器允许脚本异步加载。

下面就是两种异步加载的语法。

<script src="path/to/myModule.js" defer></script>
<script src="path/to/myModule.js" async></script>

上面代码中,<script>标签打开deferasync属性,脚本就会异步加载。渲染引擎遇到这一行命令,就会开始下载外部脚本,但不会等它下载和执行,而是直接执行后面的命令。

deferasync的区别是:

  • defer要等到整个页面在内存中正常渲染结束(DOM 结构完全生成,以及其他脚本执行完成),才会执行;
  • async一旦下载完,渲染引擎就会中断渲染,执行这个脚本以后,再继续渲染。
  • 一句话,defer是“渲染完再执行”,async是“下载完就执行”。
  • 另外,如果有多个defer脚本,会按照它们在页面出现的顺序加载,而多个async脚本是不能保证加载顺序的。
2. 加载ES6 Module

浏览器内嵌、外链 ES6 模块代码,也使用<script>标签,但是都要加入type="module"属性。

type属性设为module,所以浏览器知道这是一个 ES6 模块。浏览器对于带有type="module"<script>,都是异步加载,不会造成堵塞浏览器,即等到整个页面渲染完,再执行模块脚本,等同于打开了<script>标签的defer属性。

<script type="module" src="./foo.js"></script>

<!-- 等同于下面代码。如果网页有多个 <script type="module">,它们会按照在页面出现的顺序依次执行。 -->
<script type="module" src="./foo.js" defer></script>

<!-- 
<script>标签的async属性也可以打开:
    这时只要加载完成,渲染引擎就会中断渲染立即执行。执行完成后,再恢复渲染。 
    同样的:一旦使用了此属性,<script type="module">就不会按照在页面出现的顺序执行,而是只要该模块加载完成,就执行该模块。
-->
<script type="module" src="./foo.js" async></script>

ES6 模块也允许内嵌在网页中,语法行为与加载外部脚本完全一致。

<script type="module">
  import utils from "./utils.js";

  // other code
</script>

对于外部的模块脚本(上例是foo.js),有几点需要注意。

  • 代码是在模块作用域之中运行,而不是在全局作用域运行。模块内部的顶层变量,外部不可见。
  • 模块脚本自动采用严格模式,不管有没有声明use strict
  • 模块之中,可以使用import命令加载其他模块(.js后缀不可省略,需要提供绝对 URL 或相对 URL),也可以使用export命令输出对外接口。
  • 模块之中,顶层的this关键字返回undefined,而不是指向window。也就是说,在模块顶层使用this关键字,是无意义的。
  • 同一个模块如果加载多次,将只执行一次。

下面是一个示例模块。

import utils from 'https://example.com/js/utils.js';

const x = 1;

console.log(x === window.x); //false
console.log(this === undefined); // true

利用顶层的this等于undefined这个语法点,可以侦测当前代码是否在 ES6 模块之中。

const isNotModuleScript = this !== undefined;

4.1.4 本地浏览的报错

代码结构如下(个人习惯)

├── index.html
├── main.js
└── modules
    └── foo.js

index.html中引入两个js文件作为模块:

<script src="./modules/foo.js" type="module"></script>
<script src="main.js" type="module"></script>

如果直接在浏览器中运行代码,会报如下错误:

这个在MDN上面有给出解释:

我这里使用的VSCode,VSCode中有一个插件:Live Server

  • 通过插件运行,可以将我们的代码运行在一个本地服务中;

4.2 ES6 Module的语法

模块功能主要由两个命令构成:exportimport

  • export命令用于规定模块的对外接口
  • import命令用于输入其他模块提供的功能。

4.2.1 模块与CommonJS模块的区别

1. 相同点

与CommonJS的相同点:一个模块就是一个独立的文件。该文件内部的所有变量,外部无法获取。如果你希望外部能够读取模块内部的某个变量,就必须使用export关键字输出该变量。

2. 导出的不同

CommonJS通过module.exports导出的是一个对象,是module.exports属性浅拷贝后导出:

  • 该对象只有在脚本运行完才会生成。
  • 导出的是一个对象意味着可以将这个对象的引用在导入模块中赋值给其他变量;但是最终他们指向的都是同一个对象,那么一个变量修改了对象的属性,所有的地方都会被修改;

// 导出
var counter = 3;
var obj = {count: 3}
function incCounter() {
    counter++;
    obj.count++;
}
module.exports = {
  counter: counter,
  incCounter: incCounter,
  obj: obj
};

// 导入
var mod = require('./lib');

console.log(mod.counter, mod.obj.count); // 3  3
mod.incCounter();
console.log(mod.counter, mod.obj.count); // 3  4

ES Module通过export导出的不是对象,是一个个导出变量/函数/类本身的引用:

说法1:

  • 它的对外接口只是一种静态定义,在代码静态解析阶段就会生成。JS 引擎对脚本静态分析的时候,遇到模块加载命令import,就会生成一个只读引用。等到脚本真正执行时,再根据这个只读引用,到被加载的那个模块里面去取值。
  • 换句话说,ES6 的import有点像 Unix 系统的“符号连接”,原始值变了,import加载的值也会跟着变。(由于 ES6 输入的模块变量,只是一个“符号连接”,所以这个变量是只读的,对它进行重新赋值会报错)
  • 所以,import命令叫做“连接” binding 其实更合适。

说法2:

  • export在导出一个变量时,js引擎会解析这个语法,并且创建模块环境记录(module environment record);
  • 模块环境记录会和变量进行 绑定(binding),并且这个绑定是实时的;
  • 而在导入的地方,我们是可以实时的获取到绑定的最新值的;

export和import绑定的过程:

还是举上面的例子。

// lib.js
export let counter = 3;
export function incCounter() {
  counter++;
}

// main.js
import { counter, incCounter } from './lib';
console.log(counter); // 3
incCounter();
console.log(counter); // 4

上面代码说明,ES6 模块输入的变量counter是活的,完全反应其所在模块lib.js内部的变化。

3. 导入的不同

// CommonJS模块
let { stat, exists, readfile } = require('fs');

// 等同于
let _fs = require('fs');
let stat = _fs.stat;
let exists = _fs.exists;
let readfile = _fs.readfile;

上面代码实质会整体加载fs模块(即加载fs的所有方法),生成一个对象(_fs),然后再从这个对象上面读取 3 个方法。

// ES6模块
import { stat, exists, readFile } from 'fs';

上面代码实质只是从fs模块加载 3 个方法,其他方法不加载。

4.2.2 export

export关键字将一个模块中的变量、函数、类等导出;

1. export <decl>

方式一:分别导出。在语句声明的前面直接加上export关键字:

export const name = 'coderwhy';
export const age = 18;
export let message = "my name is why";

export function sayHello(name) {
  console.log("Hello " + name);
}

// export需要指定对外暴露的接口,所以不能直接输出一个值
// export 40; //error
2. export {}

方式二:统一导出。将所有需要导出的标识符,放到export后面的 {}中。它与上一种写法是等价的,但是应该优先考虑使用这种写法。因为这样就可以在脚本尾部,一眼看清楚输出了哪些数据。

  • 注意:这里的 {}里面不是ES6的对象字面量的增强写法,{}也不是表示一个对象的;
  • 所以:export {name: name},是错误的写法;

const name = 'coderwhy';
const age = 18;

function sayHello(name) {
  console.log("Hello " + name);
}

export {
  name,
  age,
  sayHello
}
3. export {<> as <>}

方式三:通常情况下,export输出的变量就是本来的名字,但是可以使用as关键字在导出时给标识符起一个别名:export {<> as <>}

export {
  name as fName,
  age as fAge,
  sayHello as fSayHello1,
  sayHello as fSayHello2, // 重命名后,sayHello可以用不同的名字输出两次。
}
4. export导出的是标识符的地址

export语句输出的接口,与其对应的值是动态绑定关系,即通过该接口,可以取到模块内部实时的值。

export var foo = 'bar';
setTimeout(() => foo = 'baz', 500);

上面代码输出变量foo,值为bar,500 毫秒之后变成baz

这一点与 CommonJS 规范完全不同。CommonJS 模块输出的是值的缓存,不存在动态更新。

5. export导出同一个实例

function C() {
  this.sum = 0;
}

export let c = new C();

不同的模块中,加载这个模块,得到的都是同一个实例。对c修改,其他模块导入的数据也会改变

6. export书写位置

export命令可以出现在模块的任何位置,只要处于模块顶层就可以。如果处于块级作用域内,就会报错,import命令也是如此。这是因为处于条件代码块之中,就没法做静态优化了,违背了 ES6 模块的设计初衷。

function foo() {
  export default 'bar' // SyntaxError
}
foo()
7. export书写次数

一个模块中:export <decl>export {}export {<> as <>}都是可以出现0-n次的

4.2.3 import

import关键字负责从另外一个模块中导入内容。

import语句会执行所加载的模块。如果同一个模块被加载多次,那么模块里的代码只执行一次。

导入内容的方式也有多种:

1. import {} from ''

方式一:选择导入。import {标识符列表} from '模块'

注意:

  • 大括号里面的变量名,必须与被导入模块对外接口的名称相同。
  • 这里的{}也不是一个对象,里面只是存放导入的标识符列表内容;

import { name, age, sayHello } from './modules/foo.js';

console.log(name)
console.log(age);
sayHello("Kobe");

import { name } from './modules/foo.js';
import { age } from './modules/foo.js';
// 等同于
import { name, age } from './modules/foo.js';

上面代码中,虽然nameage在两个语句中加载,但是它们对应的是同一个foo.js模块。也就是说,import语句是 Singleton 模式。

1. import ''的含义

import语句会执行所加载的模块,因此可以有下面的写法。

import 'lodash'; 

上面代码仅仅执行lodash模块,但是不导入任何值。

同样的,如果多次重复执行同一句import语句,那么只会执行一次,而不会执行多次。

import 'lodash';
import 'lodash'; // 代码加载了两次`lodash`,但是只会执行一次。
2. import {<> as <>} from ''

方式二:导入时给标识符起别名: import {<> as <>} from ''

import { name as wName, age as wAge, sayHello as wSayHello } from './modules/foo.js';
3. import * as <> from ''

方式三:整体导入。将模块功能放到一个模块功能对象(a module object)上,用*指定: import * as <> from ''

import * as foo from './modules/foo.js';

console.log(foo.name);
console.log(foo.age);
foo.sayHello("Kobe");

// foo.n = "add"; // Type Error: object is not extensible
// foo.f = function () {}; 

注意,模块整体加载所在的那个对象,应该是可以静态分析的,所以不允许运行时改变。上面的写法是不允许的。

4. import导入为只读

import { name } from './modules/foo.js';
name = "mod"; // Syntax Error : 'name' is read-only;

name是只读的。但是,如果name是一个对象,改写其属性是允许的,并且其他模块也可以读到改写后的值。不过,这种写法很难查错,建议凡是输入的变量,都当作完全只读,不要轻易改变它的属性。

5. import from后的路径

import后面的from指定模块文件的位置,可以是相对路径,也可以是绝对路径,<font color=red>后缀名不能省略</font>。

如果不带有路径,只是一个模块名,那么必须有配置文件,告诉 JavaScript 引擎该模块的位置。

import { myMethod } from 'util';

上面代码中,util是模块文件名,由于不带有路径,必须通过配置,告诉引擎怎么取到这个模块。

6. import命令的提升

注意,import命令具有提升效果,会提升到整个模块的头部,首先执行。

foo();
import { foo } from 'my_module';

上面的代码不会报错,因为import的执行早于foo的调用。这种行为的本质是,import命令是编译阶段执行的,在代码运行之前。

目前阶段,通过 Babel 转码,CommonJS 模块的require命令和 ES6 模块的import命令,可以写在同一个模块里面,但是最好不要这样做。因为import在静态解析阶段执行,所以它是一个模块之中最早执行的。下面的代码可能不会得到预期结果。

require('core-js/modules/es6.symbol');
require('core-js/modules/es6.promise');
import React from 'React';
7. import中不能使用表达式和变量

由于import是静态执行,所以不能使用表达式和变量,这些只有在运行时才能得到结果的语法结构。

// 报错
import { 'f' + 'oo' } from 'my_module';

// 报错
let module = 'my_module';
import { foo } from module;

// 报错
if (x === 1) {
  import { foo } from 'module1';
} else {
  import { foo } from 'module2';
}

上面三种写法都会报错,因为它们用到了表达式、变量和if结构。在静态分析阶段,这些语法都是没法得到值的。

4.2.4 export default

1. 概述

前面我们学习的导出功能都是有名字的导出(named exports):

  • 在导出export时指定了名字;
  • 在导入import时需要知道具体的名字;

还有一种导出叫做默认导出(default export)

  • 默认导出export时可以不需要指定名字;
  • 在导入时不需要使用 {},并且可以自己来指定名字;
  • 它也方便我们和现有的CommonJS等规范相互操作;
2. 导出与导入格式

也是可以导出变量、函数、类的。

// 导出格式1
export default function sub(num1, num2) {
  return num1 - num2;
}

// 导出格式2:用在非匿名函数前
export default function() {}

// 导出格式3:用在函数变量前
function sub() { console.log('sub'); }
export default sub;

// 函数名`sub`,在模块外部是无效的。加载的时候,视同匿名函数加载。


// 导入格式1:常用及推荐
import sub from './modules/foo.js';
console.log(sub(20, 30));

// 导入格式2
import * as m from './modules/foo.js';
console.log(m.default.sub(20, 30));

// 导入格式3
import {default as m} from './modules/foo.js';
console.log(m.sub(20, 30));
3. export default的本质

本质上,export default就是输出一个叫做default的变量或方法,然后系统允许你为它取任意名字。所以,下面的写法是有效的。

// modules.js
function add(x, y) {
  return x * y;
}
export {add as default};  // 等同于 export default add;

// app.js
import { default as foo } from 'modules'; // 等同于 import foo from 'modules';

正是因为export default命令其实只是输出一个叫做default的变量,所以它后面不能跟变量声明语句。

// 正确
export var a = 1;

// 正确
var a = 1;
export default a; // 含义是将变量`a`的值赋给变量`default`。所以,最后一种写法会报错。

// 错误
// export default var a = 1;

// 同样地,因为`export default`命令的本质是将后面的值,赋给`default`变量,所以可以直接将一个值写在`export default`之后。
// 正确
export default 42;
// 报错
// export 42; // export后面得跟声明,或者{标识符}
4. export default与export

注意:在一个模块中,export default是可以与export同时使用的:

  • export default用于指定模块的默认输出。显然,一个模块只能有一个默认输出,因此export default命令只能使用一次。
  • export是没有限制的。export <decl>export {}export {<> as <>}都是可以出现0-n次的

// 导出
export default function sub(num1, num2) {
  return num1 - num2;
}
export var name = "module1";

// 导入 在一条`import`语句中,同时输入默认接口和其他接口
import m, {name} from './modules/foo.js'; //m.sub、name
import * as m from './modules/foo.js'; // m.default.sub、m.name
import {default as m, name} from './modules/foo.js'; // m.sub、name

4.2.5 export和import结合

// bar.js 导出一个sum函数
export const sum = function(num1, num2) {
  return num1 + num2;
}

// foo.js做一个中转

// main.js直接从foo中导入
import { sum } from './modules/foo.js';
console.log(sum(20, 30));

如果从一个模块中导入的内容,我们希望再直接导出出去,这个时候可以使用export和import的结合,写成一行。

// foo.js 导入,但是只是做一个中转
export { sum } from './bar.js';

// 接口改名
export { sum as barSum } from './bar.js'; // 甚至在foo.js中导出时,我们可以变化它的名字

// 整体导入和导出
export * from './bar.js';
    // 相当于实现了模块之间的继承。注意,`export *`命令会忽略后面模块的`default`接口。

// 默认接口
export { default } from 'foo';

// 具名接口改为默认接口的写法如下:
export { es6 as default } from './someModule';
        // 等同于
        import { es6 } from './someModule';
        export default es6;

// 默认接口也可以改名为具名接口:
export { default as es6 } from './someModule';

// ES2020 之前,有一种`import`语句,没有对应的复合写法。[ES2020](https://github.com/tc39/proposal-export-ns-from)补上了这个写法。
export * as ns from "mod";
        // 等同于
        import * as ns from "mod";
        export {ns};

// 需要注意的是,写成一行以后,`sum`实际上并没有被导入当前模块,只是相当于对外转发了这个接口,导致当前模块不能直接使用`sum`。

为什么要这样做呢?

  • 在开发和封装一个功能库时,通常我们希望将暴露的所有接口放到一个文件中;
  • 这样方便指定统一的接口规范,也方便阅读;
  • 这个时候,我们就可以使用export和import结合使用;

4.2.6 import()

1. import()的背景

前面介绍过,import命令会被 JavaScript 引擎静态分析,先于模块内的其他语句执行。所以,importexport命令只能在模块的顶层,是不可以在其放到逻辑代码中(比如在if代码块之中,或在函数之中)的。下面的代码会报错:

if (true) {
  import sub from './modules/foo.js';
}

引擎处理import语句是在编译时,这时不会去分析或执行if语句,所以import语句放在if代码块之中毫无意义,因此会报句法错误,而不是执行时错误。

这样的设计,固然有利于编译器提高效率,但也导致无法在运行时加载模块。在语法上,条件加载就不可能实现。如果import命令要取代 Node 的require方法,这就形成了一个障碍。因为require是运行时加载模块,import命令无法取代require的动态加载功能。

const path = './' + fileName;
const myModual = require(path); 
// 上面的语句就是动态加载,`require`到底加载哪一个模块,只有运行时才知道。`import`命令做不到这一点。

ES2020提案 引入import()函数,支持动态加载模块。

import(specifier)

上面代码中,import函数的参数specifier,指定所要加载的模块的位置。import命令能够接受什么参数,import()函数就能接受什么参数,两者区别主要是后者为动态加载。

2. 语法

import()返回一个 Promise 对象。下面是一个例子。

const main = document.querySelector('main');

import(`./section-modules/${someVariable}.js`)
  .then(module => {     // 加载模块成功以后,这个模块会作为一个对象,当作`then`方法的参数.
//.then({export1, export2} => {     // 可以使用对象解构赋值的语法,获取输出接口。
//.then({default: theDefault} => {  // 如果是default,那么需要解构重命名
    
    module.loadPageInto(main); // module.default来使用默认导出
  })
  .catch(err => {
    main.textContent = err.message;
  });

// 如果想同时加载多个模块,可以采用下面的写法。
Promise.all([
  import('./module1.js'),
  import('./module2.js'),
  import('./module3.js'),
])
.then(([module1, module2, module3]) => {
   ···
});

// 返回值是Promise对象,所以也可以用在async函数中
async function main() {
  const myModule = await import('./myModule.js');
  const {export1, export2} = await import('./myModule.js');
  const [module1, module2, module3] =
    await Promise.all([
      import('./module1.js'),
      import('./module2.js'),
      import('./module3.js'),
    ]);
}
main();

import()函数可以用在任何地方,不仅仅是模块,非模块的脚本也可以使用。它是运行时执行,也就是说,什么时候运行到这一句,就会加载指定的模块。另外,import()函数与所加载的模块没有静态连接关系,这点也是与import语句不相同。import()类似于 Node 的require方法,区别主要是前者是异步加载,后者是同步加载。

3. 适用场合
  • 按需加载。

    import()可以在需要的时候,再加载某个模块。比如放在click事件的监听函数之中,只有用户点击了按钮,才会加载这个模块。

  • 条件加载

    import()可以放在if代码块,根据不同的情况,加载不同的模块。

  • 动态的模块路径

    import()允许模块路径动态生成。

    import(f()).then(...);  // 根据函数`f`的返回结果,加载不同的模块。
    

4.2.7 应用: 公共头文件

介绍const命令的时候说过,const声明的常量只在当前代码块有效。如果想设置跨模块的常量(即跨多个文件),或者说一个值要被多个模块共享,可以采用下面的写法。

// constants.js 模块
export const A = 1;
export const B = 3;
export const C = 4;

// test1.js 模块
import * as constants from './constants';
console.log(constants.A); // 1
console.log(constants.B); // 3

// test2.js 模块
import {A, B} from './constants';
console.log(A); // 1
console.log(B); // 3

如果要使用的常量非常多,可以建一个专门的constants目录,将各种常量写在不同的文件里面,保存在该目录下。

// constants/db.js
export const db = {
  url: 'http://my.couchdbserver.local:5984',
  admin_username: 'admin',
  admin_password: 'admin password'
};

// constants/user.js
export const users = ['root', 'admin', 'staff', 'ceo', 'chief', 'moderator'];

然后,将这些文件输出的常量,合并在index.js里面。

// constants/index.js
export {db} from './db';
export {users} from './users';

使用的时候,直接加载index.js就可以了。

// script.js
import {db, users} from './constants/index.js';

4.2.8 与CommonJS模块化的差异

  • CommonJS 模块输出的是一个值的拷贝(module.exports的浅拷贝),ES6 模块输出的是值的引用。
  • CommonJS 模块是运行时加载,ES6 模块是编译(解析)时加载。
    • 运行时加载意味着是js引擎在 执行js代码的过程中 加载模块;所以require可以与变量、表达式等运行时代码结合使用
    • 编译时(解析)时加载,意味着import不能和运行时相关的内容放在一起使用:
      • 比如from后面的路径需要动态获取;
      • 比如不能将import放到if等语句的代码块中;
      • 所以我们有时候也称ES Module是静态解析的,而不是动态或者运行时解析的;
  • CommonJS 模块的require()是同步加载模块,ES6 模块的import命令是异步加载,有一个独立的模块依赖的解析阶段。
    • 同步的就意味着一个文件没有加载结束之前,后面的代码都不会执行;
    • 异步的意味着:不会阻塞主线程继续执行;
      • JS引擎在遇到import时会去获取这个js文件的过程是异步的
      • 设置了 type=module 的script标签,相当于加上了 async 属性;
      • 如果我们后面有普通的script标签以及对应的代码,那么ES Module对应的js文件和代码不会阻塞它们的执行;

CommonJS代码:

console.log("main代码执行");

const flag = true;
if (flag) {
  // 同步加载foo文件,并且执行一次内部的代码
  const foo = require('./foo');
  console.log("if语句继续执行");
}

ES Module代码:

<script src="main.js" type="module"></script>
<!-- 这个js文件的代码不会被阻塞执行 -->
<script src="index.js"></script>

四、CommonJS模块与ES6模块的混编

4.3 CommonJS模块加载ES6模块

通常情况下,CommonJS不能加载ES Module

  • 因为CommonJS是同步加载的,但是ES Module必须经过静态分析等,无法在这个时候执行JavaScript代码;
  • 但是这个并非绝对的,某些平台在实现的时候可以对代码进行针对性的解析,也可能会支持;

可以使用import()这个方法加载

(async () => {
  await import('./my-app.mjs');
})();

上面代码可以在 CommonJS 模块中运行。

require()不支持 ES6 模块的一个原因是,它是同步加载,而 ES6 模块内部可以使用顶层await命令,导致无法被同步加载。

4.2 ES6模块加载CommonJS模块

多数情况下,ES Module可以加载CommonJS,但是只能整体加载,不能只加载单一的输出项。

  • ES Module在加载CommonJS时,会将其module.exports导出的内容作为default导出方式来使用;
  • 这个依然需要看具体的实现,比如webpack中是支持的、Node最新的Current(v14.13.1)版本也是支持的;

// foo.js
const address = 'foo的address';

module.exports = {
  address
}

// main.js
import foo from './modules/foo.js';
console.log(foo.address);

还有一种变通的加载方法,就是使用 Node.js 内置的module.createRequire()方法。

// cjs.cjs
module.exports = 'cjs';

// esm.mjs
import { createRequire } from 'module';

const require = createRequire(import.meta.url);

const cjs = require('./cjs.cjs');
cjs === 'cjs'; // true

上面代码中,ES6 模块通过module.createRequire()方法可以加载 CommonJS 模块。但是,这种写法等于将 ES6 和 CommonJS 混在一起了,所以不建议使用。

4.3 使模块同时支持两种模块化导入

一个模块同时要支持 CommonJS 和 ES6 两种格式,也很容易。

如果原始模块是 ES6 格式,那么需要给出一个整体输出接口,比如export default obj,使得 CommonJS 可以用import()进行加载。

如果原始模块是 CommonJS 格式,那么可以加一个包装层。

import cjsModule from '../index.js';
export const foo = cjsModule.foo;

上面代码先整体输入 CommonJS 模块,然后再根据需要输出具名接口。

你可以把这个文件的后缀名改为.mjs,或者将它放在一个子目录,再在这个子目录里面放一个单独的package.json文件,指明{ type: "module" }

如果是Node.js中,还有一种做法是在package.json文件的exports字段,指明两种格式模块各自的加载入口。

"exports"{
  "require": "./index.js""import": "./esm/wrapper.js"
}

上面代码指定require()import,加载该模块会自动切换到不一样的入口文件。

五、Node.js中的模块化

5.1 Node中支持 ES6 Module

JavaScript 现在常用的有两种模块。

  • ES6 模块,简称 ESM;
  • CommonJS 模块,简称 CJS。

CommonJS 模块是 Node.js 专用的,与 ES6 模块不兼容。语法上面,两者最明显的差异是,CommonJS 模块使用require()module.exports,ES6 模块使用importexport

从 Node.js v13.2 版本开始,Node.js 已经默认打开了 ES6 模块支持,需要进行以下操作:

  • 方式一:文件以 .mjs 结尾,表示使用的是ES Module;
  • 方式二:在package.json中配置字段 type: module,一旦设置了以后,该目录里面的 JS 脚本,就被解释用 ES6 模块。
    • 如果这时还要使用 CommonJS 模块,那么需要将 CommonJS 脚本的后缀名都改成.cjs
  • 如果没有type字段,或者type字段为commonjs,则.js脚本会被解释成 CommonJS 模块。

在之前的版本(比如v12.19.0)中,也是可以正常运行的,但是输出台会报一个警告:The ESM Module loader is experimental

Node.js 遇到 ES6 模块,默认启用严格模式,不必在每个模块文件顶部指定"use strict"

总结为一句话:

  • .mjs文件总是以 ES6 模块加载
  • .cjs文件总是以 CommonJS 模块加载
  • .js文件的加载取决于package.json里面type字段的设置。

注意,ES6 模块与 CommonJS 模块尽量不要混用。require命令不能加载.mjs文件,会报错,只有import命令才可以加载.mjs文件。反过来,.mjs文件里面也不能使用require命令,必须使用import

5.2 Node.js包模块的入口文件设置

5.2.1 package.json 的 main 字段

package.json文件有两个字段可以指定模块的入口文件:mainexports。比较简单的模块,可以只使用main字段,指定模块加载的入口文件。

举例:指定入口文件,格式为ESM

// ./node_modules/es-module-package/package.json
{
  "type": "module",
  "main": "./src/index.js"
}

上面代码指定项目的入口脚本为./src/index.js,它的格式为 ES6 模块。如果没有type字段,index.js就会被解释为 CommonJS 模块。

然后,import命令就可以加载这个模块。

// ./my-app.mjs

import { something } from 'es-module-package';
// 实际加载的是 ./node_modules/es-module-package/src/index.js

上面代码中,运行该脚本以后,Node.js 就会到./node_modules目录下面,寻找es-module-package模块,然后根据该模块package.jsonmain字段去执行入口文件。

这时,如果用 CommonJS 模块的require()命令去加载es-module-package模块会报错,因为 CommonJS 模块不能处理export命令。

5.2.2 package.json 的 exports 字段

exports字段的优先级高于main字段。它有多种用法。

1. 给脚本或子目录起别名

package.json文件的exports字段可以指定脚本或子目录的别名。

// ./node_modules/es-module-package/package.json
{
  "exports": {
    "./submodule": "./src/submodule.js",  //给脚本文件 src/submodule.js 起别名
    "./features/": "./src/features/"// 给子目录 ./src/features/ 起别名
  }
}

通过别名加载:

import submodule from 'es-module-package/submodule';
// 加载 ./node_modules/es-module-package/src/submodule.js

import feature from 'es-module-package/features/x.js';
// 加载 ./node_modules/es-module-package/src/features/x.js

如果没有指定别名,就不能用“模块+脚本名”这种形式加载脚本。

// 报错
import submodule from 'es-module-package/private-module.js';

// 不报错
import submodule from './node_modules/es-module-package/private-module.js';
2. main 的别名.

exports字段的别名如果是. 就代表了是模块的主入口,优先级高于main字段,并且可以直接简写成exports字段的值。

{
  "exports": {
    ".": "./main.js"
  }
}

// 等同于
{
  "exports": "./main.js"
}

由于exports字段只有支持 ES6 的 Node.js 才认识,所以可以用来兼容旧版本的 Node.js。

{
  "main": "./main-legacy.cjs",
  "exports": {
    ".": "./main-modern.cjs"
  }
}

上面代码中,老版本的 Node.js (不支持 ES6 模块)的入口文件是main-legacy.cjs,新版本的 Node.js 的入口文件是main-modern.cjs

3. 条件加载

利用.这个别名,可以为 ES6 模块和 CommonJS 指定不同的入口。目前,这个功能需要在 Node.js 运行的时候,打开--experimental-conditional-exports标志。

{
  "type": "module",
  "exports": {
    ".": {
      "require": "./main.cjs", // 别名`.`的`require`条件指定`require()`命令的入口文件(即 CommonJS 的入口)
      "default": "./main.js" // 别名`.`的`default`条件指定其他情况的入口(即 ES6 的入口)。
    }
  }
}

上面的写法可以简写如下

{
  "exports": {
    "require": "./main.cjs",
    "default": "./main.js"
  }
}

注意,如果同时还有其他别名,就不能采用简写,否则或报错。

{
  // 报错
  "exports": {
    "./feature": "./lib/feature.js",
    "require": "./main.cjs",
    "default": "./main.js"
  }
}

5.3 Node.js原生模块完全支持ES6 Module

Node.js 的内置模块可以整体加载,也可以加载指定的输出项。

// 整体加载
import EventEmitter from 'events';
const e = new EventEmitter();

// 加载指定的输出项
import { readFile } from 'fs';
readFile('./foo.txt', (err, source) => {
  if (err) {
    console.error(err);
  } else {
    console.log(source);
  }
});

5.4 加载路径

ES6 模块的加载路径必须给出脚本的完整路径,不能省略脚本的后缀名。import命令和package.json文件的main字段如果省略脚本的后缀名,会报错。

// ES6 模块中将报错
import { something } from './index';

为了与浏览器的import加载规则相同,Node.js 的.mjs文件支持 URL 路径。

import './foo.mjs?query=1'; // 加载 ./foo 传入参数 ?query=1

上面代码中,脚本路径带有参数?query=1,Node 会按 URL 规则解读。同一个脚本只要参数不同,就会被加载多次,并且保存成不同的缓存。由于这个原因,只要文件名中含有:%#?等特殊字符,最好对这些字符进行转义。

目前,Node.js 的import命令只支持加载本地模块(file:协议)和data:协议,不支持加载远程模块。另外,脚本路径只支持相对路径,不支持绝对路径(即以///开头的路径)。

5.5 内部变量

ES6 模块应该是通用的,同一个模块不用修改,就可以用在浏览器环境和服务器环境。为了达到这个目标,Node.js 规定 ES6 模块之中不能使用 CommonJS 模块的特有的一些内部变量。

首先,就是this关键字。ES6 模块之中,顶层的this指向undefined;CommonJS 模块的顶层this指向当前模块,这是两者的一个重大差异。

其次,以下这些顶层变量在 ES6 模块之中都是不存在的。

  • arguments
  • require
  • module
  • exports
  • __filename
  • __dirname

六、循环加载

“循环加载”(circular dependency)指的是,a脚本的执行依赖b脚本,而b脚本的执行又依赖a脚本。

// a.js
var b = require('b');

// b.js
var a = require('a');

通常,“循环加载”表示存在强耦合,如果处理不好,还可能导致递归加载,使得程序无法执行,因此应该避免出现。

但是实际上,这是很难避免的,尤其是依赖关系复杂的大项目,很容易出现a依赖bb依赖cc又依赖a这样的情况。这意味着,模块加载机制必须考虑“循环加载”的情况。

对于 JavaScript 语言来说,目前最常见的两种模块格式 CommonJS 和 ES6,处理“循环加载”的方法是不一样的,返回的结果也不一样。

6.1 CommonJS 模块的循环加载

CommonJS 模块的重要特性是加载时执行,即脚本代码在require的时候,就会全部执行。一旦出现某个模块被”循环加载”,就只输出已经执行的部分,还未执行的部分不会输出。

让我们来看,Node 官方文档里面的例子。

// a.js
exports.done = false;   // 先输出一个`done`变量

var b = require('./b.js'); // 然后加载另一个脚本文件b.js。注意,此时代码就停在这里,等待`b.js`执行完毕,再往下执行。

console.log('在 a.js 之中,b.done = %j', b.done); // b.js执行完毕,返回来a.js接着往下执行,直到执行完毕。
exports.done = true;
console.log('a.js 执行完毕');

// b.js
exports.done = false;

/*
 执行到这一行,会去加载a.js,这时,就发生了“循环加载”。系统会去a.js模块对应对象的exports属性取值,可是因为a.js还没有执行完,从exports属性只能取回已经执行的部分,而不是最后的值。
 此时:a.js已经执行的部分,只有一行:exports.done = false; 即对于b.js来说,它从a.js只输入一个变量done=false 。
 */
var a = require('./a.js'); 

console.log('在 b.js 之中,a.done = %j', a.done);
exports.done = true;
console.log('b.js 执行完毕');
// b.js接着往下执行,等到全部执行完毕,再把执行权交还给a.js。

我们写一个脚本main.js,验证这个过程。

var a = require('./a.js');
var b = require('./b.js');
console.log('在 main.js 之中, a.done=%j, b.done=%j', a.done, b.done);

执行main.js,运行结果如下:

$ node main.js

在 b.js 之中,a.done = false
b.js 执行完毕
在 a.js 之中,b.done = true
a.js 执行完毕
在 main.js 之中, a.done=true, b.done=true

上面的代码证明了两件事:

  1. b.js之中,a.js没有执行完毕,只执行了第一行。
  2. main.js执行到第二行时,不会再次执行b.js,而是输出缓存的b.js的执行结果,即它的第四行exports.done = true;

总之,CommonJS 输入的是被输出值的拷贝,不是引用。

另外,由于 CommonJS 模块遇到循环加载时,返回的是当前已经执行的部分的值,而不是代码全部执行后的值,两者可能会有差异。所以,输入变量的时候,必须非常小心。

var a = require('a'); // 安全的写法
var foo = require('a').foo; // 危险的写法

exports.good = function (arg) {
  return a.foo('good', arg); // 使用的是 a.foo 的最新值
};

exports.bad = function (arg) {
  return foo('bad', arg); // 使用的是一个部分加载时的值
};

上面代码中,如果发生循环加载,require('a').foo的值很可能后面会被改写,改用require('a')会更保险一点。

6.2 ES6 模块的循环加载

ES6 处理“循环加载”与 CommonJS 有本质的不同。ES6 模块是动态引用,如果使用import从一个模块加载变量(即import foo from 'foo'),那些变量不会被缓存,而是成为一个指向被加载模块的引用,需要开发者自己保证,真正取值的时候能够取到值。

请看下面这个例子。

// a.mjs
import {bar} from './b';
console.log('a.mjs');
console.log(bar);
export let foo = 'foo';

// b.mjs
import {foo} from './a';
console.log('b.mjs');
console.log(foo);
export let bar = 'bar';

上面代码中,a.mjs加载b.mjsb.mjs又加载a.mjs,构成循环加载。执行a.mjs,结果如下。

$ node --experimental-modules a.mjs
b.mjs
ReferenceError: foo is not defined

上面代码中,执行a.mjs以后会报错,foo变量未定义,这是为什么?

让我们一行行来看,ES6 循环加载是怎么处理的:

  • 首先,执行a.mjs以后,引擎发现它加载了b.mjs,因此会优先执行b.mjs,然后再执行a.mjs
  • 接着,执行b.mjs的时候,已知它从a.mjs输入了foo接口,这时不会去执行a.mjs,而是认为这个接口已经存在了,继续往下执行。
  • 执行到第三行console.log(foo)的时候,才发现这个接口根本没定义,因此报错。

解决这个问题的方法,就是让b.mjs运行的时候,foo已经有定义了。这可以通过将foo写成函数来解决。

// a.mjs
import {bar} from './b';
console.log('a.mjs');
console.log(bar());
function foo() { return 'foo' }   // const foo = () => 'foo'; 仍然会执行报错。函数表达式,就不具有提升作用
export {foo};

// b.mjs
import {foo} from './a';
console.log('b.mjs');
console.log(foo());
function bar() { return 'bar' }
export {bar};

这时再执行a.mjs就可以得到预期结果。

$ node --experimental-modules a.mjs
b.mjs
foo
a.mjs
bar

这是因为函数具有提升作用,在执行import {bar} from './b'时,函数foo就已经有定义了,所以b.mjs加载的时候不会报错。

这也意味着,如果把函数foo改写成函数表达式,也会报错。

6.3 代码示例

我们再来看 ES6 模块加载器SystemJS给出的一个例子。

// even.js
import { odd } from './odd'
export var counter = 0;
export function even(n) {
  counter++;
  return n === 0 || odd(n - 1);
}

// odd.js
import { even } from './even';
export function odd(n) {
  return n !== 0 && even(n - 1);
}

上面代码中,even.js里面的函数even有一个参数n,只要不等于 0,就会减去 1,传入加载的odd()odd.js也会做类似操作。

运行上面这段代码,结果如下。

$ babel-node
> import * as m from './even.js';
> m.even(10);
true
> m.counter
6
> m.even(20)
true
> m.counter
17

上面代码中,参数n从 10 变为 0 的过程中,even()一共会执行 6 次,所以变量counter等于 6。第二次调用even()时,参数n从 20 变为 0,even()一共会执行 11 次,加上前面的 6 次,所以变量counter等于 17。

这个例子要是改写成 CommonJS,就根本无法执行,会报错。

// even.js
var odd = require('./odd');
var counter = 0;
exports.counter = counter;
exports.even = function (n) {
  counter++;
  return n == 0 || odd(n - 1);
}

// odd.js
var even = require('./even').even;
module.exports = function (n) {
  return n != 0 && even(n - 1);
}

上面代码中,even.js加载odd.js,而odd.js又去加载even.js,形成“循环加载”。这时,执行引擎就会输出even.js已经执行的部分(不存在任何结果),所以在odd.js之中,变量even等于undefined,等到后面调用even(n - 1)就会报错。

$ node
> var m = require('./even');
> m.even(10)
TypeError: even is not a function

七、了解:AMD和CMD规范

7.1. CommonJS规范缺点

CommonJS加载模块是同步的:

  • 同步的意味着只有等到对应的模块加载完毕,当前模块中的内容才能被运行;
  • 这个在服务器不会有什么问题,因为服务器加载的js文件都是本地文件,加载速度非常快;

如果将它应用于浏览器呢?

  • 浏览器加载js文件需要先从服务器将文件下载下来,之后在加载运行;
  • 那么采用同步的就意味着后续的js代码都无法正常运行,即使是一些简单的DOM操作;

所以在浏览器中,我们通常不使用CommonJS规范:

  • 当然在webpack中使用CommonJS是另外一回事;
  • 因为它会将我们的代码转成浏览器可以直接执行的代码;

在早期为了可以在浏览器中使用模块化,通常会采用AMD或CMD:

  • 但是目前一方面现代的浏览器已经支持ES Modules,另一方面借助于webpack等工具可以实现对CommonJS或者ES Module代码的转换;
  • AMD和CMD已经使用非常少了,所以这里我们进行简单的演练;

7.2. AMD规范

7.2.1 AMD与Require.js

AMD主要是应用于浏览器的一种模块化规范:

  • AMD是Asynchronous Module Definition(异步模块定义)的缩写;
  • 它采用的是异步加载模块;
  • 事实上AMD的规范还要早于CommonJS,但是CommonJS目前依然在被使用,而AMD使用的较少了;

我们提到过,规范只是定义代码的应该如何去编写,只有有了具体的实现才能被应用:

  • AMD实现的比较常用的库是require.js和curl.js;

7.2.2 Require.js的使用

第一步:下载require.js

第二步:定义HTML的script标签引入require.js和定义入口文件:

  • data-main属性的作用是在加载完src的文件后会加载执行该文件

<script src="./lib/require.js" data-main="./index.js"></script>

第三步:编写如下目录和代码(个人习惯)

├── index.html
├── index.js
├── lib
│   └── require.js
└── modules
    ├── bar.js
    └── foo.js

index.js

(function() {
  require.config({
    baseUrl: '',
    paths: {
      foo: './modules/foo',
      bar: './modules/bar'
    }
  })
 
  // 开始加载执行foo模块的代码
  require(['foo'], function(foo) {

  })
})();

modules/bar.js

  • 如果一个模块不依赖其他,那么直接使用define(function)即可

define(function() {
  const name = "coderwhy";
  const age = 18;
  const sayHello = function(name) {
    console.log("Hello " + name);
  }

  return {
    name,
    age, 
    sayHello
  }
})

modules/foo.js

define(['bar'], function(bar) {
  console.log(bar.name);
  console.log(bar.age);
  bar.sayHello('kobe');
})

7.3 CMD规范

7.3.1 CMD与SeaJS

CMD规范也是应用于浏览器的一种模块化规范:

  • CMD 是Common Module Definition(通用模块定义)的缩写;
  • 它也采用了异步加载模块,但是它将CommonJS的优点吸收了过来;
  • 但是目前CMD使用也非常少了;

CMD也有自己比较优秀的实现方案:

  • SeaJS

7.3.2 SeaJS的使用

1. 下载SeaJS
2. 引入sea.js和启动模块
  • seajs是指定主入口文件的,也称为启动模块

<script src="./lib/sea.js"></script> <!--在调用 seajs 之前,必须先引入 sea.js 文件-->
<script>
  seajs.use('./index.js');  
  /*
   通过 seajs.use() 函数可以启动模块
        - ('模块id' [,callback])  加载一个模块,并执行回调函数
        - (['模块1', '模块2'] [,callback])  加载多个模块,并执行回调函数
        - callback 参数是可选的。格式为:function( 模块对象 ){ 业务代码 };
        
     - seajs.use 理论上只用于加载启动,不应该出现在 define 中的模块代码里
     - seajs.use 和 DOM ready 事件没有任何关系。要想保证 文档结构加载完毕再执行你的 js 代码,一定要在seajs.use内部通过 window.onload 或者 $(function(){})
   */
</script>
3. 编写如下目录和代码(个人习惯)

├── index.html
├── index.js
├── lib
│   └── sea.js
└── modules
    ├── bar.js
    └── foo.js
4. 定义模块define
  • 在CMD规范中,一个模块就是一个js文件

module是一个对象,存储了模块的元信息,具体如下:

  • module.id——模块的ID。
  • module.dependencies——一个数组,存储了此模块依赖的所有模块的ID列表。
  • module.exports——与exports指向同一个对象。
  • module.uri

define 是一个全局函数,用来定义模块:define( factory )

  • 对象{}:这种方式,外部会直接获取到该对象
  • 字符串"": 同上
  • 函数:define(function(require, exports, module){ 模块代码 }); 为了减少出错,定义函数的时候直接把这三个参数写上
5. 导出接口exports和module.exports
  • 功能:通过给 exports或module.exports动态的挂载变量、函数或对象,外部会获取到该接口
  • exports 等价于 module.exports。exports能做什么,module.exports就能做什么
  • 可以通过多次给exports 挂载属性向外暴露
  • 不能直接给 exports 赋值
  • 如果想暴露单个变量、函数或对象可以通过直接给 module.exports 赋值 即可
6. 依赖模块require

/*
 模块标识/模块id
    - 模块标识就是一个`字符串`,用来`标识模块`
    - 模块标识 可以不包含后缀名.js
    - 以 ./或 ../ 开头的相对路径模块,相对于 require 所在模块的路径
    - 不以 ./ 或 ../ 开头的顶级标识,会相对于模块的基础路径解析(配置项中的base)
    - 绝对路径如http://127.0.0.1:8080/js/a.js、/js/a.js
 */
requeire('模块id')
/*
 1.用于根据一个模块id加载/依赖该模块
 2.参数必须是一个字符串
 3.该方法会得到 要加载的模块中的 module.exports 对象
 */
  • 只能在模块环境define中使用,define(factory)的构造方法第一个参数必须命名为 require
  • 不要重命名require函数或者在任何作用域中给 require 重新赋值
  • 在一个模块系统中,require 加载过的模块会被缓存
  • 默认 require 是同步加载模块的

require.async

SeaJS会在html页面打开时通过静态分析一次性记载所有需要的js文件,如果想要某个js文件在用到时才下载,可以使用require.async:

require.async('/path/to/module/file', function(m) {
    //code of callback...
});

这样只有在用到这个模块时,对应的js文件才会被下载,也就实现了JavaScript代码的按需加载。

SeaJS高级配置
  • alias:别名配置
  • paths:路径配置
  • vars:变量配置
  • map:映射配置
  • preload:预加载项
  • Debug:调试模式
  • base:基础路径
  • charset:文件编码
代码示例

index.js

define(function(require, exports, module) {
  const foo = require('./modules/foo');
})

bar.js

define(function(require, exports, module) {
  const name = 'lilei';
  const age = 20;
  const sayHello = function(name) {
    console.log("你好 " + name);
  }

  module.exports = {
    name,
    age,
    sayHello
  }
})

foo.js

define(function(require, exports, module) {
  const bar = require('./bar');

  console.log(bar.name);
  console.log(bar.age);
  bar.sayHello("韩梅梅");
})

八、参考链接

作者:Tenlo
链接:https://www.jianshu.com/p/7472f0dfab55
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

layui-扩展模块 - 简书

mikel阅读(746)

来源: layui-扩展模块 – 简书

定义模块方法:layui.define([mods], callback);参数mods是可选的也可不要,用于声明该模块所依赖的模块。callback即为模块加载完毕的回调函数,它会返回一个exports参数,用于输出该模块的接口。

第一步:新建一个demo.js扩展模块,模块名叫mymod。并定义一个obj对象,里面装我们要创建这个模块的方法,比如openMsg。exports(‘定义模块的名称’,‘模块的方法对象’)。也就是exports(‘mymod’,’obj’),这里我起名叫mymod。

demo.js

第二步:在index里面先配置config(这个配置是全局的)。把自定义模块引入。extend()里面的mymod一定得跟你创建的模块名称相同。即exports(‘mymod’,obj)里面的mymod。最后use就可以使用了。

index.html

补充:你也可以忽略 base 设定的根目录,直接在 extend 指定路径(注意:该功能为 layui 2.2.0 新增)

作者:Mr丶HS
链接:https://www.jianshu.com/p/880f424cf756
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

Layui 源码浅读(模块加载原理) - 简书

mikel阅读(773)

来源: Layui 源码浅读(模块加载原理) – 简书

前情提要

文章部分内容有修改,部分压缩代码替换成未压缩代码,由于版本问题部分变量名为猜测,但不影响阅读。
纠正之前的错误猜测,if 括号内多个非布偶语句和 return 后多个赋值语句应该是压缩后所导致的简写格式。
正常开发情况下,尽量把代码的可读性放在第一,性能问题就交给压缩工具吧。

经典开场

// Layui
;! function (win) {
    var Lay = function () {
        this.v = '2.5.5';
    };
    win.layui = new Lay();
}(window);
// Jquery
(function (global, factory) {
    "use strict";
    if (typeof module === "object" && typeof module.exports === "object") {
        module.exports = global.document ?
            factory(global, true) :
            function (w) {
                if (!w.document) {
                    throw new Error("jQuery requires a window with a document");
                }
                return factory(w);
            };
    } else {
        factory(global);
    }
})(typeof window !== "undefined" ? window : this, function (window, noGlobal) {
    var jQuery = function (selector, context) {
        return new jQuery.fn.init(selector, context);
    };
    return jQuery;
});

这是一种很经典的开场方式,以 ! 定义一个函数并立即执行,并且将对象赋值到全局 window 变量上。当然除了 ! 还有 ~ 等符号都可以定义后面的这个函数,而 ; 应该是为了防止其他的代码对本身造成影响。

实际上( function (window) { "use strict"; } )( window )的写法更被我们理解,如JQuery未压缩的源码。而!定义函数的方法唯一优势就是代码相对较少,所以压缩后的Js代码大多数会以!开头。

动态加载

Lay.prototype.link = function (href, fn, cssname) {
    var that = this,
        link = doc.createElement('link'),
        head = doc.getElementsByTagName('head')[0];
    if (typeof fn === 'string')
        cssname = fn;
    var app = (cssname || href).replace(/\.|\//g, '');
    var id = link.id = 'layuicss-' + app,
        timeout = 0;
    link.rel = 'stylesheet';
    link.href = href + (config.debug ? '?v=' + new Date().getTime() : '');
    link.media = 'all';
    if (!doc.getElementById(id)) {
        head.appendChild(link);
    }
    if (typeof fn != 'function') return that;
    (function poll() {
        if (++timeout > config.timeout * 1000 / 100) {
            return error(href + ' timeout');
        };
        if (parseInt(that.getStyle(doc.getElementById(id), 'width')) === 1989) {
            fn();
        } else {
            setTimeout(poll, 100);
        }
    }());
    return that;
}

先来看看官方文档:

方法:layui.link(href)
href 即为 css 路径。注意:该方法并非是你使用 layui 所必须的,它一般只是用于动态加载你的外部 CSS 文件。

虽然官方只给出了一个参数,但是我们看源码的话可以知道后两个参数是加载完后运行的函数和自定义的Id。
有趣的是,临时创建的 poll函数 如果parseInt(that.getStyle(doc.getElementById(id), 'width')) === 1989判断为 false ,也就是样式没有被引入的时候会重新调用 poll函数 最后要么加载成功循环结束,要么加载超时调用 Layui hint 打印出超时信息。
因为同样的手段在加载 module 时也同样使用到,所以如果你使用过 Layui 那么[module] is not a valid module这样的警告或多或少能遇到几次。

模块引入

用过 Layui 的兄dei应该对 layui.use 不陌生,先来看官方文档:

方法:layui.use([mods], callback)
layui 的内置模块并非默认就加载的,他必须在你执行该方法后才会加载。

对于用了 Layui 有段时间的我来说,也只是按照官方的例子使用,并不知道实现的原理。
接下来就是见证遗迹的时候,看看 layui.use 做了什么:

Lay.fn.use = function (apps, callback, exports) {
    function onScriptLoad(e, url) {
        var readyRegExp = navigator.platform === 'PLaySTATION 3' ? /^complete$/ : /^(complete|loaded)$/;
        if (e.type === 'load' || (readyRegExp.test((e.currentTarget || e.srcElement).readyState))) {
            config.modules[item] = url;
            head.removeChild(node);
            (function poll() {
                if (++timeout > config.timeout * 1000 / 4) {
                    return error(item + ' is not a valid module');
                };
                config.status[item] ? onCallback() : setTimeout(poll, 4);
            }());
        }
    }
    function onCallback() {
        exports.push(layui[item]);
        apps.length > 1 ? that.use(apps.slice(1), callback, exports) : (typeof callback === 'function' && callback.apply(layui, exports));
    }
    var that = this,
        dir = config.dir = config.dir ? config.dir : getPath;
    var head = doc.getElementsByTagName('head')[0];
    apps = typeof apps === 'string' ? [apps] : apps;
    if (window.jQuery && jQuery.fn.on) {
        that.each(apps, function (index, item) {
            if (item === 'jquery') {
                apps.splice(index, 1);
            }
        });
        layui.jquery = layui.$ = jQuery;
    }
    var item = apps[0],
        timeout = 0;
    exports = exports || [];
    config.host = config.host || (dir.match(/\/\/([\s\S]+?)\//) || ['//' + location.host + '/'])[0];
    if (apps.length === 0 || (layui['layui.all'] && modules[item]) || (!layui['layui.all'] && layui['layui.mobile'] && modules[item])) {
        return onCallback(), that;
    }
    if (config.modules[item]) {
        (function poll() {
            if (++timeout > config.timeout * 1000 / 4) {
                return error(item + ' is not a valid module');
            };
            if (typeof config.modules[item] === 'string' && config.status[item]) {
                onCallback();
            } else {
                setTimeout(poll, 4);
            }
        }());
    } else {
        var node = doc.createElement('script'),
            url = (modules[item] ? dir + 'lay/' : /^\{\/\}/.test(that.modules[item]) ? '' : config.base || '') + (that.modules[item] || item) + '.js';
        node.async = true;
        node.charset = 'utf-8';
        node.src = url + function () {
            var version = config.version === true ? config.v || (new Date()).getTime() : config.version || '';
            return version ? '?v=' + version : '';
        }();
        head.appendChild(node);
        if (!node.attachEvent || (node.attachEvent.toString && node.attachEvent.toString().indexOf('[native code]') < 0) || isOpera) {
            node.addEventListener('load', function () {
                onScriptLoad(e, url);
            }, false);
        } else {
            node.addEventListener('onreadystatechange', function (e) {
                onScriptLoad(e, url);
            });
        }
        config.modules[item] = url;
    }
    return that;
};

首先跳过前两个创建的函数,经过一堆巴拉巴拉的赋值后来到第2个if中我们直接可以判断语句apps.length === 0,根据文档可知我们第一个参数是一个数组 [mods] ,当然前面的赋值apps = typeof apps === 'string' ? [apps] : apps;可以看出即使你传的是一个字符串也会被封装成数组。

很明显第一次进来apps.length === 0和下面的if ( config.modules[item] ) 也必为 false ,那么我们直接移步到 else 内。

创建一个 script 元素并赋予属性和模块的地址,通过 appendChild 追加到 head 之后留下一个 addEventListener 监听 script 的加载( ps:attachEvent 是给非人类使用的浏览器准备的 )并将开始创建的function onScriptLoad(e, url)函数抛进去,然后整段代码除了return that到这里戛然而止。

再来看看function onScriptLoad(e, url)函数,首先开幕雷击"PLaySTATION 3" === navigator.platform

Layui 的业务已经发展到PS3上了吗?

仅关心PC端浏览器的部分e.type === 'load', 因为监听的是 load 所以这里必为 true 并执行config.modules[item] = url后将追加的 script 元素移除。剩余的代码就是动态加载时使用的技巧,直到config.status[item]true 时循环结束。

定义模块

由于config.status[item]不会自动变成 true,之后的骚操作由 layui.define 接手。

先看官方文档:

方法:layui.define([mods], callback)

通过该方法可定义一个 layui 模块。参数 mods 是可选的,用于声明该模块所依赖的模块。callback 即为模块加载完毕的回调函数,它返回一个 exports 参数,用于输出该模块的接口。

以比较常用的 laypage.js 模块为例,基础源码如下:

// Laypage 模块的部分代码(部分变量名为猜测,但不影响内容本身)
layui.define(function (exports) {
    'use strict';
    var MOD_NAME = 'laypage',
        LayPage = function (options) {
            var that = this;
            that.config = options || {}, that.config.index = ++laypage.index, that.render(true);
        };
    var laypage = {
        render: function (options) {
            var laypage = new LayPage(options);
            return laypage.index
        },
        index: layui.laypage ? layui.laypage.index + 10000 : 0,
        on: function (elem, even, fn) {
            return elem.attachEvent ? elem.attachEvent("on" + even, function (param) {
                param.target = param.srcElement, fn.call(elem, param)
            }) : elem.addEventListener(even, fn, false), this
        }
    };
    exports(MOD_NAME, laypage);
});

因为 Layui 已经注册了全局的变量,所以当模块文件通过元素追加的方式引入时,调用了 layui.define 方法:

Lay.fn.define = function (deps, callback) {
    var that = this,
        type = typeof deps === 'function',
        mods = function () {
            var e = function (app, exports) {
                layui[app] = exports;
                config.status[app] = true;
            }
            typeof callback === 'function' && callback(function (app, exports) {
                e(app, exports);
                config.callback[app] = function () {
                    callback(e);
                }
            });
            return this;
        };
    type && (callback = deps, deps = []);
    if (!layui['layui.all'] && layui['layui.mobile']) {
        return mods.call(that);
    } else {
        that.use(deps, mods);
        return that;
    }
};

因为不管你在定义的模块中有没有引入其他模块,如 laypage 和 laytpl 这些 Layui 本身提供的模块都会因 (callback = deps, deps = []) 回到 [mods], callback 的参数格式。

再经过一系列巴拉巴拉的步骤回到定义的 mods 方法中,由layui[app] = exports, config.status[app] = true给全局 layui 变量添加属性(app)且给属性赋值(exports),并把 status 改为 true 至此模块加载完成。

总结

正如 Layui 官方所说:我们认为,这恰是符合当下国内绝大多数程序员从旧时代过渡到未来新标准的最佳指引

作为一个后端的工作者(以后可能要接触前端框架的人)没有接触过前端框架,只对原生态的 HTML / CSS / JavaScript 有所了解,那么 Layui 无非是较优的选择。

而写这篇文章无非就是为了感谢 Layui 对非前端工作者做出的贡献,也可能是我对使用了两年多 Layui 最后的告别吧,感谢贤心。

相关网站

其他

如果你没有接触过 UglifyJS 或其他 JS 压缩器,而你又恰巧使用 Visual Studio Code 工具开发,那么 Minify 扩展插件就已经足够日常使用了。

作者:三岁能抬头
链接:https://www.jianshu.com/p/e86da690daf1
来源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

layer.js源码分析_玉案轩窗的博客-CSDN博客_layer.js源码

mikel阅读(482)

来源: layer.js源码分析_玉案轩窗的博客-CSDN博客_layer.js源码

最近在看layer.js源码,从中得到了一些启发,对于一个框架的设计也有了一定的看法,现在对于这个框架的设计以及其他的问题来说明一下。

layer.js是一个专注于弹出层的框架,这个框架本身可以实现5种弹出层类型,其他的就不多说了,可以去看看它的官网,下面说一下它的主要组织形式:

首先,这个框架本身就是一个IIFE(立即执行函数表达式),保证了局部环境,避免了全局变量污染的问题
框架内部主要是三个对象构成,分别是Class构造函数、layer对象、ready对象
通过window来暴露对外api
以前看过一点JQuery的源码,layer.js的框架结构和JQuery是相同形式,框架内部主要是这三个对象来组成,对于这三个对象上具体的方法以及属性我列举了下,如下图所示:

整个框架的结构组织以及脉络还是很清晰的,框架整体的代码量大概1300多行左右,我对这个框架运行的具体流程做了个较为详细的流程,具体流程如下:

上面图片中是该框架初始化过程所做的工作,具体框架代码的详细注释在我的 Github上,如果你感兴趣,可以看看。
————————————————
版权声明:本文为CSDN博主「玉案轩窗」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/s1879046/article/details/76034784

layui源码详细分析之树形菜单_玉案轩窗的博客-CSDN博客_layui源码

mikel阅读(493)

来源: layui源码详细分析之树形菜单_玉案轩窗的博客-CSDN博客_layui源码

前言
今天分析的是layui框架内置模块tree.js,该模块的功能是构建树形菜单,具体的形式(layui官网该模块的具体形式)如下:

自实现树形菜单
使用html+css+js实现了树形菜单,具体的实现思路如下:

html中定义包含树形菜单的容器节点
规划好树形菜单的样式以及图标
使用js构建html结构以及绑定事件,实现树形菜单的点击折叠
实现效果图如下:

核心的实现是构建html结构,组织树状结构的数据,使用递归构建树,在本次实现中html的组织有两种形式,具体如下所述:
– 子菜单和父菜单逻辑上形成父子关系,结构上是分离的
– 子菜单和父菜单逻辑以及机构上都是父子关系

在刚一开始,我实际上是实现的第一种形式的,该形式的html结构体现如下:

<ul>
<li>菜单1</li>
<ul>
<li>子菜单1</li>
<li>子菜单2</li>
</ul>
</ul>
1
2
3
4
5
6
7
后来又补充了下一种形式的(这种更常见),该形式的html结构体现如下:

<ul>
<li>
<span>菜单1</span>
<ul>
<li>子菜单1</li>
<li>子菜单2</li>
</ul>
</li>
</ul>
1
2
3
4
5
6
7
8
9
递归形成树形菜单结构的代码如下(第二种形式):

tool.menuView = function(parentNode, menu) {
if (!parentNode || parentNode.nodeType !== 1 || !Array.isArray(menu)) return;
for (let i = 0; i < menu.length; i++) {
let option = menu[i], name = option.name,
children = option.children,
liNode = tool.createElement(‘li’);
tool.append(parentNode, liNode);
if (children && children.length > 0) {
let ulNode = tool.createElement(‘ul’);
tool.menuView(ulNode, children);
let [iNode, spanNode] = tool.createElement([‘i’, ‘span’])
spanNode.innerText = name;
iNode.className = ‘fa fa-play’;
tool.append([liNode, parentNode, liNode], [[iNode, spanNode], [liNode], [ulNode]]);
} else {
liNode.innerText = name;
}
}
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
需要传入的数据形式如下:

data = [
{
name: ‘菜单1’,
children: [
{
name: ‘子菜单1’
},
{
name: ‘子菜单2
}
]
}
];
1
2
3
4
5
6
7
8
9
10
11
12
13
构建树形结构是关键的一步,之后就是对交互的处理,该模块的具体代码组织如下图:

本次实现较大的缺点:

可扩展性不强,对于树形菜单的css样式没有考虑作为模块来调用的形式,传入的容器id写死了(css样式)
下面来分析下layui内置的tree.js模块的具体实现以及模块代码组织结构,tree.js的代码组织如下图所示:

基本的使用形式是:layui.tree(options),简洁易用。该内置模块内容使用JQuery,对于树形结构的形成同样是采用递归形式生成,不过该内置模块还提供皮肤模式的选择等,对于扩展性等方面非常不错。

该内置模块的源码详细注释以及自实现demo一如既往会上传到我的Github上,每天都要接触新的知识点,将知识变为自己的永远是最好的。
————————————————
版权声明:本文为CSDN博主「玉案轩窗」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/s1879046/article/details/77071940

layui源码详细分析系列之流加载模块_玉案轩窗的博客-CSDN博客_layui 流加载

mikel阅读(479)

来源: layui源码详细分析系列之流加载模块_玉案轩窗的博客-CSDN博客_layui 流加载

前言
所谓的流加载实际上是第一种优化手段,通常用于图片丰富的网站,目的是为了提供更好的用户体验。

具体的体现是在页面初始化时,先加载一小部分内容,当用户下拉页面到一定的距离,开始加载另一小部分的内容,直至将所有资源加载呈现,体现的是化整为零的思想,具有较好地用户体现效果。

自实现流加载以及图片懒加载功能
流加载功能和图片懒加载功能是分开实现的,使用原生的JavaScript开发(所有涉及交互效果的案例等都是使用JavaScript来实现,基础才是王道)现在先说说流加载功能,具体的实现效果图如下:

上面的是自动带图标加载形式的,还有事按钮形式的加载形式,具体效果图如下:

下面说说具体的实现思路,实际上就是监听指定元素的scroll事件,当滚动条滚动时需要做的事情:

判断是否滚动到底部,判断条件是(假设elem就是外部容器节点), elem.clientHeight+ elem.scrollTop === elem.scrollHeight(容器可是区域的高度 + 滚动条距离顶部的距离 === 容器的滚动高度)
当到达条件时就创建加载区域的节点并追加到容器中,当加载成功后,首先删除加载节点,将元素节点都追加到容器中
判断资源是否完全加载,完全加载就显示没有多余的资源
在上面实现思路需要考虑的问题:

滚动条向上滚动带来的重复性问题
我的解决是维持一个状态数组,记录任何时刻前一次scroll触发时的scrollTop,与当前scrollTop比较,只有当前scrollTop大于保存的状态值,才进行相应的程序处理。

流加载中最主要的是判断滚动条是否滚动条底部,从而执行程序处理。

图片懒加载:
所谓的图片懒加载就是页面初始化时不加载所有图片,当用户滚动到可视区域(就是图片需要显示的区域时),加载当前可视区域内的图片,具体的实现效果如下:

由于上传图片有大小限制,可能拉滚动条有点快,不过效果还是可以看到的。
实现的关键点:

判断图片是否在当前可是区域内
实现思路:

所有的img标签的src属性都是空或没有src属性,初始化时显示当前区域的图片,判断的条件(假设图片节点是image, 容器节点elem):image.offsetTop < elem.clientHeight
elem容器节点绑定scroll事件,同时也要处理向上滚动带来的问题
设置需要显示图片的可视区域,判断当前图片是否在可视区域从而是否需要显示,代码如下:
// record = [0], data是图片src的数据源
elem.addEventListener(‘scroll’, function() {
let scrollTop = this.scrollTop,
scrollHeight = this.scrollHeight,
clientHeight = elem.clientHeight;
// 处理向上滚动的重复性问题
if (scrollTop > record[0]) {
record.shift();
record.push(scrollTop);
}
// 只有向下滚动才执行相关程序
if (scrollTop >= record[0]) {
for (let index = 0; index < images.length; index++) {
let image = images[index],
offsetTop = image.offsetTop,
start = scrollTop,
end = start + clientHeight;
// 核心代码,图片显示的可视区域: scrollTop ~ scollTop + clientHeight
if (offsetTop >= start && offsetTop <= end) {
if (!image.src) {
setTimeout(function() {
image.src = data[index];
}, 300);
}
}
}
}
});
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
代码主要组织结构图如下:

下面说说layui中流加载模块的实现,该内置模块使用JQuery来实现,对于流加载以及图片懒加载实现思想,我上面的实现思路跟它的相似,核心代码还是有所区别,下面主要说说区别点:

layui内置流加载模块,考虑到容器元素是全局的情况处理, 作者考虑的很全面
内置模块对外提供api支持用于自实现具体的容器元素
layui该内置模块实现在操作的过程中更加流畅自然
该内置模块代码组织结构图如下:

该模块组织非常简洁明了,load是用于处理流加载,lazyimg是处理图片懒加载的。

layui框架内置模块flow.js的详细代码注释以及我自己实现的demo的源代码会上传到我的Github上,与君共进步。
————————————————
版权声明:本文为CSDN博主「玉案轩窗」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/s1879046/article/details/76856015

layui源码详细分析系列之element模块以及自定义事件机制_玉案轩窗的博客-CSDN博客

mikel阅读(530)

来源: layui源码详细分析系列之element模块以及自定义事件机制_玉案轩窗的博客-CSDN博客

element内置模块时layui框架中页面元素的交互功能的实现,主要是选项卡、面板、导航等的交互的实现。

下面先分析element模块的组织结构,具体如下图所示:

从上图中可以看出,element模块使用该框架自己的模块加载机制来加载该模块。

该框架内置的模块都是采用面向对象的编程,该模块也是,定义了Element构造函数,对外的API接口都定义在Element的原型对象上,使用JQuery来绑定一些原生的事件。call对象中定义真正处理选项卡等交互以及初始状态的处理程序。

element模块中使用框架自己定义的事件处理机制,具体实际上使用layui主体文件中的onevent和event来进行事件的注册以及事件的执行。

因为该模块最后输出的是函数类型,所以在使用该模块时要求如下:

layui.use([‘element’], function() {
var element = layui.element();
});
1
2
3
上面实际会自动执行一些初始化的工作,具体就会选项卡、面板等的初始状态的设置。

下面讲解layui自定义的事件机制,该框架定义事件名的形式如下:

功能名(lay-filter属性名)
1
在该框架中有lay-filter属性,该属性就是用于事件标识的。

什么时候使用该框架内置的事件机制?当你想要执行其他的操作,例如获取相关数据等,就可以使用自定义的事件机制。

下面使用实例来讲解框架事件机制的具体的逻辑处理,假设选项卡有属性lay-filter=’demo’, 那么就可以使用该框架自定义的事件机制,具体如下:

使用该机制的代码:
layui.use([‘element’], function() {
var ele = layui.element();

// tab(demo)就是事件名
ele.on(‘tab(demo)’, function(data) {
cosnole.log(data);
});
});
1
2
3
4
5
6
7
8
9
具体的逻辑流程如下图:

具体如上图所示,实际上内部维持了config.event对象来保存事件,onevent实现事件注册以及监听,实际上就是存储在config.event对象中,具体存储形式如下:

config.event[modeName + ‘.’ + event] = [callback]
1
在本例中modeName为element,event为tab(demo), callback就是就是事件处理程序,本例中callback如下:

callback = functio(data) {
console.log(data);
};
1
2
3
详细的代码注释以及相关的逻辑图我会上传到我的Github上,通过今天对于现在这种代码学习,有些迷茫了。

总结下现在这种阅读代码的方式的缺点:

有点纸上谈兵的感觉,不充实很虚
有些为看而看的感觉,没有非常大的收获,反而有些疲惫,没有自己成长了的自豪感
所以以后的文章就不会是这种方式出现了,目前想到的很好提高自己同时最大程度的提高自己,以后的风格将会以事实为依据,来具体展开,具体的形式如下:

自己会动手编写一个简易版实现核心功能的demo,并给出自己的思路
查看框架作者实现的思路,比较自己的思路与作者思路的相同点以及不同点,进行分析总结,丰满自己的思路
今天就到此为止,走走停停,方能走得更远,明天会分析文件上传以及流加载模块。
————————————————
版权声明:本文为CSDN博主「玉案轩窗」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/s1879046/article/details/76216485