Question

angular universal：仅适用于浏览器的动态导入

2016-11-22

7881

angular primeng angular-universal

是否可以根据条件导入模块？具体来说，仅当 angular 2 通用应用程序在浏览器中呈现而不是在服务器中呈现时，才导入外部模块。

这个问题与一些依赖于浏览器功能并且只能在浏览器中呈现的 PrimeNG 模块有关。在服务器渲染时省略它们会很棒，因为日历和其他组件对 SEO 来说并不重要。

目前，如果关闭服务器渲染，我可以渲染日历组件。但是当我在 app.module.ts 中包含以下代码并打开服务器渲染时，服务器会在 button.js 中产生错误“ReferenceError：未定义事件”。

import { CalendarModule } from 'primeng/components/calendar/calendar';
@NgModule({
    ...
    imports: [
        ...,
        CalendarModule
    ]
})

angular 提供了一个 isBrowser 条件。

import { isBrowser } from 'angular2-universal';

但我不知道如何将其用于条件导入。真的有办法对模块做到这一点吗？

Answer 1

因此，有一种方法可以在浏览器中渲染 PrimeNG 组件，并在服务器渲染时忽略它们。这些问题帮助我开始挖掘正确的方向：

angular-cli：使用环境变量进行条件导入

如何有条件地导入 ES6 模块？

在服务器渲染时，我使用了模拟组件，该组件渲染一个简单的输入字段并使用相同的选择器“p-calendar”。我最终在 app.module 中得到了最终代码。

...//other imports
import { isBrowser } from 'angular2-universal';

let imports = [
    ... //your modules here
];
let declarations = [
    ... //your declarations here
];

if (isBrowser) {
    let CalendarModule = require('primeng/components/calendar/calendar').CalendarModule;
    imports.push(CalendarModule);
}
else {
    let CalendarMockComponent = require('./components/primeng/calendarmock.component').CalendarMockComponent;
    declarations.push(CalendarMockComponent);
}

@NgModule({
    bootstrap: [AppComponent],
    declarations: declarations,
    providers: [
        ... //your providers here
    ],
    imports: imports
})

要使您的模拟组件支持 [(ngModel)] 绑定，请使用本教程。 http://almerosteyn.com/2016/04/linkup-custom-control-to-ngcontrol-ngmodel

import { Component, forwardRef } from '@angular/core';
import { NG_VALUE_ACCESSOR, ControlValueAccessor } from '@angular/forms';

export const CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR: any = {
    provide: NG_VALUE_ACCESSOR,
    useExisting: forwardRef(() => CalendarMockComponent),
    multi: true
};

@Component({
    selector: 'p-calendar',
    template: '<input type="text" class="form-control"/>',
    providers: [CUSTOM_INPUT_CONTROL_VALUE_ACCESSOR]
})
export class CalendarMockComponent implements ControlValueAccessor {

    private innerValue: any = '';

    private onTouchedCallback: () => void = () => {};
    private onChangeCallback: (_: any) => void = () => {};

    //From ControlValueAccessor interface
    writeValue(value: any) {
        if (value !== this.innerValue) {
            this.innerValue = value;
        }
    }

    registerOnChange(fn: any) {
        this.onChangeCallback = fn;
    }

    registerOnTouched(fn: any) {
        this.onTouchedCallback = fn;
    }
}

Answer 2

不需要动态脚本加载的模块导入的替代解决方案：您可以使用服务器应用程序的 tsconfig.json 文件中的 compilerOptions.paths 选项将导入的模块重定向到仅限服务器的版本：

{
    ...
    "compilerOptions": {
        ...
        "paths": {
            "path/to/browser/module": "path/to/server/module"
        }
    }
}

当服务器应用程序构建时，编译器将导入服务器模块而不是浏览器模块。

Answer 3

我也想回答。这是我的解决方案。您需要创建三个环境，如下所示：

src/environments/server/environments.ts
src/environments/browser/environments.ts
src/environments/environments.ts

然后在 angular.json 的构建部分中为 browser 创建欺骗文件：

"configurations": {
        "dev": {
          "fileReplacements": [
            {
              "replace": "src/environments/environment.ts",
              "with": "src/environments/browser/environment.ts"
            }
          ]
        },
        "production": {
          ...
          "fileReplacements": [
            {
              "replace": "src/environments/environment.ts",
              "with": "src/environments/browser/environment.ts"
            }
          ]
        }
      }

以及为 server 创建欺骗文件：

"configurations": {
        "dev": {
          "fileReplacements": [
            {
              "replace": "src/environments/environment.ts",
              "with": "src/environments/server/environment.ts"
            }
          ]
        },
        "production": {
          ...
          "fileReplacements": [
            {
              "replace": "src/environments/environment.ts",
              "with": "src/environments/server/environment.ts"
            }
          ]
        }
      }

因此，我们可以在任何地方使用变量 environment.isServer

import { environment } from '../../environments/environment';
...

environment.isServer ? MapMockModule : MapModule,

如果有什么不清楚的地方，您可以在此处查看示例 sourse