Spring Cloud Netflix之声明式REST客户端：Feign

最新推荐文章于 2024-08-30 06:31:59 发布

AnY11

最新推荐文章于 2024-08-30 06:31:59 发布

阅读量440

点赞数

分类专栏： Spring Cloud Netflix

本文链接：https://blog.csdn.net/AnY11/article/details/84989217

版权

Spring Cloud Netflix 专栏收录该内容

14 篇文章 0 订阅

订阅专栏

Feign是一个声明性web服务客户端。它使编写web服务客户机变得更容易。要使用Feign创建一个接口并对其进行注释。它具有可插入的注释支持，包括伪注释和JAX-RS注释。Feign还支持可插拔的编码器和解码器。Spring Cloud增加了对Spring MVC注释的支持，并支持使用在Spring Web中默认使用的相同httpmessageconverter。Spring Cloud集成Ribbon和Eureka，在使用Feign时提供负载均衡的http客户端。

如何引入Feign

在项目中引入Feign，通过starter使用group org.springframework.cloud and artifact id spring-cloud-starter-openfeign。

Example spring boot app：

@Configuration
@ComponentScan
@EnableAutoConfiguration
@EnableFeignClients
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

StoreClient.java.

@FeignClient("stores")
public interface StoreClient {
    @RequestMapping(method = RequestMethod.GET, value = "/stores")
    List<Store> getStores();

    @RequestMapping(method = RequestMethod.POST, value = "/stores/{storeId}", consumes = "application/json")
    Store update(@PathVariable("storeId") Long storeId, Store store);
}

在@FeignClient注释中，字符串值(上面的“stores”)是一个任意的客户机名称，用于创建Ribbon负载均衡器。您还可以使用URL属性指定URL（绝对值或主机名）。应用程序上下文中bean的名称是接口的完全限定名称。要指定自己的别名值，可以使用@FeignClient注释的qualifier。

上面的Ribbon客户机希望发现“stores”服务的物理地址。如果您的应用程序是Eureka客户端，那么它将在Eureka服务注册中心解析服务。如果您不想使用Eureka，可以在外部配置中简单地配置一个服务器列表(请参见上面的示例)。

Overriding Feign Defaults

Spring Cloud默认支持的一个核心概念是命名客户端。每个虚拟客户端都是组件集合的一部分，这些组件一起工作，根据需要联系远程服务器，集成有一个名称，您可以使用@FeignClient注释作为应用程序开发人员给它命名。Spring Cloud使用FeignClientsConfiguration根据需要为每个命名客户机创建一个新的集成作为ApplicationContext。这里面(除了其他东西)有一个 feign.Decoder, a feign.Encoder, and a feign.Contract。

通过使用@FeignClient声明额外的配置(在FeignClientsConfiguration之上)，Spring Cloud允许您完全控制feign客户机。

@FeignClient(name = "stores", configuration = FooConfiguration.class)
public interface StoreClient {
    //..
}

在这种情况下，客户端由FeignClientsConfiguration中已经存在的组件以及FooConfiguration中的任何组件组成(在FooConfiguration中，后者将覆盖前者)。

FooConfiguration不需要用@Configuration注释。但是，如果它是，那么要注意将它从任何@ComponentScan中排除，否则将包括这个配置，因为它将成为“feign”的默认源feign.Decoder, feign.Encoder, feign.Contract。可以通过将它与任何@ComponentScan或@SpringBootApplication放在一个单独的、不重叠的包中来避免，也可以在@ComponentScan中显式地排除它。

serviceId属性现在已被弃用，取而代之的是name属性。

以前，使用url属性不需要name属性。现在需要使用名称。

名称和url属性支持占位符。

@FeignClient(name = "${feign.name}", url = "${feign.url}")
public interface StoreClient {
    //..
}

Spring Cloud Netflix默认为feign提供了以下bean (BeanType beanName: ClassName):

Decoder feignDecoder: ResponseEntityDecoder (which wraps a SpringDecoder)
Encoder feignEncoder: SpringEncoder
Logger feignLogger: Slf4jLogger
Contract feignContract: SpringMvcContract
Feign.Builder feignBuilder: HystrixFeign.Builder
Client feignClient: 如果启用Ribbon，它将是一个LoadBalancerFeignClient，否则将使用默认的feign客户机。

