Feign を使用して Java API 開発で HTTP 呼び出しを行う

Feign を使用して Java API 開発で HTTP 呼び出しを行う

Java アプリケーションの開発では、外部サービスからデータを取得したり、リモート API を呼び出したりするために HTTP 呼び出しがよく行われます。現時点では、通常、これらのリクエストを処理するために HTTP クライアント ライブラリを選択する必要があります。この分野では、Feign が間違いなく良い選択です。

Feign は、RESTful API の呼び出しを簡素化するための宣言型 HTTP クライアント ライブラリです。これは、Retrofit の注釈スタイルからインスピレーションを得ています。 Feign を使用すると、開発者は基礎となる HTTP クライアント実装の詳細を知らなくても、HTTP リクエストを簡単に作成できます。

この記事では、Feign を使用して HTTP 呼び出しを行う基本的な使い方といくつかの例を紹介します。始める前に、Feign のライブラリをインポートする必要があります。 Maven プロジェクトでは、pom.xml ファイルに次の依存関係を追加できます。

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
    <version>2.2.2.RELEASE</version>
</dependency>

次に、その使用方法を説明します。

基本的な使用法

まず、リモート サービス インターフェイスを定義する必要があります。このインターフェイスには、呼び出す各 HTTP エンドポイントのメソッドが含まれている必要があります。メソッドごとに、Feign によって提供されるアノテーションを使用して、URL、HTTP メソッド、リクエスト本文、リクエスト ヘッダーなど、送信する HTTP リクエストのさまざまな側面を定義できます。サンプル コードは次のとおりです。

@FeignClient(name = "github", url = "https://api.github.com")
public interface GitHubApiClient {
    @RequestMapping(value = "/users/{username}", method = RequestMethod.GET)
    GitHubUser getUserByName(@PathVariable("username") String username);
}

この例では、Feign クライアント インターフェイス GitHubApiClient を定義します。これは @FeignClient アノテーションを使用して「github」という名前のリモート サービスと対話します。サービスの URL は次のとおりです。 https://api.github.com。インターフェイスには getUserByName メソッドがあります。このメソッドでは、@RequestMapping および @PathVariable アノテーションを使用して、送信する HTTP GET リクエストの URL およびパス パラメーターを指定します。

次に、インターフェイスをコードに挿入し、そのメソッドを呼び出して HTTP リクエストを作成します。サンプル コードは次のとおりです。

@RestController
public class GitHubUserController {
    @Autowired
    private GitHubApiClient gitHubApiClient;

    @GetMapping("/users/{username}")
    public GitHubUser getUserByName(@PathVariable("username") String username) {
        return gitHubApiClient.getUserByName(username);
    }
}

この例では、GitHubApiClient を GitHubUserController に挿入し、このインターフェイスを getUserByName メソッドで使用して GitHub ユーザー情報を取得します。このメソッドは、Feign によって返された応答オブジェクトを返します。この場合、具体的なクラスは GitHubUser です。

カスタマイズされた Feign 構成

Feign の動作をカスタマイズする必要がある場合があります。たとえば、リクエスト インターセプターの追加、タイムアウトの変更、またはログ レベルの変更が必要になる場合があります。この場合、対応する構成を追加して、これらのカスタム動作を実装できます。

Feign を構成するには、Spring Cloud によって提供される @ConfigurationProperties および @Bean アノテーションを使用して構成クラスを定義できます。 Feign の設定例を次に示します。

@ConfigurationProperties("feign.client.config.github")
public class GitHubFeignConfiguration {
    @Bean
    public RequestInterceptor requestInterceptor() {
        return new BasicAuthRequestInterceptor("username", "password");
    }
}

この例では、Feign の BasicAuthRequestInterceptor クラスを使用してリクエスト インターセプターを追加します。さらに、 @ConfigurationProperties アノテーションを使用して、カスタム構成をプロパティ ファイル内のプロパティにマップしました。

この設定を Feign クライアント インターフェイスに接続するには、@Configuration アノテーションと @Import アノテーションを使用する必要があります。サンプル コードは次のとおりです。

@Configuration
@Import({GitHubFeignConfiguration.class})
public class GitHubApiConfiguration {
    @Bean
    public GitHubApiClient gitHubApiClient() {
        return Feign.builder()
                .decoder(new JacksonDecoder())
                .encoder(new JacksonEncoder())
                .contract(new SpringMvcContract())
                .target(GitHubApiClient.class, "https://api.github.com");
    }
}

この例では、Feign のビルダー モードを使用して GitHubApiClient オブジェクトを作成します。 build() メソッドで、返された Feign クライアント オブジェクトのエンコーダー、デコーダー、およびコントラクトを定義します。さらに、GitHubApiClient タイプのターゲット アドレスを https://api.github.com に設定します。

概要

この記事では、Feign クライアント ライブラリの使用方法といくつかの例を紹介しました。 Feign を使用すると、宣言的な方法で HTTP 呼び出しを簡単に行うことができます。日々の開発では、特定のビジネス ニーズに応じて Feign の動作をカスタマイズできます。まだ Feign を開発に使ったことがない方は、より便利で効率的な開発体験を提供できると思いますので、ぜひ試してみてください。

以上がFeign を使用して Java API 開発で HTTP 呼び出しを行うの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。