Spring との違い
spring_boot_starter_feign は Spring Cloud OpenFeign に従っています。同じアノテーション、マッピングのアノテーション、プロパティのキー、例外、Retryer.Default、インターセプターです。このページでは、そうでない箇所とその理由を列挙します。
使う理由
Spring のクライアントを移植するとき、動作が期待どおりでない箇所を知る必要があります。違いのほとんどは、Dart (非同期の HTTP、リフレクションがない) と、Spring Cloud のインフラストラクチャー (サービスディスカバリー、ロードバランシング、サーキットブレーカー) がここには存在しないことから来ています。
例
@FeignClient('catalog', url: r'${catalog.url}')
abstract interface class CatalogClient {
@GetMapping('/books/{isbn}')
Future<Book> find(@PathVariable() String isbn);
}
@EnableFeignClients
@SpringBootApplication
class ShopApplication {}
@FeignClient(name = "catalog", url = "${catalog.url}")
interface CatalogClient {
@GetMapping("/books/{isbn}")
Book find(@PathVariable String isbn);
}
セットアップと設定
| Spring Cloud OpenFeign |
ここでは |
理由 |
@EnableFeignClients |
不要 |
スターターだけで足りる。 |
spring.cloud.openfeign.* |
spring.feign.*。古い名前は起動を止める |
Spring Cloud は Dart では意味を持たない。 |
| 名前によるサービスディスカバリーとロードバランシング |
すべてのクライアントに URL が必要 |
ディスカバリーのクライアントがない。 |
クライアントごとの connect-timeout |
default の下でのみ |
共有の一つのトランスポート。 |
| 試行ごとの接続と読み取りのタイムアウトだけ |
call-timeout と呼び出し元の RequestDeadline が呼び出し全体を制限する |
呼び出しはそのリクエストより長く生き残るべきではない。 |
retryer、error-decoder、request-interceptors は Spring が生成するクラスを指定する |
Bean 名、またはちょうど一つの Bean に一致するクラス名で、Bean を指定する |
リフレクションがない。 |
| 子コンテキストの中の構成クラス |
他のクライアントから遠ざけられた普通の @Configuration() の Bean。クライアントごとなのは Retryer、ErrorDecoder、RequestInterceptor だけ |
Dart はリフレクションでクラスを生成できない。 |
<contextId>FeignClient の別名 |
なし。primary と qualifiers はジェネレーターが読む |
|
リクエスト
| Feign |
ここでは |
理由 |
| 同期的なメソッド |
Future、または EventStream<T> |
Dart では HTTP は非同期。 |
Accept は produces のときだけ送られる |
デフォルトで Accept: application/json (ストリームでは text/event-stream) |
ほとんどの API は JSON。 |
クエリパラメーターの空白は %20 |
+ として (フォームのエンコーディング) |
|
@PathVariable の値 . や .. はそのまま送られる |
ArgumentError |
Dart の Uri はそうしたセグメントを取り除くため、呼び出しが別のパスに行ってしまう。 |
| メソッドごとに一つのクエリマップと一つのヘッダーマップ |
複数の Map パラメーターが許される |
|
| リトライ時、インターセプターは同じテンプレートの上で再び実行される |
各リトライは新しいテンプレートから始まる |
ヘッダーの値が積み重なってしまう。 |
feign-form の @FormProperty |
ObjectMapper の名前 (@JsonProperty)。ネストしたオブジェクトは EncodeException で失敗する |
|
| ストリーミングのマルチパート |
メモリ上で組み立てられる。単なる値のリストは項目ごとに一つのテキストのフィールド |
|
| ストリーミングなし |
EventStream<T> と再接続によるサーバー送信イベント |
|
エラー、フォールバック、ログ
| Spring Cloud OpenFeign |
ここでは |
サーキットブレーカーを通したフォールバック、FallbackFactory |
フォールバックは、リトライの後に、404 も含めてすべての失敗に応答する。サーキットブレーカーも FallbackFactory もまだない。 |
| Feign のロガーは何もマスクしない |
Authorization、Proxy-Authorization、Cookie、Set-Cookie、DPoP、sensitive-headers はマスクされる。 |
| インターフェースの修飾名にちなんだロガー |
feign.<Interface>。 |
まだ対応していないもの
@SpringQueryMap。
- その他のレスポンスボディのストリーミング (ダウンロード) とストリーミングのアップロード。
FallbackFactory とサーキットブレーカー。
- クライアントごとの
Decoder、Encoder、Contract、Client、Logger.Level の Bean。
関連項目