From 66146a6e064dc458a61304fb36c2945864d99388 Mon Sep 17 00:00:00 2001 From: Ruan Yifeng Date: Thu, 4 Dec 2014 09:05:18 +0800 Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9module=E9=83=A8=E5=88=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/class.md | 193 ++++++++++++++++++++++++++++++++++++++-------- docs/reference.md | 2 + 2 files changed, 163 insertions(+), 32 deletions(-) diff --git a/docs/class.md b/docs/class.md index a723fe5..ac24218 100644 --- a/docs/class.md +++ b/docs/class.md @@ -73,63 +73,71 @@ class ColorPoint extends Point { ## Module的基本用法 -**（1）export和import** +JavaScript没有模块（module）体系，无法将一个大程序拆分成互相依赖的小文件，再用简单的方法拼装起来。其他语言都有这项功能，比如Ruby的require、Python的import，甚至就连CSS都有@import，但是JavaScript任何这方面的支持都没有，这对开发大型的、复杂的项目形成了巨大障碍。 -ES6实现了模块功能，试图解决JavaScript代码的依赖和部署上的问题，取代现有的CommonJS和AMD规范，成为浏览器和服务器通用的模块解决方案。 +ES6解决了这个问题，实现了模块功能，而且实现得相当简单，完全可以取代现有的CommonJS和AMD规范，成为浏览器和服务器通用的模块解决方案。 -模块功能有两个关键字：export和import。export用于用户自定义模块，规定对外接口；import用于输入其他模块提供的功能，同时创造命名空间（namespace），防止函数名冲突。 +**（1）export命令，import命令** + +模块功能有两个命令：export和import。export命令用于用户自定义模块，规定对外接口；import命令用于输入其他模块提供的功能，同时创造命名空间（namespace），防止函数名冲突。 ES6允许将独立的JS文件作为模块，也就是说，允许一个JavaScript脚本文件调用另一个脚本文件。该文件内部的所有变量，外部无法获取，必须使用export关键字输出变量。下面是一个JS文件，里面使用export关键字输出变量。 ```javascript // profile.js -export var firstName = 'David'; -export var lastName = 'Belle'; -export var year = 1973; +export var firstName = 'Michael'; +export var lastName = 'Jackson'; +export var year = 1958; ``` -上面是profile.js文件，ES6将其视为一个模块，里面用export关键字输出了三个变量。export的写法，除了像上面这样，还有另外一种。 +上面代码是profile.js文件，保存了用户信息。ES6将其视为一个模块，里面用export命令对外部输出了三个变量。 + +export的写法，除了像上面这样，还有另外一种。 ```javascript // profile.js -var firstName = 'David'; -var lastName = 'Belle'; -var year = 1973; +var firstName = 'Michael'; +var lastName = 'Jackson'; +var year = 1958; export {firstName, lastName, year}; ``` -上面代码在export关键字后，使用大括号输出一组变量，它与前一种写法是等价的。 +上面代码在export命令后面，使用大括号指定所要输出的一组变量。 -使用export定义模块以后，其他JS文件就可以通过import关键字加载这个模块（文件）。 +它与前一种export命令直接放置在var语句前的写法是等价的，但是应该优先考虑使用这种写法。因为这样就可以在脚本尾部，一眼看清楚输出了哪些变量。 + +使用export命令定义了模块的对外接口以后，其他JS文件就可以通过import命令加载这个模块（文件）。 ```javascript +// main.js + import {firstName, lastName, year} from './profile'; -function setHeader(element) { +function sfirsetHeader(element) { element.textContent = firstName + ' ' + lastName; } ``` -上面代码中import关键字接受一个对象（用大括号表示），里面指定要从其他模块导入的变量。大括号里面的变量名，必须与被导入模块对外接口的名称相同。 +上面代码属于另一个文件main.js，import命令就用于加载profile.js文件，并从中输入变量。import命令接受一个对象（用大括号表示），里面指定要从其他模块导入的变量名。大括号里面的变量名，必须与被导入模块（profile.js）对外接口的名称相同。 -如果想为输入的属性或方法重新取一个名字，import语句要写成下面这样。 +如果想为输入的变量重新取一个名字，import语句中要使用as关键字，将输入的变量重命名。 ```javascript -import { someMethod, another as newName } from './exporter'; +import { lastName as surname } from './profile'; ``` -**（2）模块的整体加载** +**（2）模块的整体输入，module命令** -export关键字除了输出变量，还可以输出方法或类（class）。下面是一个circle.js文件，它输出两个方法。 +export命令除了输出变量，还可以输出方法或类（class）。下面是一个circle.js文件，它输出两个方法area和circumference。 ```javascript @@ -145,7 +153,7 @@ export function circumference(radius) { ``` -然后，main.js引用这个模块。 +然后，main.js输入circlek.js模块。 ```javascript @@ -158,7 +166,7 @@ console.log("圆周长：" + circumference(14)); ``` -上面写法是逐一指定要导入的方法。另一种写法是整体导入。 +上面写法是逐一指定要输入的方法。另一种写法是整体输入。 ```javascript @@ -169,7 +177,7 @@ console.log("圆周长：" + circle.circumference(14)); ``` -module关键字可以取代import语句，达到整体输入模块的作用。 +module命令可以取代import语句，达到整体输入模块的作用。 ```javascript @@ -182,25 +190,23 @@ console.log("圆周长：" + circle.circumference(14)); ``` -module关键字后面跟一个变量，表示导入的模块定义在该变量上。 +module命令后面跟一个变量，表示输入的模块定义在该变量上。 -**（3）export default语句** +**（3）export default命令** -如果不想为某个属性或方法，指定输入的名称，可以使用export default语句。 +如果想要输出匿名函数，可以使用export default命令。 ```javascript // export-default.js -export default function foo() { +export default function () { console.log('foo'); } ``` -上面代码中的foo方法，就被称为该模块的默认方法。 - -在其他模块导入该模块时，import语句可以为默认方法指定任意名字。 +其他模块输入该模块时，import命令可以为该匿名函数指定任意名字。 ```javascript @@ -212,9 +218,41 @@ customName(); // 'foo' ``` -显然，一个模块只能有一个默认方法。 +上面代码的import命令，可以用任意名称指向输出的匿名函数。需要注意的是，这时import命令后面，不使用大括号。 -如果想在一条import语句中，同时输入默认方法和指定名称的变量，可以写成下面这样。 +export default命令用在非匿名函数前，也是可以的。 + +```javascript + +// export-default.js + +export default function foo() { + console.log('foo'); +} + +// 或者写成 + +function foo() { + console.log('foo'); +} + +export default foo; + +``` + +上面代码中，foo函数的函数名foo，在模块外部是无效的。加载的时候，视同匿名函数加载。 + +export default命令用于指定模块的默认输出。如果模块加载时，只能输出一个值或方法，那就是export default所指定的那个值或方法。所以，import命令后面才不用加大括号。显然，一个模块只能有一个默认输出，因此export deault命令只能使用一次。 + +有了export default命令，输入模块时就非常直观了，以输入jQuery模块为例。 + +```javascript + +import $ from 'jquery'; + +``` + +如果想在一条import语句中，同时输入默认方法和其他变量，可以写成下面这样。 ```javascript @@ -222,7 +260,7 @@ import customName, { otherMethod } from './export-default'; ``` -如果要输出默认属性，只需将值跟在`export default`之后即可。 +如果要输出默认的值，只需将值跟在`export default`之后即可。 ```javascript @@ -262,14 +300,18 @@ export default function(x) { 上面代码中的“export *”，表示输出circle模块的所有属性和方法，export default命令定义模块的默认方法。 -这时，可以为circle中的属性或方法，改名后再输出。 +这时，也可以将circle的属性或方法，改名后再输出。 ```javascript +// circleplus.js + export { area as circleArea } from 'circle'; ``` +上面代码表示，只输出circle模块的area方法，且将其改名为circleArea。 + 加载上面模块的写法如下。 ```javascript @@ -283,3 +325,90 @@ console.log(exp(math.pi)); ``` 上面代码中的"import exp"表示，将circleplus模块的默认方法加载为exp方法。 + +## ES6模块的转码 + +浏览器目前还不支持ES6模块，为了现在就能使用，可以将转为ES5的写法。 + +**（1）ES6 module transpiler** + +[ES6 module transpiler](https://github.com/esnext/es6-module-transpiler)是square公司开源的一个转码器，可以将ES6模块转为CommonJS模块或AMD模块的写法，从而在浏览器中使用。 + +首先，安装这个转玛器。 + +```bash + +$ npm install -g es6-module-transpiler + +``` + +然后，使用`compile-modules convert`命令，将ES6模块文件转码。 + +```bash + +$ compile-modules convert file1.js file2.js + +``` + +o参数可以指定转码后的文件名。 + +```bash + +$ compile-modules convert -o out.js file1.js + +``` + +**（2）SystemJS** + +另一种解决方法是使用[SystemJS](https://github.com/systemjs/systemjs)。它是一个垫片库（polyfill），可以在浏览器内加载ES6模块、AMD模块和CommonJS模块，将其转为ES5格式。它在后台调用的是Google的Traceur转码器。 + +使用时，先在网页内载入system.js文件。 + +```html + + + +``` + +然后，使用`System.import`方法加载模块文件。 + +```html + + + +``` + +上面代码中的`./app`，指的是当前目录下的app.js文件。它可以是ES6模块文件，`System.import`会自动将其转码。 + +需要注意的是，`System.import`使用异步加载，返回一个Promise对象，可以针对这个对象编程。下面是一个模块文件。 + +```javascript + +// app/es6-file.js: + +export class q { + constructor() { + this.es6 = 'hello'; + } +} + + +``` + +然后，在网页内加载这个模块文件。 + +```html + + + +``` + +上面代码中，`System.import`方法返回的是一个Promise对象，所以可以用then方法指定回调函数。 diff --git a/docs/reference.md b/docs/reference.md index 2cd53cf..d0704f1 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -34,6 +34,7 @@ - Mozilla Developer Network, [WeakSet](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet)：介绍WeakSet数据结构 - Mathias Bynens, [Unicode-aware regular expressions in ES6](https://mathiasbynens.be/notes/es6-unicode-regex): 详细介绍正则表达式的u修饰符 - Jack Franklin, [An introduction to ES6 classes](http://javascriptplayground.com/blog/2014/07/introduction-to-es6-classes-tutorial/): ES6 class的入门介绍 +- Jack Franklin, [JavaScript Modules the ES6 Way](http://24ways.org/2014/javascript-modules-the-es6-way/): ES6模块入门 ## Generator @@ -65,3 +66,4 @@ - army8735, [Javascript Downcast](https://github.com/army8735/jsdc): 国产的ES6到ES5的转码器 - esnext, [ES6 Module Transpiler](https://github.com/esnext/es6-module-transpiler)：基于node.js的将ES6模块转为ES5代码的命令行工具 - Sebastian McKenzie, [6to5](https://github.com/sebmck/6to5): 将ES6转为ES5代码的Node模块，支持source map +- SystemJS, [SystemJS](https://github.com/systemjs/systemjs): 在浏览器中加载AMD、CJS、ES6模块的一个垫片库