AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

【Fegin技术专题】「原生态」打开Fegin之RPC技术的开端，你会使用原生态的Fegin吗？(中)

2023-01-14 156
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 【Fegin技术专题】「原生态」打开Fegin之RPC技术的开端，你会使用原生态的Fegin吗？(中)

为什么选择Feign而不是其他

  • 你可以使用 Jersey 和 CXF 这些来写一个 Rest 或 SOAP 服务的java客服端。
  • 你也可以直接使用 Apache HttpClient 来实现。但是 Feign 的目的是尽量的减少资源和代码来实现和 HTTP API 的连接。
  • 通过自定义的编码解码器以及错误处理，你可以编写任何基于文本的 HTTP API。




Feign工作机制

  • Feign通过注解注入一个模板化请求进行工作。只需在发送之前关闭它，参数就可以被直接的运用到模板中。
  • 然而这也限制了Feign，只支持文本形式的API，它在响应请求等方面极大的简化了系统。




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 (默认的实现是 HardCodedTarget), 它允许在执行请求前动态发现和装饰该请求。


举个例子，下面的这个模式允许使用当前url和身份验证token来装饰每个发往身份验证中心服务的请求。


CloudDNS cloudDNS = Feign.builder().target(new CloudIdentityTarget(user, apiKey));

示例


Feign 包含了 GitHub 和 Wikipedia 客户端的实现样例.相似的项目也同样在实践中运用了Feign。尤其是它的示例后台程序。




Feign集成多种类型编码器


Feign 可以和其他的开源工具集成工作。你可以将这些开源工具集成到 Feign 中来。目前已经有的一些模块如下：


Gson


  • Gson包含了一个编码器和一个解码器，这个可以被用于JSON格式的API。

添加 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


  • Jackson包含了一个编码器和一个解码器，这个可以被用于JSON格式的API。

添加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


  • SaxDecoder 用于解析XML,并兼容普通JVM和Android。下面是一个配置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


  • JAXB包含了一个编码器和一个解码器，这个可以被用于XML格式的API。

添加 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 name
MyService 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 类型的，那么你需要配置一个非默认的解码器。

  • 下面是一个配置使用JSON解码器(使用的是feign-gson扩展)的例子:
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 templates

@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


  • Feign 支持给请求的api设置或者请求的客户端设置请求头，如下:
  • 给API设置请求头
使用 @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);
复制代码
  • 设置key和value都是动态的请求头
  • 有些API需要根据调用时动态确定使用不同的请求头(e.g. custom metadata header fields such as “x-amz-meta-“ or “x-goog-meta-“),

这时候可以使用 @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)来为不同的线程设置不同的请求头。




