本文へ移動
Senri
リクエストとレスポンス

本文の読み方と上限

c.body()・c.bodyJson()・c.bodyBytes() と c.req.json() など。既定の 1 MiB の上限と、bodyLimit() で上げる方法

import {  } from "@senrijs/senri";

const  = ();

.("/notes", async (, ) => {
    const  = await .<{ : string }>();   // Content-Type に合わせて読む
    return { : . };
});

読み方

書き方結果
c.body()JSON は値、フォームはオブジェクト、テキストは文字列、それ以外は ArrayBuffer
c.bodyJson()Content-Type を見ずに JSON として読む。読めなければ 400
c.bodyBytes()Content-Type を見ずに ArrayBuffer で読む
c.req.json()・text()・formData()・arrayBuffer()Request のメソッドそのまま
c.req.bodyストリームのまま読む
ルートの body のスキーマ確かめた値を c.valid("body") で読む(バリデーション)

c.body() は何度呼んでも同じ結果です。ミドルウェアとハンドラーの両方から読めます。

JSON・バイト列と決めて読む

c.body() は、Content-Type によって返すものの形が変わります。形を決めて読みたいときは、c.bodyJson() か c.bodyBytes() を使います。

.("/notes", async (, ) => {
    const  = await .<{ : string }>();   // Content-Type が何でも JSON として読む
    return { : . };
});

.("/upload", async (, ) => {
    const  = await .();   // いつも ArrayBuffer
    return { : . };
});
  • c.bodyJson() は、壊れた JSON と空の本文を 400 にします。<T> は型を付けるだけで、中身は確かめません。確かめるならルートの body のスキーマを使います
  • 3 つとも、何度呼んでも同じ値を返します。c.body() と c.bodyJson() は、同じリクエストでどちらを先に呼んでも両方読めます

c.req.json() との違い

c.req.json()・c.req.arrayBuffer() は Request のメソッドそのままです。

c.bodyJson()・c.bodyBytes()c.req.json()・c.req.arrayBuffer()
2 回目に呼んだとき1 回目と同じ値エラー(本文はもう読まれている)で 500
壊れた JSON400500
既定の上限(1 MiB)と bodyLimit()効く効く

上限はどちらにも同じに効きます。違うのは、覚えておくかどうかと、エラーの応答です。

署名を確かめてから読む

Webhook の署名のように元のバイト列が要るときは、ミドルウェアで先に c.bodyBytes() を呼びます。そのあとの c.body()・c.bodyJson()・ルートの body のスキーマは、そのバイト列から読みます。

import {  } from "@senrijs/senri";

.("/webhook", async (, ) => {
    const  = await (await .(), ...("x-signature"));
    if (!) throw new (401);
    return ();
});
.("/webhook", async (, ) => {
    const  = await .<{ : string }>();   // 同じバイト列から読む
    return { : . };
});

順番が逆だと読めません。本文を文字列やフォームとして読んだあと(c.body()・c.bodyJson()・スキーマ・c.req.text() など)の c.bodyBytes() は、元のバイト列が残っていないので、code が "body_bytes_after_read" のエラーになります。

既定の上限は 1 MiB

本文を読むときは(c.body()・c.bodyJson()・c.bodyBytes()・c.req.json() など)、既定で 1 MiB までです。超えたら 413 を返します。

  • 本文を読んだときだけ効きます。読まないルートは、大きい本文が来ても変わりません
  • Content-Length が上限より大きければ、中身を読まずに 413 にします。Content-Length のない本文(チャンク転送など)は、読みながら数えます
  • c.req.body をストリームとして読むときも、1 MiB を超えると 413 です
  • ハンドラーが読み取りのエラーを握りつぶしても、応答は 413 になります

ルートの上限を上げる

大きい本文を受けるルートにだけ、bodyLimit({ maxSize }) を付けます。ルートの上限は、既定の 1 MiB を置き換えます(重ねません)。

import {  } from "@senrijs/senri";

.("/import", ({ : 50 * 1024 * 1024 }));   // このルートだけ 50 MiB まで
.("/import", async (, ) => {
    const  = await ..();
    return { : .length };
});
  • 表のルートなら endpoint({ use: [bodyLimit({ maxSize })] }, handler) と書けます(ルートごとに付ける)
  • uploadLimit() と multipart() も、自分の上限で既定を置き換えます

アプリ全体の上限を変える

const  = ({ : 10 * 1024 * 1024 });   // Infinity で上限なし

Content-Length のない本文は、数えるためにストリームで包むので、読むのが少し遅くなります(小さい本文で数十 µs)。Content-Length のある本文は包まないので、速さは変わりません。

サーバー全体の上限

serve(app, { maxRequestBodySize }) は、サーバーが受け取る本文の上限です。超えたら 413 です。省略すると、どのランタイムでも上限なしです(serve() のオプション)。

このページの内容