专栏首页mall学习教程Spring Cloud OpenFeign:基于 Ribbon 和 Hystrix 的声明式服务调用

Spring Cloud OpenFeign:基于 Ribbon 和 Hystrix 的声明式服务调用

Spring Cloud OpenFeign 是声明式的服务调用工具,它整合了 Ribbon 和 Hystrix,拥有负载均衡和服务容错功能,本文将对其用法进行详细介绍。

Feign 简介

Feign 是声明式的服务调用工具,我们只需创建一个接口并用注解的方式来配置它,就可以实现对某个服务接口的调用,简化了直接使用 RestTemplate 来调用服务接口的开发量。Feign 具备可插拔的注解支持,同时支持 Feign 注解、JAX-RS 注解及 SpringMvc 注解。当使用 Feign 时,Spring Cloud 集成了 Ribbon 和 Eureka 以提供负载均衡的服务调用及基于 Hystrix 的服务容错保护功能。

创建一个 feign-service 模块

这里我们创建一个 feign-service 模块来演示 feign 的常用功能。

在 pom.xml 中添加相关依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

在 application.yml 中进行配置

server:
  port: 8701
spring:
  application:
    name: feign-service
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8001/eureka/

在启动类上添加@EnableFeignClients 注解来启用 Feign 的客户端功能

@EnableFeignClients
@EnableDiscoveryClient
@SpringBootApplication
public class FeignServiceApplication {

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

}

添加 UserService 接口完成对 user-service 服务的接口绑定

我们通过@FeignClient 注解实现了一个 Feign 客户端,其中的 value 为 user-service 表示这是对 user-service 服务的接口调用客户端。我们可以回想下 user-service 中的 UserController,只需将其改为接口,保留原来的 SpringMvc 注释即可。

/**
 * Created by macro on 2019/9/5.
 */
@FeignClient(value = "user-service")
public interface UserService {
    @PostMapping("/user/create")
    CommonResult create(@RequestBody User user);

    @GetMapping("/user/{id}")
    CommonResult<User> getUser(@PathVariable Long id);

    @GetMapping("/user/getByUsername")
    CommonResult<User> getByUsername(@RequestParam String username);

    @PostMapping("/user/update")
    CommonResult update(@RequestBody User user);

    @PostMapping("/user/delete/{id}")
    CommonResult delete(@PathVariable Long id);
}

添加 UserFeignController 调用 UserService 实现服务调用

/**
 * Created by macro on 2019/8/29.
 */
@RestController
@RequestMapping("/user")
public class UserFeignController {
    @Autowired
    private UserService userService;

    @GetMapping("/{id}")
    public CommonResult getUser(@PathVariable Long id) {
        return userService.getUser(id);
    }

    @GetMapping("/getByUsername")
    public CommonResult getByUsername(@RequestParam String username) {
        return userService.getByUsername(username);
    }

    @PostMapping("/create")
    public CommonResult create(@RequestBody User user) {
        return userService.create(user);
    }

    @PostMapping("/update")
    public CommonResult update(@RequestBody User user) {
        return userService.update(user);
    }

    @PostMapping("/delete/{id}")
    public CommonResult delete(@PathVariable Long id) {
        return userService.delete(id);
    }
}

负载均衡功能演示

  • 启动 eureka-service,两个 user-service,feign-service 服务,启动后注册中心显示如下:
  • 多次调用http://localhost:8701/user/1进行测试,可以发现运行在 8201 和 8202 的 user-service 服务交替打印如下信息:
2019-10-04 15:15:34.829  INFO 9236 --- [nio-8201-exec-5] c.macro.cloud.controller.UserController  : 根据id获取用户信息,用户名称为:macro
2019-10-04 15:15:35.492  INFO 9236 --- [io-8201-exec-10] c.macro.cloud.controller.UserController  : 根据id获取用户信息,用户名称为:macro
2019-10-04 15:15:35.825  INFO 9236 --- [nio-8201-exec-9] c.macro.cloud.controller.UserController  : 根据id获取用户信息,用户名称为:macro

Feign 中的服务降级

Feign 中的服务降级使用起来非常方便,只需要为 Feign 客户端定义的接口添加一个服务降级处理的实现类即可,下面我们为 UserService 接口添加一个服务降级实现类。

添加服务降级实现类 UserFallbackService

需要注意的是它实现了 UserService 接口,并且对接口中的每个实现方法进行了服务降级逻辑的实现。

/**
 * Created by macro on 2019/9/5.
 */
@Component
public class UserFallbackService implements UserService {
    @Override
    public CommonResult create(User user) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult<User> getUser(Long id) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult<User> getByUsername(String username) {
        User defaultUser = new User(-1L, "defaultUser", "123456");
        return new CommonResult<>(defaultUser);
    }

    @Override
    public CommonResult update(User user) {
        return new CommonResult("调用失败,服务被降级",500);
    }

    @Override
    public CommonResult delete(Long id) {
        return new CommonResult("调用失败,服务被降级",500);
    }
}

修改 UserService 接口,设置服务降级处理类为 UserFallbackService

修改@FeignClient 注解中的参数,设置 fallback 为 UserFallbackService.class 即可。

@FeignClient(value = "user-service",fallback = UserFallbackService.class)
public interface UserService {
}

修改 application.yml,开启 Hystrix 功能

feign:
  hystrix:
    enabled: true #在Feign中开启Hystrix

服务降级功能演示

  • 关闭两个 user-service 服务,重新启动 feign-service;
  • 调用http://localhost:8701/user/1进行测试,可以发现返回了服务降级信息。

