# Ahead-of-Time Compilation # 预 (AoT) 编译器 This cookbook describes how to radically improve performance by compiling _ahead-of-time_ (AOT) during a build process. 本章描述了如何通过在构建期间使用预编译(AOT编译)技术来根本性的提高性能。 {@a overview} ## Overview ## 概览 An Angular application consists largely of components and their HTML templates. Before the browser can render the application, the components and templates must be converted to executable JavaScript by the _Angular compiler_. Angular应用主要包含组件和它们的HTML模板。 在浏览器可以渲染应用之前,组件和模板必须要被**Angular编译器**转换为可以执行的JavaScript。
Watch compiler author Tobias Bosch explain the Angular Compiler at AngularConnect 2016. 观看编译器作者Tobias Bosch在AngularConnect 2016大会里,对Angular编译器的演讲。
You can compile the app in the browser, at runtime, as the application loads, using the **_just-in-time_ (JIT) compiler**. This is the standard development approach shown throughout the documentation. It's great but it has shortcomings. 你可以在浏览器中使用*即时编译器*(Just-in-Time - JIT)在运行期间编译该应用,也就是在应用加载时。 这是本文档中展示过的标准开发方式。 它很不错,但是有自己的缺点。 JIT compilation incurs a runtime performance penalty. Views take longer to render because of the in-browser compilation step. The application is bigger because it includes the Angular compiler and a lot of library code that the application won't actually need. Bigger apps take longer to transmit and are slower to load. JIT编译导致运行期间的性能损耗。 由于需要在浏览器中执行这个编译过程,视图需要花更长时间才能渲染出来。 由于应用包含了Angular编译器以及大量实际上并不需要的库代码,所以文件体积也会更大。 更大的应用需要更长的时间进行传输,加载也更慢。 Compilation can uncover many component-template binding errors. JIT compilation discovers them at runtime, which is late in the process. 编译可以发现一些组件模板绑定错误。JIT编译在运行时才揭露它们,那样有点太晚了。 The **_ahead-of-time_ (AOT) compiler** can catch template errors early and improve performance by compiling at build time. 而**预编译**(AOT)会在构建时编译,这样可以在早期截获模板错误,提高应用性能。 {@a aot-jit} ## _Ahead-of-time_ (AOT) vs _just-in-time_ (JIT) ## 预编译(AOT) vs 即时编译(JIT) There is actually only one Angular compiler. The difference between AOT and JIT is a matter of timing and tooling. With AOT, the compiler runs once at build time using one set of libraries; with JIT it runs every time for every user at runtime using a different set of libraries. 事实上只有一个Angular编译器,AOT和JIT之间的差别仅仅在于编译的时机和所用的工具。 使用AOT,编译器仅仅使用一组库在构建期间运行一次;使用JIT,编译器在每个用户的每次运行期间都要用不同的库运行一次。 {@a why-aot} ## Why do AOT compilation? ## 为什么需要AOT编译? *Faster rendering* **渲染得更快** With AOT, the browser downloads a pre-compiled version of the application. The browser loads executable code so it can render the application immediately, without waiting to compile the app first. 使用AOT,浏览器下载预编译版本的应用程序。 浏览器直接加载运行代码,所以它可以立即渲染该应用,而不用等应用完成首次编译。 *Fewer asynchronous requests* **需要的异步请求更少** The compiler _inlines_ external HTML templates and CSS style sheets within the application JavaScript, eliminating separate ajax requests for those source files. 编译器把外部HTML模板和CSS样式表内联到了该应用的JavaScript中。 消除了用来下载那些源文件的Ajax请求。 *Smaller Angular framework download size* **需要下载的Angular框架体积更小** There's no need to download the Angular compiler if the app is already compiled. The compiler is roughly half of Angular itself, so omitting it dramatically reduces the application payload. 如果应用已经编译过了,自然不需要再下载Angular编译器了。 该编译器差不多占了Angular自身体积的一半儿,所以,省略它可以显著减小应用的体积。 *Detect template errors earlier* **提早检测模板错误** The AOT compiler detects and reports template binding errors during the build step before users can see them. AOT编译器在构建过程中检测和报告模板绑定错误,避免用户遇到这些错误。 *Better security* **更安全** AOT compiles HTML templates and components into JavaScript files long before they are served to the client. With no templates to read and no risky client-side HTML or JavaScript evaluation, there are fewer opportunities for injection attacks. AOT编译远在HTML模版和组件被服务到客户端之前,将它们编译到JavaScript文件。 没有模版可以阅读,没有高风险客户端HTML或JavaScript可利用,所以注入攻击的机会较少。 {@a compile} ## Compile with AOT ## 用AOT进行编译 Preparing for offline compilation takes a few simple steps. Take the Setup as a starting point. A few minor changes to the lone `app.component` lead to these two class and HTML files: AOT编译需要一些简单的准备步骤。我们先从搭建本地开发环境开始。 只要单独对`app.component`文件的类文件和HTML文件做少量修改就可以了。 Install a few new npm dependencies with the following command: 用下列命令安装少量新的npm依赖: npm install @angular/compiler-cli @angular/platform-server --save You will run the `ngc` compiler provided in the `@angular/compiler-cli` npm package instead of the TypeScript compiler (`tsc`). 你要用`@angular/compiler-cli`包中提供的`ngc`编译器来代替TypeScript编译器(`tsc`)。 `ngc` is a drop-in replacement for `tsc` and is configured much the same way. `ngc`是一个`tsc`的高仿替代品,它们的配置方式几乎完全一样。 `ngc` requires its own `tsconfig.json` with AOT-oriented settings. Copy the original `src/tsconfig.json` to a file called `tsconfig-aot.json` on the project root, then modify it as follows. `ngc`需要自己的带有AOT专用设置的`tsconfig.json`。 把原始的`tsconfig.json`拷贝到一个名叫`tsconfig-aot.json`的文件中,然后像这样修改它: The `compilerOptions` section is unchanged except for one property. **Set the `module` to `es2015`**. This is important as explained later in the [Tree Shaking](guide/aot-compiler#tree-shaking) section. `compilerOptions`部分只修改了一个属性:**把`module`设置为`es2015`。 这一点非常重要,我们会在后面的[摇树优化](guide/aot-compiler#tree-shaking)部分解释为什么。 What's really new is the `ngc` section at the bottom called `angularCompilerOptions`. Its `genDir` property tells the compiler to store the compiled output files in a new `aot` folder. `ngc`区真正新增的内容是底部的`angularCompilerOptions`。 它的`genDir`属性告诉编译器把编译结果保存在新的`aot`目录下。 The `"skipMetadataEmit" : true` property prevents the compiler from generating metadata files with the compiled application. Metadata files are not necessary when targeting TypeScript files, so there is no reason to include them. `"skipMetadataEmit" : true`属性阻止编译器为编译后的应用生成元数据文件。 当输出成TypeScript文件时,元数据并不是必须的,因此不需要包含它们。 ***Component-relative template URLS*** ***相对于组件的模板URL*** The AOT compiler requires that `@Component` URLS for external templates and CSS files be _component-relative_. That means that the value of `@Component.templateUrl` is a URL value _relative_ to the component class file. For example, an `'app.component.html'` URL means that the template file is a sibling of its companion `app.component.ts` file. AOT编译器要求`@Component`中的外部模板和CSS文件的URL是*相对于组件的*。 这意味着`@Component.templateUrl`的值是一个*相对于*组件类文件的URL值。 例如,`'app.component.html'` URL表示模板文件与它相应的`app.component.ts`文件放在一起。 While JIT app URLs are more flexible, stick with _component-relative_ URLs for compatibility with AOT compilation. 而JIT应用的URL更灵活,固定写成*相对于组件的*URL的形式对AOT编译的兼容性也更好。 ***Compiling the application*** *** 编译该应用 *** Initiate AOT compilation from the command line using the previously installed `ngc` compiler by executing: 在命令行中执行下列命令,借助刚安装好的`ngc`编译器来启动AOT编译: node_modules/.bin/ngc -p tsconfig-aot.json
Windows users should surround the `ngc` command in double quotes: Windows用户应该双引号`ngc`命令: "node_modules/.bin/ngc" -p tsconfig-aot.json
`ngc` expects the `-p` switch to point to a `tsconfig.json` file or a folder containing a `tsconfig.json` file. `ngc`希望`-p`选项指向一个`tsconfig.json`文件,或者一个包含`tsconfig.json`文件的目录。 After `ngc` completes, look for a collection of _NgFactory_ files in the `aot` folder. The `aot` folder is the directory specified as `genDir` in `tsconfig-aot.json`. 在`ngc`完成时,会在`aot`目录下看到一组*NgFactory*文件(该目录是在`tsconfig-aot.json`的`genDir`属性中指定的)。 These factory files are essential to the compiled application. Each component factory creates an instance of the component at runtime by combining the original class file and a JavaScript representation of the component's template. Note that the original component class is still referenced internally by the generated factory. 这些工厂文件对于编译后的应用是必要的。 每个组件工厂都可以在运行时创建一个组件的实例,其中带有一个原始的类文件和一个用JavaScript表示的组件模板。 注意,原始的组件类依然是由所生成的这个工厂进行内部引用的。
The curious can open `aot/app.component.ngfactory.ts` to see the original Angular template syntax compiled to TypeScript, its intermediate form. 如果你好奇,可以打开`aot/app.component.ngfactory.ts`来看看原始Angular模板语法被编译成TypeScript时的中间结果。JIT compilation generates these same _NgFactories_ in memory where they are largely invisible. AOT compilation reveals them as separate, physical files. JIT编译器在内存中同样会生成这一堆*NgFactory*,但它们大部分是不可见的。 AOT编译器则会生成在单独的物理文件中。
Do not edit the _NgFactories_! Re-compilation replaces these files and all edits will be lost. 不要编辑这些*NgFactory*!重新编译时会替换这些文件,你做的所有修改都会丢失。
{@a bootstrap} ## Bootstrap ## 引导 The AOT approach changes application bootstrapping. AOT也改变了应用的引导方式。 Instead of bootstrapping `AppModule`, you bootstrap the application with the generated module factory, `AppModuleNgFactory`. 引导的方式从引导`AppModule`改成了引导生成的模块工厂:`AppModuleNgFactory`。 Make a copy of `main.ts` and name it `main-jit.ts`. This is the JIT version; set it aside as you may need it [later](guide/aot-compiler#run-jit "Running with JIT"). 复制一份`main.ts`并把它改名为`main-jit.ts`。 这就是JIT版本,先把它放在一边,我们[稍后](guide/aot-compiler#run-jit "Running with JIT")会用到它。 Open `main.ts` and convert it to AOT compilation. Switch from the `platformBrowserDynamic.bootstrap` used in JIT compilation to `platformBrowser().bootstrapModuleFactory` and pass in the AOT-generated `AppModuleNgFactory`. 打开`main.ts`,并把它改成AOT编译。 从`platformBrowserDynamic.bootstrap`改成使用`platformBrowser().bootstrapModuleFactory`并把`AppModuleNgFactory`的AOT编译结果传给它。 Here is AOT bootstrap in `main.ts` next to the original JIT version: 这里是AOT版本`main.ts`中的引导过程,下一个是你所熟悉的JIT版本。 Be sure to [recompile](guide/aot-compiler#compile) with `ngc`! 确保用`ngc`进行[重新编译](guide/aot-compiler#compile)! {@a tree-shaking} ## Tree shaking ## 摇树优化(Tree shaking) AOT compilation sets the stage for further optimization through a process called _tree shaking_. A tree shaker walks the dependency graph, top to bottom, and _shakes out_ unused code like dead leaves in a tree. AOT编译为接下来通过一个叫做*摇树优化*的过程做好了准备。 摇树优化器从上到下遍历依赖图谱,并且*摇掉*用不到的代码,这些代码就像是圣诞树中那些死掉的松针一样。 Tree shaking can greatly reduce the downloaded size of the application by removing unused portions of both source and library code. In fact, most of the reduction in small apps comes from removing unreferenced Angular features. 通过移除源码和库代码中用不到的部分,摇树优化可以大幅缩减应用的下载体积。 事实上,在小型应用中大部分的缩减都是因为筛掉了那些没用到的Angular特性。 For example, this demo application doesn't use anything from the `@angular/forms` library. There is no reason to download forms-related Angular code and tree shaking ensures that you don't. 例如,这个演示程序中没有用到`@angular/forms`库中的任何东西,那么也就没有理由去下载这些与表单有关的Angular代码了。摇树优化可以帮你确保这一点。 Tree shaking and AOT compilation are separate steps. Tree shaking can only target JavaScript code. AOT compilation converts more of the application to JavaScript, which in turn makes more of the application "tree shakable". 摇树优化和AOT编译是单独的步骤。 摇树优化仅仅针对JavaScript代码。 AOT编译会把应用中的大部分都转换成JavaScript,这种转换会让应用更容易被“摇树优化”。 {@a rollup} ### Rollup ### Rollup 工具 This cookbook illustrates a tree shaking utility called _Rollup_. 这个烹饪宝典中用来示范的摇树优化工具是*Rollup*。 Rollup statically analyzes the application by following the trail of `import` and `export` statements. It produces a final code _bundle_ that excludes code that is exported, but never imported. Rollup会通过跟踪`import`和`export`语句来对本应用进行静态分析。 它所生成的最终代码*捆*中会排除那些被导出过但又从未被导入的代码。 Rollup can only tree shake `ES2015` modules which have `import` and `export` statements. Rollup只能对`ES2015`模块摇树,因为那里有`import`和`export`语句。
Recall that `tsconfig-aot.json` is configured to produce `ES2015` modules. It's not important that the code itself be written with `ES2015` syntax such as `class` and `const`. What matters is that the code uses ES `import` and `export` statements rather than `require` statements. 回忆一下,`tsconfig-aot.json`中曾配置为生成`ES2015`的模块。 代码本身是否用到了`ES2015`语法(例如`class`和`const`)并不重要,重要的是这些代码使用的应该是`import`和`export`语句,而不是`require`语句。
In the terminal window, install the Rollup dependencies with this command: 通过下列命令安装Rollup依赖: npm install rollup rollup-plugin-node-resolve rollup-plugin-commonjs rollup-plugin-uglify --save-dev Next, create a configuration file (`rollup-config.js`) in the project root directory to tell Rollup how to process the application. The cookbook configuration file looks like this. 接下来,在项目根目录新建一个配置文件(`rollup-config.js`),来告诉Rollup如何处理应用。 本烹饪书配置文件是这样的: This config file tells Rollup that the app entry point is `src/app/main.js` . The `dest` attribute tells Rollup to create a bundle called `build.js` in the `dist` folder. It overrides the default `onwarn` method in order to skip annoying messages about the AOT compiler's use of the `this` keyword. 这个配置文件告诉Rollup,该应用的入口点是`app/main.js`。 `dest`属性告诉Rollup要在`dist`目录下创建一个名叫`build.js`的捆文件。 它覆盖了默认的`onwarn`方法,以便忽略由于AOT编译器使用`this`关键字导致的噪音消息。 The next section covers the plugins in more depth. 下一节我们将深入讲解插件。 {@a rollup-plugins} ### Rollup Plugins ### Rollup插件 Optional plugins filter and transform the Rollup inputs and output. 这些可选插件过滤并转换Rollup的输入和输出。 *RxJS* *RxJS* 库 Rollup expects application source code to use `ES2015` modules. Not all external dependencies are published as `ES2015` modules. In fact, most are not. Many of them are published as _CommonJS_ modules. Rollup期望应用的源码使用`ES2015`模块。 但并不是所有外部依赖都发布成了`ES2015`模块。 事实上,大多数都不是。它们大多数都发布成了*CommonJS*模块。 The _RxJs_ Observable library is an essential Angular dependency published as an ES5 JavaScript _CommonJS_ module. 可观察对象库*RxJS*是Angular所依赖的基础之一,它就是发布成了ES5 JavaScript的*CommonJS*模块。 Luckily, there is a Rollup plugin that modifies _RxJs_ to use the ES `import` and `export` statements that Rollup requires. Rollup then preserves the parts of `RxJS` referenced by the application in the final bundle. Using it is straigthforward. Add the following to the `plugins` array in `rollup-config.js`: 幸运的是,有一个Rollup插件,它会修改*RxJS*,以使用Rollup所需的ES`import`和`export`语句。 然后Rollup就可以把该应用中用到的那部分`RxJS`代码留在“捆”文件中了。 它的用法很简单。把下列代码添加到`rollup-config.js`的`plugins`数组中: *Minification* *最小化* Rollup tree shaking reduces code size considerably. Minification makes it smaller still. This cookbook relies on the _uglify_ Rollup plugin to minify and mangle the code. Add the following to the `plugins` array: Rollup做摇树优化时会大幅减小代码体积。最小化过程则会让它更小。 本烹饪宝典依赖于Rollup插件*uglify*来最小化并混淆代码。 把下列代码添加到`plugins`数组中:
In a production setting, you would also enable gzip on the web server to compress the code into an even smaller package going over the wire. 在生产环境中,我们还应该打开Web服务器的gzip特性来把代码压缩得更小。
{@a run-rollup} ### Run Rollup ### 运行Rollup Execute the Rollup process with this command: 通过下列命令执行Rollup过程: node_modules/.bin/rollup -c rollup-config.js
Windows users should surround the `rollup` command in double quotes: Windows用户要把`rollup`命令放进双引号中: "node_modules/.bin/rollup" -c rollup-config.js
{@a load} ## Load the bundle ## 加载捆文件 Loading the generated application bundle does not require a module loader like SystemJS. Remove the scripts that concern SystemJS. Instead, load the bundle file using a single `