fis3-postpackager-loader-fork

v2.1.14

Published

3 years ago

fis asyncs resouce loader

Downloads

0High
0Medium
0Low

senro

fis3 asyncs loader

与原来版本差异

在allInOne=true的时候，增加了自动分析项目源代码的所有异步加载模块，独立打包出各个异步模块的单个文件，并且剔除每个异步模块的所有依赖中的共同依赖和所有同步依赖，把共同依赖当做同步依赖加入到默认同步模块打包队列中，输出resourceMap的时候也只输出异步加载模块的依赖信息，减小resourceMap的体积，因为同步加载的模块关系map并没有任何作用，这样就实现了类似webpack的异步加载打包机制，不需要用fis3-packager-deps-pack插件去手动配置各个异步模块与同步模块的关系，虽然不能完全避免部分异步模块之间的相同模块二次加载问题，但是基本可以解决一般的异步加载打包问题。目前只支持一级异步加载，不支持异步加载模块里再引入异步模块。

实现流程

在lib/pack.js:98加入实现代码，大概流程

*这里计算所有的异步模块的共用模块，然后放到pkg，同时把包的依赖信息同步到resourceMap*/
 /*
 1.循环（因为递归会内存溢出）找出当前入口文件的所有依赖数组entrySrc，找出entrySrc里所有有asyncs属性并且length>0到数组A，这个数组A里就是所有异步加载的模块。
 2.递归数组A里的每个元素Item的requires,合并到数组A-item[i]-requires,找到所有异步加载模块的所有同步依赖模块。
 3.找到每个A-item[i]-requires里相同的模块，这就是所有异步模块公用的模块集合AC,再去除所有同步模块集合相同的模块，以免重复引用。
 4.去除A-item[i]-requires里包含在集合AC的模块及所有同步加载的模块，得到每个异步模块的打包模块集合。
 5.把AC合并到同步模块队列中。
 6.把A-item[i]-requires的file合并成一个pkg文件，命名为：host文件的filePath为前缀+A-item[i]（_连接）+asyncs.js。
 7.改变resoureMap为A及其指向的asyncs.js。
 */

新加的配置

{
   allInOne: true,
   scriptPlaceHolder: "<!--SCRIPT_PLACEHOLDER-->",
   stylePlaceHolder: '<!--STYLE_PLACEHOLDER-->',
   resourcePlaceHolder: '<!--RESOURCEMAP_PLACEHOLDER-->',
  +resourceType: 'asyncsMod',//这种模式只输出异步模块的依赖信息，减小体积（注意：其他原来模式暂时没有加入相应的异步模块包的信息）
   processor: {
     '.html': 'html'
   },
   obtainScript: true,
   obtainStyle: true,
   useInlineMap: false
}

注意由于fis有个历史遗留问题，通过引入的map和内联输出的map，里面依赖信息的url命名不一致，mod.js需要的是url 也就是输出的格式，所以建议用这种方式输出map即可

入口文件示例：

  <!DOCTYPE html>
  <html>
  <head>
      <meta charset="utf-8">
      <title></title>

      <meta name="keywords" content=""/>
      <meta name="description" content=""/>
      <meta name="viewport" content="initial-scale=1 ,maximum-scale=1, minimum-scale=1, user-scalable=no, target-densitydpi=medium-dpi">
      <meta name="apple-mobile-web-app-capable" content="yes">
      <meta name="apple-mobile-web-app-status-bar-style" content="black">
      <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
      <meta name="format-detection" content="telephone=no">
      <link rel="shortcut icon" href="favicon.ico">
  </head>
  <body>

  <div id="app"></div>

  <!--STYLE_PLACEHOLDER-->
  <script src="static/lib/mod.js"></script><!--ignore-->
  <!--SCRIPT_PLACEHOLDER-->
  <!--RESOURCEMAP_PLACEHOLDER-->
  <script>
    require('./static/js/index');//注意入口文件一定要这样require进去，不然分析不了异步依赖
  </script><!--ignore-->

  </body>
  </html>

测试

可以node test/index运行一个简单的异步模块加载示例

fis3-postpackager-loader

静态资源前端加载器，用来分析页面中使用的和依赖的资源（js或css）, 并将这些资源做一定的优化后插入页面中。如把零散的文件合并。

注意

此插件做前端硬加载，适用于纯前端项目，不适用有后端 loader 的项目。因为不识别模板语言，对于资源的分析和收集，比较的粗暴！！！

默认会把页面中用到的样式插入在 header 中，脚本插入在 body 底部。如果想修改，请在页面自己插入  和  占位符来控制位置。

此插件会收集所有的资源，如果希望某个资源不被收集，请在资源结尾处如 </script> 后面加上  注释.

```html


注意：被 ignore 的资源，不会被修改位置，同时也不会参与 allInOne 合并。

## 安装
支持全局安装和局部安装，根据自己的需求来定。

```bash
npm install fis3-postpackager-loader

使用

fis.match('::packager', {
  postpackager: fis.plugin('loader', {
    allInOne: true
  })
});

文件属性

新版本中所有 isHtmlLike:true 的资源都会默认采用 html 的方式来处理，比如： .md, .tpl 或者是更多。如果你希望某类 isHtmlLike 为 true 的资源，不经过此插件处理，那么请设置 loaderLang 属性为 false。

