Un article explorant le rendu côté serveur (SSR) dans Angular

De manière générale, les applications Angular ordinaires s'exécutent dans le navigateur, affichent les pages dans le DOM et interagissent avec les utilisateurs. Le rendu Angular Universal côté serveur (Server-Side Rendering, SSR), génère des pages Web d'application statiques, puis les affiche sur le client. L'avantage est qu'il peut être rendu plus rapidement, avant de fournir une interaction complète. pour les utilisateurs. [Recommandations de didacticiel associées : "Tutoriel angulaire"]

Cet article a été réalisé dans l'environnement Angular 14. Certains contenus peuvent ne pas être applicables à la nouvelle version d'Angular. Veuillez vous référer à la documentation officielle d'Angular.

Avantages de l'utilisation de SSR

Plus convivial pour le référencement

Bien que certains moteurs de recherche et médias sociaux, dont Google, prétendent déjà prendre en charge SPA (Single-Page) piloté par JavaScript (JS) Application) pour explorer , mais les résultats ne semblent pas satisfaisants. Les performances SEO des sites Web HTML statiques sont toujours meilleures que celles des sites Web dynamiques, ce qui est également l'avis du site officiel d'Angular (Angular appartient à Google !).

Universal peut générer une version statique de l'application sans JS, avec une meilleure prise en charge de la recherche, des liens externes et de la navigation.

Améliorez les performances mobiles

Certains appareils mobiles peuvent ne pas prendre en charge JS ou avoir une prise en charge très limitée de JS, ce qui entraîne une très mauvaise expérience d'accès au site Web. Dans ce cas, nous devons fournir une version de l'application sans JS pour offrir une meilleure expérience aux utilisateurs.

Afficher la page d'accueil plus rapidement

Pour l'expérience utilisateur, la vitesse d'affichage de la page d'accueil est cruciale. Selon

eBay

, toutes les 100 millisecondes d'affichage plus rapide des résultats de recherche, l'utilisation de l'option « ajouter au panier » augmente de 0,5 %. Après avoir utilisé Universal, la page d'accueil de l'application sera affichée à l'utilisateur sous une forme complète. Il s'agit d'une page Web purement HTML, qui peut être affichée même si JS n'est pas pris en charge. À l'heure actuelle, bien que la page Web ne puisse pas gérer les événements du navigateur, elle prend en charge le passage via routerLink.

L'avantage de ceci est que nous pouvons utiliser une page Web statique pour attirer d'abord l'attention de l'utilisateur et charger l'intégralité de l'application Angular en même temps lorsque l'utilisateur parcourt la page Web. Cela offre aux utilisateurs une expérience de chargement très bonne et extrêmement rapide. 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()

Ajouter SSR au projet🎜🎜🎜Angular CLI peut nous aider à convertir facilement un projet Angular ordinaire en un projet avec SSR. La création d'une application côté serveur ne nécessite qu'une seule commande : 🎜

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');
  }
}

🎜🎜 Il est recommandé de valider toutes les modifications avant d'exécuter cette commande. 🎜🎜🎜Cette commande apportera les modifications suivantes au projet : 🎜

• 🎜Ajouter le fichier serveur : 🎜
  • main .server .ts - Fichier programme principal du serveur
  • app/app.server.module.ts - Module principal de l'application serveur
  • tsconfig.server.json - Fichier de configuration du serveur TypeScript
  • server.ts - Fichier exécutant le serveur Web Express🎜
• 🎜Fichier modifié :🎜
  • package. json - Ajouter les dépendances et exécuter les scripts requis pour SSR
  • angular.json - Ajouter les configurations requises pour le développement et la création d'applications SSR

🎜Dans package.json, certains scripts npm seront automatiquement ajoutés : dev:ssr pour être exécutés dans l'environnement de développement version SSR  ; serve:ssr est utilisé pour exécuter directement la page Web construite ou pré-rendue ; build:ssr construit la version SSR de la page Web ; prerender construit la page Web pré-rendue. les pages Web rendues sont différentes de build. Les fichiers HTML de ces pages seront générés en fonction des routes fournies. 🎜

