close
logologo
指南
配置
插件
API
社区
版本
更新日志
Rsbuild 0.x 文档
English
简体中文
指南
配置
插件
API
社区
更新日志
Rsbuild 0.x 文档
English
简体中文
logologo
Overview
root
mode
plugins
logLevel
environments

dev

dev.assetPrefix
dev.browserLogs
dev.cliShortcuts
dev.client
dev.hmr
dev.lazyCompilation
dev.liveReload
dev.progressBar
dev.setupMiddlewares
dev.watchFiles
dev.writeToDisk

resolve

resolve.aliasStrategy
resolve.alias
resolve.conditionNames
resolve.dedupe
resolve.extensions
resolve.mainFields

source

source.assetsInclude
source.decorators
source.define
source.entry
source.exclude
source.include
source.preEntry
source.transformImport
source.tsconfigPath

output

output.assetPrefix
output.charset
output.cleanDistPath
output.copy
output.cssModules
output.dataUriLimit
output.distPath
output.emitAssets
output.emitCss
output.externals
output.filenameHash
output.filename
output.injectStyles
output.inlineScripts
output.inlineStyles
output.legalComments
output.manifest
output.minify
output.module
output.overrideBrowserslist
output.polyfill
output.sourceMap
output.target

html

html.appIcon
html.crossorigin
html.favicon
html.inject
html.meta
html.mountId
html.outputStructure
html.scriptLoading
html.tags
html.templateParameters
html.template
html.title

server

server.base
server.compress
server.cors
server.headers
server.historyApiFallback
server.host
server.htmlFallback
server.https
server.middlewareMode
server.open
server.port
server.printUrls
server.proxy
server.publicDir
server.strictPort

security

security.nonce
security.sri

tools

tools.bundlerChain
tools.cssExtract
tools.cssLoader
tools.htmlPlugin
tools.lightningcssLoader
tools.postcss
tools.rspack
tools.styleLoader
tools.swc

performance

performance.buildCache
performance.bundleAnalyze
performance.chunkSplit
performance.dnsPrefetch
performance.preconnect
performance.prefetch
performance.preload
performance.printFileSize
performance.profile
performance.removeConsole
performance.removeMomentLocale

moduleFederation

moduleFederation.options
📝 在 GitHub 上编辑此页
上一页server.base
下一页server.cors

#server.compress

  • 类型:
type Compress =
  | boolean
  | {
      filter?: (req: IncomingMessage, res: ServerResponse) => boolean;
    };
  • 默认值: true

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

#禁用压缩

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

rsbuild.config.ts
export default {
  server: {
    compress: false,
  },
};

#选项

#filter

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

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

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

rsbuild.config.ts
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。

rsbuild.config.ts
export default {
  server: {
    compress: {
      level: 6,
    },
  },
};
TIP

在实际生产环境中,通常会使用 Nginx 或 Apache 等 Web 服务器,它们可能使用不同的压缩级别,因此你可能会发现本地环境中使用 gzip 压缩后的文件大小与生产环境存在差异。