fis.match('*.md', {
  loaderLang: false
});

处理流程说明

如果你真的很关心的话，以下详细的流程处理介绍。

先假定所有优化功能全开，处理流程如下：

遍历所有的 html 文件，每个文件单独走以下流程。
分析 html 内容，插入注释块  到 </body> 前面，如果页面里面没有这个注释块的话。
分析 html 内容，插入注释块  到 </head> 前面，如果页面没有这个注释的话。
分析源码中 <script> 带有 data-loader 属性的或者资源名为[mod.js, require.js, sea.js, system.js]的资源找出来，如果有的话。把找到的 js 加入队列，并且在该 <script> 后面加入  注释块，如果页面里面没有这个注释的话。
分析源码中 <script> 带有 data-framework 属性的资源找出来。把找到的 js 加入队列。
如果不存在 注释，则开始分析此 html 文件的依赖，以及递归进去查找依赖中的依赖。把分析到的 js 加入到队列，css 加入到队列。如果存在，则在 7 步骤中处理，遇到注释开始加入依赖。
分析此 html 中 <script> 、 <link> 和 <style> 把搜集到的资源加入队列。
启用 allinone 打包，把队列中，挨一起的资源合并。如果是内联内容，直接合并即可，如果是外链文件，则合并文件内容，生成新内容。
把优化后的结果，即队列中资源，插入到  、  和  注释块。

那么 js 的输出顺序就是：带 data-loader 的js，带 resource map 信息的js, 带 data-framework 的js，依赖中的 js, 页面中其他 js.

也就是说，如果你发现资源的加载顺序不符合你的预期时，请加适当的属性来调整资源级别。

疑问解释

什么是页面依赖？

分两种方式指定依赖：

通过 fis 中的注释指定依赖。

<!--@require "xxx.js"-->

更多用法，请查看声明依赖 2. 通过 js 语句指定依赖。

require('./main');

表示此代码所在的文件，依赖当前目录下面的 main.js 文件。

另外依赖又分两种性质，以上都是同步依赖，还有一种异步依赖。

require(['./main']);

同步js 是页面加载时加载，而异步js 依赖则是运行时加载，能满足按需加载的需求。

什么是 js loader

fis 中对依赖的js 加载，尤其是异步 js，需要一个 js loader。比如 mod.js 是一个 loader, require.js 也是一种 loader。

什么是 resourcemap ?

当有异步依赖的时候，为了让 loader 知道文件所在位置，所以需要需要 resourcemap 信息。

此插件能生成两类 resourcemap.

给 mod.js 用的，格式如下:

require.resourcemap({
  res: {...},
  pkg: {...}
})

给 require.js amd loader 用的，格式如下:

require.config({
  paths: {
    ...
  }
})

配置说明

scriptPlaceHolder 默认 
stylePlaceHolder 默认 
resourcePlaceHolder 默认
dependenciesInjectPlaceHolder 默认
resourceType 默认 'auto', 可选 'mod'、'amd'、'system'、'commonJs'、'cmd'(sea.js)。
allInOne 默认 false, 配置是否合并零碎资源。
allInOne 接收对象配置项。
- css, js 可接受函数, 回传file, 可定制化路径规则, 如:
```
  postpackager: fis.plugin('loader', {
    allInOne: {
      js: function (file) {
        return "/static/js/" + file.filename + "_aio.js";
      },
      css: function (file) {
        return "/static/css/" + file.filename + "_aio.css";
      }
    }
  })
```
- css all in one 打包后， css 文件的路径规则。默认为 pkg/${filepath}_aio.css
- js all in one 打包后， js 文件的路径规则。默认为 pkg/${filepath}_aio.js
- includeAsyncs 默认为 false。all in one 打包，是不包含异步依赖的，不过可以通过把此属性设置成 true，包含异步依赖。
- ignore 默认为空。如果不希望部分文件被 all in one 打包，请设置 ignore 清单。
- sourceMap 默认为 false。是否生成 sourcemap.
- useTrack 默认为 true. 是否在打包文件中添加track信息

processor 默认为 {'.html': 'html'}, 即支持后缀是 .html 的文件，如果要支持其他后缀，请在此扩展。

fis.match('::package', {
  postpackager: fis.plugin('loader', {
    processor: {
      '.html': 'html',

      // 支持 markdown 文档
      '.md': 'html'
    }
  })
})

obtainScript 是否收集 <script> 内容。（非页面依赖部分）
obtainStyle 是否收集 <style> 和 <link> 内容。（非页面依赖部分）
useInlineMap 是否将 sourcemap 作为内嵌脚本输出。
resoucemap 默认为 /pkg/${filepath}_map.js 当 useInLineMap 为 false 的时候有效，用来控制 resourcemap 生成位置。
resourcemapWhitespace resourcemap缩进宽度, 默认为2.

include 默认生成的 sourcemap 只会包含异步依赖的 js, 如果想把一批模块化的 js 加入到 sourcemap 中，请参考一下配置：

fis.match('::package', {
  postpackager: fis.plugin('loader', {
    include: '/widget/a/**.js'
  })
})

fis.match('::package', {
  postpackager: fis.plugin('loader', {
    include: [
      '/widget/**.js',
      '!/widget/a/**.js'
    ]
  })
})