Angular SSR 探究_ZenDei技術網路在線

一般來說，普通的 Angular 應用是在瀏覽器中運行，在 DOM 中對頁面進行渲染，並與用戶進行交互。而 Angular Universal 是在服務端進行渲染（Server-Side Rendering，SSR），生成靜態的應用程式網頁，然後在客戶端展示，好處是可以更快地進行渲染，在提供 ...

一般來說，普通的 Angular 應用是在 瀏覽器 中運行，在 DOM 中對頁面進行渲染，並與用戶進行交互。而 Angular Universal 是在 服務端 進行渲染（Server-Side Rendering，SSR），生成靜態的應用程式網頁，然後在客戶端展示，好處是可以更快地進行渲染，在提供完整的交互之前就可以為用戶提供內容展示。

本文是在 Angular 14 環境中完成，有些內容對於新的 Angular 版本可能並不適用，請參考 Angular 官方文檔。

使用 SSR 的好處

對 SEO 更加友好

雖然現在包括 Google 在內的某些搜索引擎和社交媒體聲稱已經能支持對由 JavaScript（JS）驅動的 SPA（Single-Page Application）應用進行爬取，但是結果似乎差強人意。靜態 HTML 網站的 SEO 表現還是要好於動態網站，這也是 Angular 官網所持有的觀點（Angular 可是 Google 的！）。

Universal 可以生成無 JS 的靜態版本的應用程式，對搜索、外鏈、導航的支持更好。

提高移動端的性能

某些移動端設備可能不支持 JS 或者對 JS 的支持非常有限，導致網站的訪問體驗非常差。這種情況下，我們需要提供無 JS 版本的應用，以便為用戶提供更好的體驗。

更快地展示首頁

對於用戶的使用體驗來說，首頁展示速度的快慢至關重要。根據 eBay 的數據，搜索結果的展示速度每提高 100 毫秒，“添加至購物車”的使用率就提高 0.5%。

使用了 Universal 之後，應用程式的首頁會以完整的形態展示給用戶，這是純的 HTML 網頁，即使不支持 JS，也可以展示。此時，網頁雖然不能處理瀏覽器的事件，但是支持通過 routerLink 進行跳轉。

這麼做的好處是，我們可以先用靜態網頁抓住用戶的註意力，在用戶瀏覽網頁的時候，同時載入整個 Angular 應用。這給了用戶一個非常好的極速載入的體驗。

為項目增加 SSR

Angular CLI 可以幫助我們非常便捷的將一個普通的 Angular 項目轉變為一個帶有 SSR 的項目。創建服務端應用只需要一個命令：

ng add @nguniversal/express-engine

建議在運行該命令之前先提交所有的改動。

這個命令會對項目做如下修改：

添加服務端文件：
- main.server.ts - 服務端主程式文件
- app/app.server.module.ts - 服務端應用程式主模塊
- tsconfig.server.json - TypeScript 服務端配置文件
- server.ts - Express web server 的運行文件
修改的文件：
- package.json - 添加 SSR 所需要的依賴和運行腳本
- angular.json - 添加開發、構建 SSR 應用所需要的配置

在 package.json 中，會自動添加一些 npm 腳本：dev:ssr 用於在開發環境運行 SSR 版本；serve:ssr 用於直接運行 build 或 prerender 後的網頁；build:ssr 構建 SSR 版本的網頁；prerender 構建預渲染後的網頁，與 build 不同，這裡會根據提供的 routes 生成這些頁面的 HTML 文件。

替換瀏覽器 API

由於 Universal 應用不是在瀏覽器中執行，因此一些瀏覽器的 API 或功能將不可用。例如，服務端應用是無法使用瀏覽器中的全局對象 window、document，navigator，location。

Angular 提供了兩個可註入對象，用於在服務端替換對等的對象：Location 和 DOCUMENT。

例如，在瀏覽器中，我們通過 window.location.href 獲取當前瀏覽器的地址，而改成 SSR 之後，代碼如下：

import { Location } from '@angular/common';

export class AbmNavbarComponent implements OnInit{
  // ctor 中註入 Location
  constructor(private _location:Location){
    //...
  }

  ngOnInit() {
    // 列印當前地址
    console.log(this._location.path(true));
  }
}

同樣，對於在瀏覽器使用 document.getElementById() 獲取 DOM 元素，在改成 SSR 之後，代碼如下：

import { DOCUMENT } from '@angular/common';

export class AbmFoxComponent implements OnInit{
  // ctor 中註入 DOCUMENT
  constructor(@Inject(DOCUMENT) private _document: Document) { }

  ngOnInit() {
    // 獲取 id 為 fox-container 的 DOM
    const container = this._document.getElementById('fox-container');
  }
}

使用 URL 絕對地址

在 Angular SSR 應用中，HTTP 請求的 URL 地址必須為 絕對地址（即，以 http/https 開頭的地址，不能是相對地址，如 /api/heros）。Angular 官方推薦將請求的 URL 全路徑設置到 renderModule() 或 renderModuleFactory() 的 options 參數中。但是在 v14 自動生成的代碼中，並沒有顯式調用這兩個方法的代碼。而通過讀 Http 請求的攔截，也可以達到同樣的效果。

下麵我們先準備一個攔截器，假設文件位於項目的 shared/universal-relative.interceptor.ts 路徑：

import { HttpHandler, HttpInterceptor, HttpRequest } from '@angular/common/http';
import { Inject, Injectable, Optional } from '@angular/core';
import { REQUEST } from '@nguniversal/express-engine/tokens';
import { Request } from 'express';

// 忽略大小寫檢查
const startsWithAny = (arr: string[] = []) => (value = '') => {
    return arr.some(test => value.toLowerCase().startsWith(test.toLowerCase()));
};

