前端项目模块化的实践2:使用 Webpack 打包基础设施代码

以下是关于前端项目模块化的实践,包含以下内容:

  1. 搭建 NPM 私有仓库管理源码及依赖
  2. 使用 Webpack 打包基础设施代码
  3. 使用 TypeScript 编写可靠类库 (实现中)

本文是关于前端项目模板化的第2部分

现状

实际项目远远比示例使用的 myGreeting 复杂,比如

  • 为了提高可维护性我们将项目折成了许多功能模板;
  • 我们希望使用 Promise 等语法等,但是顾忌目标环境的支持能力;
  • 可能依赖了多个第三方类库;
  • 为了提高加载速度我们打包时需要进行很多额外工作;
    • 代码压缩;
    • Tree Shaking(参考文末);
  • 既能运行在 WEB 浏览器,也能在 NodeJS 中使用;

假设我们有一个工具集项目 myHammer,包含 base64 转换功能和一个简单版的字典树实现,项目结构如下:

[email protected] /d/Documents/MyGit/PracticeInNPM/myHammer
$ tree src/ test/
src/
├── base64.js
├── index.js
└── TrieFilter.js
test/
├── base64.test.js
└── TrieFilter.test.js

0 directories, 5 files

index.js 导出了项目中的功能模块:

const base64     = require('./base64');
const TrieFilter = require('./TrieFilter')

module.exports = {
    base64,
    TrieFilter,
}

如果不打包,单独发布当前项目到 NPM 仓库并没有问题,只是

  1. 依赖本项目的时候写法比较纠结,形如 const base64 = require(‘myHammer/src/base64‘)
  2. 可能存在到目标环境的适配问题,如前文所述;
  • 目标环境不支持 Promise 等语法等
  • 源码是 CoffeeScript 或者 TypeScript,没法直接引用

下面使用 Webpack 来解决这些问题。

Webpack 打包基础类库

Webpack 文档内容多,网上教程多是关于应用打包,现整理如下。

本文并非 Webpack 的使用指南,只提及类库打包,行文时Webpack已更新至4.x 版本。

package.json

需要配置 package.jsonmain 节点供 NodeJS 环境使用。

"main": "src/index.js",

NodeJS 运行环境作了约定,使用 require(‘xxx‘)时将读取该配置。

  1. 避免形如 require(‘myHammer/src/base64‘)类似的引用完整路径的写法
  2. 如果源码使用了高版本的语言特性,可以转译和打包代码到形如 dist/inde-es5.js 的路径,再修改该配置指向该文件以向下兼容
  3. 使用需要转译成 JavaScript 语言同理

在部分 IDE 时我们查找引用时,往往发现函数声明有好多处实现,原因就在于代码转译、打包成了很多份,如下图所示。

webpack.config.js

类库打包需要对 webpack.config.js 中的 output 进行配置,摘取如下:

output : {
  library      : "hammer",
  libraryTarget: "umd",
  globalObject : "this",
  path         : path.join(__dirname, "dist"),
  filename     : "hammer.js",
}

其他配置请自行阅读文档,完整内容见代码 webpack.config.js。

如前文所述,在不考虑语言、版本、目标平台的差异的情况下,直接将源码发布到 NPM 仓库,再添加依赖和引用并无问题。在业务日益复杂的情况下,手写代码在实现层面直接消除这些差异是无比巨大的工作量,使用 Webpack 让我们更专注业务本身, Make life easier


发布到 NPM 和使用依赖

在完成了具体业务后,我们打包项目并发布到私有 NPM 仓库

webpack --mode development # 视具体需求
npm publish --registry http://ubuntu-17:4873 # --force

myDemo 项目中我们添加引用

yarn add myHammer --registry http://ubuntu-17:4873

修改 index.js 如下:

const myGreeting = require('myGreeting');
const {base64}   = require('myHammer');

(function () {
    let greeting = myGreeting('Rattz');
    console.log(base64.encode(greeting));
})();

运行起来

$ node index.js
SGVsbG8gUmF0dHo=

关于 Tree Shaking

略微提及一下 Tree Shaking ,简单地说 Tree Shaking 通过不引用没有依赖的代码,能有效缩减打包后的文件大小。

举例来说,我们使用了 ES2016 的语法,希望最后编译在 ES2015 环境使用。这里有若干种可行方案,其中一种是

  • 使用 babel 全家桶包含 babel-cli, babel-core, babel-loader, babel-preset-env
  • 添加 .babelrc 文件写入内容 {"presets":["env"]};
  • 在入口代码的首行使用 require(‘babel-polyfill‘);

babel 进行语法转换,补丁文件进行对低版本 ES2015 的适配,该方案中 babel-polyfill 被完整引用, 打包完成后占用120k 左右大小,往往比业务代码还多。

Tree Shaking 即为解决该问题而来,比如某模板同时提供了加法和减法,而我们只依赖了加法方法,如果打包工具支持 Tree Shaking,就能在打包时剔除掉未使用的减法相关代码。

Webpack 提供了相关支持,见于 Tree Shaking - webpack
项目所使用源码已发布 github,jusfrw 原创

