2021-10-27

Spring Cloud OpenFeign

---

前言

有人说Spring Cloud OpenFeign是一个四不像，又或者说Spring Cloud OpenFeign是Ribbon和Hystrix的集合体，这样的说法其实都有自己的道理，当我们去看Spring Cloud OpenFeign的时候，我们发现Spring Cloud OpenFeign其实就是基于Ribbon和Hystrix的声明式服务调用。
Feign是声明式的服务调用工具，我们只需创建一个接口并用注解的方式来配置它，就可以实现对某个服务接口的调用，简化了直接使用RestTemplate来调用服务接口的开发量。大家应该还记得我们上次就在介绍Ribbon时介绍了RestTemplate，Feign具备可插拔的注解支持，同时支持Feign注解、JAX-RS注解及SpringMvc注解。当使用Feign时，Spring Cloud集成了Ribbon和Eureka以提供负载均衡的服务调用及基于Hystrix的服务容错保护功能。
这样说大家其实就能够明白了，这个Feign其实就是升级版的Ribbon和Hystrix的集合体，那我们用他其实会更加方便。
还有就是Feign提供了日志打印的功能，日志打印能够满足不同级别的打印，效果还是不错的。

---

一、负载均衡

在pom.xml中添加相关依赖，在application.yml中进行配置。

<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>

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注释即可。

@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);
}

@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服务交替打印信息。

二、服务降级

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

@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(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中，我们还需要关注一项功能就是日志打印功能，日志打印功能能够打印日志，我们可以不需要添加其他工具来帮助我们打印日志。
日志记录级别

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

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

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

在application.yml中配置需要开启日志的Feign客户端，比如我们开启一个debug日志级别。

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

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

---

总结

其实当我们需要同时满足负载均衡，日志打印和服务降级的时候，我们最好就使用Feign，这种情况下我们就能更好去设计。本次用到了eureka-server 服务 eureka，user-service 提供User对象CRUD接口的服务，还有就是feign-service 这种feign服务调用测试服务。