客户端渲染
客户端渲染(Client-Side Rendering,CSR)是一种在浏览器端执行页面渲染技术方案。在 Esmx 中,当你的应用无法部署 Node.js 服务器实例时,可以选择在构建阶段生成静态的 index.html
文件,实现纯客户端渲染。
使用场景
以下场景推荐使用客户端渲染:
- 静态托管环境:如 GitHub Pages、CDN 等不支持服务端渲染的托管服务
- 简单应用:对首屏加载速度和 SEO 要求不高的小型应用
- 开发环境:在开发阶段快速预览和调试应用
配置说明
HTML 模板配置
在客户端渲染模式下,你需要配置一个通用的 HTML 模板。这个模板将作为应用的容器,包含必要的资源引用和挂载点。
src/entry.server.ts
1import type { RenderContext } from '@esmx/core';
2
3export default async (rc: RenderContext) => {
4 // 提交依赖收集
5 await rc.commit();
6
7 // 配置 HTML 模板
8 rc.html = `
9<!DOCTYPE html>
10<html>
11<head>
12 ${rc.preload()} // 预加载资源
13 <title>Esmx</title>
14 ${rc.css()} // 注入样式
15</head>
16<body>
17 <div id="app"></div>
18 ${rc.importmap()} // 导入映射
19 ${rc.moduleEntry()} // 入口模块
20 ${rc.modulePreload()} // 模块预加载
21</body>
22</html>
23`;
24};
静态 HTML 生成
要在生产环境中使用客户端渲染,需要在构建阶段生成静态的 HTML 文件。Esmx 提供了 postBuild
钩子函数来实现这一功能:
src/entry.node.ts
1import type { EsmxOptions } from '@esmx/core';
2
3export default {
4 async postBuild(esmx) {
5 // 生成静态 HTML 文件
6 const rc = await esmx.render();
7 // 写入 HTML 文件
8 esmx.writeSync(
9 esmx.resolvePath('dist/client', 'index.html'),
10 rc.html
11 );
12 }
13} satisfies EsmxOptions;