日志打印功能

Feign 提供了日志打印功能,我们可以通过配置来调整日志级别,从而了解 Feign 中 Http 请求的细节。

日志级别

  • NONE:默认的,不显示任何日志;
  • BASIC:仅记录请求方法、URL、响应状态码及执行时间;
  • HEADERS:除了 BASIC 中定义的信息之外,还有请求和响应的头信息;
  • FULL:除了 HEADERS 中定义的信息之外,还有请求和响应的正文及元数据。

通过配置开启更为详细的日志

我们通过 java 配置来使 Feign 打印最详细的 Http 请求日志信息。

/**
 * Created by macro on 2019/9/5.
 */
@Configuration
public class FeignConfig {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

在 application.yml 中配置需要开启日志的 Feign 客户端

配置 UserService 的日志级别为 debug。

logging:
  level:
    com.macro.cloud.service.UserService: debug

查看日志

调用http://localhost:8701/user/1进行测试,可以看到以下日志。

2019-10-04 15:44:03.248 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] ---> GET http://user-service/user/1 HTTP/1.1
2019-10-04 15:44:03.248 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] ---> END HTTP (0-byte body)
2019-10-04 15:44:03.257 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] <--- HTTP/1.1 200 (9ms)
2019-10-04 15:44:03.257 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] content-type: application/json;charset=UTF-8
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] date: Fri, 04 Oct 2019 07:44:03 GMT
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] transfer-encoding: chunked
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser]
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] {"data":{"id":1,"username":"macro","password":"123456"},"message":"操作成功","code":200}
2019-10-04 15:44:03.258 DEBUG 5204 --- [-user-service-2] com.macro.cloud.service.UserService      : [UserService#getUser] <--- END HTTP (92-byte body)

Feign 的常用配置

Feign 自己的配置

feign:
  hystrix:
    enabled: true #在Feign中开启Hystrix
  compression:
    request:
      enabled: false #是否对请求进行GZIP压缩
      mime-types: text/xml,application/xml,application/json #指定压缩的请求数据类型
      min-request-size: 2048 #超过该大小的请求会被压缩
    response:
      enabled: false #是否对响应进行GZIP压缩
logging:
  level: #修改日志级别
    com.macro.cloud.service.UserService: debug

Feign 中的 Ribbon 配置

在 Feign 中配置 Ribbon 可以直接使用 Ribbon 的配置,具体可以参考Spring Cloud Ribbon:负载均衡的服务调用

Feign 中的 Hystrix 配置

在 Feign 中配置 Hystrix 可以直接使用 Hystrix 的配置,具体可以参考Spring Cloud Hystrix:服务容错保护

使用到的模块

springcloud-learning
├── eureka-server -- eureka注册中心
├── user-service -- 提供User对象CRUD接口的服务
└── feign-service -- feign服务调用测试服务

项目源码地址

https://github.com/macrozheng/springcloud-learning

本文分享自微信公众号 - macrozheng(gh_433697c99b25),作者:梦想de星空

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-10-08

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 你还在代码里做读写分离么,试试这个中间件吧!

    Gaea是小米中国区电商研发部研发的基于MySql协议的数据库中间件,目前在小米商城大陆和海外得到广泛使用,包括订单、社区、活动等多个业务。Gaea支持分库分表...

    macrozheng
  • 我花了10个小时,写出了这篇K8S架构解析!

    互联网技术飞速发展的今天,为了承载请求的高并发和业务的多样性,微服务的架构成了各个公司的标配。

    macrozheng
  • Spring Cloud Consul:服务治理与配置中心

    Consul是HashiCorp公司推出的开源软件,提供了微服务系统中的服务治理、配置中心、控制总线等功能。这些功能中的每一个都可以根据需要单独使用,也可以一起...

    macrozheng
  • 【好资源】《超全数据科学速查工具手册》(附PDF下载)

    今天给大家推荐由墨西哥的作者 Favio Vázquez ,他是物理学家和计算工程师,热爱科学、哲学、编程,研究的是宇宙学和大数据。

    AI算法与图像处理
  • EF大数据批量处理----BulkInsert

    之前做项目的时候,做出来的系统的性能不太好,在框架中使用了EntityFramework,于是就在网上查资料,研究如何提高EF的性能。 在这分享一篇博客 批...

    令仔很忙
  • Nginx反向代理,建立Google镜像

    进入nginx目录,执行git checkout release-1.13.9选定版本 进入ngx_http_google_filter_module目录,执...

    coderhuo
  • 使用Java开发Kubernetes控制器

    Kubernetes Java SDK官方项目最近发布了他们的最新工作成果,为Java Kubernetes开发人员提供了一个方便的Kubernetes控制器-...

    CNCF
  • Android中线程的使用

    版权声明:本文为博主原创文章,转载请标明出处。 https://blog.csdn.net/lyhhj/article/details/47...

    Hankkin
  • Ta 在假笑么?这个识别算法可以鉴定

    场景描述:假笑可能已经成为很多成年人日常生活与工作中必不可少的一个表情,也许是出于礼貌,或因为尴尬,或碍于面子,我们常常需要一个「假笑」来缓解气氛。英国布拉德福...

    HyperAI超神经
  • 微笑不可怕,谁假谁尴尬

    在我们成年人的社交生活所展现的情感中,笑是最常见的一种,每10分钟谈话中,人们平均会笑5次。尽管笑有职业假笑和真诚的笑两种区别,但它仍不失为我们人际交往中最行之...

    AiTechYun

扫码关注云+社区

领取腾讯云代金券