Spring Cloud-Feign Http客户端

Posted 2023-03-07

• 目录：
• 一、RestTemplate Http客户端
• 二、Feign Http客户端快速入门
• 三、自定义Feign配置
• 四、Feign性能优化

一、RestTemplate Http客户端

由于我们的服务调用都是基于Http协议进行的，所以代码中不得不使用Http相应的客户端来进行服务间沟通。RestTemplate是Spring Web提供的Http客户端，org.springframework.web.client.RestTemplate。

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

使用RestTemplate带来的问题：①代码可读性差；②参数url难维护。

二、Feign Http客户端快速入门

• 1、基础依赖

<!--开启对Feign的支持-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!--配置Feign一起使用-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-loadbalancer</artifactId>
        </dependency>

• 2、@EnableFeignClients注解

Spring Boot启动类上添加@EnableFeignClients注解。

@MapperScan("com.stone.mapper")
@SpringBootApplication
@EnableFeignClients
public class SpringCloudOrderserviceApplication 
    ...

• 3、编写Feign客户端

①编写客户端接口UserClient
②添加@FeignClient(value = "userservice")注解
③编写接口方法@GetMapping("/user/id")
④请求参数Long id
⑤返回值User

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

• 4、使用Feign客户端替代RestTemplate

@Override
    public Order queryOrderById(Long id)
        //1.查询订单
        Order order = orderMapper.findById(id);
        //2.使用Fegin远程调用
        User user = userClient.findById(order.getUserId());
        //3.封装User至Order
        order.setUser(user);
        //4.返回结果
        return order;
    

至此，我们的Feign快速入门的代码就编写完成了。

• 5、Feign报错处理

注意：由于Feign使用的LoadBalancer与Nacos默认使用的Robbin不一致，此时可能会报错。需要在Nacos的依赖项内做对应排除，以解决依赖冲突引发的问题。具体如下：

<!-- nacos客户端依赖包 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <!--避免与Feign负载均衡策略冲突-->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

三、自定义Feign配置

• 1、application.yml配置文件形式

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

• 2、编写配置类

①配置类：

public class LoggerFeignConfiguration 
    @Bean
    public Logger.Level feignLogLevel()
        return Logger.Level.NONE;
    

②@EnableFeignClients注解配置生效

@MapperScan("com.stone.mapper")
@SpringBootApplication
@EnableFeignClients(defaultConfiguration = LoggerFeignConfiguration.class)
public class SpringCloudOrderserviceApplication 
    ...

③@FeignClient注解配置生效

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

注意：application.yml配置优先级优于注解配置。

• 3、Log等级

默认为NONE等级，LOG等级越高信息越详细，但是性能反而下降。建议维持NONE等级，或者仅调整为BASIC等级。
①NONE, No logging (DEFAULT).
②BASIC, Log only the request method and URL and the response status code and execution time.(打印连接和断开信息)
③HEADERS, Log the basic information along with request and response headers.
④FULL, Log the headers, body, and metadata for both requests and responses.

四、Feign性能优化

• 1、日志级别
  使用NONE或者BASIC；
• 2、使用连接池技术
  HttpClient/OKHttp

使用HttpClient实例：
Ⅰ 相关依赖

<!--HttpClient的依赖 -->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>

Ⅱ 配置连接池

其余内容无需调整，即可使用。

虽然Feign比起RestTemplate看起来确实更优雅，但是比起Dubbo的服务调用还是有些逊色

五、结尾

以上即为Feign基础使用的内容