hapi

Hapi

快速入门

const server = Hapi.server({ port: 3000 });
server.route({ method: 'GET', path: '/', handler: () => 'ok' });
await server.start();

关键规则

1. 通过装饰器和方法进行组合 - 通过装饰器公开服务，通过方法提供可复用逻辑
2. 遵循生命周期 - 请求流程共 24 个步骤；参见生命周期概览
3. 身份验证分为三层 - scheme → strategy → default；参见服务端身份验证
4. 在路由中进行验证 - 在 params、query、payload 和 headers 上使用 joi schemas；参见验证
5. 使用 Refs 为路由添加类型 - 使用 ServerRoute<Refs>，且只填写需要的键（Params、Query、Payload 等）；省略的键保留默认值。参见路由框架

身份验证的三层模式：

server.auth.scheme('custom', schemeImpl);     // 1. scheme（如何进行身份验证）
server.auth.strategy('session', 'custom', options); // 2. strategy（已配置的实例）
server.auth.default('session');                // 3. default（应用于所有路由）

Scheme authenticate 必须返回包含 credentials 和 artifacts 的 h.authenticated()：

return h.authenticated({
    credentials: { user: { id, name }, scope: ['user'] },
    artifacts: { token }       // 始终包含原始身份验证数据的 artifacts
});

路由验证模式：

server.route({
    method: 'POST',
    path: '/users',
    options: {
        validate: {
            payload: Joi.object({
                name: Joi.string().required(),
                email: Joi.string().email().required()
            })
        }
    },
    handler: (request) => request.payload
});

工作流

1. 创建服务端 - 构造函数选项参见服务端概览
2. 注册插件 - 参见插件和插件结构
3. 配置身份验证 - 参见身份验证 schemes和路由身份验证
4. 验证身份验证 - 定义受保护的路由前，使用 server.inject() 进行测试；参见网络
5. 定义路由 - 参见路由概览和处理程序
6. 添加扩展 - 参见生命周期钩子和预处理程序

Key Patterns

Topic	Reference
Request/response objects	request, response
Response toolkit (h)	toolkit
Sessions (yar)	sessions
Caching & CORS	cache-cors, server cache, catbox-memory engine, catbox-fs engine, catbox-redis engine
Security headers	security
Payload parsing	payload
Decorations & methods	decorations, methods
MIME types (mimos)	mimos
Realms & plugin scoping	realm
Response marshalling	marshal pipeline
File serving (inert)	overview, file handler, directory handler
Basic authentication	basic auth
Error handling (Boom)	boom errors
Error filtering (Bounce)	bounce utility
WebSockets (nes)	overview, subscriptions, client
SSE (sse)	overview, api, subscriptions, session, replay
Startup & shutdown	startup lifecycle
Events	events
Testing (server.inject)	network
TypeScript overview	typescript
TypeScript auth typing	auth-scheme, type-author
JWT authentication	jwt overview, validate function, token API
TypeScript plugins	plugin-scaffold
Views & templates	vision overview, engines, context & layouts