#server.compress

• 类型：

type Compress =
  | boolean
  | {
      filter?: (req: IncomingMessage, res: ServerResponse) => boolean;
      level?: number;
    };

• 默认值： true

配置开发和预览服务器是否对静态资源启用 gzip 压缩。

#禁用压缩

如果你需要禁用 gzip 压缩，可以将 compress 设置为 false：

export default {
  server: {
    compress: false,
  },
};

#选项

#filter

• 类型： (req: IncomingMessage, res: ServerResponse) => boolean
• 默认值： undefined
• 版本： >= v1.4.4

一个过滤函数，用于决定 response 是否需要被压缩。

返回 true 表示需要压缩该 response，返回 false 表示跳过压缩。

export default {
  server: {
    compress: {
      filter: (req) => {
        if (req.url?.includes('/foo')) {
          return false;
        }
        return true;
      },
    },
  },
};

#level

• 类型： number
• 默认值：
  • 开发服务器：1 (zlib.constants.Z_BEST_SPEED)
  • 预览服务器：6 (zlib.constants.Z_DEFAULT_COMPRESSION)
• 版本： >= v1.4.4

用于设置应用于响应的 zlib 压缩级别。更高的级别会产生更好的压缩效果，但需要更长时间完成；更低的级别压缩效果较差，但速度更快。该值是一个范围在 0（无压缩）到 9（最大压缩）之间的整数。

Rsbuild 的开发服务器默认采用 zlib.constants.Z_BEST_SPEED 作为压缩级别，这提供了最佳的压缩性能；预览服务器默认将 level 设置为 zlib.constants.Z_DEFAULT_COMPRESSION。

export default {
  server: {
    compress: {
      level: 6,
    },
  },
};

#流式响应

Gzip 压缩可能会缓冲数据，导致流式 HTML 延迟发送。如果需要在响应结束前发送某段内容，可以在 res.write() 后调用 res.flush?.()。

res.setHeader('Content-Type', 'text/html');
res.write('<!doctype html><html><body><p>Loading...</p>');
res.flush?.();

// 数据准备好后继续写入，最后调用 res.end()。

res.flush() 会刷新 gzip 缓冲区，但不会结束响应。它由压缩中间件提供，因此建议使用可选链（?.），以兼容禁用压缩等情况下该方法不存在的场景。

使用 server.setup 时，请在其返回的回调中调用 server.middlewares.use() 注册流式响应处理逻辑，确保压缩中间件先执行。详见中间件执行顺序。