如何使用 Aurelia.io 增强服务器端生成的页面？

Question

我正在编写一个应用程序，其中一些部分作为 SPA，一些页面在服务器端生成以用于 SEO。我选择了 Aurelia.io 框架并使用 enhance 方法在我的页面上启用自定义元素。但是我找不到在我的服务器端页面上使用 aurelia 特定模板指令和插值的最佳方法。让我们从一个例子开始。

我的所有页面都包含动态 header。此 header 将是一个名为 my-cool-header 的自定义元素。此 header 将加载经过身份验证的用户并显示其名称，或者，如果当前没有用户经过身份验证，则会显示 link 登录。页面的 body 将在服务器端生成并缓存。所以，我们会有类似的东西：

<html>
<body>
    <my-cool-header>
        <img src="logo.png">
        <div
            show.bind="user">${user.name}</div>
        <div
            show.bind="!user"><a href="/signin">Sign-in</a></div>
    </my-cool-header>
    <div>Cachabled content</div>
</body>
</html>

然后，我的 header 将由 :

定义

import {UserService} from './user';
import {inject} from 'aurelia-framework';

@inject(UserService)
export class MyCoolHeader {
    constructor(userService) {
        this.userService = userService;
    }

    async attached() {
        this.user = await this.userService.get();
    }
}

使用以下模板：

<template>
    <content></content>
</template>

还有这个 bootstrap 脚本：

export function configure(aurelia) {
  aurelia.use
    .standardConfiguration()
    .developmentLogging()
    .globalResources('my-cool-header');

  aurelia.start().then(a => a.enhance(document.body));
}

