mkdir api-compression
cd api-compression
npm init -y
npm install express compression winston

📋 Copiar

// server.js

// Importa os módulos essenciais para nossa aplicação
const express = require('express');
const compression = require('compression'); // Módulo para compressão HTTP
const winston = require('winston'); // Módulo para logging profissional
const path = require('path'); // Módulo nativo do Node.js para lidar com caminhos de arquivos
// Configuração do logger com Winston para registrar eventos da aplicação
const logger = winston.createLogger({
  level: 'info', // Define o nível mínimo de log a ser exibido
  format: winston.format.combine( // Combina diferentes formatos para o log
    winston.format.timestamp(), // Adiciona um timestamp a cada log
    winston.format.json() // Formata o log como JSON para facilitar a análise
  ),
  transports: [
    // Define onde os logs serão armazenados ou exibidos
    new winston.transports.File({ filename: 'error.log', level: 'error' }), // Logs de erro vão para 'error.log'
    new winston.transports.File({ filename: 'combined.log' }), // Todos os logs vão para 'combined.log'
    new winston.transports.Console({ // Exibe logs no console durante o desenvolvimento
        format: winston.format.combine(
            winston.format.colorize(), // Adiciona cores aos logs no console
            winston.format.simple() // Formato simples para console
        )
    })
  ],
});
// Cria uma instância da aplicação Express
const app = express();
const PORT = process.env.PORT || 3000; // Define a porta, usando a variável de ambiente ou 3000 como padrão
// --- Aplicação da Compressão HTTP ---
// Melhores práticas: Usar o middleware de compressão ANTES das suas rotas.
// Isso garante que todas as respostas geradas pelas rotas passem pelo processo de compressão.
// O middleware 'compression()' irá automaticamente verificar o cabeçalho 'Accept-Encoding'
// da requisição e comprimir a resposta usando Gzip (padrão) se o cliente suportar.
app.use(compression({
    // Opções de configuração para o middleware de compressão:
    // filter: Uma função que determina se uma resposta deve ser comprimida.
    // Aqui, comprimimos apenas se o cabeçalho 'Content-Type' incluir 'text' ou 'json'.
    // Isso evita comprimir dados que já são compactados (como imagens ou vídeos).
    filter: (req, res) => {
        if (req.headers['x-no-compression']) {
            // Se o cliente enviar um cabeçalho 'x-no-compression', desabilitamos a compressão.
            // Útil para depuração ou cenários específicos.
            return false;
        }
        // Comprime apenas se o tipo de conteúdo é 'text' ou 'json'.
        // Evita comprimir arquivos binários que já são compactados.
        return compression.filter(req, res);
    },
    // level: Define o nível de compressão (0 a 9). 9 é o máximo (mais compressão, mais CPU).
    // O padrão é -1 (usa a velocidade padrão de zlib, que é um bom equilíbrio).
    // Para a maioria dos casos, o padrão é suficiente. Para esta aula, vamos definir um nível explícito.
    level: 6, // Um nível intermediário que oferece boa compressão sem uso excessivo de CPU.
    // threshold: O tamanho mínimo em bytes da resposta para que a compressão seja aplicada.
    // Respostas menores que 1KB não são comprimidas, pois o overhead pode ser maior que o benefício.
    threshold: 1024 // 1KB
}));
// --- Rotas da API ---
// Rota de exemplo que retorna uma grande quantidade de dados JSON.
// Esta rota é um caso de uso ideal para testar a compressão.
app.get('/api/produtos', (req, res) => {
  logger.info('Requisição recebida para /api/produtos');
  const produtos = [];
  // Gera 1000 produtos fictícios para simular um grande payload de dados.
  for (let i = 0; i < 1000; i++) {
    produtos.push({
      id: i + 1,
      nome: Produto ${i + 1},
      descricao: Esta é a descrição detalhada do Produto ${i + 1}. Contém informações relevantes e especificações técnicas que tornam o texto longo e repetitivo, ideal para demonstrar a eficácia da compressão. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.,
      preco: (Math.random()  100).toFixed(2),
      categoria: Categoria ${(i % 5) + 1},
      estoque: Math.floor(Math.random()  500)
    });
  }
  // Envia os produtos como uma resposta JSON.
  // Graças ao middleware compression, esta resposta será comprimida se o cliente suportar.
  res.json(produtos);
  logger.info('Resposta enviada para /api/produtos');
});
// Rota de exemplo com um payload pequeno, para demonstrar que a compressão não será aplicada
// devido ao threshold configurado.
app.get('/api/status', (req, res) => {
    logger.info('Requisição recebida para /api/status');
    const status = {
        uptime: process.uptime(),
        message: 'Serviço online e operacional.'
    };
    res.json(status);
    logger.info('Resposta enviada para /api/status');
});
// --- Middleware de Tratamento de Erros ---
// Este middleware captura erros que ocorrem em qualquer parte da sua aplicação.
// É uma boa prática tê-lo no final da cadeia de middlewares.
app.use((err, req, res, next) => {
  logger.error(Erro inesperado: ${err.message}, { stack: err.stack }); // Registra o erro detalhadamente
  if (res.headersSent) {
    // Se os cabeçalhos já foram enviados, delegue ao manipulador de erro padrão do Express
    return next(err);
  }
  // Envia uma resposta de erro padrão para o cliente
  res.status(500).json({
    message: 'Ocorreu um erro interno no servidor.',
    error: process.env.NODE_ENV === 'production' ? {} : err.message // Em produção, não expõe detalhes do erro
  });
});
// --- Início do Servidor ---
// Inicia o servidor Express na porta especificada.
app.listen(PORT, () => {
  logger.info(Servidor Express rodando na porta ${PORT});
  logger.info(Acesse http://localhost:${PORT}/api/produtos para testar a compressão.);
  logger.info(Acesse http://localhost:${PORT}/api/status para testar a compressão com payload pequeno.);
});

📋 Copiar

node server.js

📋 Copiar

    // ... código inicial ...

    app.get('/api/dados-criticos', compression(), (req, res) => {
      // Retorna dados que só precisam de compressão aqui
      res.json({ / dados grandes / });
    });

    // ... outras rotas sem compressão por padrão ...

// server.js - Solução do Exercício

const express = require('express');
const compression = require('compression');
const winston = require('winston');
const path = require('path');
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.json()
  ),
  transports: [
    new winston.transports.File({ filename: 'error.log', level: 'error' }),
    new winston.transports.File({ filename: 'combined.log' }),
    new winston.transports.Console({
        format: winston.format.combine(
            winston.format.colorize(),
            winston.format.simple()
        )
    })
  ],
});
const app = express();
const PORT = process.env.PORT || 3000;
// --- Configuração atualizada da Compressão HTTP ---
app.use(compression({
    filter: (req, res) => {
        if (req.headers['x-no-compression']) {
            return false;
        }
        return compression.filter(req, res);
    },
    // Desafio: Threshold de 2KB e nível de compressão 4
    threshold: 2048, // 2KB
    level: 4 // Nível de compressão moderado
}));
// --- Rotas da API ---
app.get('/api/produtos', (req, res) => {
  logger.info('Requisição recebida para /api/produtos');
  const produtos = [];
  for (let i = 0; i < 1000; i++) {
    produtos.push({
      id: i + 1,
      nome: Produto ${i + 1},
      descricao: Esta é a descrição detalhada do Produto ${i + 1}. Contém informações relevantes e especificações técnicas que tornam o texto longo e repetitivo, ideal para demonstrar a eficácia da compressão. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.,
      preco: (Math.random()  100).toFixed(2),
      categoria: Categoria ${(i % 5) + 1},
      estoque: Math.floor(Math.random()  500)
    });
  }
  res.json(produtos);
  logger.info('Resposta enviada para /api/produtos');
});

