Feign入门

最新推荐文章于 2024-03-28 14:01:45 发布

超凡脱俗的程序猿

最新推荐文章于 2024-03-28 14:01:45 发布

阅读量220

点赞数

分类专栏： Spring Cloud 文章标签： spring cloud

本文链接：https://blog.csdn.net/m0_54759967/article/details/120427499

版权

Spring Cloud 专栏收录该内容

10 篇文章 0 订阅

订阅专栏

使用的RestTemplate实现REST API调用，代码大致如下：

@GetMapping("/buy/{id}")
public Product order() {
    Product product = restTemplate.getForObject("http://service-product/product/1", Product.class);
    return product;
}

由代码可知，我们是使用拼接字符串的方式构造URL的。但是URL 中往往含有多个参数。这时候我们如果还用这种方式构造URL，那么就会非常痛苦。

1. Feign简介

Feign是Netflix开发的声明式，模板化的HTTP客户端，其灵感来自Retrofit,JAXRS-2.0以及WebSocket.

Feign可帮助我们更加便捷，优雅的调用HTTP API。
在SpringCloud中，使用Feign非常简单——创建一个接口，并在接口上添加一些注解，代码就完成了。
Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。
SpringCloud对Feign进行了增强，使Feign支持了SpringMVC注解，并整合了Ribbon和Eureka，从而让Feign的使用更加方便。

2. 基于Feign的服务调用

（1）引入依赖

在服务消费者 shop_service_order 添加Fegin依赖

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

（2）启动类添加Feign的支持

@SpringBootApplication(scanBasePackages="cn.itcast.order")
@EntityScan("cn.itcast.entity")
@EnableFeignClients
public class OrderApplication {
   public static void main(String[] args) {
     SpringApplication.run(OrderApplication.class, args);
 }
}

通过@EnableFeignClients注解开启Spring Cloud Feign的功能

（3）启动类激活FeignClient

创建一个Feign接口，此接口是在Feign中调用微服务的核心接口在服务消费者 service_order 添加一个 ProductFeginClient 接口

//指定需要调用的微服务名称
@FeignClient(name="service-product")
public interface ProductFeginClient {
//调用的请求路径
@RequestMapping(value = "/product/{id}",method = RequestMethod.GET)
public Product findById(@PathVariable("id") Long id);
}

定义各参数绑定时，@PathVariable、@RequestParam、@RequestHeader等可以指定参数属性，在Feign中绑定参数必须通过value属性来指明具体的参数名，不然会抛出异常
@FeignClient：注解通过name指定需要调用的微服务的名称，用于创建Ribbon的负载均衡器。所以Ribbon会把 service-product 解析为注册中心的服务。

（4）配置请求提供者的调用接口

修改 OrderController ，添加 ProductFeginClient 的自动注入，在order中使用 ProductFeginClient 完成微服务调用

@RestController
@RequestMapping("/order")
public class OrderController {
    @Autowired
    private ProductFeginClient productFeginClient;

    @GetMapping("/buy/{id}")
    public Product order(@PathVariable Long id) {
        return productFeginClient.findById(id);
    }
}

3. Feign和Ribbon的联系

Ribbon是一个基于HTTP和TCP客户端的负载均衡的工具。它可以在客户端配置RibbonServerList（服务端列表），使用 HttpClient 或 RestTemplate 模拟http请求，步骤相当繁琐。

Feign是在Ribbon的基础上进行了一次改进，是一个使用起来更加方便的 HTTP 客户端。采用接口的方式，只需要创建一个接口，然后在上面添加注解即可，将需要调用的其他服务的方法定义成抽象方法即可，不需要自己构建http请求。然后就像是调用自身工程的方法调用，而感觉不到是调用远程方法，使得编写客户端变得非常容易

4. 负载均衡

Feign中本身已经集成了Ribbon依赖和自动配置，因此我们不需要额外引入依赖，也不需要再注册 RestTemplate对象。另外，我们可以去配置Ribbon，可以通过 ribbon.xx 来进行全局配置。也可以通过服务名.ribbon.xx 来对指定服务配置

5. 服务调用Feign高级

从Spring Cloud Edgware开始，Feign支持使用属性自定义Feign。对于一个指定名称的Feign Client（例如该Feign Client的名称为 feignName ），Feign支持如下配置项：

feign:
    client:
        config:
            feignName: ##定义FeginClient的名称
                connectTimeout: 5000 # 相当于Request.Options
                readTimeout: 5000 # 相当于Request.Options
                # 配置Feign的日志级别，相当于代码配置方式中的Logger
                loggerLevel: full
                # Feign的错误解码器，相当于代码配置方式中的ErrorDecoder
                errorDecoder: com.example.SimpleErrorDecoder
                # 配置重试，相当于代码配置方式中的Retryer
                retryer: com.example.SimpleRetryer
                # 配置拦截器，相当于代码配置方式中的RequestInterceptor
                requestInterceptors:
                    - com.example.FooRequestInterceptor
                    - com.example.BarRequestInterceptor
                decode404: false

feignName：FeginClient的名称
connectTimeout ：建立链接的超时时长
readTimeout ：读取超时时长
loggerLevel: Fegin的日志级别
errorDecoder ：Feign的错误解码器
retryer ：配置重试
requestInterceptors ：添加请求拦截器
decode404 ：配置熔断不处理404异常

6. 请求压缩

Spring Cloud Feign 支持对请求和响应进行GZIP压缩，以减少通信过程中的性能损耗。通过下面的参数即可开启请求与响应的压缩功能：

feign:
    compression:
        request:
            enabled: true # 开启请求压缩
        response:
            enabled: true # 开启响应压缩

同时，我们也可以对请求的数据类型，以及触发压缩的大小下限进行设置：

feign:
    compression:
        request:
            enabled: true # 开启请求压缩
            mime-types: text/html,application/xml,application/json # 设置压缩的数据类型
            min-request-size: 2048 # 设置触发压缩的大小下限

7. 日志级别

在开发或者运行阶段往往希望看到Feign请求过程的日志记录，默认情况下Feign的日志是没有开启的。要想用属性配置方式来达到日志效果，只需在 application.yml 中添加如下内容即可：

feign:
    client:
        config:
            shop-service-product:
                loggerLevel: FULL
logging:
    level:
        cn.itcast.order.fegin.ProductFeginClient: debug

logging.level.xx : debug : Feign日志只会对日志级别为debug的做出响应

feign.client.config.shop-service-product.loggerLevel : 配置Feign的日志Feign有四种日志级别：