在此配置中，自定义元素已很好地加载和实例化。但是，我无法访问 <content> 节点内节点的 viewModel。所以，所有的插值（${user.name}) and attributes (show.bind) are ignored. If I include a custom-element in my content template, it will be loaded only if it is declared as global in the bootstrap : the`标签都被忽略了。

我找到了一种解决方法，可以在阅读文档后更改 viewModel，方法是设置自定义 viewModel 以增强方法，然后将其注入我的自定义元素 class。像 :

import {MainData} from './main-data';
export function configure(aurelia) {
  const mainData = aurelia.container.get(MainData);
  aurelia.use
    .standardConfiguration()
    .developmentLogging()
    .globalResources('my-cool-header');

  aurelia.start().then(a => a.enhance(mainData, document.body));
}

自定义元素：

import {UserService} from './user';
import {inject} from 'aurelia-framework';
import {MainData} from './main-data';

@inject(UserService, MainData)
export class MyCustomElement {
    constructor(userService, mainData) {
        this.userService = userService;
        this.mainData = mainData;
    }

    async attached() {
        this.mainData.user = await this.userService.get();
    }
}

最后，如果我这样更改我的模板，它就会起作用:

<html>
<body>
    <my-cool-header
        user.bind="user">
        <img src="logo.png">
        <div
            show.bind="user">${user.name}</div>
        <div
            show.bind="!user"><a href="/signin">Sign-in</a></div>
    </my-cool-header>
    <div>Cachabled content</div>
</body>
</html>

我不敢相信这是正确的做法，因为它很难看，而且不能解决 <require> 标签的问题。所以我的问题是：最好的方法是什么？

Answer 1

更改 MyCoolHeader 的模板：

<template>
  <content></content>
</template>

至：

<template>
  <img src="logo.png">
  <div show.bind="user">${user.name}</div>
  <div show.bind="!user"><a href="/signin">Sign-in</a></div>
</template>

然后将服务器生成的页面更改为如下内容：

<html>
<body>
  <my-cool-header></my-cool-header>
  <div>Cachabled content</div>
</body>
</html>

希望对您有所帮助。如果这不能解决问题或不是可接受的解决方案，请告诉我。

编辑

阅读您的回复并进一步考虑后，我倾向于删除 <my-cool-header> 元素。它不提供任何行为，它只充当数据加载器，它的模板由服务器端渲染进程提供，预计将在 aurelia 模板系统之外渲染，没有真正需要重新渲染它。这是这种方法的样子，让我知道它是否更合适：

<html>
<body>
  <div class="my-cool-header">
    <img src="logo.png">
    <div show.bind="user">${user.name}</div>
    <div show.bind="!user"><a href="/signin">Sign-in</a></div>
  </div>

  <div>Cachabled content</div>
</body>
</html>

import {MainData} from './main-data';
import {UserService} from './user';

export function configure(aurelia) {
  const mainData = aurelia.container.get(MainData);
  const userService = aurelia.container.get(UserService);

  aurelia.use
    .standardConfiguration()
    .developmentLogging();

  Promise.all([
    this.userService.get(),
    aurelia.start()    
  ]).then(([user, a]) => {
    mainData.user = user;
    a.enhance(mainData, document.body);
  });
}

Answer 2

为了补充 Jeremy 的回答，如果您确实将模板更改为：

<template>
  <img src="logo.png">
  <div show.bind="user">${user.name}</div>
  <div show.bind="!user"><a href="/signin">Sign-in</a></div>
</template>

当 Aurelia 处理元素时，此内容将出现，并且在没有内容选择器的情况下，自定义元素标签内的任何内容都将被模板替换

如果您随后将非 javascript 内容放入自定义元素标签内：

<my-cool-header>
    <div>This stuff will be visible when JS is turned off</div>
</my-cool-header>

在上面的示例中，在没有 JS 的情况下，div 应该仍然存在，因为 Aurelia 不会将其从 DOM 中删除。

（这当然是假设您的服务器端技术在提供页面时出于某种原因没有 mangle/fix DOM 中的未知 HTML 标记 - 它可能不会' t因为无论如何它都会破坏Aurelia）

编辑：

您可能正在寻找的替代方案是 @processContent 装饰器。

这允许您传递在 Aurelia 检查元素之前运行的回调函数。

此时您可以提取自定义元素标签之间的内容并将其添加为模板元素的子元素。然后内容应该在您的视图模型的范围内。

通过这种方式，当 Aurelia 为运行

时，您可以在没有 javascript 的自定义元素标签之间以及正确范围内的模板内部使用相同的标记

import {processContent, TargetInstruction, inject} from 'aurelia-framework';

@inject(Element, TargetInstruction)
@processContent(function(viewCompiler, viewResources, element, instruction) {
    // Do stuff
    instruction.templateContent = element;

    return true;
})
class MyViewModel {
    constructor(element, targetInstruction) {
        var behavior = targetInstruction.behaviorInstructions[0];
        var userTemplate = behavior.templateContent;

        element.addChild(userTemplate);
    }
}

免责声明：以上代码尚未经过测试，我从我的网格中提取了它，该网格已有多个版本 - 您可能需要调整

Answer 3

多亏了你的线索，我找到了解决办法！

自定义元素需要构建自己的模板：

import {processContent, noView} from 'aurelia-framework';

@processContent(function(viewCompiler, viewResources, element, instruction) {
  instruction.viewFactory = viewCompiler.compile(`<template>${element.innerHTML}</template>`, viewResources, instruction);
  element.innerHTML = '';
  return false;
})
@noView
export class MyCustomElement {
  attached() {
    this.world = 'World!';
    this.display = true;
  }  
}

然后，在我的服务器视图中，我们可以插入并要求自定义元素！

<body>
  <my-custom-element>
    <require="./other-custom-element"></require>
    <p
      if.bind="display">Hello ${world}</p>
    <other-custom-element></other-custom-element>
  </my-custom-element>
</body>

我写了一个装饰器来帮助创建这种增强的自定义元素：https://github.com/hadrienl/aurelia-enhanced-template

加上法语博客的详细信息：https://blog.hadrien.eu/2016/02/04/amelioration-progressive-avec-aurelia-io/

编辑：<require> 并没有真正使用这个解决方案。我必须再次挖掘:(

如何使用 Aurelia.io 增强服务器端生成的页面？

How to enhance a server side generated page with Aurelia.io?

javascript

progressive-enhancement

aurelia

编辑