すべてのプロパティ
spring_boot_starter_feign が読むすべてのプロパティです。一つを除いてすべてクライアントごとで、spring.feign.client.config.<name>.<key> と書きます。<name> はクライアントの @FeignClient の名前 (またはその contextId) で、default はすべてのクライアントに適用されます。スターターのメタデータ (lib/spring_gen/spring_metadata.json) にも同じ 17 個のキーが列挙されています。
使う理由
クライアントは、サービスと環境によって異なります。URL、タイムアウト、ロギング、クレデンシャルです。プロパティを使えば、ビルドなしでそれらを変えられます。このページはすべてのキーをその型とデフォルトとともに列挙しているため、すべてのページを読まなくても一つを確認できます。
例
# lib/resources/application.yml
catalog:
url: https://api.neon.books
spring:
feign:
client:
decode-slash: true
config:
default:
connect-timeout: 2s
read-timeout: 10s
call-timeout: 15s
logger-level: basic
sensitive-headers: X-Api-Key
default-request-headers:
X-Shop: neon
catalog:
url: ${catalog.url}
dismiss404: true
follow-redirects: false
retryer: catalogRetryer
error-decoder: ShopErrors
request-interceptors:
- requestIds
default-query-parameters:
lang: en
orders:
read-timeout: 30s
event-stream:
reconnect: true
reconnect-delay: 3s
max-attempts: 10
同じ内容を .properties で:
# lib/resources/application.properties
catalog.url=https://api.neon.books
spring.feign.client.decode-slash=true
spring.feign.client.config.default.connect-timeout=2s
spring.feign.client.config.default.read-timeout=10s
spring.feign.client.config.default.call-timeout=15s
spring.feign.client.config.default.logger-level=basic
spring.feign.client.config.default.sensitive-headers=X-Api-Key
spring.feign.client.config.default.default-request-headers.X-Shop=neon
spring.feign.client.config.catalog.url=${catalog.url}
spring.feign.client.config.catalog.dismiss404=true
spring.feign.client.config.catalog.follow-redirects=false
spring.feign.client.config.catalog.retryer=catalogRetryer
spring.feign.client.config.catalog.error-decoder=ShopErrors
spring.feign.client.config.catalog.request-interceptors[0]=requestIds
spring.feign.client.config.catalog.default-query-parameters.lang=en
spring.feign.client.config.orders.read-timeout=30s
spring.feign.client.config.orders.event-stream.reconnect=true
spring.feign.client.config.orders.event-stream.reconnect-delay=3s
spring.feign.client.config.orders.event-stream.max-attempts=10
値の書き方
- 期間:
500ms、10s、1m、ISO 8601 (PT1M)、または単なるミリ秒の数値。read-timeout、connect-timeout、call-timeoutでは0はなしを意味します。Durations を参照してください。 - オン/オフの値 (
dismiss404、follow-redirects、event-stream.reconnect、decode-slash): 大文字小文字を問わずtrue/false、on/off、yes/no、1/0。それ以外の値は、キーを示してアプリケーションを止めます。 - リスト: カンマ区切り (
a,b)、インデックス付き ([0]、[1])、または YAML のリスト。
クライアントごと: spring.feign.client.config
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
url |
String |
なし | @FeignClient(url:) が空のときのベース URL。スキームがなければ http:// が追加される。${...} のプレースホルダーも可。URL のまったくないクライアントは起動を止める。 |
connect-timeout |
Duration |
10s |
default の下でのみ: すべてのクライアントが共有するトランスポートの接続タイムアウト。なしは 0。 |
read-timeout |
Duration |
60s |
レスポンスを、次にボディの 2 つのチャンクの間を待つ最長時間。呼び出し全体の上限ではない。なしは 0。イベントストリームでは、ヘッダーの待機だけ。 |
call-timeout |
Duration |
なし | 一回の呼び出しが全体でかけてよい最長時間: すべての試行、Retryer の待機、応答の待機。0 以下: なし。過ぎてもリトライされることはない。 |
logger-level |
none、basic、headers、full |
none |
各呼び出しのどれだけを、ロガー feign.<Interface> のもとで debug レベルでログに出すか。none: 何も、失敗した接続やリトライも出さない。basic: メソッド、URL、ステータス、時間、失敗、リトライ、再接続。headers: さらにヘッダー。クレデンシャルはマスクされる。full: さらにボディ。 |
dismiss404 |
bool |
false |
404 は例外ではなく null (または ResponseEntity) を返す。void メソッドは引き続き例外を投げる。@FeignClient(dismiss404: true) も同じ。 |
follow-redirects |
bool |
true |
リダイレクトをたどる。false では 3xx の応答はエラー。 |
default-request-headers.<Name> |
List<String> |
なし | インターセプターが実行された後、リクエストがその名前のヘッダーを持たないときに送るヘッダー。default のものとクライアントのものはマージされ、同じ名前ではクライアントのものが優先される。カンマ区切りのリストかインデックス付きのリストで複数の値。 |
default-query-parameters.<name> |
List<String> |
なし | クエリパラメーターについて同じ。クエリを含む URL はログの行と例外のメッセージに出るため、秘密にはヘッダーを選ぶこと。 |
retryer |
String |
なし: リトライしない | クライアントの Retryer: Bean 名、またはちょうど一つの Bean の型に一致するクラス名。Bean より優先される。 |
error-decoder |
String |
DefaultErrorDecoder |
クライアントの ErrorDecoder: Bean 名、またはちょうど一つの Bean の型に一致するクラス名。 |
request-interceptors |
List<String> |
なし | Bean 名またはクラス名で指定する追加の RequestInterceptor の Bean: default のもの、次にクライアントのもの。クライアントがいずれにせよ持つものの後に。 |
sensitive-headers |
List<String> |
なし | headers と full のログが値を *** と示す追加のヘッダー (名前は大文字小文字を問わない): default のもの、次にクライアントのもの。Authorization、Proxy-Authorization、Cookie、Set-Cookie、DPoP は常にマスクされる。 |
event-stream.reconnect |
bool |
true |
EventStream<T> メソッドは、接続が終わると再び接続する。 |
event-stream.reconnect-delay |
Duration |
3s、またはサーバーの retry: |
再び接続する前の待機。 |
event-stream.max-attempts |
int |
上限なし | ストリームがあきらめるまでに、イベントなしで連続して終わってよい接続の数。 |
各キーは spring.feign.client.config.<name>.<key> と書きます。たとえば spring.feign.client.config.catalog.read-timeout=5s です。
spring.feign.client: すべてのクライアント
| キー | 型 | デフォルト | 意味 |
|---|---|---|---|
spring.feign.client.decode-slash |
bool |
true |
false はパス変数の中の / を %2F としてエンコードする。すべてのクライアントに一つの設定。 |
値の組み合わせ方
| 種類 | ルール |
|---|---|
単一の値 (url、タイムアウト、logger-level、dismiss404、follow-redirects、retryer、error-decoder、event-stream.*) |
クライアントのキーが default のものより優先される。@FeignClient(url:) は url より優先される。 |
default-request-headers、default-query-parameters |
マージされる。同じ名前ではクライアントのものが優先される。 |
request-interceptors、sensitive-headers |
足し合わされる: default のもの、次にクライアントのもの。 |
connect-timeout |
default の下でだけ読まれる。 |
他のパッケージから読まれるもの
| キー | パッケージ | 意味 |
|---|---|---|
logging.level.feign |
ロギング | logger-level の行を表示するには debug でなければならない。 |
server.request-timeout |
spring_boot_starter_web | Web のリクエストの期限。それを処理している間に行われた Feign の呼び出しも、それによって制限される。 |
Spring (Java) との対応
キーは Spring Cloud OpenFeign のもので、spring.cloud.openfeign ではなく spring.feign の下にあります。spring.cloud.openfeign.* のキーは起動を止め、新しいキーを示します。call-timeout、sensitive-headers、event-stream.* は追加されたもので、connect-timeout は default の下でだけ読まれます。Spring の decoder、encoder、contract、capabilities、micrometer のキーに対応するものはありません。