文章标签：
Java
Android开发
网络协议
网络架构
Maven
安全
API
数据格式
JSON
XML
关键词：
RPC技术
技术RPC
RPC技术专题
fegin技术专题RPC技术开端原生态
fegin技术RPC
洛神灬殇
目录
相关文章
洛神灬殇
|
8月前
|
Dubbo Cloud Native 网络协议
【Dubbo3技术专题】「服务架构体系」第一章之Dubbo3新特性要点之RPC协议分析介绍
【Dubbo3技术专题】「服务架构体系」第一章之Dubbo3新特性要点之RPC协议分析介绍
洛神灬殇
108 1
洛神灬殇
|
8月前
|
设计模式 负载均衡 网络协议
【分布式技术专题】「分布式技术架构」实践见真知，手把手教你如何实现一个属于自己的RPC框架（架构技术引导篇）
【分布式技术专题】「分布式技术架构」实践见真知，手把手教你如何实现一个属于自己的RPC框架（架构技术引导篇）
洛神灬殇
320 0
hnrk7epeorhrk
|
7月前
|
XML 编解码 JSON
技术经验解读：什么是RPC？
技术经验解读：什么是RPC？
hnrk7epeorhrk
53 0
洛神灬殇
|
8月前
|
Java fastjson 数据安全/隐私保护
【Dubbo3技术专题】「云原生微服务开发实战」 一同探索和分析研究RPC服务的底层原理和实现
【Dubbo3技术专题】「云原生微服务开发实战」 一同探索和分析研究RPC服务的底层原理和实现
洛神灬殇
168 0
洛神灬殇
|
自然语言处理 Kubernetes Dubbo
【Alibaba微服务技术系列】「Dubbo3.0技术专题」第一章之Dubbo3新特性要点之RPC协议分析介绍
【Alibaba微服务技术系列】「Dubbo3.0技术专题」第一章之Dubbo3新特性要点之RPC协议分析介绍
洛神灬殇
210 0
喜欢猪猪
|
8月前
|
负载均衡 Dubbo Java
Dubbo 3.x：探索阿里巴巴的开源RPC框架新技术
随着微服务架构的兴起，远程过程调用（RPC）框架成为了关键组件。Dubbo，作为阿里巴巴的开源RPC框架，已经演进到了3.x版本，带来了许多新特性和技术改进。本文将探讨Dubbo 3.x中的一些最新技术，包括服务注册与发现、负载均衡、服务治理等，并通过代码示例展示其使用方式。
喜欢猪猪
428 9
全干程序员demo
|
2月前
|
自然语言处理 负载均衡 API
gRPC 一种现代、开源、高性能的远程过程调用 （RPC） 可以在任何地方运行的框架
gRPC 是一种现代开源高性能远程过程调用（RPC）框架，支持多种编程语言，可在任何环境中运行。它通过高效的连接方式，支持负载平衡、跟踪、健康检查和身份验证，适用于微服务架构、移动设备和浏览器客户端连接后端服务等场景。gRPC 使用 Protocol Buffers 作为接口定义语言，支持四种服务方法：一元 RPC、服务器流式处理、客户端流式处理和双向流式处理。
全干程序员demo
157 4
热爱技术的小郑
|
5月前
|
Dubbo 网络协议 Java
RPC框架：一文带你搞懂RPC
这篇文章全面介绍了RPC（远程过程调用）的概念、原理和应用场景，解释了RPC如何工作以及为什么在分布式系统中广泛使用，并探讨了几种常用的RPC框架如Thrift、gRPC、Dubbo和Spring Cloud，同时详细阐述了RPC调用流程和实现透明化远程服务调用的关键技术，包括动态代理和消息的编码解码过程。
热爱技术的小郑
2362 1
RPC框架：一文带你搞懂RPC
1176112968452250
|
4月前
|
XML 负载均衡 监控
分布式-dubbo-简易版的RPC框架
分布式-dubbo-简易版的RPC框架
1176112968452250
47 0
拂去尘世尘
|
7月前
|
存储 缓存 Linux
【实战指南】嵌入式RPC框架设计实践：六大核心类构建高效RPC框架
在先前的文章基础上，本文讨论如何通过分层封装提升一个针对嵌入式Linux的RPC框架的易用性。设计包括自动服务注册、高性能通信、泛型序列化和简洁API。框架分为6个关键类：BindingHub、SharedRingBuffer、Parcel、Binder、IBinder和BindInterface。BindingHub负责服务注册，SharedRingBuffer实现高效数据传输，Parcel处理序列化，而Binder和IBinder分别用于服务端和客户端交互。BindInterface提供简单的初始化接口，简化应用集成。测试案例展示了客户端和服务端的交互，验证了RPC功能的有效性。
拂去尘世尘
458 9

热门文章

最新文章

  • 1
    高并发架构系列：如何从0到1设计一个类Dubbo的RPC框架
  • 2
    git 报错 RPC failed; curl 18 transfer closed with outstanding read data remaining
  • 3
    rpc框架之 thrift连接池实现
  • 4
    RPC vs. HTTP：谁主沉浮在网络通信的江湖？
  • 5
    SOAP协议是RPC协议的升级版，出现了WSDL
  • 6
    SOFAGW 网关：安全可信的跨域 RPC/消息 互通解决方案
  • 7
    微服务学习 | Springboot整合Dubbo+Nacos实现RPC调用
  • 8
    RPC框架几行代码就够了
  • 9
    远程调用服务(RPC)和消息(Message Queue)对比及其适用/不适用场合
  • 10
    ENVI：如何进行对自带RPC的图像进行RPC正射校正呢？
  • 1
    性能工具之Jmeter压测Hprose RPC服务
    91
  • 2
    RPC与REST对比指南
    113
  • 3
    实时计算 Flink版产品使用合集之将sdkMode从rpc模式改为jdbc模式后，table.exec.mini-batch.enabled参数还生效吗
    68
  • 4
    java利用xml-rpc协议操作wordpress博客
    93
  • 5
    微服务学习 | Springboot整合Dubbo+Nacos实现RPC调用
    973
  • 6
    一个不错的的rpc开源代码-rest_rpc
    130
  • 7
    【Dubbo3技术专题】「云原生微服务开发实战」 一同探索和分析研究RPC服务的底层原理和实现
    168
  • 8
    【分布式技术专题】「分布式技术架构」实践见真知，手把手教你如何实现一个属于自己的RPC框架（架构技术引导篇）
    320
  • 9
    【Dubbo3技术专题】「服务架构体系」第一章之Dubbo3新特性要点之RPC协议分析介绍
    108
  • 10
    RPC 通信与MQ 消息队列通信的微服务架构区别
    116

    • 相关课程

    更多
  • SpringMVC框架入门
  • 基于Zookeeper、Dubbo构建互联网分布式基础架构
  • Java面向对象开发

    • 相关电子书

    更多
  • 一招玩转微服务注册&配置中心
  • 当泛型遇上协议
  • Spring框架入门

    • 相关实验场景

    更多
  • 使用Java面向对象编写网络通信程序应用
  • 快速上手使用Dubbo进行远程调用
    • 下一篇
    DataWorks智能交互式数据开发与分析之旅