【日常记录-Java】SpringBoot使用Feign请求

Author：赵志乾
Date：2024-08-22
Declaration：All Right Reserved！！！

1. 简介

        在SpringBoot中，使用Feign客户端进行服务间调用是一种非常流行的做法，特别是在微服务架构中。Feign是一个声明式的Web服务客户端，其使得编写Web服务客户端变得非常容易。

2. 步骤

   2.1 添加依赖

        在pom.xml中添加如下依赖：

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

    2.2 启用Feign客户端

        在Spring主类或配置类上添加@EnableFeignClients注解，该注解会告诉SpringBoot去扫描 @FeignClient注解的类，并将它们注册为Spring应用程序上下文中的Bean。默认情况下SpringBoot扫描@EnableFeignClients注解标注类所在的包及其子包，当你的Feign客户端接口不在这些包内时，需要通过basePackages属性明确指定扫描的包路径。

@SpringBootApplication  
@EnableFeignClients(basePackages = "com.yourcompany.feignclients")  
public class YourApplication {  
    public static void main(String[] args) {  
        SpringApplication.run(YourApplication.class, args);  
    }  
}

   2.3 定义Feign客户端

        通过@FeignClient注解来定义Feign客户端，该注解可以指定服务名称（若使用了服务发现组件时，可用于服务发现），还可以配置其他与Feign相关的选项，如请求拦截、错误解码等。当需要向远端服务传递参数时，可以使用与SpringMVC相同的注解来定义参数传递方式，这些注解包括@RequestParam、@PathVariable、@RequestBody、@Header等。

@FeignClient(name = "your-service-name",url="${client.url}")  
public interface YourServiceClient {  
 
    @GetMapping("/some-endpoint")  
    String someMethod(@RequestParam("taskId")String taskId);  
}

  2.4 定义Feign客户端地址

        在application.yml中定义Feign客户端url属性的引用值。

client:
  url: http://localhost:8080/

  2.5 使用Feign客户端

        在SpringBoot应用中的任何地方注入并使用Feign客户端接口。

@Service  
public class MyService {  
  
    @Resource  
    private YourServiceClient yourServiceClient;  
  
    public String someMethod(String taskId)  {  
        return yourServiceClient.someMethod(taskId);  
    }  
}

  2.6 测试

        运行SpringBoot应用，并调用MyService中的方法，查看是否能够正确地从远程服务接收到响应。