Spring Cloud OpenFeign 实现服务调用

OpenFeign是什么？

OpenFeign是一个声明式的web服务客户端，让编写web服务客户端变的非常容易，只需要创建一个接口并在接口上添加注解即可，openFeign的前身是Feign，后者目前已经停更了，openFeign是SpringCloud在Feign的基础上支持了Spring MVC的注解，并通过动态代理的方式产生实现类来做负载均衡并进行调用其他服务。

Feign目的就是为了使编写Java Http客户端变的更加容易。使用Ribbon+RestTemplate时，利用了RestTemplate对http请求的封装处理，形成了一套模版化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装-些客户端类来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上面标注一个Feign注解即可，即可完成对服务提供方的接口绑定，简化了使用Spring cloud Ribbon时，自动封装服务调用客户端的开发量。

Ribbon、Feign和OpenFeign

Ribbon

Ribbon 是Netflix开源的基于HTTP和TCP等协议负载均衡组件，可以用来做客户端负载均衡来调用注册中心的服务，但是Ribbon的使用需要代码里面手动调用所需服务。

Feign

Feign是SpringCloud组件中的一个轻量级RESTFul的HTTP服务客户端,内置了Ribbon来做客户端负载均衡去调注册中心的服务，它的使用就是使用Feign的注解定义接口，然后调用这个接口就可以调用注册中心的服务。

Feign使用的是自己的一套注解，本身不支持Spring MVC的注解。

OpenFeign

OpenFeign是Spring Cloud在Feign的基础上支持了Spring MVC的注解,列如@RequestMapping等，OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务。

需要注意，@RequesMapping不能在类名上与@FeignClient同时使用

使用

基本环境

注册中心

已启动了一个Eureka注册中心,地址为本机8080端口,当然，如果是其他注册中心也可以。
服务注册

已经注册了两个服务名为CLOUD-EUREKA-PROVIDE-USERINFO-SERVICE的服务，地址分别为本机8081和8082端口。
提供的服务

提供getUserById和sayHi的接口

@RestController
@RequestMapping("/user")
public class UserAdminController {

 @Autowired
 IUserAdminService userAdminService;

 @Value("${server.port}")
 private String serverPort;

 @GetMapping("/getUserById/{userId}")
 public BaseResponse<UserVO> getUserById(@PathVariable Integer userId){ 
   ...
     return BaseResponse.success(userVO);
 }

 @GetMapping("/sayHi")
 public String sayHi(){
   String number= UUID.randomUUID().toString();
   return "service,port:"+serverPort+",number:"+ number;
 }

}

添加依赖

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

修改yml

因为使用的是Eureka,所以这里需要配置Eureka的注册中心

server:
  port: 80 
spring:
  application:
    name: cloud-eureka-consumer-openfeign-useradmin
eureka:
  client:
    #表示是否将自己注册进EurekaServer默认为true
    register-with-eureka: true
    #是否从EurekaServer抓取已有的注册消息，默认为true，单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8080/eureka/

接口注册

使用openFeign需要先将接口注册了，注册时讲接口和服务绑定好，后面需要调用服务的时候直接调用改接口接口。这里创建了一个service文件夹，并在该文件夹下创建了UserInfoService

@Component
@FeignClient(value = "CLOUD-EUREKA-PROVIDE-USERINFO-SERVICE")
public interface UserInfoService {

    @GetMapping("/user/sayHi")
    String sayHi();

    @GetMapping("/user/getUser/{userId}")
    BaseResponse getUser(@PathVariable("userId") String userId);

}

@FeignClient注解这里指定了CLOUD-EUREKA-PROVIDE-USERINFO-SERVICE服务名称。

下面的接口绑定了服务调用地址
@GetMapping("/user/sayHi")`和`@GetMapping("/user/getUser/{userId}")

服务调用

@RestController
@RequestMapping("/user")
public class UserAdminController {

    @Resource
    UserInfoService userInfoService;

    @GetMapping("/getUser/{userId}")
    public BaseResponse getUser(@PathVariable String userId){
        return userInfoService.getUser(userId);
    } 

    @GetMapping("/sayHi")
    public String sayHi(){
        return userInfoService.sayHi();
    }
}

如果要调用服务的话，我们只需要使用@Resource或者@Autowired注解来引入之前我们添加的注册接口，然后要调用服务的时候，调用该接口即可。

启动OpenFeign

启动OpenFeign需要在启动类上添加@EnableFeignClients注解

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

总结

因为之前学习过Dubbo，当然,Dubbo的服务调用更加简单，不过OpenFeign在Dubbo之前，所以学习到这里感慨颇深，程序员真是个会偷懒，把框架做的越来越方便，使用越来越简单~

参考文献

作者：Martain
来源：https://www.jianshu.com/p/7d45185ae7f1