すべてのプロパティ
spring_boot_starter_web が読むすべてのプロパティを、プレフィックスごとにまとめています。各行には、キー、その型と指定できる値、デフォルト、働き、そして詳しく解説するページを示します。
使う理由
スターターのほとんどは、コードではなくプロパティで設定します。このページはそのすべてを列挙した唯一の場所で、すべてのページを読まなくても、キー、そのデフォルト、その単位を確認できます。スターター自身のメタデータ (lib/spring_gen/spring_metadata.json) にも同じ 76 個のキーが列挙されているため、補完機能のあるエディターでも候補に出ます。
例
TLS プロキシの背後にあり、アップロード、セッション、ビルド済みの Web アプリを持つショップのバックエンドの、実際的な設定です。
# lib/resources/application.yml
server:
port: 8080
address: 127.0.0.1
shutdown: graceful
context-path: /shop
max-http-request-body-size: 10MB
connection-timeout: 30s
request-timeout: 15s
max-concurrent-requests: 500
retry-after: 2s
forward-headers-strategy: native
forward-headers:
trusted-proxies: 127.0.0.1,::1
compression:
enabled: true
mime-types: text/html,text/css,text/javascript,application/javascript,application/json,application/problem+json
min-response-size: 2KB
mime-mappings:
wasm: application/wasm
session:
timeout: 30m
max-sessions: 10000
cookie:
name: SHOPSESSION
path: /shop
http-only: true
same-site: lax
websocket:
max-text-message-size: 64KB
max-binary-message-size: 1MB
send-buffer-size-limit: 512KB
send-time-limit: 10s
spring:
main:
register-shutdown-hook: true
lifecycle:
timeout-per-shutdown-phase: 20s
mvc:
log-request-details: false
static-path-pattern: /**
async:
request-timeout: 30m
sse:
heartbeat-interval: 15s
web:
multipart:
enabled: true
max-file-size: 5MB
max-request-size: 20MB
max-part-count: 20
file-size-threshold: 64KB
location: /var/tmp/shop-uploads
resources:
static-locations: file:build/web/
add-mappings: true
spa-fallback: true
directory-index: true
cache:
use-last-modified: true
cachecontrol:
max-age: 1h
cache-public: true
stale-while-revalidate: 1m
chain:
compressed: true
同じ内容を .properties で:
# lib/resources/application.properties
server.port=8080
server.address=127.0.0.1
server.shutdown=graceful
server.context-path=/shop
server.max-http-request-body-size=10MB
server.connection-timeout=30s
server.request-timeout=15s
server.max-concurrent-requests=500
server.retry-after=2s
server.forward-headers-strategy=native
server.forward-headers.trusted-proxies=127.0.0.1,::1
server.compression.enabled=true
server.compression.mime-types=text/html,text/css,text/javascript,application/javascript,application/json,application/problem+json
server.compression.min-response-size=2KB
server.mime-mappings.wasm=application/wasm
server.session.timeout=30m
server.session.max-sessions=10000
server.session.cookie.name=SHOPSESSION
server.session.cookie.path=/shop
server.session.cookie.http-only=true
server.session.cookie.same-site=lax
server.websocket.max-text-message-size=64KB
server.websocket.max-binary-message-size=1MB
server.websocket.send-buffer-size-limit=512KB
server.websocket.send-time-limit=10s
spring.main.register-shutdown-hook=true
spring.lifecycle.timeout-per-shutdown-phase=20s
spring.mvc.log-request-details=false
spring.mvc.static-path-pattern=/**
spring.mvc.async.request-timeout=30m
spring.mvc.sse.heartbeat-interval=15s
spring.web.multipart.enabled=true
spring.web.multipart.max-file-size=5MB
spring.web.multipart.max-request-size=20MB
spring.web.multipart.max-part-count=20
spring.web.multipart.file-size-threshold=64KB
spring.web.multipart.location=/var/tmp/shop-uploads
spring.web.resources.static-locations=file:build/web/
spring.web.resources.add-mappings=true
spring.web.resources.spa-fallback=true
spring.web.resources.directory-index=true
spring.web.resources.cache.use-last-modified=true
spring.web.resources.cache.cachecontrol.max-age=1h
spring.web.resources.cache.cachecontrol.cache-public=true
spring.web.resources.cache.cachecontrol.stale-while-revalidate=1m
spring.web.resources.chain.compressed=true
spring.main.register-shutdown-hook と spring.lifecycle.timeout-per-shutdown-phase はこのスターターではなく spring_boot_dart のものです。サーバーに必要なので例に含めています。
値の書き方
- 期間:
30s、500ms、5m、1h、2d、または ISO 8601 (PT30S)。単位のない数値はミリ秒です。ただし、以下で「単位なしは秒」と記したキーは例外です。Durations を参照してください。
- データサイズ:
512B、8KB、10MB、1GB。単位のない数値はバイトです。データサイズ を参照してください。
-1 は、表にそう書かれている場合「上限なし」を意味します。
- 列挙値は小文字で書きます (
graceful、need、lax)。不明な値は、キーを示すバインド失敗で起動を止めます。
- リストはカンマ区切り (
a,b) か YAML のリストです。優先度の高いソースで指定したリストは、リスト全体を置き換えます。
- マップ (
server.mime-mappings.*) は、すべてのソースからエントリーを集めます。
- 緩い名前:
server.max-http-request-body-size、server.maxHttpRequestBodySize、環境変数 SERVER_MAXHTTPREQUESTBODYSIZE は同じキーです。コマンドラインでは --server.port=9090 です。
- 名前が変わったキー:
server.servlet.* と spring.servlet.multipart.* (Spring Boot の名前) は起動を止め、新しいキー (server.*、spring.web.multipart.*) を示します。
@ConfigurationProperties と Environment を参照してください。
server.*: サーバー
| キー |
型 |
デフォルト |
意味 |
server.port |
int |
8080 |
待ち受けるポート。0 は空いているポートを選び、local.server.port で公開する。使用中のポートは Web server failed to start. Port 8080 was already in use. で起動を失敗させる。→ 組み込みサーバー |
server.address |
String: IP アドレスまたはホスト名 |
すべてのインターフェース。Flutter アプリでは 127.0.0.1 |
待ち受けるアドレス。localhost は 127.0.0.1。ホスト名は起動時に解決される。→ 組み込みサーバー |
server.shutdown |
graceful / immediate |
graceful |
graceful は新しい接続を受け付けず、実行中のリクエストを spring.lifecycle.timeout-per-shutdown-phase の範囲で完了させる。immediate はそれらを切断する。→ シャットダウン |
server.context-path |
String |
なし |
すべてのパスのプレフィックス (/shop)。ルーティングの前に取り除かれ、それ以外のパスは 404 になる。先頭の / がなければ追加され、末尾の / は取り除かれる。→ 組み込みサーバー |
server.max-http-request-body-size |
DataSize、または -1 |
10MB |
これより大きいリクエストボディには、種類にかかわらず 413 で応答する。アップロードには代わりに spring.web.multipart.max-request-size が使われる。-1: 上限なし。→ 組み込みサーバー |
server.connection-timeout |
Duration。0 以下: なし |
60s |
リクエストボディが何も送らないまま 408 になるまでの時間 (その後接続は閉じられる)。アイドル状態の keep-alive 接続を開いておく時間でもある。→ タイムアウト |
server.request-timeout |
Duration。0 以下: なし |
なし |
フィルターとハンドラーが応答を開始するまでの最長時間。超えると 503。リクエストの RequestDeadline。ストリームと WebSocket のハンドシェイクは計測されない。→ タイムアウト |
server.max-concurrent-requests |
int。0 以下: なし |
なし |
一つの isolate が同時に応答するリクエストの最大数。イベントストリームは数えない。それを超えたリクエストは、他のリクエストの後ろで待たされるのではなく、ただちに Retry-After 付きの 503 で応答される。その接続は次の試行のために開いたままになる。→ 過負荷 |
server.max-connections |
int。0 以下: なし |
なし |
一つの isolate が開いたままにする接続の最大数。それより多い間は、数が上限を下回るまで、すべてのリクエストが Retry-After 付きの 503 で応答され、その接続は閉じられる。→ 過負荷 |
server.retry-after |
Duration |
1s |
それらの 503 の Retry-After。秒単位の整数で、最小は 1。→ 過負荷 |
server.mime-mappings.* |
マップ: 拡張子 → メディアタイプ |
空 |
組み込みのものに加えて、拡張子ごとの静的ファイルの Content-Type を追加する。列挙した拡張子が優先される。大文字小文字を区別せずに照合する。例: server.mime-mappings.wasm=application/wasm。→ 組み込みサーバー、静的リソース |
server.ssl.certificate が設定され、server.ssl.enabled が false でない場合に TLS が有効になります。
| キー |
型 |
デフォルト |
意味 |
server.ssl.enabled |
bool |
true |
false は他の server.ssl.* キーを無視し、通常の HTTP にする。→ TLS |
server.ssl.certificate |
String: ファイルパス |
なし |
証明書チェーン (PEM ファイル)。設定すると TLS が有効になる。resources: のロケーションではない。→ TLS |
server.ssl.certificate-private-key |
String: ファイルパス |
なし |
秘密鍵 (PEM ファイル)。certificate とともに必須で、ないと server.ssl.certificate needs server.ssl.certificate-private-key で起動が失敗する。→ TLS |
server.ssl.key-password |
String |
なし |
暗号化された秘密鍵のパスワード。→ TLS |
server.ssl.trust-certificate |
String: ファイルパス |
なし |
クライアント証明書の署名元でなければならない証明書 (PEM ファイル)。client-auth とともに使う。→ TLS |
server.ssl.client-auth |
none / want / need |
none |
クライアントに証明書を求める。want: なくても処理する。need: 証明書のないリクエストは 403 になる。→ TLS |
server.compression.*: gzip
| キー |
型 |
デフォルト |
意味 |
server.compression.enabled |
bool |
false |
gzip を受け付けるクライアントに対し、mime-types の応答のうち min-response-size 以上 (または長さ不明) のものを gzip 圧縮する。部分コンテンツ、Content-Encoding のある応答、強い ETag のある応答は圧縮しない。Vary: Accept-Encoding を追加する。→ レスポンスの圧縮 |
server.compression.mime-types |
メディアタイプの List<String>。text/* も可 |
text/html、text/xml、text/plain、text/css、text/javascript、application/javascript、application/json、application/xml |
圧縮するメディアタイプ。設定するとリストを置き換える。イベントストリームを圧縮するには text/event-stream を追加する。→ レスポンスの圧縮 |
server.compression.min-response-size |
DataSize |
2KB |
圧縮する最小の Content-Length。→ レスポンスの圧縮 |
server.isolates.*: isolate のプール
プールのすべての isolate が、自分の Bean でアプリケーション全体を実行します。count を上げる前に isolate が複数になると変わること を読んでください。
| キー |
型 |
デフォルト |
意味 |
server.isolates.count |
数値、または auto |
1 |
起動時にポートを担当する isolate の数。auto: プロセッサーコアごとに一つ。1: アプリケーション自身の isolate だけ。→ isolate のプール |
server.isolates.drain-timeout |
Duration |
30s |
プールを離れる isolate が、それでも停止されるまでにリクエストを完了させてよい時間。→ isolate のスケーリング |
server.isolates.scaling |
manual / auto |
manual |
サーバーの実行中に isolate の数を変えるもの: IsolateScaler Bean を通したアプリケーションだけか、スケーリングのポリシーもか。→ isolate のスケーリング |
server.isolates.min |
int |
1 |
スケーリングが下げる最小の isolate の数。→ isolate のスケーリング |
server.isolates.max |
int |
未設定: プロセッサーコアの数。count のほうが大きければ count |
スケーリングが上げる最大の isolate の数。1 より大きいと、count: 1 でもサーバーはプール (と IsolateScaler) を持つ。→ isolate のスケーリング |
server.isolates.scale-up-lag |
Duration |
5ms |
デフォルトのポリシーが過負荷とみなす、isolate のイベントループの平均の遅れ。→ isolate のスケーリング |
server.isolates.scale-up-after |
Duration |
5s |
デフォルトのポリシーが isolate を追加するまでに、isolate が遅れていなければならない時間。→ isolate のスケーリング |
server.isolates.scale-down-after |
Duration |
2m |
デフォルトのポリシーが isolate を一つ削除するまでに、isolate が空いていなければならない時間。→ isolate のスケーリング |
server.isolates.cooldown |
Duration |
15s |
スケーリングのステップの後、再びポリシーに尋ねるまでの休止時間。→ isolate のスケーリング |
server.max-concurrent-requests、server.max-connections、server.session.max-sessions は isolate ごとです。
server.session.*: セッション
| キー |
型 |
デフォルト |
意味 |
server.session.timeout |
Duration。単位なしは秒 |
30m |
リクエストがないままセッションが生きる時間。server.session.timeout=90 は 90 秒。→ セッション |
server.session.max-sessions |
int、または -1 |
10000 |
同時に保持するセッションの最大数。上限に達すると、まず期限切れのセッションが削除される。それでもストアが満杯なら、新しいセッションは 503 で拒否され、警告 Session limit 10000 reached: refused a new session (raise server.session.max-sessions) が出る。生きているセッションが押し出されることはない。-1: 上限なし。→ セッション |
server.session.cookie.name |
String |
JSESSIONID |
セッション Cookie の名前。→ セッション |
server.session.cookie.domain |
String |
なし |
Cookie の Domain。なし: Cookie はそれを設定したホストにだけ返される。→ セッション |
server.session.cookie.path |
String |
server.context-path、または / |
Cookie の Path。→ セッション |
server.session.cookie.http-only |
bool |
true |
HttpOnly を送る: スクリプトは Cookie を読めない。→ セッション |
server.session.cookie.secure |
bool |
未設定: リクエストが secure なら secure |
Secure を送る: HTTPS のみ。未設定: HTTPS のリクエストで Secure (server.forward-headers-strategy を設定した TLS プロキシの背後でも)。→ セッション |
server.session.cookie.same-site |
lax / strict / none / unset |
lax |
Cookie の SameSite。unset は送らない。ブラウザーは none に Secure を求める。→ セッション |
server.websocket.*: WebSocket セッション
| キー |
型 |
デフォルト |
意味 |
server.websocket.max-text-message-size |
DataSize、または -1 |
8KB |
セッションが読むテキストメッセージの最大サイズ (UTF-8 のバイト数)。これより大きいとセッションを 1009 で閉じる。→ WebSocket |
server.websocket.max-binary-message-size |
DataSize、または -1 |
8KB |
セッションが読むバイナリメッセージの最大サイズ。これより大きいとセッションを 1009 で閉じる。→ WebSocket |
server.websocket.send-buffer-size-limit |
DataSize、または -1 |
512KB |
遅いクライアントへの送信待ちとして溜められる量 (pong を含む)。超えるとクローズステータス 4500 で接続を切る。→ WebSocket |
server.websocket.send-time-limit |
Duration、または -1 |
10s |
送ったものが出ていくまでにかかってよい時間。超えると 4500 で接続を切る。→ WebSocket |
| キー |
型 |
デフォルト |
意味 |
server.forward-headers-strategy |
none / native / framework |
none |
native と framework (ここでは同じ) は、信頼するプロキシからの Forwarded、または X-Forwarded-Proto、-Host、-Port、-For を適用する: スキーム、ホスト、ポート、クライアントアドレス。→ リバースプロキシの背後で |
server.forward-headers.trusted-proxies |
IP アドレスと CIDR 範囲の List<String> |
127.0.0.0/8、10.0.0.0/8、172.16.0.0/12、192.168.0.0/16、169.254.0.0/16、100.64.0.0/10、::1/128、fc00::/7、fe80::/10 |
転送ヘッダーを信じる相手。設定するとデフォルトのリストを置き換える。不正なエントリーは起動を止める (Not an address or range: ...)。→ リバースプロキシの背後で |
spring.mvc.*: リクエスト、ストリーム、静的パス
| キー |
型 |
デフォルト |
意味 |
spring.mvc.log-request-details |
bool |
false |
ディスパッチャーの debug と trace の行に、パラメーターとヘッダーの値を表示する。クレデンシャルは masked のまま。→ 組み込みサーバー |
spring.mvc.static-path-pattern |
String: パスパターン |
/** |
spring.web.resources.static-locations の静的リソースを配信するパス。/assets/** なら static/app.css を /assets/app.css として配信する。ウェルカムページは /** の場合のみ。→ 静的リソース |
spring.mvc.async.request-timeout |
Duration |
なし |
タイムアウトを指定せずに作った SseEmitter のタイムアウト。その onTimeout コールバックが実行され、その後完了する。Stream の戻り値には使われない。→ サーバー送信イベント、タイムアウト |
spring.mvc.sse.heartbeat-interval |
Duration |
なし |
開いているすべてのイベントストリームに、この間隔でコメント行を送り、プロキシがアイドル状態のストリームを開いたままにするようにする。このスターター独自のキー。→ サーバー送信イベント |
spring.web.multipart.*: アップロード
| キー |
型 |
デフォルト |
意味 |
spring.web.multipart.enabled |
bool |
true |
false: multipart/* のリクエストは解析されず、@RequestPart のパラメーターは 400 で応答する。→ アップロード |
spring.web.multipart.max-file-size |
DataSize、または -1 |
1MB |
アップロードのファイル (または他のパート) の最大サイズ。超えると 413 (MaxUploadSizeExceededException)。→ アップロード |
spring.web.multipart.max-request-size |
DataSize、または -1 |
10MB |
マルチパートリクエスト全体の最大サイズ。超えると 413。アップロードでは server.max-http-request-body-size の代わりになる。→ アップロード |
spring.web.multipart.max-part-count |
int、または -1 |
50 |
マルチパートリクエストのパート (ファイルとフィールド) の最大数。超えると 413。Spring Boot の server.tomcat.max-part-count に当たる。→ アップロード |
spring.web.multipart.file-size-threshold |
DataSize |
0B |
このサイズを超えるファイルは一時ファイルに、小さいものはメモリに置かれる。0B ではすべてのファイルがディスクに置かれる (dart:io がない環境ではメモリ)。→ アップロード |
spring.web.multipart.location |
String: ディレクトリのパス |
システムの一時ディレクトリ |
一時ファイル用のプライベートディレクトリ (0700) を作る場所。ファイルはランダムな名前を持ち、リクエストが終了または失敗すると削除される。→ アップロード |
spring.web.resources.*: 静的リソース
| キー |
型 |
デフォルト |
意味 |
spring.web.resources.static-locations |
resources: と file: のロケーションの List<String> |
resources:static/、resources:public/ |
静的ファイルを順に読む場所。ファイルを持つ最初のロケーションが採用される。resources: は lib/resources/ のフォルダー (埋め込み、1 MB までのファイル)、file: は実行時に読むディレクトリ。ルートの resources: や他のプレフィックスは起動を止める。→ 静的リソース |
spring.web.resources.add-mappings |
bool |
true |
false はデフォルトのマッピングとウェルカムページを無効にする。WebMvcConfigurer.addResourceHandlers のマッピングは残る。→ 静的リソース |
spring.web.resources.spa-fallback |
bool |
false |
ファイルもハンドラーもないパスへのブラウザーの GET または HEAD で、最後のセグメントに拡張子がなく、Accept に text/html があるものは、404 の代わりに index.html を受け取る (.well-known/ の下では決してない)。このスターター独自のキー。→ 静的リソース |
spring.web.resources.directory-index |
bool |
false |
ファイルのないパスで、そのフォルダーに index.html があればそれを返す: /guide と /guide/ は guide/index.html を受け取る。spa-fallback より先に判断される。このスターター独自のキー。→ 静的リソース |
spring.web.resources.chain.compressed |
bool |
false |
受け付けるクライアントには、app.js の隣にある app.js.br (優先) または app.js.gz を、Content-Encoding と Vary: Accept-Encoding 付きで配信する。→ 静的リソース |
spring.web.resources.cache.*
| キー |
型 |
デフォルト |
意味 |
spring.web.resources.cache.period |
Duration。単位なしは秒 |
なし: Cache-Control なし |
Cache-Control: max-age=<seconds>。0 は no-store を送る。cachecontrol.* のキーがあればそれに置き換えられる。→ 静的リソース |
spring.web.resources.cache.use-last-modified |
bool |
true |
Last-Modified を送り、If-Modified-Since に 304 で応答する。→ 静的リソース |
spring.web.resources.cache.cachecontrol.*
これらのキーのどれかが設定されていると、それらが Cache-Control ヘッダーを作り、cache.period は使われません。no-store は no-cache より、no-cache は max-age より優先され、その他のディレクティブはその後に追加されます。真偽値のキーは true のときだけ効果があります。
| キー |
型 |
デフォルト |
意味 |
spring.web.resources.cache.cachecontrol.max-age |
Duration。単位なしは秒 |
なし |
max-age: サーバーに問い合わせずに応答を再利用できる時間。→ 静的リソース |
spring.web.resources.cache.cachecontrol.no-cache |
bool |
なし |
no-cache: サーバーが確認した後にのみ再利用する。→ 静的リソース |
spring.web.resources.cache.cachecontrol.no-store |
bool |
なし |
no-store: 決して保存しない。no-cache と max-age より優先される。→ 静的リソース |
spring.web.resources.cache.cachecontrol.must-revalidate |
bool |
なし |
must-revalidate: 古くなったら、サーバーに問い合わせずには使わない。→ 静的リソース |
spring.web.resources.cache.cachecontrol.no-transform |
bool |
なし |
no-transform: プロキシは内容を変更してはならない。→ 静的リソース |
spring.web.resources.cache.cachecontrol.cache-public |
bool |
なし |
public: 共有キャッシュ (CDN、プロキシ) も応答を保存できる。→ 静的リソース |
spring.web.resources.cache.cachecontrol.cache-private |
bool |
なし |
private: ユーザー自身のキャッシュだけが応答を保存できる。→ 静的リソース |
spring.web.resources.cache.cachecontrol.proxy-revalidate |
bool |
なし |
proxy-revalidate: 共有キャッシュだけに対する must-revalidate。→ 静的リソース |
spring.web.resources.cache.cachecontrol.s-max-age |
Duration。単位なしは秒 |
なし |
s-maxage: 共有キャッシュが応答を保持できる時間。→ 静的リソース |
spring.web.resources.cache.cachecontrol.stale-while-revalidate |
Duration。単位なしは秒 |
なし |
stale-while-revalidate: 新しい応答を取得する間、古い応答を使える時間。→ 静的リソース |
spring.web.resources.cache.cachecontrol.stale-if-error |
Duration。単位なしは秒 |
なし |
stale-if-error: サーバーが失敗したときに古い応答を使える時間。→ 静的リソース |
spring.web.rate-limit.*: レート制限
rules にルールがあるか、enabled が true になるまではオフです。すべてのキーとその型、デフォルトは、専用のページにあります: → レート制限。
| キー |
型 |
デフォルト |
意味 |
spring.web.rate-limit.enabled |
bool |
未設定: rules にルールがあればオン |
リクエストを制限するかどうか。→ レート制限 |
spring.web.rate-limit.rules[n].* |
リスト |
空 |
ルール: path、methods、key、limit、burst、name、on-store-failure。→ レート制限 |
spring.web.rate-limit.store |
memory / primary-isolate / jdbc / procedure / d1 |
アプリケーションが持つもののうち、もっとも具体的なもの |
バケットの置き場所。→ レート制限 |
spring.web.rate-limit.on-store-failure |
deny / allow |
deny |
ストアに到達できないときにリクエストに返るもの: 503、または数えずに通す。 |
spring.web.rate-limit.verify-store |
bool |
true |
起動時に、テーブル、関数、バインディングがあるかをストアに尋ねるかどうか。なければアプリケーションは起動しない。 |
spring.web.rate-limit.trusted-proxies |
アドレスと CIDR の範囲のリスト |
空 |
client-address-header を読むリバースプロキシ。→ レート制限 |
spring.web.debug.*: デバッグ機能
それぞれ、求められたときにだけビルドに入ります。ジェネレーターは、build_runner の実行時に application.yml または application.properties から enabled キーを読みます。
| キー |
型 |
デフォルト |
意味 |
spring.web.debug.qps.enabled |
bool |
false |
true: ビルドは、リクエストを数えるフィルターと RequestRates を持つ。RequestRates は毎秒のリクエスト数をログに出し、Actuator の qps エンドポイントに応答する。なければ、そのコードは一切ない。→ 毎秒のリクエスト数 |
spring.web.debug.qps.log-interval |
Duration |
10s |
ウィンドウの長さ: レートを求めてログに出す頻度。0: 何もログに出さず、ウィンドウは /actuator/qps/now の二回の読み取りの間の時間になる。→ 毎秒のリクエスト数 |
spring.main.* と spring.test.*: サーバーを起動するかどうか
| キー |
型 |
デフォルト |
意味 |
spring.main.web-application-type |
String: none、またはそれ以外 |
未設定: サーバーが起動する |
none (大文字小文字を問わない): Web の Bean と MockMvc は存在するが、サーバーは起動しない。その他の値では起動する。→ 組み込みサーバー |
spring.test.web-environment |
mock / random-port / defined-port / none |
未設定: サーバーが起動する |
自分ではなく、テストサポート (springBootTest、ApplicationContextRunner) が設定する。サーバーを起動するのは random-port (ポート 0) と defined-port (server.port) だけ。→ 組み込みサーバー、テスト |
local.server.*: サーバーが書き込む
| キー |
型 |
デフォルト |
意味 |
local.server.port |
int |
サーバーが待ち受けを始めた時点で設定される |
サーバーが実際に待ち受けているポート (WebServerInitializedEvent にもある)。読むためのもので、設定しても効果はない。→ 組み込みサーバー |
読まれないキー
次の Spring Boot のキーは、ここでは効果がないか、起動を止めます。
| キー |
ここでは |
server.servlet.* (context-path、session.*) |
起動を止める: server.context-path、server.session.* を使う |
spring.servlet.multipart.* |
起動を止める: spring.web.multipart.* を使う |
server.http2.enabled |
読まれない: dart:io は HTTP/1.1 を話す |
server.max-http-request-header-size |
読まれない |
server.ssl.key-store、trust-store、bundle、protocol、ciphers |
読まれない: PEM ファイルのみ |
server.compression.excluded-user-agents |
読まれない |
server.error.*、spring.mvc.problemdetails.enabled |
読まれない: エラーは常に ProblemDetail |
spring.web.cors.* |
読まれない: CORS はコードで設定する (CORS を参照) |
spring.web.resources.chain.enabled、chain.cache、chain.strategy.* |
読まれない |
server.tomcat.*、server.jetty.*、server.undertow.*、server.netty.* |
読まれない |
Spring (Java) との対応
キーは Spring Boot の ServerProperties、WebMvcProperties、MultipartProperties、WebProperties.Resources に従います。重要な違い:
server.servlet.* は server.*、spring.servlet.multipart.* は spring.web.multipart.* です。サーブレットコンテナがないためです。
- 次のキーはこのスターター独自のものです:
server.max-http-request-body-size、server.request-timeout、server.max-concurrent-requests、server.max-connections、server.retry-after、server.isolates.*、spring.web.debug.*、server.forward-headers.trusted-proxies、server.websocket.*、spring.mvc.sse.heartbeat-interval、spring.web.multipart.max-part-count (Boot: server.tomcat.max-part-count)、spring.web.resources.spa-fallback、spring.web.resources.directory-index。
server.connection-timeout は Spring Boot 2.0 にあったキーです (Boot 3 と 4: server.tomcat.connection-timeout)。
spring.web.resources.static-locations は classpath: ではなく resources: と file: を受け取ります。META-INF/resources/ と resources/ はデフォルトに含まれません。
spring.web.multipart.file-size-threshold は 0B で、location はこのスターター独自の一時ディレクトリです。
関連項目