Alibaba微服务组件 - Feign
JAVA 项目中如何实现接口调用？
-
Httpclient
HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的，支持 Http 协议的客户端编程工具包，并且它支持 HTTP 协议最新版本和建议。HttpClient相比传统 JDK 自带的 URLConnection，提升了易用性和灵活性，使客户端发送 HTTP 请求变得容易，提高了开发的效率。
-
Okhttp
一个处理网络请求的开源项目，是安卓端最火的轻量级框架，由 Square 公司贡献，用于替代HttpUrlConnection 和 Apache HttpClient。OkHttp 拥有简洁的 API、高效的性能，并支持多种协议（HTTP/2 和 SPDY）
-
HttpURLConnection
HttpURLConnection 是 Java 的标准类，它继承自 URLConnection，可用于向指定网站发送GET 请求、POST 请求。HttpURLConnection 使用比较复杂，不像 HttpClient 那样容易使用。
-
RestTemplate WebClient
RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端，RestTemplate 提供了多种便捷访问远程 HTTP 服务的方法，能够大大提高客户端的编写效率。上面介绍的是最常见的几种调用接口的方法，我们下面要介绍的方法比上面的更简单、方便，它就是 Feign。
1. 什么是Feign
Feign是Netflix开发的声明式、模板化的HTTP客户端，其灵感来自Retrofit、JAXRS-2.0以及WebSocket。Feign可帮助我们更加便捷、优雅地调用HTTP API。
Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。
Spring Cloud openfeign对Feign进行了增强，使其支持Spring MVC注解，另外还整合了Ribbon和Nacos，从而使得Feign的使用更加方便
1.1 优势
Feign可以做到使用 HTTP 请求远程服务时就像调用本地方法一样的体验，开发者完全感知不到这是远程方法，更感知不到这是个 HTTP 请求。它像 Dubbo 一样，consumer 直接调用接口方法调用 provider，而不需要通过常规的 Http Client 构造请求再解析返回数据。它解决了让开发者调用远程接口就跟调用本地方法一样，无需关注与远程的交互细节，更无需关注分布式环境开发。
2. Spring Cloud Alibaba快速整合OpenFeign
2.1 引入依赖
<!--openfeign 远程调用-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2.2 编写调用接口+@FeignClient注解
package com.xiexie.order.feign;
import com.xiexie.order.config.FeignConfig;
import feign.Param;
import feign.Request;
import feign.RequestLine;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* @Description 添加feign接口和方法
* name: 指定调用rest接口所对应的服务名
* path: 指定调用rest接口所在的stockController所对应的@requestMapping
* configuration: 如果想针对某个或某些服务进行openFeign调用，去掉@Configuration注解，并在此声明
* @Date 2022-04-11 15:06
* @Author xie
*/
@FeignClient(name = "stock-server", path = "/stock", configuration = FeignConfig.class)
public interface StockFeignService {
@RequestMapping("/reduct")
public String reduct();
/**
* 在openFeign中必须要指定参数名 @PathVariable("id")
*
* @param id
* @return java.lang.String
*/
@RequestMapping("/{id}")
public String get(@PathVariable("id") Integer id);
/**
* 使用原生feign注解
*
* @param id
* @return java.lang.String
*/
//@RequestLine("GET /{id}")
//public String get(@Param("id") Integer id);
/**
* 使用原生feign注解
*
* @param id
* @return java.lang.String
*/
}
2.3 调用端在启动类上添加@EnableFeignClients注解
package com.xiexie.order;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.client.loadbalancer.LoadBalanced;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
/**
* @Description
* @Date 2022-04-07 14:52
* @Author xie
*/
@SpringBootApplication
@EnableDiscoveryClient // 后面版本中可以不加这个注解
@EnableFeignClients
public class OrderApplication {
public static void main(String[] args) {
SpringApplication.run(OrderApplication.class, args);
}
@Bean
@LoadBalanced // 负载均衡器 默认采用ribbon的轮询方式（在做微服务的时候必须要加此注解）
public RestTemplate restTemplate(RestTemplateBuilder builder) {
RestTemplate restTemplate = builder.build();
return restTemplate;
}
}
2.4 发起调用，像调用本地方式一样调用远程服务
package com.xiexie.order.controller;
import com.xiexie.order.feign.StockFeignService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
/**
* @Description
* @Date 2022-04-07 14:46
* @Author xie
*/
@RestController
@RequestMapping("/order")
public class OrderController {
@Autowired
private RestTemplate restTemplate;
@Autowired
private StockFeignService stockFeignService;
@RequestMapping("/add")
public String add() {
System.out.println("下单成功");
//String msg = restTemplate.getForObject("http://localhost:8011/stock/reduct", String.class);
//String msg = restTemplate.getForObject("http://stock-server/stock/reduct", String.class);
String reduct = stockFeignService.reduct();
String get = stockFeignService.get(1);
return "Hello order add " + reduct + get;
}
}
3. Spring Cloud Feign的自定义配置及使用
Feign 提供了很多的扩展机制，让用户可以更加灵活的使用。
3.1 日志配置
有时候我们遇到 Bug，比如接口调用失败、参数没收到等问题，或者想看看调用性能，就需要配置 Feign 的日志了，以此让 Feign 把请求信息输出来
3.1.1 定义一个配置类，指定日志级别
package com.xiexie.order.config;
import com.xiexie.order.interceptor.feign.CustomFeignInterceptor;
import feign.Contract;
import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @Description OpenFeign配置类
* <p>
* 全局配置：当使用@Configuration，会将配置作用于所有的服务提供方
* 局部配置：如果只想针对某一个或某些服务进行配置，就不需要加@Configuration注解
* @Date 2022-04-11 14:44
* @Author xie
*/
@Configuration
public class FeignConfig {
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
/**
* 修改契约配置，支持Feign原生的注解
*
* @return feign.Contract
*/
//@Bean
//public Contract feignContract() {
// return new feign.Contract.Default();
//}
/**
* 设置超时时间
* @return feign.Request.Options
*/
//@Bean
//public Request.Options options() {
// return new Request.Options(5000, 10000);
//}
/**
* 自定义拦截器
* @return com.xiexie.order.interceptor.feign.CustomFeignInterceptor
*/
//@Bean
//public CustomFeignInterceptor customFeignInterceptor() {
// return new CustomFeignInterceptor();
//}
}
通过源码可以看到日志等级有 4 种，分别是：
- NONE【性能最佳，适用于生产】：不记录任何日志（默认值）。
- BASIC【适用于生产环境追踪问题】：仅记录请求方法、URL、响应状态代码以及执行时间。
- HEADERS：记录BASIC级别的基础上，记录请求和响应的header。
- FULL【比较适用于开发及测试环境定位问题】：记录请求和响应的header、body和元数据。
3.1.2 局部配置（两种方式）如下：代码 或者 配置文件
局部配置，让调用的微服务生效，在@FeignClient 注解中指定使用的配置类
指定configuration = FeignConfig.class
package com.xiexie.order.feign;
import com.xiexie.order.config.FeignConfig;
import feign.Param;
import feign.Request;
import feign.RequestLine;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
/**
* @Description 添加feign接口和方法
* name: 指定调用rest接口所对应的服务名
* path: 指定调用rest接口所在的stockController所对应的@requestMapping
* configuration: 如果想针对某个或某些服务进行openFeign调用，去掉@Configuration注解，并在此声明
* @Date 2022-04-11 15:06
* @Author xie
*/
@FeignClient(name = "stock-server", path = "/stock", configuration = FeignConfig.class)
public interface StockFeignService {
@RequestMapping("/reduct")
public String reduct();
/**
* 在openFeign中必须要指定参数名 @PathVariable("id")
*
* @param id
* @return java.lang.String
*/
@RequestMapping("/{id}")
public String get(@PathVariable("id") Integer id);
/**
* 使用原生feign注解
*
* @param id
* @return java.lang.String
*/
//@RequestLine("GET /{id}")
//public String get(@Param("id") Integer id);
/**
* 使用原生feign注解
*
* @param id
* @return java.lang.String
*/
}
在yml配置文件中执行 Client 的日志级别才能正常输出日志，格式是"logging.level.feign接口包路径=debug"
# springboot的默认日志级别是info, feign的debug日志级别就不会输出（针对feign的接口包进行debug日志输出）
logging:
level:
com.xiexie.order.feign: debug
# 指定局部配置，针对某一个或某些服务进行配置
feign:
client:
config:
# 指定服务
stock-server:
# feign日志局部配置
loggerLevel: BASIC
3.2 契约配置
Spring Cloud 在 Feign 的基础上做了扩展，使用 Spring MVC 的注解来完成Feign的功能。原生的 Feign 是不支持 Spring MVC 注解的，如果你想在 Spring Cloud 中使用原生的注解方式来定义客户端也是可以的，通过配置契约来改变这个配置，Spring Cloud 中默认的是 SpringMvcContract。
3.2.1 修改契约配置，支持Feign原生的注解（两种方式）如下：代码 或者 配置文件
注意：修改契约配置后，OrderFeignService 不再支持springmvc的注解，需要使用Feign原生的注解
/**
* 修改契约配置，支持Feign原生的注解
*
* @return feign.Contract
*/
@Bean
public Contract feignContract() {
return new feign.Contract.Default();
}
也可以通过yml配置契约
# 指定局部配置，针对某一个或某些服务进行配置
feign:
client:
config:
# 指定服务
stock-server:
# feign日志局部配置
loggerLevel: BASIC
# 设置为默认的契约（还原成原生注解）
contract: feign.Contract.Default()
# 连接超时时间，默认2s
connectTimeout: 2000
# 读取超时时间，默认5s
readTimeout: 5000
# 配置拦截器
requestInterceptors[0]:
com.xiexie.order.interceptor.feign.CustomFeignInterceptor
3.2.2 使用Feign原生的注解
/**
* 使用原生feign注解
*
* @param id
* @return java.lang.String
*/
@RequestLine("GET /{id}")
public String get(@Param("id") Integer id);
3.3 自定义拦截器实现认证逻辑（两种方式）如下：代码 或者 配置文件
package com.xiexie.order.interceptor.feign;
import feign.RequestInterceptor;
import feign.RequestTemplate;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.UUID;
/**
* @Description 自定义openFeign拦截器
* @Date 2022-04-11 16:11
* @Author xie
*/
public class CustomFeignInterceptor implements RequestInterceptor {
private static final Logger LOGGER = LoggerFactory.getLogger(CustomFeignInterceptor.class);
public void apply(RequestTemplate requestTemplate) {
// 可以做拦截处理，比如认证或者日志等
LOGGER.info("feign拦截器");
String access_token = UUID.randomUUID().toString();
requestTemplate.header("Authorization", access_token);
//requestTemplate.uri();
}
}
package com.xiexie.order.config;
import com.xiexie.order.interceptor.feign.CustomFeignInterceptor;
import feign.Contract;
import feign.Logger;
import feign.Request;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* @Description OpenFeign配置类
* <p>
* 全局配置：当使用@Configuration，会将配置作用于所有的服务提供方
* 局部配置：如果只想针对某一个或某些服务进行配置，就不需要加@Configuration注解
* @Date 2022-04-11 14:44
* @Author xie
*/
@Configuration
public class FeignConfig {
@Bean
public Logger.Level feignLoggerLevel() {
return Logger.Level.FULL;
}
/**
* 修改契约配置，支持Feign原生的注解
*
* @return feign.Contract
*/
//@Bean
//public Contract feignContract() {
// return new feign.Contract.Default();
//}
/**
* 设置超时时间
* @return feign.Request.Options
*/
//@Bean
//public Request.Options options() {
// return new Request.Options(5000, 10000);
//}
/**
* 自定义拦截器
* @return com.xiexie.order.interceptor.feign.CustomFeignInterceptor
*/
@Bean
public CustomFeignInterceptor customFeignInterceptor() {
return new CustomFeignInterceptor();
}
}
通过yml配置
feign:
client:
config:
# 指定服务
stock-server:
# feign日志局部配置
loggerLevel: BASIC
# 设置为默认的契约（还原成原生注解）
# contract: feign.Contract.Default()
# 连接超时时间，默认2s
connectTimeout: 2000
# 读取超时时间，默认5s
readTimeout: 5000
# 配置拦截器
requestInterceptors[0]:
com.xiexie.order.interceptor.feign.CustomFeignInterceptor
3.4 超时时间配置（两种方式）如下：代码 或者 配置文件
通过 Options 可以配置连接超时时间和读取超时时间，Options 的第一个参数是连接的超时时间（ms），默认值是 2s；第二个是请求处理的超时时间（ms），默认值是 5s。
/**
* 设置超时时间
* @return feign.Request.Options
*/
@Bean
public Request.Options options() {
return new Request.Options(5000, 10000);
}
通过yml配置
feign:
client:
config:
# 指定服务
stock-server:
# feign日志局部配置
loggerLevel: BASIC
# 设置为默认的契约（还原成原生注解）
# contract: feign.Contract.Default()
# 连接超时时间，默认2s
connectTimeout: 2000
# 读取超时时间，默认5s
readTimeout: 5000
# 配置拦截器
requestInterceptors[0]:
com.xiexie.order.interceptor.feign.CustomFeignInterceptor
充补充说明： Feign的底层用的是Ribbon，但超时时间以Feign配置为准
3.5 客户端组件配置
Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求，我们可以集成别的组件来替换掉 URLConnection，比如 Apache HttpClient，OkHttp。
Feign发起调用真正执行逻辑：feign.Client#execute （扩展点）
3.5.1 配置Apache HttpClient
<!--替换Feign默认URLConnection为HttpClient-->
<dependency>
<groupId>org.apache.httpcomponents</groupId>
<artifactId>httpclient</artifactId>
<version>4.5.7</version>
</dependency>
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
<version>10.1.0</version>
</dependency>
修改yml配置，将 Feign 的 Apache HttpClient启用 ：
feign:
httpclient:
# feign 使用 Apache HttpClient 可以忽略，默认开启
enabled: true
关于配置可参考源码： org.springframework.cloud.openfeign.FeignAutoConfiguration
测试：调用会进入feign.httpclient.ApacheHttpClient#execute
3.5.2 配置 OkHttp
<!--替换Feign默认URLConnection为okhttp-->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
</dependency>
修改yml配置，将 Feign 的 Apache okhttp启用 ：
feign:
httpclient:
# feign 使用 Apache HttpClient 可以忽略，默认开启
enabled: false
# feign 使用 okhttp
okhttp:
enabled: true
关于配置可参考源码： org.springframework.cloud.openfeign.FeignAutoConfiguration
测试：调用会进入feign.okhttp.OkHttpClient#execute
3.6 GZIP 压缩配置
开启压缩可以有效节约网络资源，提升接口性能，我们可以配置 GZIP 来压缩数据：
feign:
httpclient:
# feign 使用 Apache HttpClient 可以忽略，默认开启
enabled: false
# feign 使用 okhttp
okhttp:
enabled: true
# 配置 GZIP 来压缩数据
compression:
request:
enabled: true
# 配置压缩的类型
mime-types: text/xml,application/xml,application/json
# 最小压缩值
min-request-size: 2048
response:
enabled: true
注意：只有当 Feign 的 Http Client 不是 okhttp3 的时候，压缩才会生效，配置源码在FeignAcceptGzipEncodingAutoConfiguration
核心代码就是 @ConditionalOnMissingBean（type="okhttp3.OkHttpClient"），表示Spring BeanFactory 中不包含指定的 bean 时条件匹配，也就是没有启用 okhttp3 时才会进行压缩配置。
欢迎一起来学习和指导，谢谢关注！
本文来自博客园，作者：xiexie0812，转载请注明原文链接：https://www.cnblogs.com/mask-xiexie/p/16131085.html
浙公网安备 33010602011771号