可以通过设置feign.okhttp.enabled or feign.httpclient.enabled to true来使用OkHttpClient和ApacheHttpClient Feign客户机，并将它们放在类路径中。在使用Apache时，您可以通过提供ClosableHttpClient或使用OK HTTP时提供OkHttpClient的bean来定制所使用的HTTP客户机。

默认情况下，Spring Cloud Netflix并没有为feign提供以下bean，但仍然从应用上下文中查找这些类型的bean来创建feign客户端:

Logger.Level
Retryer
ErrorDecoder
Request.Options
Collection<RequestInterceptor>
SetterFactory

创建其中一种类型的bean并将其放入@FeignClient配置(如上面的FooConfiguration)中，您可以覆盖所描述的每个bean。例子:

@Configuration
public class FooConfiguration {
    @Bean
    public Contract feignContract() {
        return new feign.Contract.Default();
    }

    @Bean
    public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
        return new BasicAuthRequestInterceptor("user", "password");
    }
}

这将用 feign.Contract.Default替换SpringMvcContract，并将请求拦截器添加到请求拦截器的集合中。

也可以使用配置属性配置@FeignClient。

application.yml

feign:
  client:
    config:
      feignName:
        connectTimeout: 5000
        readTimeout: 5000
        loggerLevel: full
        errorDecoder: com.example.SimpleErrorDecoder
        retryer: com.example.SimpleRetryer
        requestInterceptors:
          - com.example.FooRequestInterceptor
          - com.example.BarRequestInterceptor
        decode404: false

默认配置可以在@EnableFeignClients属性defaultConfiguration中以类似的方式指定，如上所述。不同的是，这个配置将适用于所有的虚拟客户端。

如果您喜欢使用配置属性来配置所有@FeignClient，那么您可以使用默认的feign名称来创建配置属性。

application.yml

feign:
  client:
    config:
      default:
        connectTimeout: 5000
        readTimeout: 5000
        loggerLevel: basic

如果我们同时创建@Configuration bean和配置属性，则配置属性将胜出。它将覆盖@Configuration值。但是如果您想将优先级更改为@Configuration，您可以将feign.client.default-to-properties更改为false。

如果您需要在请求拦截器中使用ThreadLocal绑定变量，那么您需要将Hystrix的线程隔离策略设置为“信号量”，或者在Feign中禁用Hystrix。

application.yml

# To disable Hystrix in Feign
feign:
  hystrix:
    enabled: false

# To set thread isolation to SEMAPHORE
hystrix:
  command:
    default:
      execution:
        isolation:
          strategy: SEMAPHORE

手动创建Feign 客户端

在某些情况下，可能需要定制您的虚拟客户端，而使用上述方法是不可能的。在这种情况下，您可以使用Feign Builder API创建客户机。下面是一个例子，它创建了两个具有相同接口的虚拟客户端，但是每个客户端都配置了一个单独的请求拦截器。

@Import(FeignClientsConfiguration.class)
class FooController {

	private FooClient fooClient;

	private FooClient adminClient;

    	@Autowired
	public FooController(
			Decoder decoder, Encoder encoder, Client client) {
		this.fooClient = Feign.builder().client(client)
				.encoder(encoder)
				.decoder(decoder)
				.requestInterceptor(new BasicAuthRequestInterceptor("user", "user"))
				.target(FooClient.class, "http://PROD-SVC");
		this.adminClient = Feign.builder().client(client)
				.encoder(encoder)
				.decoder(decoder)
				.requestInterceptor(new BasicAuthRequestInterceptor("admin", "admin"))
				.target(FooClient.class, "http://PROD-SVC");
    }
}

在上面的例子中，FeignClientsConfiguration类是Spring Cloud Netflix提供的默认配置。

PROD-SVC是客户机将向其发出请求的服务的名称。

Feign Hystrix支持

