mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-09-02 14:53:46 +00:00
139f30e0f1
* Drop the claim that small bodies skip compression There is no size threshold anywhere in the compression path. encoding_type() gates on the content type and Accept-Encoding only, and apply_ranges() compresses whatever body it is given, so a two-byte text/plain response comes back gzipped at 22 bytes. Say what actually happens and leave the decision to the handler. * Compress static file responses behind an opt-in (Fix #2545) apply_ranges() runs the compressor inside the branch it takes when res.body is non-empty. A response served from a file leaves res.body empty and sets content_length_, so it took the other branch, which writes Content-Length and returns; encoding_type() was computed before the split and never consulted on that side. The same bytes handed to set_content() came back gzipped, which left set_mount_point() and Response::set_file_content() as the one path that missed out. Add Server::set_static_file_compression(), off by default so nothing about an existing server changes. When it is on, the file-backed provider is run through the compressor into res.body ahead of the rest of apply_ranges(), so the response is framed the way set_content() already frames one: it keeps its Content-Length, and HEAD still reports the size a GET would return. Ranges are answered from the identity representation, since RFC 9110 applies Range after content coding and slicing a compressed body would mean compressing the whole file first. The ETag carries the coding it belongs to, so a client that cached the compressed form revalidates against its own validator rather than the identity one. Both the ETag and the body take their coding from static_file_encoding(), so the two cannot disagree. Providers registered with set_content_provider() are left alone. zlib buffers until its window fills, so running one through a compressor would hold back writes that a caller expects to reach the peer as they are produced. The compressed bytes stay in memory until the response has been written, so the peak cost scales with requests in flight. set_static_file_compression_max_length() bounds it, defaulting to 4MB. * Add a minimum size for static file compression Compressing a file that already fits in a single 1500-byte MTU does not get it to the client any sooner, and a file of a few bytes comes back larger than it went in once gzip's header and trailer are added. Every other server draws this line: nginx's gzip_min_length, Caddy's minimum_length, IIS's minFileSizeForComp, CloudFront's 1000-byte floor. The note this replaces told callers to decide in the handler. A response served through set_mount_point() has no handler to decide in, so the floor has to live in the server. It defaults to 1400 bytes, the size that fits inside one MTU with room for headers. set_static_file_compression_min_length() moves it, and CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH sets the default at compile time. The empty-file case keeps its own early-out so that a zero floor still cannot turn an empty body into a 20-byte gzip stream. The two bounds now read as a pair, so the documentation says what each one is for: the lower bound is about what is worth compressing, the upper bound about what one request is allowed to cost. Every file under test/www except 1MB.txt is below the default floor, so the tests that need a small file compressed lower it explicitly.
79 lines
4.8 KiB
Markdown
79 lines
4.8 KiB
Markdown
---
|
||
title: "S08. レスポンスを圧縮して返す"
|
||
order: 27
|
||
status: "draft"
|
||
---
|
||
|
||
cpp-httplibは、クライアントが`Accept-Encoding`で対応を表明していれば、レスポンスボディを自動で圧縮してくれます。ハンドラ側で特別なことをする必要はありません。対応しているのはgzip、Brotli、Zstdです。
|
||
|
||
## ビルド時の準備
|
||
|
||
圧縮機能を使うには、`httplib.h`をインクルードする前に対応するマクロを定義しておきます。
|
||
|
||
```cpp
|
||
#define CPPHTTPLIB_ZLIB_SUPPORT // gzip
|
||
#define CPPHTTPLIB_BROTLI_SUPPORT // brotli
|
||
#define CPPHTTPLIB_ZSTD_SUPPORT // zstd
|
||
#include <httplib.h>
|
||
```
|
||
|
||
それぞれ`zlib`、`brotli`、`zstd`をリンクする必要があります。必要な圧縮方式だけ有効にすればOKです。
|
||
|
||
## 使い方
|
||
|
||
```cpp
|
||
svr.Get("/api/data", [](const httplib::Request &req, httplib::Response &res) {
|
||
std::string body = build_large_response();
|
||
res.set_content(body, "application/json");
|
||
});
|
||
```
|
||
|
||
これだけです。クライアントが`Accept-Encoding: gzip`を送ってきていれば、cpp-httplibが自動でgzip圧縮して返します。レスポンスには`Content-Encoding: gzip`と`Vary: Accept-Encoding`が自動で付きます。
|
||
|
||
## 圧縮の優先順位
|
||
|
||
クライアントが複数の方式を受け入れる場合、Brotli → Zstd → gzipの順に選ばれます（ビルドで有効になっている中から）。クライアント側では気にせず、一番効率の良い方式で圧縮されます。
|
||
|
||
## ストリーミングレスポンスも圧縮される
|
||
|
||
`set_chunked_content_provider()`で返すストリーミングレスポンスも、同じように自動で圧縮されます。
|
||
|
||
```cpp
|
||
svr.Get("/events", [](const httplib::Request &req, httplib::Response &res) {
|
||
res.set_chunked_content_provider(
|
||
"text/plain",
|
||
[](size_t offset, httplib::DataSink &sink) {
|
||
// ...
|
||
});
|
||
});
|
||
```
|
||
|
||
## 静的ファイルは明示的に有効にする
|
||
|
||
`set_mount_point()`や`Response::set_file_content()`でファイルをそのまま返す場合、デフォルトでは圧縮されません。有効にするには次を呼びます。
|
||
|
||
```cpp
|
||
svr.set_static_file_compression(true);
|
||
```
|
||
|
||
圧縮の対象になるのは一定のサイズ範囲に収まるファイルだけで、上下どちらの境界も変更できます。
|
||
|
||
```cpp
|
||
svr.set_static_file_compression_min_length(512);
|
||
svr.set_static_file_compression_max_length(1024 * 1024);
|
||
```
|
||
|
||
下限のデフォルトは1400バイトです。1500バイトのMTUに収まるレスポンスは、小さくしたところで到達が速くなるわけではありません。さらに数バイトのファイルは、gzipのヘッダとトレーラがdeflateの削減分を上回るため、かえって大きくなって返ります。
|
||
|
||
上限のデフォルトは4MBで、こちらは理由が違います。リクエストのたびに圧縮が走り、圧縮後のバイト列はレスポンスを書き終えるまでメモリに載るため、ピーク時のコストが同時処理中のリクエスト数に比例するからです。つまり1リクエストあたりのコストを抑えるための値であって、大きいファイルは圧縮しても無駄だという意味ではありません。配信するファイルが分かっていてトラフィックがそれほど多くないなら、引き上げて構いません。
|
||
|
||
どちらの境界も`0`で無効にできます。コンパイル時のデフォルトは`CPPHTTPLIB_STATIC_FILE_COMPRESSION_MIN_LENGTH`と`CPPHTTPLIB_STATIC_FILE_COMPRESSION_MAX_LENGTH`で決まります。
|
||
|
||
圧縮しても`Content-Length`は付いたままなので、`HEAD`は`GET`と同じサイズを返します。細かい挙動として、Rangeリクエストは非圧縮の表現から切り出して返し、`ETag`には`W/"...-gzip"`のように使われた圧縮方式が入ります。
|
||
|
||
なお`set_content_provider()`で登録したコンテンツプロバイダは対象外です。圧縮器を通すと、内部バッファが埋まるまで書き込みが送出されず、ボディを少しずつ生成するプロバイダが止まってしまうためです。生成したボディを圧縮したい場合は`set_chunked_content_provider()`を使ってください。
|
||
|
||
> **Note:** サイズ範囲が効くのは静的ファイルだけです。`set_content()`に渡したボディは、圧縮対象のMIMEタイプでクライアントが受け入れていれば、大きさによらず圧縮されます。数バイトのレスポンスはgzipのヘッダ分だけかえって大きくなるので、避けたい場合はハンドラ側で判断してください。
|
||
|
||
> クライアント側の挙動は[C15. 圧縮を有効にする](../c15-compression)を参照してください。
|