SpringCloud(二) FeignClient (整理&转发)
SpringCloud跨服务调用
在一个服务里面调用其他服务的接口,有大概以下几种思路:(此处主要整理Nacos 注册中心调用服务)
一、.在前台ajax直接请求接口的绝对路径,通过请求参数和返回体完成请求,但是缺点如果请求的接口服务器地址或者域名更换,需要重新替换代码,还可能造成跨域请求接口
二、.使用springwork自带的RestTemplate或者使用第三方请求工具完成请求,这种方法虽然不会跨域请求,但是请求方的接口地址变化同样也需要改变
三、.如果请求服务和被请求服务都注册在Nacos server上使用Feign请求。
Nacos注册中心原理
@FeignClient()注解就是为了解决这个跨服务调用问题的。
@FeignClient()注解的源码要求它必须在Interface接口上使用。( FeignClient注解被@Target(ElementType.TYPE)修饰,表示FeignClient注解的作用目标在接口上)
@FeignClient标签的常用属性如下
value:服务名,用于服务发现(一般微服务多用)
name: 指定FeignClient的名称,如果项目使用了Ribbon,name属性会作为微服务的名称,用于服务发现
url:url一般用于调试,可以手动指定@FeignClient调用的地址
decode404:当发生http 404错误时,如果该字段位true,会调用decoder进行解码,否则抛出FeignException
configuration:Feign配置类,可以自定义Feign的Encoder、Decoder、LogLevel、Contract
fallback:定义容错的处理类,当调用远程接口失败或超时时,会调用对应接口的容错逻辑,fallback指定的类必须实现@FeignClient标记的接口
fallbackFactory:工厂类,用于生成fallback类示例,通过这个属性我们可以实现每个接口通用的容错逻辑,减少重复的代码
path:定义当前FeignClient的统一前缀
此外还要求服务的启动类要有@EnableRyFeignClients 注解才能使Fegin生效。
示例代码:
/** * 日志服务 * * @author aei */ @FeignClient(contextId = "remoteLogService", value = ServiceNameConstants.SYSTEM_SERVICE, fallbackFactory = RemoteLogFallbackFactory.class) public interface RemoteLogService { /** * 保存系统日志 * * @param sysOperLog 日志实体 * @param source 请求来源 * @return 结果 */ @PostMapping("/operlog") public R<Boolean> saveLog(@RequestBody SysOperLog sysOperLog, @RequestHeader(SecurityConstants.FROM_SOURCE) String source); }
value=“指定映射到的服务名称,服务需要是注册到nacos之类的注册中心”,注册的服务名称取项目配置spring.application.name
fallbackFactory =RemoteUserFallbackFactory.class指定调用远程地址出错时执行的回调。
回调工厂类的示例如下:
/** * 日志服务降级处理 * * @author aei */ @Component public class RemoteLogFallbackFactory implements FallbackFactory<RemoteLogService> { private static final Logger log = LoggerFactory.getLogger(RemoteLogFallbackFactory.class); @Override public RemoteLogService create(Throwable throwable) { log.error("日志服务调用失败:{}", throwable.getMessage()); return new RemoteLogService() { @Override public R<Boolean> saveLog(SysOperLog sysOperLog, String source) { return null; } }; } }
参考学习网址:
SpringCloud微服务使用FeignClient调用跨服务接口
SpringCloud通过@FeignClient()注解定义调用远程服务
备注:以上信息仅个人学习整理,部分内容摘抄优秀博主