在上一章中，讲解了如何使用RestTemplate来消费服务，如何结合Ribbon在消费服务时做负载均衡。本章将全面讲解Feign，包括如何使用Feign来远程调度其他服务、 FeignClient的各项详细配置等。Feign受Retrofit、JAXRS-2.0和WebSocket的影响，采用了声明式API接口的风格，将JavaHttp客户端绑定到它的内部。 Feign的首要目标是将JavaHttp客户端调用过程变得简单。
一、编写Feign客户端
本章的案例基于上一章的案例，在之前工程基础之上进行改造。本节的案例讲解了如何使用Feign进行远程调用。新建一个SpringBoot的Module工程，取名为eureka-feign-client。首先，在工程的pom文件中加入相关的依赖。代码如下：
<parent>
<groupId>com.hand</groupId>
<artifactId>macro-service</artifactId>
<version>1.0-SNAPSHOT</version>
<relativePath/>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
在工程的配置文件 appIication.yml 做程序的相关配置，包括指定程序名为 eureka-ribbon client， 程序的端口号为 8764，服务的注册地址http://localhost:8761/eureka/，代码如下:
spring:
application:
name: eureka-feign-client
server:
port: 8675
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8671/eureka/
@EnableEurekaClient
@EnableFeignClients
@SpringBootApplication
public class EurekaFeignClientApplication {
public static void main(String[] args) {
SpringApplication.run(EurekaFeignClientApplication.class, args);
}
}
通过以上3个步骤，该程序就具备了Feign的功能，现在来实现一个简单的FeignClient新建一个 EurekaClientFeign的接口，在接口上加@FeignClient 注解来声明一个FeignClient, 其中value 为远程调用其他服务的服务名 ， FeignConfig.class为FeignClient的配置类 。在EurekaClientFeign接口内部有一个sayHiFromClientEureka()方法，该方法通过Feign来调用 eureka-client服务的"/hi"的 API接口，代码如下：
@FeignClient(value = "eureka-client", configuration = FeignConfig.class)
public interface EurekaFeignClient {
@GetMapping("/hi")
String sayHiFromEurekaClient(@RequestParam(value = "name") String name);
}
在 FeignConfig类加上@Configuration注解，表明该类是一个配置类，并注入一个BeanName
为feignRetryer的Retryer的Bean。Feign在远程调用失败后会进行重试。注入该Bean之后， 代码如下:
在 Service 层 的 HiService 类注入 EurekaClientFeign 的 Bean，通过 EurekaClientFeign 去调 用 sayHiFromClientEureka()方法，其代码如下 :
@Service
public class HiService {
@Autowired
private EurekaFeignClient eurekaFeignClient;
public String sayHi(String name){
return eurekaFeignClient.sayHiFromEurekaClient(name);
}
}
在HiController上加上@RestController注解，开启RestController的功能，写一个 API接口"/hi"， 在该接口调用了HiService的sayHi()方法。HiService通过 EurekaClientFeign远程调用eureka-client服务的API接口"/hi"。代码如下:
@RestController
public class HiController {
@Autowired
private HiService hiService;
@GetMapping("/hi")
public String sayHi(@RequestParam("name") String name){
return hiService.sayHi(name);
}
}
启动eureka-server工程，端口号为8761；启动两个eureka-client工程的实例，端口号分别为 8762和8763:启动eureka-feign-client工程，端口号为8765，在浏览器上多次访问http://localhost:8765/hi，浏览器会轮流显示以下内容:
hi ben, i am from port:8763
hi ben, i am from port:8762
由此可见， FeignClient远程调用了 eureka-client服务(存在端口为8762和8763的两个实例)的"/hi" API 接口， FeignClient有负载均衡的能力。
二、FeignClient
为了深入理解Feign，下面将从源码的角度来讲解Feign。首先来查看FeignClient注解@FeignClient的源码，其代码如下:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FeignClient {
@AliasFor("name")
String value() default "";
@Deprecated
String serviceId() default "";
@AliasFor("value")
String name() default "";
String qualifier() default "";
String url() default "";
boolean decode404() default false;
Class<?>[] configuration() default {};
Class<?> fallback() default void.class;
Class<?> fallbackFactory() default void.class;
String path() default "";
boolean primary() default true;
}
FeignClient注解被@Target(ElementType.TYPE)修饰，表示 FeignClient注解的作用目标在接口上。@Retention(RetentionPolicy.RUNTlME)注解表明该注解会在Class字节码文件中存在， 在运行时可以通过反射获取到。@Documented 表示该注解将被包含在Javadoc中。@FeignClient注解用于创建声明式API接口，该接口是RESTful风格的。 Feign被设计成插拔式的，可以注入其他组件和Feign一起使用。最典型的是如果Ribbon可用，Feign会和Ribbon相结合进行负载均衡。
在代码中，value()和name()一样，是被调用的服务的Serviceld。url()直接填写硬编码的Uri地址。decode404()即404是被解码，还是抛异常。 configuration()指明FeignClient的配置类， 默认的配置类为FeignClientsConfiguration类，在缺省的情况下，这个类注入了默认的Decoder、 Encoder和Contract等配置的Bean。fallback()为配置熔断器的处理类。
三、FeignClient配置
FeignClient默认的配置类为FeignClientsConfiguration，这个类在spring-cloud-netflix-core的jar包下。打开这个类，可以发现这个类注入了很多 Feign相关的配置Bean，包括FeignRetryer、FeignLoggerFactory和FormattingConversionService等。另外，Decoder、 Encoder和Contract这3个类在没有 Bean被注入的情况下，会自动注入默认配置的Bean，即 ResponseEntityDecoder、SpringEncoder和 SpringMvcContract。默认注入的配置如下。
- Decoder feignDecoder: ResponseEntityDecoder
- Encoder feignEncoder: SpringEncoder
- Logger feignLogger: Slf4jLogger
- Contract feignContract: SpringMvcContract
- Feign.Builder feignBuilder: HystrixFeign.Builder
FeignClientsConfiguration 的配置类部分代码如下，@ConditionalOnMissingBean 注解表示如果没有注入该类的Bean就会默认注入一个 Bean。
@Configuration
public class FeignClientsConfiguration {
...//省略代码
@Bean
@ConditionalOnMissingBean
public Decoder feignDecoder () {
return new ResponseEntityDecoder(new SpringDecoder(this.messageConverters));
}
@Bean
@ConditionalOnMissingBean
public Encoder feignEncoder() {
return new SpringEncoder(this.messageConverters);
}
@Bean
@ConditionalOnMissingBean
public Contract feignContract(ConversionService feignConversionService) {
return new SpringMvcContract(this.parameterProcessors, feignConversionServic);
}
....//省略代码
}
重写FeignClientsConfiguration类中的Bean，覆盖掉默认的配置Bean，从而达到自定义配置的目的。例如Feign默认的配置在请求失败后，重试次数为0，即不重试( Retryer.NEVER_RETRY)。现在希望在请求失败后能够重试，这时需要写一个配置FeignConfig类，在该类中注入Retryer的Bean，覆盖掉默认的Retryer的Bean，并将FeignConfig指定为FeignClient的配置类。 FeignConfig类的代码如下:
@Configuration
public class FeignConfig {
@Bean
public Retryer feignRetryer(){
return new Retryer.Default(100, SECONDS.toMillis(1), 5);
}
}
在上面的代码中 ，通过覆盖了默认的Retryer的Bean， 更改了该FeignClient的请求失败重试的策略，重试问隔为100毫秒，最大重试时间为1秒，重试次数为5次。
网友评论