当前位置:首页 > 技术文章 > 正文内容

Spring Cloud OpenFeign 详细介绍?

zonemu2个月前 (08-11)技术文章28

Spring Cloud OpenFeign是Spring Cloud生态系统中的一个组件主要作用是为开发者提供声名式的REST客户端。可以帮助开发者调用远程的HTTP接口API,通过OpenFeign开发者不需要编写复杂的HTTP客户端请求,可以通过定义接口通过注解的方式来发起HTTP请求。Feign最初是由Netflix公司开发,然后集成到了Spring Cloud中后,作为Spring Cloud Feign或 Spring Cloud OpenFeign出现为开发者提供方便的HTTP调用。

使用步骤

在pom.xml中引入Spring Cloud OpenFeign依赖,如下所示。

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

接下来就是在SpringBoot应用的主启动类上添加@EnableFeignClients注解来启动Feign客户端功能,如下所示。

@SpringBootApplication
@EnableFeignClients
public class FeignApplication {
    public static void main(String[] args) {
        SpringApplication.run(FeignApplication.class, args);
    }
}

然后,定义一个接口类,使用 @FeignClient 注解来声明这是一个 Feign 客户端,如下所示。

@FeignClient(name = "user-service")
public interface UserClient {

    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") Long id);
}

其中,name = "user-service" 表示这个客户端要调用user-service服务,Feign会根据服务名称自动从服务注册中心获取该服务的地址。

在需要调用远程服务的地方,我们可以注入这个客户端调用并且直接调用远程接口实现。如下所示。

@RestController
public class UserController {

    @Autowired
    private UserClient userClient;

    @GetMapping("/feign/user/{id}")
    public User getUserById(@PathVariable("id") Long id) {
        return userClient.getUserById(id);
    }
}

通过这样的方式,就可以非常方便地通过 Feign 来调用远程服务,而不需要自己手动处理 HTTP 请求。

高级特性

熔断器(Hystrix 或 Resilience4j)

在Feign中支持与熔断器集成来实现容错处理,也就是说当当某个远程服务不可用时,通过定义一个 fallback 类来返回默认值,如下所示。

@FeignClient(name = "user-service", fallback = UserClientFallback.class)
public interface UserClient {
    @GetMapping("/users/{id}")
    User getUserById(@PathVariable("id") Long id);
}

然后定义降级类 UserClientFallback

@Component
public class UserClientFallback implements UserClient {
    @Override
    public User getUserById(Long id) {
        return new User();  // 返回一个空用户对象
    }
}

配置自定义的请求拦截器

我们也可以通过实现RequestInterceptor接口来自定义 Feign 请求拦截器,如下所示,可以在请求中添加一个全局的认证Token。

@Component
public class FeignRequestInterceptor implements RequestInterceptor {
    @Override
    public void apply(RequestTemplate template) {
        template.header("Authorization", "Bearer " + getToken());
    }

    private String getToken() {
        // 获取 Token 的逻辑
        return "some-token";
    }
}

日志支持

Feign 提供了对请求和响应日志的支持。可以通过在配置文件中设置日志级别来启用日志功能,如下所示。

logging:
  level:
    com.example.feign.UserClient: DEBUG

可以在代码中通过 Logger.Level 来控制日志的级别

@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

总结

Spring Cloud OpenFeign 是一个非常强大的 HTTP 客户端工具,它简化了微服务之间的服务调用过程,支持了各种高级特性来实现自定义的功能。在微服务架构中通过OpenFeign技术可以简化服务调用的过程,提升了微服务开发的效率。

相关文章

智能停车场管理系统五种收费类型设置

智能停车场管理系统五种收费类型设置  点击智能停车场管理系统收费标准设置图标,出现下图所示对话框,在这个界面里面可以对停车场系统需要使用的收费标准进行个性化设置:共有五种收费类型(标准收费类、通用标准...

Vue3 中,父子组件如何传递参数?(vue父子组件传递数据方法)

在 Vue3 中,组件化开发是非常重要的特征,那么组件之间传值就是开发中常见的需求了。组件之间的传值三种方式:父传子、子传父、非父子组件传值。一、父传子( defineProps )父组件主要通过使用...

「 VUE3 + TS + Vite 」父子组件间如何通信?

组件之间传值,大家都很熟悉,涉及到 VUE3 +TS 好多同学就无从下手了,所以分享这篇文章,希望看完后提起 VUE3+TS 能够不慌不忙。平时使用的函数如:ref、reactive、watch、co...

Vue3快速入门(vue3快速上手)

  1.核心语法  1. 1选项式和组合式的区别  Vue2的API设计是Options(选项)风格的。  Vue3的API设计是Composition(组合)风格的。  Options类型的 API...

Vue2的16种传参通信方式(vue传参数)

前言先直入主题列出有哪些传参方式,下面再通过事例一一讲解。props(父传子)$emit与v-on (子传父)EventBus (兄弟传参).sync与update: (父子双向)v-model (父...

基于Docker构建安装Git/GitLab,以及制作springboot工程镜像

今天给大家分享的是《领先的开源自动化服务器Jenkins的应用实战》之基于Docker安装构建Git/GitLab版本控制与代码云存储的场所;使用Git管理项目,springboot工程制作镜像知识体...