SpringCloud 核心组件Feign远程调用&自定义配置

Posted 2023-04-03 爱吃豆的土豆

目录

1，Feign远程调用

1.1：Feign概述

1.2：Feign替代RestTemplate

        1）：引入依赖

        2）：添加注解

        3）：编写Feign的消费服务，提供服务

        4）：测试

        5）：总结

1.3：自定义配置

1.3.1：配置文件方式

1.3.2：Java代码方式

---

1，Feign远程调用

1.1：Feign概述

Feign是一款Java语言编写的HttpClient绑定器，在Spring Cloud微服务中用于实现微服务之间的声明式调用。Feign 可以定义请求到其他服务的接口，用于微服务间的调用，不用自己再写http请求（eg：使用spring自带的restTemplate或者httpClinents工具构建http请求调用第三方服务接口，在客户端实现，调用此接口就像远程调用其他服务一样，当请求出错时可以调用接口的实现类来返回

Feign是一个声明式的web service客户端，它使得编写web service客户端更为容易。

创建接口，为接口添加注解，即可使用Feign。

Feign可以使用Feign注解或者JAX-RS注解，还支持热插拔的编码器和解码器。

Spring Cloud为Feign添加了Spring MVC的注解支持，并整合了Ribbon和Eureka来为使用Feign时提供负载均衡。

1.2：Feign替代RestTemplate

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

存在下面的问题：

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

•参数复杂URL难以维护

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

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

 

 

        1）：引入依赖

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

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

        2）：添加注解

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

@SpringBootApplication
@EnableDiscoveryClient  //服务发现
@EnableFeignClients  //开启远程调用
public class TestNacosConsumerApplication 
    public static void main(String[] args) 
        SpringApplication.run(TestNacosConsumerApplication.class, args );
    

 

        3）：编写Feign的消费服务，提供服务

消费服务调用提供服务

消费服务Feign接口，用来请求提供服务

service-consumer服务：

编写Controller层调用Feign：

@RestController
@RequestMapping("/feign")
public class TestFeignController 
    @Resource
    private EchoFeign echoFeign;
    @GetMapping("/echo")
    public String echo()
        //调用Feign
        String echo = echoFeign.tudou();
        return "consumer-->"+echo;
    

编写Feign接口：

@FeignClient(value = "service-provider",path = "test")
public interface EchoFeign 
    @GetMapping("/tudou")
    public String tudou() ;

 service-provider服务：

编写Controller层提供被调用：

@RestController
@RequestMapping("/test")
public class EchoController 
    @Resource
    private HttpServletRequest request;
    @Resource
    private PatternProperties patternProperties;
    @GetMapping("/tudou")
    public String tudou() 
        int serverPort = request.getServerPort();
        System.out.println(serverPort);
        return "你好nacos服务，我是爱吃豆的土豆 " + ":" + serverPort;
    

        4）：测试

        访问路径访问消费服务，得到提供服务的结果：http://localhost:8071/feign/echo

 

 

 

        5）：总结

使用Feign的步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

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

1.3：自定义配置

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

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

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

1.3.1：方式一配置文件方式

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

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

 也可以针对所有服务：全局生效

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

而日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。

• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间

• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息

• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

 

1.3.2：方式二Java代码方式

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

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

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class) 

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

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

总结：

Feign的日志配置:

1. 方式一是配置文件， feign.client.config.xxx.loggerLevel ① 如果 xxx 是 default 则代表全局 ② 如果 xxx 是服务名称，例如 userservice 则代表某服务 2. 方式二是 java 代码配置 Logger.Level 这个 Bean ① 如果在 @EnableFeignClients 注解声明则代表全局 ② 如果在 @FeignClient 注解中声明则代表某服务

 

SpringCloud基础组件完结--第七章

SpringCloud基础组件完结（第六章用的是RestTemplate远程调用，现在讲的是OpenFeign远程调用） 第七章 SpringCloud-Hello案例开发-Feign-声明式调用 7.1 Feign声明式调用 准备工作： copy 之前的cloud-consumer-user模块，