承接上篇文章：
【SpringCloud技术专题】「原生态Fegin」打开Fegin之RPC技术的开端，你会使用原生态的Fegin吗？(上)
为什么选择 Feign 而不是其他
你可以使用 Jersey 和 CXF 这些来写一个 Rest 或 SOAP 服务的 java 客服端。
你也可以直接使用 Apache HttpClient 来实现。但是 Feign 的目的是尽量的减少资源和代码来实现和 HTTP API 的连接。
通过自定义的编码解码器以及错误处理，你可以编写任何基于文本的 HTTP API。
Feign 工作机制
Feign 使用回顾
基本用法
基本的使用如下所示
interface UserService { // RequestLine注解声明请求方法和请求地址,可以允许有查询参数 @RequestLine("GET /repos/{userName}/{age}/users") List<User> getUserList(@Param("userName") String userName, @Param("age") int age);}
static class User { String userName; int age;}
public static void main(String... args) { User user = Feign.builder() .decoder(new GsonDecoder()) .target(UserService.class, "https://api.github.com"); // Fetch and print a list of the contributors to this library. List<User> userList = github.getUserList("libo", 12); for (User user : userList) { System.out.println(user.userName + " (" + user.age + ")"); }}
复制代码
自定义实现接口
Feign 有许多可以自定义的方面。举个简单的例子，你可以使用 Feign.builder() 来构造一个拥有你自己组件的 API 接口，如下:
interface Bank { @RequestLine("POST /account/{id}") Account getAccountInfo(@Param("id") String id);}
复制代码
// AccountDecoder() 是自己实现的一个 Decoder
Bank bank = Feign.builder().decoder(new AccountDecoder()).target(Bank.class, https://api.examplebank.com);
复制代码
多种接口
Feign 可以提供多种 API 接口，这些接口都被定义为 Target<T> (默认的实现是 HardCodedTarget<T>), 它允许在执行请求前动态发现和装饰该请求。
举个例子，下面的这个模式允许使用当前 url 和身份验证 token 来装饰每个发往身份验证中心服务的请求。
CloudDNS cloudDNS = Feign.builder().target(new CloudIdentityTarget<CloudDNS>(user, apiKey));
示例
Feign 包含了 GitHub 和 Wikipedia 客户端的实现样例.相似的项目也同样在实践中运用了 Feign。尤其是它的示例后台程序。
Feign 集成多种类型编码器
Feign 可以和其他的开源工具集成工作。你可以将这些开源工具集成到 Feign 中来。目前已经有的一些模块如下：
Gson
添加 GsonEncoder 以及 GsonDecoder 到你的 Feign.Builder 中， 如下:
GsonCodec codec = new GsonCodec();GitHub github = Feign.builder() .encoder(new GsonEncoder()) .decoder(new GsonDecoder()) .target(GitHub.class, https://api.github.com);
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-gson</artifactId> <version>8.18.0</version></dependency>
复制代码
Jackson
添加 JacksonEncoder 以及 JacksonDecoder 到你的 Feign.Builder 中， 如下:
UserService service = Feign.builder() .encoder(new JacksonEncoder()) .decoder(new JacksonDecoder()) .target(UserService.class, https://api.user.com);
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-jackson</artifactId> <version>8.18.0</version></dependency>
复制代码
Sax
api = Feign.builder().decoder(SAXDecoder.builder().registerContentHandler(UserIdHandler.class).build()).target(Api.class, https://apihost);
复制代码
Maven 依赖:
<dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-sax</artifactId> <version>8.18.0</version></dependency>
复制代码
JAXB
添加 JAXBEncoder 以及 JAXBDecoder 到你的 Feign.Builder 中， 如下:
api = Feign.builder() .encoder(new JAXBEncoder()) .decoder(new JAXBDecoder()) .target(Api.class, https://apihost);
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-jaxb</artifactId> <version>8.18.0</version></dependency>
复制代码
JAX-RS
JAXRSContract 使用 JAX-RS 规范重写覆盖了默认的注解处理。
下面是一个使用 JAX-RS 的例子:
interface GitHub { @GET @Path("/repos/{owner}/{repo}/contributors") List<Contributor> contributors(@PathParam("owner") String owner, @PathParam("repo") String repo);}
// contract 方法配置注解处理器,注解处理器定义了哪些注解和值是可以作用于接口的GitHub github = Feign.builder() .contract(new JAXRSContract()) .target(GitHub.class, https://api.github.com);
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-jaxrs</artifactId> <version>8.18.0</version></dependency>
复制代码
OkHttp
OkHttpClient 使用 OkHttp 来发送 Feign 的请求，OkHttp 支持 SPDY (SPDY 是 Google 开发的基于 TCP 的传输层协议，用以最小化网络延迟，提升网络速度，优化用户的网络使用体验),并有更好的控制 http 请求。
要让 Feign 使用 OkHttp ，你需要将 OkHttp 加入到你的环境变量中区，然后配置 Feign 使用 OkHttpClient，如下:
GitHub github = Feign.builder() .client(new OkHttpClient()) .target(GitHub.class, "https://api.github.com");
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-okhttp</artifactId> <version>8.18.0</version></dependency>
复制代码
Ribbon
RibbonClient 重写了 Feign 客户端的对 URL 的处理，其添加了 智能路由以及一些其他由 Ribbon 提供的弹性功能。集成 Ribbon 需要你将 ribbon 的客户端名称当做 url 的 host 部分来传递，如下：
// myAppProd是你的ribbon client nameMyService api = Feign.builder().client(RibbonClient.create()).target(MyService.class, "https://myAppProd");
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-ribbon</artifactId> <version>8.18.0</version></dependency>
复制代码
Hystrix
HystrixFeign 配置了 Hystrix 提供的熔断机制。
要在 Feign 中使用 Hystrix ，你需要添加 Hystrix 模块到你的环境变量，然后使用 HystrixFeign 来构造你的 API:
MyService api = HystrixFeign.builder().target(MyService.class, "https://myAppProd");
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-hystrix</artifactId> <version>8.18.0</version></dependency>
复制代码
SLF4J
SLF4JModule 允许你使用 SLF4J 作为 Feign 的日志记录模块，这样你就可以轻松的使用 Logback, Log4J , 等 来记录你的日志.
要在 Feign 中使用 SLF4J ，你需要添加 SLF4J 模块和对应的日志记录实现模块(比如 Log4J)到你的环境变量，然后配置 Feign 使用 Slf4jLogger :
GitHub github = Feign.builder() .logger(new Slf4jLogger()) .target(GitHub.class, "https://api.github.com");
复制代码
Maven 依赖:
<!-- https://mvnrepository.com/artifact/com.netflix.feign/feign-gson --><dependency> <groupId>com.netflix.feign</groupId> <artifactId>feign-slf4j</artifactId> <version>8.18.0</version></dependency>
复制代码
Feign 组成
Decoders
Feign.builder() 允许你自定义一些额外的配置，比如说如何解码一个响应。假如有接口方法返回的消息不是 Response, String, byte[] 或者 void 类型的，那么你需要配置一个非默认的解码器。
GitHub github = Feign.builder() .decoder(new GsonDecoder()) .target(GitHub.class, https://api.github.com);
复制代码
假如你想在将响应传递给解码器处理前做一些额外的处理，那么你可以使用 mapAndDecode 方法。一个用例就是使用 jsonp 服务的时候:
// 貌似1.8.0版本中沒有mapAndDecode这个方法。。。JsonpApi jsonpApi = Feign.builder() .mapAndDecode((response, type) -> jsopUnwrap(response, type), new GsonDecoder()) .target(JsonpApi.class, https://some-jsonp-api.com);
复制代码
Encoders
发送一个 Post 请求最简单的方法就是传递一个 String 或者 byte[] 类型的参数了。你也许还需添加一个 Content-Type 请求头，如下:
interface LoginClient { @RequestLine("POST /") @Headers("Content-Type: application/json") void login(String content);}
client.login("{\"user_name\": \"denominator\", \"password\": \"secret\"}");
复制代码
通过配置一个解码器，你可以发送一个安全类型的请求体，如下是一个使用 feign-gson 扩展的例子:
static class Credentials { final String user_name; final String password; Credentials(String user_name, String password) { this.user_name = user_name; this.password = password; }}interface LoginClient { @RequestLine("POST /") void login(Credentials creds);}...LoginClient client = Feign.builder() .encoder(new GsonEncoder()) .target(LoginClient.class, "https://foo.com");client.login(new Credentials("denominator", "secret"));
复制代码
@Body 注解申明一个请求体模板，模板中可以带有参数，与方法中 @Param 注解申明的参数相匹配,使用方法如下:
interface LoginClient {
@RequestLine("POST /") @Headers("Content-Type: application/xml") @Body("<login \"user_name\"=\"{user_name}\" \"password\"=\"{password}\"/>") void xml(@Param("user_name") String user, @Param("password") String password);
@RequestLine("POST /") @Headers("Content-Type: application/json") // json curly braces must be escaped! // 这里JSON格式需要的花括号居然需要转码，有点蛋疼了。 @Body("%7B\"user_name\": \"{user_name}\", \"password\": \"{password}\"%7D") void json(@Param("user_name") String user, @Param("password") String password);}...client.xml("denominator", "secret"); // <login "user_name"="denominator" "password"="secret"/>client.json("denominator", "secret"); // {"user_name": "denominator", "password": "secret"}
复制代码
Headers
使用 @Headers 设置静态请求头
// 给BaseApi中的所有方法设置Accept请求头@Headers("Accept: application/json")interface BaseApi<V> { // 单独给put方法设置Content-Type请求头 @Headers("Content-Type: application/json") @RequestLine("PUT /api/{key}") void put(@Param("key") String, V value);}
复制代码
设置动态值的请求头
@RequestLine("POST /")@Headers("X-Ping: {token}")void post(@Param("token") String token);
复制代码
这时候可以使用 @HeaderMap 注解，如下:
// @HeaderMap 注解设置的请求头优先于其他方式设置的@RequestLine("POST /")void post(@HeaderMap Map<String, Object> headerMap);
复制代码
给 Target 设置请求头
有时我们需要在一个 API 实现中根据不同的 endpoint 来传入不同的 Header，这个时候我们可以使用自定义的 RequestInterceptor 或 Target 来实现。
通过自定义的 RequestInterceptor 来实现
通过自定义 Target 来实现给每个 Target 设置安全校验信息 Header 的例子:
static class DynamicAuthTokenTarget<T> implements Target<T> { public DynamicAuthTokenTarget(Class<T> clazz, UrlAndTokenProvider provider, ThreadLocal<String> requestIdProvider); ... @Override public Request apply(RequestTemplate input) { TokenIdAndPublicURL urlAndToken = provider.get(); if (input.url().indexOf("http") != 0) { input.insert(0, urlAndToken.publicURL); } input.header("X-Auth-Token", urlAndToken.tokenId); input.header("X-Request-ID", requestIdProvider.get()); return input.request(); }}
...Bank bank = Feign.builder() .target(new DynamicAuthTokenTarget(Bank.class, provider, requestIdProvider));
复制代码
这种方法的实现依赖于给 Feign 客户端设置的自定义的 RequestInterceptor 或 Target。可以被用来给一个客户端的所有 api 请求设置请求头。比如说可是被用来在 header 中设置身份校验信息。这些方法是在线程执行 api 请求的时候才会执行，所以是允许在运行时根据上下文来动态设置 header 的。
比如说可以根据线程本地存储(thread-local storage)来为不同的线程设置不同的请求头。
评论