環境:
- Angular CLI: 11.0.6
- Angular: 11.0.7
- Node: 12.18.3
- npm : 6.14.6
- IDE: Visual Studio Code
1. 摘要
模塊(NgModule)是Angular的核心概念之一。模塊(NgModule)用於組織業務代碼,按照自己的業務場景,把組件、服務、路由打包到模塊里面。
模塊(NgModule)的主要作用:
- NgModule 組織業務代碼,開發者可以利用 NgModule 把關系比較緊密的組件組織到一起。
- NgModule 用來控制組件、指令、管道等的可見性,處於同一個NgModule 里面的組件默認互相可見,而對於外部的組件來說,只能看到NgModule 導出(exports)的內容。這樣就實現了封裝,只暴露希望暴露的組件、服務給調用者。
- NgModule 是 @angular/cli 打包的最小單位。打包的時候,@angular/cli 會檢查所有 @NgModule 和路由配置,如果你配置了異步模塊,cli 會自動把模塊切分成獨立的 chunk(塊)。在 Angular 里面,打包和切分的動作是 @angular/cli 自動處理的,不需要你干預。當然,如果需要,你也可以修改angular的編譯配置,基於Webpack 配一個環境出來,自定義打包規則。
- NgModule 是 Router 進行異步加載的最小單位,Router 能加載的最小單位是模塊,而不是組件。當然,也可以一個模塊里面只放一個組件是。
2. NgModule舉例、說明
前文說過,Angular中任何的Component、service,都必須屬於一個NgModule。所以,使用AngularCLI生成的框架程序,自動生成的組件,也是屬於一個Component的,並且標記為啟動模塊。
這樣,angular站點啟動后,會以這個模塊為入口,根據配置加載各個模塊。
下面以默認生成的啟動模塊為例,進行解釋:
@NgModule({
declarations: [
AppComponent,
MyComponentComponent
],
imports: [
BrowserModule,
AppRoutingModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
- declarations,用來放組件、指令、管道的聲明;
- imports,用來導入外部模塊。比如當前模塊需要調用其他模塊的組件,需要加入到這里。比如上面例子,導入了Browser和Routing 2個模塊。
- providers,需要使用的第三方或者其他模塊的Service 都放在這里;
- bootstrap,定義啟動組件。 一個可以啟動的Angular項目(如果只是一個Library除外),需要定義一個啟動組件。
- exports, 聲明的組件、指令和管道可以在導入了本模塊的模塊下任何組件的模板中使用。 導出的這些可聲明對象就是該模塊的公共 API。換句話說,其他模塊想用本模塊中定義的內容,需要在這里聲明。
- entryComponents, 如果其他模塊想要動態加載本模塊中的組件到視圖中, 那么,這些組件需要寫入entryComponents。
3. Angular CLI生成模塊
AngularCLI是一個很好很強大的工具集,可以幫助我們生成很多基礎代碼、文件, 包括創建一個模塊,並且可以制定參數。
ng generate module <name> [options]
詳情參考https://angular.io/cli/generate#module。
幾個簡單的例子:
- 創建feature1模塊:
ng generate module feature1
- 創建feature2模塊, 並且帶路由:
ng generate module feature2 --routing
- 創建一個延遲加載的feature3模塊(延遲加載模塊,參考下面章節):
ng generate module feature3 --route feature3 --module app.module
說明:
ng generate module xxx
可以簡寫為ng g m xxx
4. 延遲加載模塊
延遲加載使得應用程序在啟動時不被載入,而是結合路由配置,在需要時才動態加載相應模塊。這樣 Angular 就不需要在第一個界面從服務器下載所有的文件,直到請求它,才下載相應的模塊。這對提供性能和減少首屏的初始下載文件尺寸有巨大的幫助,而且它可以很容易設置。
舉例來說,上文創建了3個模塊,主程序模塊以及feature1、feature2會被打成一個包(js),feature3會被單獨打一個包(js),當用戶訪問/feature3/* 的地址后,才會加載feature3這個包(js),否則永遠不會請求、加載feature3的模塊,從而提高性能(首頁加載時間)。當一個項目大到一定程度時,最好考慮把某些模塊設置為延遲加載模塊。
延遲加載的路由定義(angular CLI會自動生成):
// src/app/app-routing.module.ts
import { NgModule } from '@angular/core';
import { Routes, RouterModule } from '@angular/router';
const routes: Routes = [
{
path: 'feature3',
loadChildren: () =>
import('./feature3/feature3.module').then((m) => m.Feature3Module),
},
];
@NgModule({
imports: [RouterModule.forRoot(routes)],
exports: [RouterModule],
})
export class AppRoutingModule {}
最后復習一下生成延遲加載模塊的命令ng generate module feature3 --route feature3 --module app.module
,或者簡寫為 ng g m feature3 --route feature3 --module app.module
。
5. 總結
- Angular項目,就是模塊(NgModule)的一個集合,任組件、服務等必須包含在一個模塊中。
- 延遲加載模塊用於提高首頁加載性能。
- Angular CLI命令,生成模塊。
---------------- END ----------------
======================