🎜Remplacer l'API du navigateur🎜🎜🎜Étant donné que les applications universelles ne sont pas exécutées dans le navigateur, certaines API ou fonctions du navigateur ne seront pas disponibles. Par exemple, les applications côté serveur ne peuvent pas utiliser les objets globaux window, document, navigator et location dans le navigateur. 🎜🎜Angular fournit deux objets injectables pour remplacer des objets équivalents côté serveur : Location et DOCUMENT. 🎜🎜Par exemple, dans le navigateur, nous obtenons l'adresse du navigateur actuel via window.location.href, et après l'avoir changé en SSR, le code est le suivant : 🎜

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(
                    &#39;host&#39;
                )}`;
            } else {
                // 如果注入的 REQUEST 为空，比如在进行 prerender build：
                // 这里需要添加自定义的地址前缀，比如我们的请求都是从 abmcode.com 来。
                protocolHost = &#39;https://www.abmcode.com&#39;;
            }
            const pathSeparator = !req.url.startsWith(&#39;/&#39;) ? &#39;/&#39; : &#39;&#39;;
            const url = protocolHost + pathSeparator + req.url;
            const serverRequest = req.clone({ url });
            return next.handle(serverRequest);
 
        } else {
            return next.handle(req);
        }
    }
}

🎜De même, pour en utilisant dans le code du navigateur>document.getElementById() Obtient l'élément DOM Après l'avoir changé en SSR, le code est le suivant : 🎜

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(
                    &#39;host&#39;
                )}`;
            } else {
                // 如果注入的 REQUEST 为空，比如在进行 prerender build：
                // 这里需要添加自定义的地址前缀，比如我们的请求都是从 abmcode.com 来。
                protocolHost = &#39;https://www.abmcode.com&#39;;
            }
            const pathSeparator = !req.url.startsWith(&#39;/&#39;) ? &#39;/&#39; : &#39;&#39;;
            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/9ad5cf4808085b3e6cc130d06d568f1c/browser 下面只有 index.html 文件，打开文件查看，发现其中还有 57b7f9effa9cadc72edb88082c9f873b33f1bb210aedf28e397b6902027fb58b 这样的元素，也就是说你的网页内容并没有在 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 或者使用命令行参数则按照上面f35d6e602fd7d0f0edfa6f7d103c1b572cc198a1d5eb0d3eb508d858c9f5cbdb中的命令执行），编译完成后，再打开 dist/9ad5cf4808085b3e6cc130d06d568f1c/browser 下的 index.html 会发现里面没有 57b7f9effa9cadc72edb88082c9f873b33f1bb210aedf28e397b6902027fb58b 了，取而代之的是主页的实际内容。同时也生成了相应的路径目录以及各个目录下的 index.html 子页面文件。

SEO 优化

SEO 的关键在于对网页 title，keywords 和 description 的收录，因此对于我们想要让搜索引擎收录的网页，可以修改代码提供这些内容。

在 Angular 14 中，如果路由界面通过 Routes 配置，可以将网页的静态 title 直接写在路由的配置中：

{ path: &#39;home&#39;, component: AbmHomeComponent, title: &#39;<你想显示在浏览器 tab 上的标题>&#39; },

另外，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(&#39;<此页的标题>&#39;);
    this._meta.addTags([
      { name: &#39;keywords&#39;, content: &#39;<此页的 keywords，以英文逗号隔开>&#39; },
      { name: &#39;description&#39;, content: &#39;<此页的描述>&#39; }
    ]);
  }
}

总结

Angular 作为 SPA 企业级开发框架，在模块化、团队合作开发方面有自己独到的优势。在进化到 v14 这个版本中提供了不依赖 NgModule 的独立 Component 功能，进一步简化了模块化的架构。

Angular Universal 主要关注将 Angular App 如何进行服务端渲染和生成静态 HTML，对于用户交互复杂的 SPA 并不推荐使用 SSR。针对页面数量较少、又有 SEO 需求的网站或系统，则可以考虑使用 Universal 和 SSR 技术。

更多编程相关知识，请访问：编程教学！！

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!