// --- Nova Rota para o Desafio: /api/usuarios ---
app.get('/api/usuarios', (req, res) => {
    logger.info('Requisição recebida para /api/usuarios'); // Log de início da rota
    const usuarios = [];
    for (let i = 0; i < 500; i++) {
        usuarios.push({
            id: i + 1,
            nome: Usuário Teste ${i + 1} da Silva Sauro com Nome Composto Longo para Teste,
            email: usuario.${i + 1}@example.com,
            endereco: Rua da Programação, ${i + 1}, Bairro da Otimização, Cidade do Código, Estado da Compressão - CEP: ${10000 + i}
        });
    }
    res.json(usuarios);
    logger.info('Resposta enviada para /api/usuarios'); // Log de fim da rota
});
app.get('/api/status', (req, res) => {
    logger.info('Requisição recebida para /api/status');
    const status = {
        uptime: process.uptime(),
        message: 'Serviço online e operacional.'
    };
    res.json(status);
    logger.info('Resposta enviada para /api/status');
});
// --- Middleware de Tratamento de Erros ---
app.use((err, req, res, next) => {
  logger.error(Erro inesperado: ${err.message}, { stack: err.stack });
  if (res.headersSent) {
    return next(err);
  }
  res.status(500).json({
    message: 'Ocorreu um erro interno no servidor.',
    error: process.env.NODE_ENV === 'production' ? {} : err.message
  });
});
// --- Início do Servidor ---
app.listen(PORT, () => {
  logger.info(Servidor Express rodando na porta ${PORT});
  logger.info(Acesse http://localhost:${PORT}/api/produtos para testar a compressão.);
  logger.info(Acesse http://localhost:${PORT}/api/usuarios para testar a nova rota com compressão.);
  logger.info(Acesse http://localhost:${PORT}/api/status para testar sem compressão (payload pequeno).);
});

🚀 Pronto para a próxima aula?

Continue sua jornada no desenvolvimento de APIs e domine Node.js & Express!

📚 Ver todas as aulas