SpringCloud第二篇：Feign远程调用

思考：为啥要学Feign呢？

先来看我们以前利用RestTemplate发起远程调用的代码：

String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getFor0bject(url,User.class);

这里就有几个问题：

• 代码可读性差，编程体验不统一
• 参数复杂URL难以维护

而Feign是一个声明式的http客户端。其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题

一、Feign替代RestTemplate步骤

1、引入依赖

我们在order-service服务的pom文件中引入feign的依赖：

    org.springframework.cloud
    spring-cloud-starter-openfeign

2、添加注解

再order-service的启动类加@EnableFeignClients

 3、编写Feign的客户端

在order-service中新建一个接口，内容如下

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息，比如：

• 服务名称：userservice
• 请求方式：GET
• 请求路径：/user/{id}
• 请求参数：Long id
• 返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了

4、测试

修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate：

 5、总结

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

二、自定义配置

Feign可以支持很多自定义配置，如下表所示：

一般来说，我们需要配置的就是日志级别

1、两种配置Feign的方法

方法一：采用配置文件方式

针对单个服务：

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

针对所有服务（default）

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

日志的级别分为四种： 

• NONE：不记录任何日志信息，这是默认值
• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据

方法二：Java代码方式

先声明一个类，然后声明一个Logger.Level的对象

public class DefalutFeignConfiguration {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class) 

三、Feign使用优化

Feign底层发起http请求，依赖于其它的框架。其底层客户端实现包括：

• URLConnection：默认实现，不支持连接池
• Apache HttpClient ：支持连接池
• OKHttp：支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

这里我们用Apache的HttpClient来演示：

1）在order-service的pom文件中引入Apache的HttpClient依赖：

    io.github.openfeign
    feign-httpclient

2）配置连接池

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

总结Feign的优化：

• 日志级别尽量用basic

• 使用HttpClient或OKHttp代替URLConnection

  ① 引入feign-httpClient依赖

  ② 配置文件开启httpClient功能，设置连接池参数

 四、最佳实践

观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

Feign客户端：

 UserController

 我们可以想办法简化代码

1、继承方式

①定义一个API接口，利用定义方法，并基于SpringMVC注解做声明
②Feign客户端和Controller都集成改接口

 

优点：

• 简单
• 实现了代码共享

缺点：

• 服务提供方、服务消费方紧耦合
• 参数列表中的注解映射并不会继承，因此Controller中必须再次声明方法、参数列表、注解

2、抽取方式

Feign的Client抽取为独立模块，并且把接口有关的POJO、默认的Feign配置都放到这个模块中，提供给所有消费者使用。

例如，将UserClient、User、Feign的默认配置都抽取到一个feign-api包中，所有微服务引用该依赖包，即可直接使用

 步骤如下：

1）首先创建一个module，命名为feign-api：

项目结构

 

 2）在 feign-api 中然后引入feign的starter依赖：

    org.springframework.cloud
    spring-cloud-starter-openfeign

3）然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

 4）在order-service中使用 feign-api

       首先，删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口
       在order-service的pom文件中中引入feign-api的依赖

    com.xn2001.feign
    feign-api
    1.0

5）修改order-service中的所有与上述三个组件有关的导包部分，改成导入feign-api中的包

6）解决扫描包问题

指定需要加载的Client接口（推荐！！）

@EnableFeignClients(clients = {UserClient.class})

还有一种方法，指定Feign应该扫描的包：（不推荐）

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")