Repolode
LianjiaTech

LianjiaTech/retrofit-spring-boot-starter

RetrofitのHTTPインターフェースをSpring管理のBeanにし、リトライ、ログ出力、サーキットブレーカーなどの機能を追加するSpring Boot starterです。

スター
1,916
フォーク
338
未解決の Issue
8
最終コミット
2 か月前

これは何?

retrofit-spring-boot-starterを使うと、@RetrofitClientを付けた通常のJavaインターフェースとしてHTTP APIを定義し、ほかのBeanと同じようにSpringのサービスへ注入できます。リクエストにはRetrofit標準のアノテーションを使用するため、@GET、@POST、@Query、@BodyなどのアノテーションをRetrofitと同じように利用できます。

基本的な連携に加えて、自動レスポンス変換、カスタムコンバーター、メソッド単位のタイムアウト、リクエストのリトライ、インターセプター、サーキットブレーカーとフォールバック、エラーデコーダー、Micrometerメトリクスなどの機能を設定できます。クライアントは自動スキャンすることも、@RetrofitScanで明示的に登録することもできます。

このプロジェクトはSpring Boot 3.xおよび4.xを対象とし、JDK 17以降が必要です。Spring Boot 1.xおよび2.xのプロジェクト向けには、別の2.xブランチが用意されています。

主な機能

  • 01Retrofit標準のアノテーションを使い、JavaインターフェースとしてHTTPクライアントを定義できます。
  • 02Springのコンポーネントスキャンまたは@RetrofitScanによってクライアントを自動登録できます。
  • 03タイムアウト、リトライ、サーキットブレーカーをメソッド単位で設定できます。
  • 04カスタムコンバーター、インターセプター、エラーデコーダーを利用できます。
  • 05MicrometerメトリクスとSpring Boot Actuatorのエンドポイントに対応しています。
  • 06GraalVM Native ImageとAOTビルドに対応しています。

ユースケース

  • リトライやタイムアウトを設定して、Spring BootサービスからサードパーティのREST APIを呼び出す。
  • Spring Bootアプリケーション内で、型安全な内部マイクロサービスクライアントを構築する。
  • 手作業での実装を増やさずに、外部へのHTTP呼び出しへログ出力、メトリクス、サーキットブレーカーを追加する。

クイックスタート

  1. 1

    starter依存関係(retrofit-spring-boot-starter 4.2.1)をpom.xmlに追加します

  2. 2

    @RetrofitClientとRetrofitのHTTPアノテーションを付けたインターフェースを定義します

  3. 3

    @Autowiredを使ってSpringのサービスにインターフェースを注入し、呼び出します

使う前に知っておきたいこと

  • JDK 17以降が必要です。
  • Spring Boot 1.xおよび2.xのプロジェクトでは、starterの別個の2.xブランチを使用する必要があります。

収録されている特集

トピック

よくある質問

retrofit-spring-boot-starter とは?
RetrofitのHTTPインターフェースをSpring管理のBeanにし、リトライ、ログ出力、サーキットブレーカーなどの機能を追加するSpring Boot starterです。 retrofit-spring-boot-starterを使うと、@RetrofitClientを付けた通常のJavaインターフェースとしてHTTP APIを定義し、ほかのBeanと同じようにSpringのサービスへ注入できます。リクエストにはRetrofit標準のアノテーションを使用するため、@GET、@POST、@Query、@BodyなどのアノテーションをRetrofitと同じように利用できます。
retrofit-spring-boot-starter は無料で使えますか?ライセンスは?
retrofit-spring-boot-starter は Apache-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
retrofit-spring-boot-starter は今もメンテナンスされていますか?
半年以内に更新あり。retrofit-spring-boot-starter の最終コミットは 2026年9月14日 です。
retrofit-spring-boot-starter は何に使えますか?
リトライやタイムアウトを設定して、Spring BootサービスからサードパーティのREST APIを呼び出す。 Spring Bootアプリケーション内で、型安全な内部マイクロサービスクライアントを構築する。 手作業での実装を増やさずに、外部へのHTTP呼び出しへログ出力、メトリクス、サーキットブレーカーを追加する。
retrofit-spring-boot-starter のインストール方法は?
starter依存関係(retrofit-spring-boot-starter 4.2.1)をpom.xmlに追加します @RetrofitClientとRetrofitのHTTPアノテーションを付けたインターフェースを定義します @Autowiredを使ってSpringのサービスにインターフェースを注入し、呼び出します
retrofit-spring-boot-starter はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/LianjiaTech/retrofit-spring-boot-starter

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト