亲宝软件园·资讯

展开

注解FeignClient的使用

你是猪, 人气:0

注解FeignClient使用规范

首先是对FeignClient里的常用属性

使用FeignClient的原因

无非让一个微服务的接口被另一个服务访问,微服务的一个特点就是业务隔离,那就要尽量的做到数据库隔离,虽 然不是真的隔离,但是要尽量在代码上做隔离。

举例,系统有一个file-server,是系统的公共服务,附件的下载,上传,获取内容等接口实现。对应操作的表是系统附件表。

现在客户的信息里有附,正常是在客户与附件之间做连表查询,将附件信息拿到,但是在微服务里这样子做是不合规的。现在如果进行如下的引用

在controller类里定义的接口方法

//在controller类里定义的接口方法   
@RequestMapping(value = "/add" ,method = RequestMethod.GET)
public Integer add(@RequestParam Integer a, @RequestParam Integer b) {
 ServiceInstance instance = client.getLocalServiceInstance();
 Integer r = a + b;
 logger.info("/add, host:" + instance.getHost() + ", service_id:" + instance.getServiceId() + ", result:" + r);
 return r;
}

使用@FeignClient

@FeignClient("compute-service")
public interface ComputeClient {
    @RequestMapping(method = RequestMethod.GET, value = "/add")
    Integer add(@RequestParam(value = "a") Integer a, @RequestParam(value = "b") Integer b);
}

然后在另一个微服务里的controller层调用

@Autowired
ComputeClient computeClient;
@RequestMapping(value = "/add", method = RequestMethod.GET)
public Integer add() {
    return computeClient.add(10, 20);
}

只能说使用成功了,但是不规范,这是网上随处可见的错误规范,一开始我也是错误的在controll层引用,但是被技术经理叼了,反正就是不合规。

理由很简单,给前端的接口不要重复。如果你这边controller调用原来的服务,不管是哪个微服务的,前端是可以直接访问的,那这样子的意义何在。接口给你调用,是让你用来获取有用的信息来处理,然后返回给前端。

所以应该在server层调用。

规范的使用@FignClient注解

以公共服务中的文件服务和客户业务模块进行服务间的通信为例

在文件服务的api模块里写如下

FeignClient(contextId = "fileService", value = ServicellaneConstants.FTLE_SERNVTCE,fallbackFactory=RenoteFileFallbackFactory.class)
public interface RemoteFileservice {
/**
*上传文件*
* aparam file 文件信息*areturn结果
*/
@PostMapping(value = "/upload",consumes = MediaType.WULTIPART_FORN_DATA_VALUE)
public RcLong uplocad(CRequestParan("module ) String nodole ,ORequestParan("sunceId ) String souneId, OlequestFart(value = "file ") liltigartFile file);

此时在客户业务板块,即客户需要和附件进行相关信息的1对多查询,不能连表查询,那就调用上面的RemoteFileservice ,一开始我在客户模块里写了一个FileController,然后写接口,接口里调用,直接NO。

应该在业务层里调用就好了,用注解@Autowired,将你需要处理的数据获取到并处理好。

接下来看看fallbackFactory,主要是为降级处理就是出错了应该返回什么。

代码仅供参考,可能还会有其它 的写法

//注意FallbackFactory<你注解对应的接口类名>
@component
public class RemoteFileFallbackFactory implements FallbackFactory<RemoteFileService>
private static final Logger log = LoggerFactory.getLogger(RemoteFileFallbackFactory.class);
0verride
public RemoteFileservice create(Throwable throwable){
//打印出错日志
log.error("文件朋务调用失败:{}", throwable.getHessage());return new RemoteFileserviceo
{
Override
public R<Long> upload(String module,String sourceId,MultipartFile file){
return R.fail("上传失败:" + throwable.getMessage(o);
}
0verride
public byte[ ] getFileBytes(Long fileId) { return new byte[0];}
@0verride
public R getURL(Long[] ids) { return R.fail("获取文件URL失败:" + throwable.getHessage());}
@0verride
public R<List<SysFileApivo>> getURL(List<Long> ids) {
return R.fail("获取文件URL失败:" + throwable.getMessage());
}
};

想要怎么用,就动手实践吧

@FeignClient注解使用的常见问题

Feign 是一个声明式的 Web 服务,通过定义一个添加相应注解的接口,即可完成一个 Web 服务的接口。SpringCloud 对 Feign 进行了封装以后,其开始能够支持 Spring MVC 标准注解,同时在 SpringCloud 架构上结合 Eureka 和 Ribbon,还能够支持负载均衡。

既然是一个 Web 服务,必然服务端模块与客户端模块都加入 Feign 依赖以及对接的 api 接口,这是 Feign 服务的基本前提。因此双方引入的 Feign 接口都要保持一致,包括服务地址、入参定义、返回值等。

基本配置

要启用 @FeignClient 接口,首先需要引入 Feign 依赖:

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

在父 pom.xml 里还需要引入 SpringCloud 依赖,这样使用 FeignClient 才有意义。

在启动类上添加启动注解 @EnableFeignClients:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.feign.EnableFeignClients;
 
@SpringBootApplication
@EnableFeignClients
public class FeignDemoApp {
    public static void main(String[] args) {
        SpringApplication.run(FeignDemoApp.class, args);
    }
}

然后定义 Feign 客户端提供的服务接口,示例代码如下:

import org.springframework.cloud.netflix.feign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
 
import com.demo.feign.model.request.FeignDemoDetailRequest;
import com.demo.feign.model.response.FeignDemoDetailResponse;
import com.demo.feign.model.response.FeignDemoListResponse;
@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
 
    @RequestMapping(value="/demo/list", method=RequestMethod.GET)
    public FeignDemoListResponse queryListByCode(@PathVariable("code") String code);
     
    @RequestMapping(value="/demo/detail", method=RequestMethod.POST)
    public FeignDemoDetailResponse queryDetail(@RequestBody FeignDemoDetailRequest request);
}

这里定义的 FeignDemoDetailRequest,FeignDemoDetailResponse 和 FeignDemoListResponse 是定义的实体类,具体就不展示了。

常见问题

Feign 的 maven 依赖报红,或者主启动类上@EnableFeignClients不识别,一直报红,或者 feign 接口注入到控制器报红。

可能的原因及处理方案:

项目 Application 启动时,使用 @Autowired 自动注入的 FeignClient 接口被告知对应的 Bean 无法寻获

***************************
APPLICATION FAILED TO START
***************************
 
Description:
Field feignDemoClient in com.xxx.xxx.service.impl.DemoServiceImpl required a bean of type 'com.xxx.xxx.feign.FeignDemoClient' that could not be found.
The injection point has the following annotations:
    - @org.springframework.beans.factory.annotation.Autowired(required=true)
 
Action:
Consider defining a bean of type 'com.xxx.xxx.feign.FeignDemoClient' in your configuration.
Disconnected from the target VM, address: '127.0.0.1:51645', transport: 'socket'
Process finished with exit code 1

可能的原因及处理方案:

// 开启Feign客户端,指定扫描 FeignClient 接口类所在的包
@EnableFeignClients("com.xxx.xxx.feign")
@SpringBootApplication

正确添加 Feign 依赖,启动类扫描 api 接口所有包路径,但注入接口仍然报红

这种情况现在比较少见,但是在一段时间以前出现比较频繁,主要是在 SpringBoot 2.0 版本后优化了相关逻辑。在 SpringBoot 2.0 之前,如果你的 Feign 接口使用 GetMapping 注解,那么注入该接口都会报红,无法注入。相应的,修改成 RequestMapping 或者 PostMapping 就能注入了。

处理方案:

1、采用合适的注解形式定义 Feign 接口。目前可行的定义方式基本有以下几种:

@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
    
    // 使用RequestMapping指定Get方法,入参单个传入
    @RequestMapping(value="/demo/list", method=RequestMethod.GET)
    public FeignDemoListResponse queryListByCode(@PathVariable("code") String code);
     
    // 使用RequestMapping指定Post方法,传入实体使用注解@RequestBody
    @RequestMapping(value="/demo/detail", method=RequestMethod.POST)
    public FeignDemoDetailResponse queryDetail(@RequestBody FeignDemoDetailRequest request);
    
    // 使用PostMapping,传入实体使用注解@RequestBody
    @PostMapping("/demo/seq")
    public FeignDemoSeqResponse querySeq(@RequestBody FeignDemoSeqRequest request);
}

通过 FeignClient 发起 Get 请求报 405 错误

通过在服务端断点捕获异常可以发现,报 405 错误的直接原因,其实是因为定义为 Get 的 Feign 接口,接收到 Post 方法的调用。但是在调用方调用时大多数也是采用 Get 方法,那么到底是什么原因呢?

暂且预设 Feign 接口的定义如下:

@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
    // 服务方接收到的请求是Post方法,而不是Get方法
    @GetMapping(value="/demo/list")
    public Response queryList(Request request);

实际上,通过断点跟踪接口调用时的调用路径,就会发现 FeignClient 最后是通过 HttpURLConnection 发起的网络连接,在发起的过程中,Connection 会判断自身请求的 body 是否为空。如果 body 不为空,则将 Get 方法转换成 Post 方法。因为 body 形式的数据只能方法 RequestBody 内以流的形式进行传输,而根据 Http 协议 param 形式的数据可以直接放在 URL 上进行传输和获取。

之所以 FeignClient 在网络请求时会出现这种转换,这跟它的初始化规则有关。在项目启动过程中,@FeignClient 直接的类会被初始化一个动态代理的类,并通过一个 RequestTemplate.Factory 的工厂类生成请求模板,具体规则如下:

需要注意的是,@RequestParam 只能用于对单个基本类型参数的注解,不能用来注解一个实体类。使用实体类作为入参出参时,建议还是使用 Post 方法进行请求。

如果在开发中觉得维护以上的对应关系不方便的话,还有另外一种修改方法可供使用,基本原理就是使用 Apache 的 HTTP Client 替换 Feign 原生的 Http Client,替换后 Get 方法也可以用一个实体类作为请求参数而不用担心请求被转换成 Post 方法了。具体修改方式如下:

引入 http client 依赖

<dependency>
    <groupId>org.apache.httpcomponents</groupId>
    <artifactId>httpclient</artifactId><br>    
    <version>4.5.2</version>
</dependency>
<dependency>
    <groupId>com.netflix.feign</groupId>
    <artifactId>feign-httpclient</artifactId>
    <version>8.18.0</version>
</dependency>

开启 Feign 对 httpClient 的设置

feign.httpclient.enabled=true

完成配置修改后,内部就可以使用 Apache 的 http client。Feign 接口的定义是相同的,但是由于 Get 方法支持了自定义实体类,与 Post 有类似的处理方式,因此参数的传输需要我们额外指定其类型,以确保 JSON 序列化与反序列化的正常进行。

这里给出一个示例接口定义:

@FeignClient("spring-boot-feign-demo")
public interface FeignDemoClient {
    @PostMapping(value="/demo/detail", consumes = MediaType.APPLICATION_JSON_VALUE)
    public Response<List<ResultDTO>> query(@RequestBody FeignQueryRequest request, 
                                           @PathVariable("page") Integer page, 
                                           @PathVariable("page_size") Integer pageSize);
}

JSON 反序列化失败

Error while extracting response for type [com.xxx.xxx.feign] and content type [application/json].Can not deserialize instance of java.util.ArrayList out of START_OBJECT token

翻译过来的意思大致就是,Feign 接口的返回值无法通过 application/json 的格式解析出来,也就是调用方返回值的定义就服务方不一致(结构不同)。

处理方案:

确保双方引入的接口 api 完全一致,可通过将接口所在模块打包成 jar 包,双方引用同一个 jar 等方式以保证接口定义一致。

以上为个人经验,希望能给大家一个参考,也希望大家多多支持。

加载全部内容

相关教程
猜你喜欢
用户评论