[Spring Cloud] Open Feign 使用

news2024/10/7 12:28:17

✨✨个人主页:沫洺的主页

📚📚系列专栏: 📖 JavaWeb专栏📖 JavaSE专栏 📖 Java基础专栏📖vue3专栏

📖MyBatis专栏📖Spring专栏📖SpringMVC专栏📖SpringBoot专栏

📖Docker专栏📖Reids专栏📖MQ专栏📖SpringCloud专栏

💖💖如果文章对你有所帮助请留下三连✨✨

衔接上篇

🌻什么是Feign

Feign是一个声明式的Web服务客户端，让编写Web服务客户端变的更加容易。只需要创建一个接口并添加注解即可。

🌼Feign能干什么

Feign可以使编写Java Http客户端更容易。之前使用Ribbon+RestTemplate时，形成了一套模板化的调用方法。但是在实际的开发过程中，由于对服务依赖的调用可能不止一处，往往一个接口会被多个地方调用，所以通常会针对每个微服务自行封装一些客户端类来包装这些依赖服务的调用。所以，Feign在此基础上做了进一步封装，使我们只需要创建一个接口并使用注解的方式配置它，就可以完成服务提供方的接口绑定，简化了使用Ribbon时，自动封装服务调用客户端的开发量。Feign集成了Ribbon

🌷Feign和OpenFeign的区别

Feign是Spring Cloud组件中一个轻量级RESTful的HTTP服务客户端，Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign的使用方式是：使用Feign的注解定义接口，调用接口，就可以调用服务注册中心的服务。
OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解，如@RequestMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并且低耦合调用其他服务。

💐OpenFeign使用

在子模块spring-cloud-eureka-b的pom.xml中添加依赖

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

客户端主启动类添加注解@EnableFeignClients

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

写接口使用@FeignClient注解调用a服务,并添加A的抽象方法接口

@FeignClient("a")
public interface AServiceClient {
    @GetMapping("/a/test")
    String test(@RequestParam(value = "name",required = false) String name);
}

通过B应用,使用OpenFeign方式调用a服务

@RestController
public class B {
    @Autowired
    private AServiceClient aServiceClient;

    @GetMapping("use-openfeign")
    public String callAServer(){
        String value = aServiceClient.test("张三");
        return value;
    }
}

运行a,b服务

访问B应用

补充

带参接口

RESTful风格

子模块spring-cloud-eureka-a中A类定义个RESTful格式的方法

@RestController
public class A {
    @GetMapping("/a/test")
    public String test(@RequestParam(value = "name",required = false) String name){
        return "这是A应用返回的接口,参数为: "+name;
    }
    //RESTful格式
    @GetMapping("/a/age/{age}")
    public String age(@PathVariable Integer age){
        return "这是A应用返回的接口,年龄为: "+age;
    }
}

接下来同理B去调用a服务

@FeignClient("a")
public interface AServiceClient {
    @GetMapping("/a/test")
    String test(@RequestParam(value = "name",required = false) String name);

    @GetMapping("/a/age/{age}")
    String age(@PathVariable Integer age);
}

@RestController
public class B {
    @Autowired
    private AServiceClient aServiceClient;

    @GetMapping("use-openfeign")
    public String callAServer(@RequestParam(value = "nickName",required = false) String nickName){
        String value = aServiceClient.test(nickName);
        String value2 = aServiceClient.age(18);
        return value+"---"+value2;
    }
}

原理解释:

@FeignClient("a")
public interface AServiceClient {
    @GetMapping("/a/test")    //使用restTempalte 调用http://a/a/test?name=传过来的参数
    String test(@RequestParam(value = "name",required = false) String name);

    @GetMapping("/a/age/{age}")  //使用restTempalte 调用http://a/a/age/传过来的参数
    String age(@PathVariable Integer age);
}

当启动类上添加@EnableFeignClients注解后,就会去扫SpringIoc中有@FeignClient("a")注解的接口,通过生成代理来调用接口方法,也就是只要调用接口方法,代理就会使用restTemplate调用类似http://a/a/test?name=参数

🌲超时控制

OpenFeign默认请求超时时间1秒，如果要修改需要在客户端添加以下配置

设置feign客户端超时时间(OpenFeign默认支持ribbon)
ribbon:
  #指的是建立连接所用的时间
  ReadTimeout: 5000
  #指的是连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

🌳日志打印

Feign 提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解 Feign 中 Http 请求的细节。说白了就是对Feign接口的调用情况进行监控和输出

日志级别：

NONE：默认的，不显示任何日志；

BASIC：仅记录请求方法、URL、响应状态码及执行时间；

HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息；

FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据。

日志配置类：
@Configuration
public class FeignConfig{
    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}
# 自己的日志级别

logging.level.com.moming=debug
再次访问a,b服务后查看日志信息