Краткий справочник

Koa.js шпаргалка

Быстрый справочник по фреймворку Koa.js: луковая модель middleware, каскад async/await, объект контекста ctx, маршрутизация и обработка ошибок.

· Опубликовано

Koa — выразительный и надежный HTTP-фреймворк промежуточного слоя для Node.js, созданный разработчиками Express.

Базовый сервер и луковая модель middleware (Onion Model)

const Koa = require('koa');
const app = new Koa();

// Middleware логирования (каскадный вызов вперед и назад)
app.use(async (ctx, next) => {
  const start = Date.now();
  await next(); // Передача управления следующему middleware
  const ms = Date.now() - start;
  console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});

// Middleware отправки ответа
app.use(async (ctx) => {
  ctx.body = { message: 'Hello from Koa!' };
});

app.listen(3000, () => console.log('Server running on http://localhost:3000'));

Справочник контекста (ctx)

// Анализ входящего запроса
ctx.method;             // "GET", "POST", etc.
ctx.url;                // Full URL path
ctx.query;              // Parsed query string object
ctx.headers;            // Request headers object
ctx.get('User-Agent');  // Хелпер для чтения заголовков

// Формирование ответа
ctx.status = 200;       // Установка кода статуса HTTP
ctx.body = 'Hello';     // Строка, Buffer, Stream или JSON-объект
ctx.set('X-Custom', 'Value'); // Установка пользовательского заголовка
ctx.type = 'json';      // Краткая запись для Content-Type
ctx.redirect('/login'); // Отправка 302-редиректа

Централизованная обработка ошибок

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    ctx.status = err.status || 500;
    ctx.body = { error: err.message };
    ctx.app.emit('error', err, ctx);
  }
});

app.on('error', (err, ctx) => {
  console.error('Server error:', err);
});

Ссылки и документация

Связанные темы