Feign远程调用

Feign远程调用

1. 为什么要使用Feign

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

存在下面的问题：

• 代码可读性差，编程体验不统一

• 参数复杂URL难以维护

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

2. Feign替代RestTemplate

使用步骤如下:

第一步:引入feign的依赖

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

第二步:在启动类添加开启Feign注解: @EnableFeignClients

@SpringBootApplication
@MapperScan("com.suke.shop.order.mapper")
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class,args);
    }

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }

    @Bean
    public IRule randomRule(){
        return new RandomRule();
    }
}

第三步:编写Feign的客户端

@RequestMapping("user")
@FeignClient("userservice")
public interface UserClient {

    @GetMapping("/users/{id}")
    User findById(@PathVariable("id") Integer id);
}

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

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

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

第四步: 替换Service实现类使用RestTemplate远程调用userservice的代码

@Service
public class OrderServiceImpl  implements OrderService {
    @Autowired
    private OrderMapper orderMapper;

    /*@Autowired
    private RestTemplate restTemplate;*/

    @Autowired
    private UserClient userClient;

    @Override
    public Order queryOrderById(Integer oid) {
        //1.查询订单
        Order order = orderMapper.selectById(oid);
        //2.根据userId查询用户
        //String url = "http://localhost:7777/user/users/"+order.getUid();
        /*String url="http://userservice/user/users/"+order.getUid();
        User user = restTemplate.getForObject(url, User.class);*/

        User user = userClient.findById(order.getUid());

        //3.设置user
        order.setUser(user);

        return order;
    }
}

是不是看起来优雅多了。

3. Feign自定义配置

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

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

注意:

一般情况下，默认值就能满足我们使用

3.1 自定义配置

第一种: 配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务：

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

而日志的级别分为四种：

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

也可以针对所有服务：

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

第二种方式: java编码实现

基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

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

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

@EnableFeignClients(defaultConfiguration = MyFeignConfiguration.class) 

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

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

4. Feign使用优化

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

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

• Apache HttpClient ：支持连接池

• OKHttp：支持连接池

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

我们的课件使用HttpClient

第一步: 引入HttpClient依赖

  <!--httpclient-->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

第二步: 配置连接池

在shop-order的application.yml中添加配置：

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

源码分析:

接下来，在FeignClientFactoryBean中的loadBalance方法中打断点：以debug重启shop-order:

我们发现我们使用client是HttpClient

经验:

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

5. Feign 最佳应用

所谓 最佳应用，就是使用过程中总结的经验，最好的一种使用方式。

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

有没有一种办法简化这种重复的代码编写呢？

我们可以将Feign的Client抽取为独立模块，并且把接口默认的Feign配置都放到这个模块中，并且依赖我们common模块,提供给所有消费者使用。

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

步骤:

第一步: 首先创建一个module，命名为feign-api：

第二步: 在feign-api中然后引入feign的starter依赖以及shop-common

  <dependencies>
      <!--OpenFeign -->
      <dependency>
          <groupId>org.springframework.cloud</groupId>
          <artifactId>spring-cloud-starter-openfeign</artifactId>
      </dependency>
      <dependency>
          <groupId>org.example</groupId>
          <artifactId>shop-common</artifactId>
          <version>1.0-SNAPSHOT</version>
      </dependency>
</dependencies>

第三步: 把shop-order中的UserClient的代码拷贝到feign-api模块中

第四步: 在其他服务引入feign-api依赖,并去掉shop-common依赖

 <!--feign-api-->
<dependency>
    <groupId>org.example</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

第五步: 把其他服务器中的XxxClient以及配置类删除,引用feign-api的类

但是我们发现userClient报错:这是因为UserClient现在在com.suke.shop.client.Us包下，

而shop-order的@EnableFeignClients注解是在com.suke.shop.order包下，不在同一个包，无法扫描到UserClient。

解决扫描包问题方案:

1. 指定Feign应该扫描的包：

@EnableFeignClients("com.suke.shop.client")

2. 指定需要加载的Client接口

@EnableFeignClients(clients={UserClient.class})

rClient现在在com.suke.shop.client.Us包下，

而shop-order的@EnableFeignClients注解是在com.suke.shop.order包下，不在同一个包，无法扫描到UserClient。

解决扫描包问题方案:

1. 指定Feign应该扫描的包：

@EnableFeignClients("com.suke.shop.client")

2. 指定需要加载的Client接口

@EnableFeignClients(clients={UserClient.class})