SpringCloud之@FeignClient()注解的使用方式

2023-04-05后端2 分钟155 次阅读
AI 摘要salmon-ai

本文详细

一、@FeignClient()的使用

由于SpringCloud采用分布式微服务架构,难免在各个子模块下存在模块方法互相调用的情况。比如A服务要调用B服务的方法;
@FeignClient() 注解就是为了解决这个问题;
@FeignClient() 注解的源码要求它必须在Interface接口上使用( FeignClient注解被@Target(ElementType.TYPE)修饰,表示FeignClient注解的作用目标在接口上)

二、@FeignClient()标签的常用属性

  1. value:服务名(接口提供方的服务名)
  2. name:指定FeignClient的名称,如果项目使用了Ribbon,name属性会作为微服务的名称,用于服务发现
  3. url:url一般用于调试,可以手动指定@FeignClient调用的地址
  4. decode404:当发生http 404错误时,如果该字段位true,会调用decoder进行解码,否则抛出FeignException
  5. configuration:Feign配置类,可以自定义Feign的Encoder、Decoder、LogLevel、Contract
  6. fallback:定义容错的处理类,当调用远程接口失败或超时时,会调用对应接口的容错逻辑,fallback指定的类必须实现@FeignClient标记的接口
  7. fallbackFactory:工厂类,用于生成fallback类示例,通过这个属性我们可以实现每个接口通用的容错逻辑,减少重复的代码
  8. path:定义当前FeignClient的统一前缀
  9. ==此外还要求服务的启动类要有 @EnableFeignClients 注解才能使Fegin生效==

三、@FeignClient()简单样例

定义OAuth2FeignConfig,用于对某些受保护的资源需要对请求校验某些参数,这里我以携带token为例,可不配置

java 复制代码
public class OAuth2FeignConfig implements RequestInterceptor {

    @Override
    public void apply(RequestTemplate template) {
        // 1 我们可以从request的上下文环境里面获取token
        RequestAttributes requestAttributes = RequestContextHolder.getRequestAttributes();
        if (requestAttributes == null) {
            log.info("没有请求的上下文,故无法进行token的传递");
        }
        HttpServletRequest request = ((ServletRequestAttributes) requestAttributes).getRequest();
        // 获取我们请求上下文的头里面的AUTHORIZATION
        String header = request.getHeader(HttpHeaders.AUTHORIZATION);
        if (!StringUtils.isEmpty(header)) {
            template.header(HttpHeaders.AUTHORIZATION, header);
            log.info("本次token传递成功,token的值为:{}", header);
        }
    }
}

定义UserServiceFeign,提供给测试微服务调用

java 复制代码
@FeignClient(name = "member-service", contextId = "userServiceFeign", configuration = OAuth2FeignConfig.class, path = "/users")
public interface UserServiceFeign {

    /**
     * 用于admin-service里面远程调用member-service
     */
    @GetMapping("/basic/users")
    Map<Long, UserDto> getBasicUsers(
            @RequestParam(value = "ids", required = false) List<Long> ids,
            @RequestParam(value = "userName", required = false) String userName,
            @RequestParam(value = "mobile", required = false) String mobile
    );

}

定义接口实现,将UserController实现UserServiceFeign接口,SpringBoot会自动注入到IOC容器

java 复制代码
@RestController
@RequestMapping("/users")
@Api(tags = "会员的控制器")
public class UserController implements UserServiceFeign {   
    /**
     * 用于admin-service 里面远程调用member-service
     *
     * @param ids
     * @return
     */
    @Override
    public Map<Long, UserDto> getBasicUsers(List<Long> ids, String userName, String mobile) {
        return userService.getBasicUsers(ids,  userName,  mobile);
    }
}

定义测试控制器,远程调用用户微服务

java 复制代码
@RestController
@RequestMapping("/test")
@Api(tags = "测试控制器")
public class TestController {

    @Autowired
    private UserServiceFeign userServiceFeign;

    @GetMapping
    public Map<Long, UserDto> getBasicUsers(List<Long> ids, String userName, String mobile) {
        
	return userServiceFeign.getBasicUsers(userIds, userName, mobile);
    }
}

测试,成功获得数据
image.png

觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句