通过插件简单实js的模块打包

相信不少小伙伴在编写前后端分离的前端项目的时候,都用过webpack进行对模块的打包吧。这次就来尝试一下通过插件简单实js模块的模块打包功能吧。
代码放在:https://gitee.com/baojuhua/js_pack_simple/tree/master

实现原理

Babel是广为使用的 ES6 转码器,可以将 ES6 代码转化为 ES5 代码。

1. ES语法转换

使用Babylon插件解析源码生成AST
通过babel-core将AST转换为ES5源码

2. 获取模块依赖关系,同时将模块执行上面一部的语法转换

使用babel-traverse插件可以获取依赖关系
使用uglify-js插件对输出的js文件源码进行压缩

3. 生成的js文件可以在浏览器运行

创建测试用的HTML文件,引入生成的js文件,通过浏览器执行预览。

项目创建

创建的目录结构如下

  • 📂lib : 存放主要打包功能的源码文件夹
  • 📂src : 存放被打包的js源码文件架
    • 📄compiler.js : 用来执行与输出
    • 📄parser.js : 解析源码与转换
  • 📄.babelrc : Babel配置文件
  • 📄pack.js : 执行打包的入口文件
  • 📄index.html : 输出脚本测试html测试文件
  • 📄package.json : 模块的描述文件

编写代码

首先编写Babel配置文件.babelrc

{
    "presets": ["@babel/preset-env"],//`@babel/preset-env` 转译包
    "comments": false,
    "plugins":[]
}

parser.js

parser.js最主要就是三个功能:

  1. 解析源码生成AST
  2. 获取源码依赖
  3. 通过AST生成目标代码

代码:

const fs = require('fs');  // 引入node中fs模块
const babylon = require('babylon'); // 通过 Babylon 生成AST
const traverse = require('babel-traverse').default; //通过 babel-traverse 的 ImportDeclaration方法获取依赖属性
const { transformFromAst } = require('babel-core'); //通过 babel-core 将AST 重新生成源码
module.exports = {
  // 生成AST树
  getAST: path => {
    // 同步读取文件
    const source = fs.readFileSync(path, 'utf-8');
    // 使用babylon的parse方法进行生成AST
    return babylon.parse(source, {
      sourceType: 'module',
    });
  },
  // 获取依赖
  getDependencies: ast => {
    const dependencies = [];
    traverse(ast, {
      // ImportDeclaration:分析import语句
      ImportDeclaration: ({ node }) => {
        // 将依赖push到dependencies中
        dependencies.push(node.source.value);
      },
    }); 
    return dependencies;
  },
  // 代码生成
  transform: ast => {
    const { code } = transformFromAst(ast, null, {
      presets: ['env'],
    });
    return code;
  }
};

compiler.js

compiler.js主要功能是调用parser.js进行循环递归构建模块代码,并将结果保存到文件中。

代码:

const fs = require('fs');
const path = require('path');
const { getAST, getDependencies, transform } = require('./parser');//解析与转化
var UglifyJS = require("uglify-js");//js压缩
module.exports = class Compiler {
    constructor(options) {
        const { entry, output } = options;
        this.entry = entry;
        this.output = output;
        this.modules = [];//定义this.modules来填充依赖
    }
    run() {
        // 构建主入口模块
        const entryModule = this.build(this.entry, true);
        // 添加依赖模块
        this.modules.push(entryModule);
        // 遍历递归添加依赖
        this.modules.forEach(_module_ => {
            _module_.dependencies.forEach(dependency => {
                this.modules.push(this.build(dependency));
            });
        });
        this.outFiles();
    }
    // 构建模块
    build(filename, isEntry) {
        let ast;
        if (isEntry) {
            ast = getAST(filename);
            filename = path.basename(filename);
        } else {
            const absolutePath = path.join(process.cwd(), './src', filename + '.js');
            ast = getAST(absolutePath);
        }
        return {
            filename,
            dependencies: getDependencies(ast),
            source: transform(ast),
        };
    }
    // 输出文件
    outFiles() {
        let outputPath = path.join(this.output.path, this.output.filename);
        let modules = '';
        this.modules.forEach(_module => {
            modules += `'${_module.filename}': function(require,module,exports){${_module.source}},`;
        });
        // 加载时自动执行
        const bundle = `(function(modules){
        function require(filename){
            var fn = modules[filename];
            var module = { exports: {}};
            fn(require, module, module.exports);
            return module.exports;
        }
        require('${path.basename(this.entry)}')
    })({${modules}})`;
        if (!fs.existsSync(this.output.path)) fs.mkdirSync(this.output.path);
        fs.writeFileSync(outputPath, bundle, 'utf-8');
        outputPath = path.join(this.output.path, this.output.minimize);
        fs.writeFileSync(outputPath, this.compress(bundle), 'utf-8');
    }
    //压缩
    compress(bundle) {
        return UglifyJS.minify(bundle, { mangle: {   eval: true, } }).code;
    }
};

pack.js

pack.js就很简单了设置配置并调用的compiler.js运行打包

代码:

const path = require('path');
const Compiler = require('./lib/compiler');
const options = {
    entry: path.join(__dirname, './src/index.js'),//指定源码的入口
    output: {
        path: path.join(__dirname, './dist'),//打包生成的目录位置
        filename: 'main.js',// 输出的文件名
        minimize: 'main.min.js' // 输出被压缩的文件名
    },
};
new Compiler(options).run();

测试

在src目录中编写测试文件

src/index.js:

import { demo1,demo2 } from './lib/demo';
demo1()
demo2()

src/lib/demo.js:

export function demo1() {
  let h1 = document.createElement('h1');
  h1.innerText = "Hello ~~"
  document.body.append(h1);
  document.body.style.backgroundColor = '#ddd';
}
export function demo2() {
  let div = document.createElement('div');
  document.body.append(div);
  setInterval(() => { div.innerText = (new Date).toLocaleTimeString(); }, 1000);
}
创建html测试文件

注意script引用的文件路径要与pack.js最终生成的文件路径位置要一致。

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>demo</title>
</head>
<body>
    <script src="./dist/main.js"></script>
</body>
</html>

运行node pack.js开始尝试打包

如果不出意外,会在执行的目录下生成以下文


打开浏览器进行测试

不出意外的话,将会看到以下画面

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

推荐阅读更多精彩内容