0%

Feign简介

Feign简介

Feign是一个声明式的Web服务客户端,只需要接口+注解即可完成对于微服务的调用,不需要使用RestTemplate+Ribbon来对微服务进行访问,简化了编程

依赖

1
2
3
4
5
<!-- feign -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>

配置启动类

1
2
3
4
5
6
7
8
9
@SpringBootApplication
@EnableEurekaClient
// 启动feign
@EnableFeignClients(basePackages = "com.zhanghe.study")
public class ConsumerApp {
public static void main(String[] args) {
SpringApplication.run(ConsumerApp.class,args);
}
}

feign接口编写

1
2
3
4
5
6
7
// value中为所要访问的微服务
@FeignClient(value = "MICRO-SERVICE-DEPT-PROVIDER")
public interface DeptClient {

@RequestMapping(value = "/dept/get/{id}",method = RequestMethod.GET)
public Dept get(@PathVariable("id") long id);
}

直接调用该方法就可以调用该微服务的接口

@FeignClient参数说明

首先主程序入口添加了@EnableFeignClients注解开启对FeignClient扫描加载处理,否则无法加载@FeignClient注解所标注的接口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public @interface FeignClient {
// 指定了FeignClient的名称,如果使用了Ribbon,该值就是微服务的名称,用于服务发现
@AliasFor("name")
String value() default "";

/** @deprecated */
@Deprecated
String serviceId() default "";
// 指定了FeignClient的名称,如果使用了Ribbon,name就是微服务的名称,用于服务发现,且会作为bean的名称,如果该服务内有多个调用某个微服务的feign接口,可以使用value,而不使用name
@AliasFor("value")
String name() default "";

String qualifier() default "";
// 指定调用的地址,一般不使用该参数,而使用微服务的名称调用
String url() default "";
// 当发生404时,如果该字段为true,会调用decoder进行解码,否则抛出FeignException
boolean decode404() default false;
// 指定Feign的配置类,可以在Feign的配置类中自定义Feign的Encoder、Decoder、LogLevel、Contract
Class<?>[] configuration() default {};
// 失败回调,用于容错
Class<?> fallback() default void.class;
// 工厂生成fallback类实例,可以生成每个接口通用的容错逻辑
Class<?> fallbackFactory() default void.class;
// 定义当前FeignClient的统一前缀
String path() default "";

boolean primary() default true;
}