// http, https, 相對協議地址
const isAbsoluteURL = startsWithAny(['http', '//']);

@Injectable()
export class UniversalRelativeInterceptor implements HttpInterceptor {
    constructor(@Optional() @Inject(REQUEST) protected request: Request) { }

    intercept(req: HttpRequest<any>, next: HttpHandler) {
        // 不是絕對地址的 URL
        if (!isAbsoluteURL(req.url)) {
            let protocolHost: string;
            if (this.request) {
                // 如果註入的 REQUEST 不為空，則從註入的 SSR REQUEST 中獲取協議和地址
                protocolHost = `${this.request.protocol}://${this.request.get(
                    'host'
                )}`;
            } else {
                // 如果註入的 REQUEST 為空，比如在進行 prerender build：
                // 這裡需要添加自定義的地址首碼，比如我們的請求都是從 abmcode.com 來。
                protocolHost = 'https://www.abmcode.com';
            }
            const pathSeparator = !req.url.startsWith('/') ? '/' : '';
            const url = protocolHost + pathSeparator + req.url;
            const serverRequest = req.clone({ url });
            return next.handle(serverRequest);

        } else {
            return next.handle(req);
        }
    }
}

然後在 app.server.module.ts 文件中 provide 出來：

import { UniversalRelativeInterceptor } from './shared/universal-relative.interceptor';
// ... 其他 imports

@NgModule({
  imports: [
    AppModule,
    ServerModule,
    // 如果你用了 @angular/flext-layout，這裡也需要引入服務端模塊
    FlexLayoutServerModule, 
  ],
  providers: [
    {
      provide: HTTP_INTERCEPTORS,
      useClass: UniversalRelativeInterceptor,
      multi: true
    }
  ],
  bootstrap: [AppComponent],
})
export class AppServerModule { }

這樣任何對於相對地址的請求都會自動轉換為絕對地址請求，在 SSR 的場景下不會再出問題。

Prerender 預渲染靜態 HTML

經過上面的步驟後，如果我們通過 npm run build:ssr 構建項目，你會發現在 dist/<your project>/browser 下麵只有 index.html 文件，打開文件查看，發現其中還有 <app-root></app-root> 這樣的元素，也就是說你的網頁內容並沒有在 html 中生成。這是因為 Angular 使用了動態路由，比如 /product/:id 這種路由，而頁面的渲染結果要經過 JS 的執行才能知道，因此，Angular 使用了 Express 作為 Web 伺服器，能在服務端運行時根據用戶請求（爬蟲請求）使用模板引擎生成靜態 HTML 界面。

而 prerender（npm run prerender）會在構建時生成靜態 HTML 文件。比如我們做企業官網，只有幾個頁面，那麼我們可以使用預渲染技術生成這幾個頁面的靜態 HTML 文件，避免在運行時動態生成，從而進一步提升網頁的訪問速度和用戶體驗。

預渲染路徑配置

需要進行預渲染（預編譯 HTML）的網頁路徑，可以有幾種方式進行提供：

通過命令行的附加參數:

ng run <app-name>:prerender --routes /product/1 /product/2

如果路徑比較多，比如針對 product/:id 這種動態路徑，則可以使用一個路徑文件：

routes.txt
```
/products/1
/products/23
/products/145
/products/555
```
然後在命令行參數指定該文件：
```
ng run <app-name>:prerender --routes-file routes.txt
```

在項目的 angular.json 文件配置需要的路徑：

 "prerender": {
   "builder": "@nguniversal/builders:prerender",
   "options": {
     "routes": [ // 這裡配置
       "/",
       "/main/home",
       "/main/service",
       "/main/team",
       "/main/contact"
     ]
   },

配置完成後，重新執行預渲染命令（npm run prerender 或者使用命令行參數則按照上面<1><2>中的命令執行），編譯完成後，再打開 dist/<your project>/browser 下的 index.html 會發現裡面沒有 <app-root></app-root> 了，取而代之的是主頁的實際內容。同時也生成了相應的路徑目錄以及各個目錄下的 index.html 子頁面文件。

SEO 優化

SEO 的關鍵在於對網頁 title，keywords 和 description 的收錄，因此對於我們想要讓搜索引擎收錄的網頁，可以修改代碼提供這些內容。

在 Angular 14 中，如果路由界面通過 Routes 配置，可以將網頁的靜態 title 直接寫在路由的配置中：

{ path: 'home', component: AbmHomeComponent, title: '<你想顯示在瀏覽器 tab 上的標題>' },

另外，Angular 也提供了可註入的 Title 和 Meta 用於修改網頁的標題和 meta 信息：

import { Meta, Title } from '@angular/platform-browser';

export class AbmHomeComponent implements OnInit {

  constructor(
    private _title: Title,
    private _meta: Meta,
  ) { }

  ngOnInit() {
    this._title.setTitle('<此頁的標題>');
    this._meta.addTags([
      { name: 'keywords', content: '<此頁的 keywords，以英文逗號隔開>' },
      { name: 'description', content: '<此頁的描述>' }
    ]);
  }
}

總結

Angular 作為 SPA 企業級開發框架，在模塊化、團隊合作開發方面有自己獨到的優勢。在進化到 v14 這個版本中提供了不依賴 NgModule 的獨立 Component 功能，進一步簡化了模塊化的架構。

Angular Universal 主要關註將 Angular App 如何進行服務端渲染和生成靜態 HTML，對於用戶交互複雜的 SPA 並不推薦使用 SSR。針對頁面數量較少、又有 SEO 需求的網站或系統，則可以考慮使用 Universal 和 SSR 技術。