如果Hystrix在类路径中，并且feign.hystrix.enabled=true, Feign将用断路器封装所有方法。还可以返回com.netflix.hystrix.HystrixCommand。这允许您使用响应模式(调用 .toObservable()或.observe()或异步使用(调用.queue())。

要在每个客户端上禁用Hystrix支持，请创建一个普通的Feign.Builder具有“prototype”作用域.

@Configuration
public class FooConfiguration {
    	@Bean
	@Scope("prototype")
	public Feign.Builder feignBuilder() {
		return Feign.builder();
	}
}

在Spring Cloud Dalston发布之前，如果Hystrix在类路径上，默认情况下，Feign会将所有方法包装在断路器中。在Spring Cloud Dalston中更改了这种默认行为，支持选择加入的方法。

Feign Hystrix Fallbacks

Hystrix支持fallback的概念:当电路打开或出现错误时执行的默认代码路径。要为给定的@FeignClient启用fallbacks ，请将fallbacks 属性设置为实现fallbacks 的类名。您还需要将实现声明为Spring bean。

@FeignClient(name = "hello", fallback = HystrixClientFallback.class)
protected interface HystrixClient {
    @RequestMapping(method = RequestMethod.GET, value = "/hello")
    Hello iFailSometimes();
}

static class HystrixClientFallback implements HystrixClient {
    @Override
    public Hello iFailSometimes() {
        return new Hello("fallback");
    }
}

如果需要访问造成回退触发器的原因，可以在@FeignClient中使用fallbackFactory属性。

@FeignClient(name = "hello", fallbackFactory = HystrixClientFallbackFactory.class)
protected interface HystrixClient {
	@RequestMapping(method = RequestMethod.GET, value = "/hello")
	Hello iFailSometimes();
}

@Component
static class HystrixClientFallbackFactory implements FallbackFactory<HystrixClient> {
	@Override
	public HystrixClient create(Throwable cause) {
		return new HystrixClient() {
			@Override
			public Hello iFailSometimes() {
				return new Hello("fallback; reason was: " + cause.getMessage());
			}
		};
	}
}

Feign and `@Primary`

当将Feign与Hystrix回退一起使用时，相同类型的ApplicationContext中有多个bean。这将导致@Autowired无法工作，因为实际上没有一个bean，或者没有一个标记为主bean。

为了解决这个问题，Spring Cloud Netflix将所有的Feign 名实例标记为@Primary，所以Spring框架将知道要注入哪个bean。在某些情况下，这可能是不可取的。要关闭此行为，请将@FeignClient的primary 属性设置为false。

@FeignClient(name = "hello", primary = false)
public interface HelloClient {
	// methods here
}

Feign Inheritance Support

Feign通过单继承接口支持样板api。这允许将公共操作分组到方便的基本接口中。

UserService.java.

public interface UserService {

    @RequestMapping(method = RequestMethod.GET, value ="/users/{id}")
    User getUser(@PathVariable("id") long id);
}

UserResource.java.

@RestController
public class UserResource implements UserService {

}

UserClient.java.

package project.user;

@FeignClient("users")
public interface UserClient extends UserService {

}

通常不建议在服务器和客户机之间共享接口。它引入了紧密耦合，而且实际上也不能与当前形式的Spring MVC一起工作(方法参数映射不是继承的)。

Feign 请求/响应压缩

您可以考虑为您的Feign请求启用请求或响应GZIP压缩。您可以通过启用以下属性之一来实现这一点:

feign.compression.request.enabled=true
feign.compression.response.enabled=true

Feign请求压缩给你的设置类似于你可以设置你的web服务器:

feign.compression.request.enabled=true
feign.compression.request.mime-types=text/xml,application/xml,application/json
feign.compression.request.min-request-size=2048

这些属性允许您选择压缩媒体类型和最小请求阈值长度。

Feign logging

为每个创建的Feign客户端创建一个日志记录器。默认情况下，日志记录器的名称是用于创建Feign客户机的接口的完整类名。Feign 日志记录只DEBUG调试级别。

application.yml.

logging.level.project.user.UserClient: DEBUG

可以为每个客户端配置的Logger.Level对象，告诉Feign要记录多少log。选择有:

NONE, No logging (DEFAULT).
BASIC, 只记录请求方法和URL以及响应状态代码和执行时间。
HEADERS, 记录基本信息以及请求和响应头。
FULL, 记录请求和响应的标题、主体和元数据。

例如，下面将设置 Logger.Level为FULL:

@Configuration
public class FooConfiguration {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

AnY11

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录

Spring Cloud Netflix之声明式REST客户端：Feign

如何引入Feign

Overriding Feign Defaults

手动创建Feign 客户端

Feign Hystrix支持

Feign Hystrix Fallbacks

Feign and @Primary

Feign Inheritance Support

Feign 请求/响应压缩

Feign logging

Feign and `@Primary`