软件技术-Webpack模块化开发上手

欢迎关注我的专栏( つ•̀ω•́)つ【人工智能通识】
【汇总】2019年4月专题


Webpack是目前最流行的Web开发模块化管理工具,这是一篇最基础的上手教程,包含了VSCode和Github项目设置。


人工智能通识-2019年3月专题汇总

前提工作

  • 首先,你需要安装VSCode(Visual Studio Code),这可以说是当今最流行的Web开发编码工具,它是开源免费的,由微软进行更新维护。

点击这里进入微软官方站点下载VSCode

  • 其次,你需要安装Git,然后在Github创建仓库Repository(我创建的是GoCraft仓库),然后在电脑上创建本地项目文件夹(我创建的是同名GoCraft文件夹),然后进入这个文件夹git init初始化本地Git仓库,然后git remote add origin https://username:password@github.com/...关联到远程的Github仓库,创建新文件如index.html,测试成功推送到本地Git和远程Github仓库。

具体完整的操作说明可以参照这个文章

  • 最后,你需要安装node.js。这是Web开发人员必备工具,它本来是用作后端开发的,但实际上前端的项目组织管理都离不开它,尤其是它包含的npm管理命令,稍后我们要一直用到。

点击这里进入Node.js官方站点下载LTS稳定版安装

初始化项目

进入你存放所有网页的文件夹(我的是GoCraft/cli),然后执行npm init -y,这个npm命令是node.js安装包提供的。

这个命令为我们快速设置项目的信息,都写在package.json文件中。-y是自动设置,如果没有它你就需要输入很多内容或敲很多回车。

注意这里的main:"index.js",表示入口文件是index.js,它是所有代码的起始点。

安装webpack

webpack是用来管理各种web文件之间的关系的,能够有效地把各种js文件组织在一起,是当前最常用的模块化开发管理工具。

安装命令:
npm install webpack --save-dev
npm install webpack-cli --save-dev

这里的--save-dev是指把安装信息记录保存到开发环境设置中,建议所有安装都带着这个参数执行。webpack-cli是webpack的一个配套命令工具,稍后会用到它。

如果你安装比较慢,建议你先用管理员权限(苹果电脑下加sudo)安装淘宝的npm镜像:npm install -g cnpm --registry=https://registry.npm.taobao.org,然后再用cnpm代替npm来执行cnpm install webpack --save-devcnpm install webpack-cli --save-dev

设置Git忽略文件夹

安装webpack的时候会导致Git出现数千个文件更改标记,这是因为在node_modules文件夹下产生数千个文件,而这些文件没必要放到Git仓库或者Github仓库中去,所以我们需要及时设置,让Git排除
node_modules文件夹。

在整个项目下(GoCraft目录而不是cli目录)下创建.gitignore文件,然后文件内添加要忽略的文件夹,这里只有一行:

cli/node_modules/

然后保存,退出Code重新启动,这时候就会看到Git需要提交的文件变成了很少的两三个。

创建index.html和index.js

作为浏览器的入口页面index.html是必不可少的,而作为main代码的入口页面index.js也是必不可少的。实际上网站的运行顺序是:

浏览器打开index.html \to index.js \to 更多.js模块文件和其他文件

我们创建dist/index.html文件:

<!doctype html>
<html>
  <head>
    <title>Getting Started</title>
  </head>
  <body>
    <script src="main.js"></script>
  </body>
</html>

在这里我们引入一个还不存在的本地文件main.js,稍后它将由webpack根据index.js生成。

然后我们创建src文件夹下的src/index.js

function component() {
    let element = document.createElement('div');
    element.innerHTML = "Hello World!"
    return element;
}
document.body.appendChild(component());

然后我们需要修改一下package.json文件,添加一行"private": true,,去掉"main": "index.js",一行,这样将自动生成main.js而不会直接使用index.js。完整内容变为:

{
  "name": "cli",
  "version": "1.0.0",
  "description": "",
  "private": true,
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "webpack": "^4.29.6",
    "webpack-cli": "^3.3.0"
  }
}

注意devDependencies开发依赖包,这个内容就是我们之前--save-dev产生的记录。

使用第三方包

安装第三方工具,这里我们使用lodash.js这个工具进行测试,它提供了一些列常用小功能。
cnpm install --save lodash
这个命令将把lodash安装到node_modules文件夹中待用。--save表示记录到生产环境(所以没有带-dev)

修改一下index.js使用我们的lodash

import _ from 'lodash';
function component() {
    let element = document.createElement('div');
    element.innerHTML = _.join(['Hello', 'webpack'], ' ');
    return element;
}
document.body.appendChild(component());

注意import xx from "XXX"就是从node_modules文件夹包含的第三方工具中调用功能,并且将这个功能重命名为xxx。所以下面直接使用了_.join功能。

然后执行npx webpack命令,这个命令将自动分析src/index.js,找到里面所有import导入的js模块文件,以及这些模块文件又可能导入的另外的模块文件,把这所有文件打包成dist/main.js,供index.html使用。

如果npx webpack命令遇到错误cannot find module...,那么可以尝试重新用标准npm命令(而不是cnpm命令)安装,注意要使用管理员模式或者加sudo开始:
npm install webpack --save-dev
npm install webpack-cli --save-dev
npm install --save lodash

成功后生成的文件结构类似:

如果在浏览器手工打开index.html文件查看,将看到Hello webpack!字样。

自定义模块

创建cli/utils/hello.js文件,内容如下:

export default function hello() {
    alert("I am hello module.")
}

然后在index.js中导入并使用它:

import _ from 'lodash';
import hello from './utils/hello';
function component() {
    let element = document.createElement('div');
    element.innerHTML = _.join(['Hello', 'webpack'], ' ');
    hello()
    return element;
}
document.body.appendChild(component());

再次执行npx webpack,然后打开index.html,正常就可以看到来自自定义模块的弹窗。

webpack.config.js设置文件

一般情况下webpack不需要额外设置,但可以在用项目根目录下创建webpack.config.js文件进行更多设置,例如:

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    filename: 'main.js',
    path: path.resolve(__dirname, 'dist')
  }
};

这里,entry: './src/index.js'指定了入口js文件,而ouput指定了npx webpack命令输出文件main.js的位置。

npx webpack和npm run build

我们可以通过修改package.json,用npm run build替换掉npx webpack命令(虽然这好像没啥意义):

{
  "name": "cli",
  "version": "1.0.0",
  "description": "",
  "private": true,
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "build": "webpack"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "webpack": "^4.29.6",
    "webpack-cli": "^3.3.0"
  },
  "dependencies": {
    "lodash": "^4.17.11",
    "resolve-cwd": "^2.0.0",
    "resolve-from": "^4.0.0"
  }
}

然后我们运行npm run build也能打包生成dist/main.js文件。

最终目录

最终目录结构看起来像这个样子:

你可以从我的Github项目中访问到完整代码:

点这里打开webpack-demo代码仓库

更多扩展内容:关于如何在打包main.js的时候支持ES6/7语法,你需要在webpack.conf.js安装和配置相应的loader工具。关于如何实现保存文件时候自动打包,你需要安装和配置webpack-dev-server。具体内容在这里暂时不扩展了。


欢迎关注我的专栏( つ•̀ω•́)つ【人工智能通识】


每个人的智能新时代

如果您发现文章错误,请不吝留言指正;
如果您觉得有用,请点喜欢;
如果您觉得很有用,欢迎转载~


END

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

推荐阅读更多精彩内容