SpringCloud 微服务应用篇 | （4）Feign远程调用

Feign远程调用

（图片引自黑马程序员）

Feign替代RestTemplate

参考之前使用 RestTemplate 发起远程调用的代码：

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

RestTemplate 方式调用存在的问题：

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

所以我们需要引入 Feign，Feign是一个声明式的 http 客户端，官方地址：https://github.com/OpenFeign/feign，其作用就是帮助我们优雅的实现 http 请求的发送，解决上面提到的问题。

使用Feign的步骤如下：

（1） 引入Feign的依赖

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

（2）在 order-service 的启动类添加注解开启Feign的功能：

@SpringBootApplication	// 开启Feign的功能
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

（3） 编写Feign客户端

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

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

我们可以清楚的发现一些对应属性：

	Feign 客户端	RestTemplate
服务名称	@FeignClient(“userservice”)	userservice
请求方式	@GetMapping	getForObject
请求路径	“/user/{id}”	/user/" + order.getUserId();
请求参数	@PathVariable(“id”) Long id	order.getUserId()
返回值类型	User	User

（4）组合后的 order-service 中的代码是这样的，使用FeignClient中定义的方法代替RestTemplate，风格趋于统一

@Autowired
private UserClient userClient;

public Order queryOrderById(Long orderId) {
    // 1.查询订单
    Order order = orderMapper.findById(orderId);
    // 2. 利用RestTemplate发送http请求，查询用户
    //        String url = "http://userservice:8081/user/" + order.getUserId();
    //        User user = restTemplate.getForObject(url, User.class);
    User user = userClient.findById(order.getUserId());
    // 3.封装User到Order
    order.setUser(user);
    // 4.返回
    return order;
}

自定义配置Feign

Feign运行自定义配置来覆盖默认配置，使用较多的配置如下：

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

以配置日志为例

方式一：配置文件方式

全局生效：

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

局部生效：

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

方式二：java代码方式

需要先声明一个Bean：

public class FeignClientConfig {
    @Bean
    public Logger.Level feignLogLevel() {
        return Logger.Level.BASIC;
    }
}

但是，我们发现这个配置类没有被扫描到，所以我们有对应全局和局部两种方式

全局生效：在启动类中的 @EnableFeignClients 标签中添加 defaultConfiguration = FeignClientConfig.class

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

局部生效：则把它放到@FeignClient这个注解之中

@FeignClient(value = "userservice", configuration = FeignClientConfig.class)
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

总结来说

Feign的日志配置

方式一：配置文件

feign.client.config.xxx.loggerLevel

• 如果xxx是default则代表全局
• 如果xxx是服务名称，例如userservice则代表某服务

方式二：java代码配置

Logger.Level 这个Bean

• 如果在@EnableFeignClients注解声明则代表全局
• 如果在@FeignClient注解中声明则代表某服务

使用优化

Feign底层的客户端实现：

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

Feign的性能主要包括：

• 使用连接池代替默认的URLConnection
• 日志级别，最好用basic或none

Feign的性能优化-连接池配置

引入依赖：

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

配置连接池：

fegin:
  client:
    config:
      default:  # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别
  httpclient:
    enable: true  # 开启feign对HttpClient的支持
    max-connections: 200  # 最大的连接数
    max-connections-per-route: 50   # 每个路径的最大连接数

最佳实践

方式一（继承）：给消费者的 FeignClient 和提供者的 controller 定义统一的父接口作为标准。

缺点：

• 服务紧耦合
• 父接口参数列表中的映射不会被继承

方式二（抽取）：将 FeignClient 抽取为独立模块，并且把接口有关的 POJO 、默认的 Feign 配置都放到这个模块中，提供给所有消费者使用

抽取FeignClient

实现最佳实践方式二的步骤如下：

1. 首先创建一个 module，命名为 feign-api ，然后引入 feign 的starter依赖
2. 将 order-service 中编写的 UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
3. 在 order-service 中引入 feign-api 的依赖
4. 修改 order-service 中的所有与上述三个组件有关的import部分，改成导入 feign-api 中的包
5. 重启测试

当定义的 FeignClient 不在 SpringBootApplication 的扫描包范围时，这些 FeignClient 无法使用。有两种方式解决：

方式一：指定 FeignClient 所在包

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

方式二：指定 FeignClient 字节码

@EnableFeignClients(clients = {UserClient.class})

不在 SpringBootApplication 的扫描包范围时，这些 FeignClient 无法使用。有两种方式解决：

方式一：指定 FeignClient 所在包

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

方式二：指定 FeignClient 字节码

@EnableFeignClients(clients = {UserClient.class})