原文地址:https://www.cnblogs.com/Jusfr/p/9547929.html

时间: 2024-10-12 07:25:35

前端项目模块化的实践2:使用 Webpack 打包基础设施代码的相关文章

简要分析webpack打包后代码

原文地址:https://www.jianshu.com/p/0e5247f9975f 1.打包单一模块 webpack.config.js module.exports = { entry:"./chunk1.js", output: { path: __dirname + '/dist', filename: '[name].js' }, }; chunk1.js var chunk1=1; exports.chunk1=chunk1; 打包后,main.js(webpack生成的

CSS多行溢出隐藏,webpack打包删除代码 -webkit-box-orient: vertical;

文本多行溢出隐藏显示省略号,本地显示正常,打包后线上代码丢失,-webkit-box-orient: vertical; /*! autoprefixer: off */ -webkit-box-orient:vertical; /*! autoprefixer: on */ 解决方式 1 :使用autoprefixer 跳过webpack的css打包. 解决方法 2 : 待补充 原文地址:https://www.cnblogs.com/lishengye/p/10990248.html

webpack打包---报错内存溢出javaScript heap out of memory

今天, npm run build打包时,又报内存溢出了.所以记录一下,之前查了博客有一些解释. “报错CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory是 JavaScript堆内存不足,这里说的 JavaScript 其实就是 Node,我们都知道 Node 是基于V8引擎,在一般的后端开发语言中,在基本的内存使用上没有什么限制. 但是我去查阅了相关的资料才发现,在 Node 中通过 JavaScript

gulp + webpack 构建多页面前端项目

修改增加了demo地址 gulp-webpack-demo 之前在使用gulp和webpack对项目进行构建的时候遇到了一些问题,最终算是搭建了一套比较完整的解决方案,接下来这篇文章以一个实际项目为例子,讲解多页面项目中如何利用gulp和webpack进行工程化构建.本文是自己的实践经验,所以有些解决方案并不是最优的,仍在探索优化中.所以有什么错误疏漏请随时指出. 使用gulp过程中的一些问题,我已经在另外一篇文章讲到了 grunt or gulp 前言 现在为什么又整了一个webpack进来呢

gulp+webpack构建前端项目

本文将介绍如何利用gulp+webpack构建一个基本的前端项目.假设你已经安装了node环境并且会使用简单的命令行 1.gulp安装 (1)全局安装 npm install gulp -g (2)查看gulp是否安装成功 gulp -v (3)进入本地目录,新建gulpfile.js 2.安装gulp-webpack插件 基于gulp的插件非常多,建议大家查看npm官网https://www.npmjs.com (1)安装 webpack的用途主要是模块化+打包.安装敲入命令 npm inst

使用vue2.x+webpack+vuex+sass+axios+elementUI等快速搭建前端项目框架

一.本文将分享如何快速搭起基于webpack+vue的前端项目框架,利用vue的自己的脚手架工具vue-cli搭建起基本的环境配置,再通过npm包管理工具引入相应的依赖来完善项目的各种依赖框架.下面是具体实操. 二.基本命令操作. 1.在开发之前需要首先安装node.js,直接百度搜索或者在其中文官网也可以下载http://nodejs.cn/download/, 在装完node之后npm包管理工具也自动的安装好,安装完之后,在命令行输入node -v或者npm -v,出现版本号说明安装成功.如

前端项目自动化构建工具——Webpack入门教程

参考资料:https://www.webpackjs.com/(中文文档)   https://www.webpackjs.com/(官方文档) 首先有必要说明一下,本文侧重讲解webpack基本配置属性,不附带实例,将会以通俗易懂的形式地讲解:如若需要实例进行相关练习,可将本文作为理论基础: Webpack是前端项目自动化构建工具,本质上,webpack 是一个现代 JavaScript 应用程序的静态模块打包器(module bundler).当 webpack 处理应用程序时,它会递归地构

前端工程模块化——以一个php项目为例

实现一个页面功能总是需要 JavaScript.CSS 和 Template 三种语言相互组织,所以我们真正需要的是一种可以将 JavaScript.CSS 和 Template 同时都考虑进去的模块化方案. 前端模块化带来的性能问题 很多主流的模块化解决方案通过 JavaScript 运行时来支持“匿名闭包”.“依赖分析”和“模块加载”等功能,例如“依赖分析”需要在 JavaScript 运行时通过正则匹配到模块的依赖关系,然后顺着依赖链(也就是顺着模块声明的依赖层层进入,直到没有依赖为止)把

如何使用webpack打包前端项目

webpack概述 随着前端体积越来越大,功能越来越丰富,这时候就需要将前端工程化,而 webpack就是用于将前端各种文件打包起来. 一个简单的webpack应该包含以下几个概念 · 入口起点 · 输出 · 配置 · 组件 · 加载器 · 插件 · 模块 · 模块热替换 下面我们一步步的搭建webpack,逐步讲解上诉模块 开发环境 推荐使用JetBrain的Webstorm,有强大的代码提示,支持JSX和ES6语法: 我们将会使用npm来下载和构建依赖,现在网上也有很多人使用yarn来安装,