介绍
Feign是一个远程调用组件,HTTP客户端,集成了ribbon和hystrix。把Rest的请求进行隐藏,伪装成类似SpringMVC的Controller一样。不用再自己拼接url,拼接参数等等操作,一切都交给Feign去做。
依赖文件
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
注解
启动类增加@EnableFeignClients
Feign的客户端
@FeignClient(value = "spring-provider") // 标注该类是一个feign接口
public interface ProviderOpenfeign {
@GetMapping("/sms/provider/{id}")
String provider(@PathVariable("id") String id);
}
-
这是一个接口,Feign会通过动态代理,帮我们生成实现类。这点跟mybatis的mapper很像;
-
@FeignClient
,声明这是一个Feign客户端,类似@Mapper
注解。同时通过value
属性指定服务名称,也可用name; -
接口中定义的方法,完全采用SpringMVC的注解,Feign会根据注解帮我们生成URL,并访问获取结果;
-
一个服务只能被一个类绑定,不能让多个类绑定同一个远程服务,否则,会在启动项目是出现『已绑定』异常。
-
如果有多个feign接口,并且都过网关gateway,需加contextId(自定义)加以区别,如:
@FeignClient(name = "server-gateway",path = "server-product",contextId = "server-product")
public interface ProductFeign {
}
@FeignClient(name = "fiserver-gateway", path = "server-order",contextId = "server-order")
public interface CartFeign {
}
说明:
- 方法的返回值、参数以及requestmapping路径要和提供方的一模一样和消费方无关,消费方只需要调用该方法得到结果;
- 如果服务方controller类有@RequestMapping 定义命名空间,provider,在这里我们建议在方法上面拼接,不能在ProviderOpenfeign接口上去定义@requestMapping("/provider/");
- @PathVariable("id") 这个括号里面的id不能省略,同理@Requestparam("id")里面的id也不能省略。
注意:
使用feign时,请求头中不会携带token,如果需过gateway网关验证身份,可使用配置类,把jwt加入到请求头中。
@Component
public class FeignConfig implements RequestInterceptor {
@Override
public void apply(RequestTemplate requestTemplate) {
// 获取到TOKEN
ServletRequestAttributes attributes = (ServletRequestAttributes)
RequestContextHolder.getRequestAttributes();
HttpServletRequest request = attributes.getRequest();
Cookie[] cookies = request.getCookies();
for (Cookie cookie : cookies) {
if ("token".equals(cookie.getName())) {
// 把TOKEN带到下游服务(token消息加到头消息)
requestTemplate.header("token", cookie.getValue());
}
}
}
}