OpenFeign入门

宋冠巡

于 2024-08-26 08:00:00 发布

阅读量453

点赞数 9

分类专栏： OpenFeign 文章标签： OpenFeign SpringCloud SpringBoot Java

本文链接：https://blog.csdn.net/sgx1825192/article/details/141504216

版权

OpenFeign 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

一、OpenFeign介绍

1. 官网

Spring Cloud OpenFeign - Spring官网

在这里插入图片描述

2. 特性：声明式REST客户端

声明式REST客户端：Feign创建了一个用JAX-RS或SpringMVC注释装饰的接口的动态实现

二、OpenFeign入门示例

本示例，基于 Spring Boot 3.3.3

1. 添加依赖

在 Maven 项目中，需要在 pom.xml 文件中添加 OpenFeign 的依赖：

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

截止 2024-08-24，OpenFeign 最新版本为：4.1.3。

在 SpringBoot3 中，OpenFeign 必须指明依赖的版本号，否则会报错。具体原因请参考后面章节《三、OpenFeign 指明依赖版本》

2. 启用 OpenFeign

在 Spring Boot 应用程序中启用 OpenFeign，可以通过在启动类上添加 @EnableFeignClients 注解来实现：

package com.example.hello_feign_client;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@EnableFeignClients
@SpringBootApplication
public class HelloFeignClientApplication {

    public static void main(String[] args) {
        SpringApplication.run(HelloFeignClientApplication.class, args);
    }

}

3. 定义 Feign Client 接口

定义一个接口来代表客户端，并使用 @FeignClient 注解来配置它。例如，假设有一个名为 hello-world 的微服务，你可以这样定义 Feign Client：

package com.example.hello_feign_client.feign;

import com.example.hello_common.model.vo.UserVo;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient(name = "hello-world", url = "http://localhost:8080", path = "/users")
public interface UserFeignClient {

    @GetMapping("/{id}")
    UserVo getUserById(@PathVariable String id);

}

在这个例子中，@FeignClient 注解中的 name 属性指定了要调用的 服务名 。在微服务架构中，通过注册中心（Eureka、Nacos等）和服务名，调用远程服务。

上例中使用 url 属性（绝对值或仅主机名）指定 URL，此时不再通过服务名来调用远程服务，而是直接访问 url 对应的地址。

UserClient 接口中定义的方法用于发起 HTTP GET 请求到 /users/{id} 路径，并且通过 @PathVariable 注解将方法参数绑定到 URL 中的 {id}。

4. 使用 Feign Client

在你的应用程序中，你可以通过注入 Feign Client 接口来使用它。例如：

package com.example.hello_feign_client.web.user.controller;

import com.example.hello_common.model.vo.UserVo;
import com.example.hello_feign_client.feign.UserFeignClient;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/users")
@RequiredArgsConstructor
public class UserController {

    private final UserFeignClient userFeignClient;

    @GetMapping("/{id}")
    public UserVo getUserById(@PathVariable String id) {
        return userFeignClient.getUserById(id);
    }

}