iT邦幫忙

2019 iT 邦幫忙鐵人賽

DAY 5
1
Modern Web

Angular 大師之路系列 第 5

[Angular 大師之路] Day 05 - 認識 NgModule

Angular 本身內建了一種模組化的機制,這個機制可以幫助我們組織管理一系列相關的程式(如 component、pipe 和 service 等等),將類型或功能相似的程式封裝成一個一個不同的模組。在開發 Angular 應用程式時,我們一定會有一個根模組,也就是 AppModule ,今天我們就來看看這個模組裡面到底要怎麼封裝不同的程式進來吧!

類型:觀念

難度:3 顆星

實用度:5 顆星

在 Angular 中,我們會宣告一個類別,並掛上 @NgModule 裝飾器,代表宣告的類別是一個模組,在這個 @NgModule 中,可以使用一個物件設定要將不同的程式納入這個模組中,包含了以下屬性宣告:

imports

代表要使用哪些模組所提供的功能,例如我們常常使用的 ngModel ,就是在 FormsModule 裡面所提供的一個 directive,此時我們就必須在 @NgModule 的 imports: [] 中加入 FormsModule

在一般使用 Angular CLI 建立好的程式中,我們可以看到在 AppModule 中的 @NgModule 包含了 imports: [BrowserModule],代表的就是針對瀏覽器開發的常用程式都來自於 BrowserModule 中。

簡單的說,當有使用到其他模組程式的需求時,就需要使用 imports: [] 將該模組加入。

declarations

declarations: [] 設定中,我們會將**可宣告(declarable)**的類別放在這個設定中,什麼是可宣告的類別呢?簡單來說就是跟樣板顯示有關的程式,都屬於這裡面的設定。

簡單來說,在 HTML 上可能會看到某個元件(component)的 selector、某個元素上掛了一個指令(directive),或是使用 管線(pipe)來改變呈現內容,這些都是跟樣板有關的,而當 Angular 在編譯這些樣板時,就會在相關的模組中,尋找是否在 declarations: [] 有加入這些類別,如果有,就執行相關的程式並且改變畫面的行為。如下程式:

@NgModule({
  declarations: [AppComponent, HighlightDirective, PasswordPipe]
})
export class AppModule { }

另外非常值得注意的一點是,這些與顯示相關的程式類別都只能存在於一個模組之中,如果存在多個模組中時,編譯程式時就會發生錯誤!

因此如果我希望將某個元件封裝在某個模組中,但在別的模組中的元件要能夠使用時,就需要使用另一個設定:exports: []

exports

在上一節中,我們已經知道 Angular 中的與畫面相關的程式類別必須放在 declarations: [] 之中,且每個與畫面相關的程式類別只能存在於一個模組內;但我們很有可能在 A 模組寫了個元件,卻想在 B 模組中的另一個元件中使用,如下:

@Component({
  selector: 'app-main',
  template: 'Hello'
})
export class MainComponent { }

@NgModule({
  declarations: [MainComponent]
})
export class MainModule { }

@Component({
  selector: 'app-root',
  template: '<app-main></app-main>'
})
export class AppComponent { }

@NgModule({
  imports: [BrowserModule, MainModule],
  declarations: [AppComponent],
  bootstrap: [AppComponent]
})
export class AppModule { }

此時在編譯 MainComponent 的樣板時,會得到以下錯誤:

https://wellwind.idv.tw/blog/2018/10/20/mastering-angular-05-knowning-ng-module/01.jpg

儘管在 imports:[] 中加入了 MainModule ,但依然無法使用 MainComponent,這是因為這些在樣板顯示用的程式類別,若要被其他模組使用,必需放在所屬模組的 exports: [] 之中,如下

@NgModule({
  declarations: [MainComponent],
  exports: [MainComponent]
})
export class MainModule { }

這麼做看起來好像多此一舉,但在共用模組時,我們可以自行決定哪些程式允許外部使用,哪些程式是不需要被外部使用的,維持最小知識原則,避免不必要的元件被外部程式誤用囉。

providers

providers: [] 主要是用來決定哪些服務(service)允許被注入,在 Angular 6 之後替 @Service 加上了 providedIn 設定,讓服務不一定非要放在 providers: [] 之中,但在很多時候要改變注入行為時,這裡依然是很重要的設定點。

關於相依注入等相關的設定,之後的文章再來深入說明。

bootstrap

在前兩天介紹應用程式啟動過程時,我們已經學過 bootstrap: [] 了,簡單來說, bootstrap : [] 裡面的元件會自動被啟動。

放在 bootstrap: [] 中的元件,會自動被視為放入 entryComponents: [] 之中。

entryComponents

在顯示一個元件時,有動態載入與靜態載入兩種方法:

  • 動態載入:代表不是在某個樣板中使用 <app-xxx></app-xxx> 的方法載入元件,而是透過我們手動撰寫程式,將元件載入在畫面中的某個地方。
  • 靜態載入:剛好與動態組入相反,也就是主動在樣板中使用 <app-xxx></app-xxx> 的方式來載入元件。

由於動態載入元件時不會在樣板中宣告使用元件,因此在打包程式時,會因為不知道何時被使用,為了減少打包程式的大小,而將元件去掉,反而造成無法載入的問題,因此 Angular 設計了 entryComponents: [],只要元件在程式中需要被動態載入,可以透過放入 entryComponents: [] 來避免程式在打包時被移除。

關於動態載入元件的時機,未來我們也會再多做介紹。

本日小節

今天我們把一個 @NgModule 中如何決定哪些程式屬於哪個模組的設定都說明了一次,雖然通常使用 Angular CLI 建立程式時,會自動幫我們加到模組對應的位置,但在有更彈性的需求,或是重構程式,將程式分類到不同模組時,理解哪個類別在哪個設定屬性裡就非常重要!

明天我們再來討論看看,在 Angular 中幾種不同分割模組的方法囉。

相關資源


上一篇
[Angular 大師之路] Day 04 - 認識 Angular 的生命週期
下一篇
[Angular 大師之路] Day 06 - 模組化的基本觀念
系列文
Angular 大師之路30

尚未有邦友留言

立即登入留言