Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | 1x 1x 1x 1x | import { pathToFileURL } from 'node:url';
import { createLoaderImport } from '@esmx/import';
import type { COMMAND, Esmx } from './core';
import {
RenderContext,
type RenderContextOptions,
type ServerRenderHandle
} from './render-context';
import { type Middleware, createMiddleware } from './utils/middleware';
/**
* 应用程序实例接口。
*
* App 是 Esmx 框架的应用抽象，提供了统一的接口来管理应用的生命周期、
* 静态资源和服务端渲染。
*
* @example
* ```ts
* // entry.node.ts
* export default {
* // 开发环境配置
* async devApp(esmx) {
* return import('@esmx/rspack').then((m) =>
* m.createRspackHtmlApp(esmx, {
* config(rc) {
* // 自定义 Rspack 配置
* }
* })
* );
* }
* }
* ```
*/
export interface App {
/**
* 静态资源处理中间件。
*
* 开发环境：
* - 处理源码的静态资源请求
* - 支持实时编译和热更新
* - 使用 no-cache 缓存策略
*
* 生产环境：
* - 处理构建后的静态资源
* - 支持不可变文件的长期缓存（.final.xxx）
* - 优化的资源加载策略
*
* @example
* ```ts
* server.use(esmx.middleware);
* ```
*/
middleware: Middleware;
/**
* 服务端渲染函数。
*
* 根据运行环境提供不同实现：
* - 生产环境（start）：加载构建后的服务端入口文件（entry.server）执行渲染
* - 开发环境（dev）：加载源码中的服务端入口文件执行渲染
*
* @param options - 渲染选项
* @returns 返回渲染上下文，包含渲染结果
*
* @example
* ```ts
* const rc = await esmx.render({
* params: { url: '/page' }
* });
* res.end(rc.html);
* ```
*/
render: (options?: RenderContextOptions) => Promise<RenderContext>;
/**
* 生产环境构建函数。
* 用于资源打包和优化。
*
* @returns 构建成功返回 true，失败返回 false
*/
build?: () => Promise<boolean>;
/**
* 资源清理函数。
* 用于关闭服务器、断开连接等。
*
* @returns 清理成功返回 true，失败返回 false
*/
destroy?: () => Promise<boolean>;
}
/**
* 创建生产环境的应用程序实例，开发环境不可用。
*/
export async function createApp(esmx: Esmx, command: COMMAND): Promise<App> {
const render =
command === esmx.COMMAND.start
? await createStartRender(esmx) // 提供实际的渲染函数
: createErrorRender(esmx); // 提供错误提示渲染函数
return {
middleware: createMiddleware(esmx),
render
};
}
/**
* 创建生产环境渲染函数。
* 加载构建后的服务端入口文件（entry.server）执行渲染。
*
* @param esmx - Esmx 实例
* @returns 返回渲染函数
* @internal
*
* @example
* ```ts
* // 服务端入口文件 (entry.server)
* export default async function render(rc: RenderContext) {
* rc.html = '<html>...</html>';
* }
* ```
*/
async function createStartRender(esmx: Esmx) {
const baseURL = pathToFileURL(esmx.resolvePath('dist/server')) as URL;
const importMap = await esmx.getImportMap('server');
const loaderImport = createLoaderImport(baseURL, importMap);
return async (options?: RenderContextOptions): Promise<RenderContext> => {
const rc = new RenderContext(esmx, options);
const result = await loaderImport(`${esmx.name}/src/entry.server`);
const serverRender: ServerRenderHandle = result[rc.entryName];
if (typeof serverRender === 'function') {
await serverRender(rc);
}
return rc;
};
}
function createErrorRender(esmx: Esmx) {
return (options?: RenderContextOptions) => {
throw new Error(
`App instance is only available in production and can only execute built artifacts.`
);
};
}
|