Java项目如何实现接口调用
1)Httpclient
HttpClient 是 Apache Jakarta Common 下的子项目,用来提供高效的、最新的、功能丰富
的支持 Http 协议的客户端编程工具包,并且它支持 HTTP 协议最新版本和建议。HttpClient
相比传统 JDK 自带的 URLConnection,提升了易用性和灵活性,使客户端发送 HTTP 请求变
得容易,提高了开发的效率。
2)Okhttp
一个处理网络请求的开源项目,是安卓端最火的轻量级框架,由 Square 公司贡献,用于替代
HttpUrlConnection 和 Apache HttpClient。OkHttp 拥有简洁的 API、高效的性能,并支持
多种协议(HTTP/2 和 SPDY)。
3)HttpURLConnection
HttpURLConnection 是 Java 的标准类,它继承自 URLConnection,可用于向指定网站发送
GET 请求、POST 请求。HttpURLConnection 使用比较复杂,不像 HttpClient 那样容易使
用。
4)RestTemplate WebClient
RestTemplate 是 Spring 提供的用于访问 Rest 服务的客户端,RestTemplate 提供了多种便
捷访问远程 HTTP 服务的方法,能够大大提高客户端的编写效率。
什么是Feign
Feign是Netflix开发的声明式、模板化的HTTP客户端,Spring Cloud openfeign对Feign进行了增强,使其支持Spring MVC注解,另外还整合了Ribbon和Nacos,从而使得Feign的使用更加方便
Feign可以做到使用 HTTP 请求远程服务时就像调用本地方法一样的体验,开发者完全感知不到这是远程方法,更感知不到这是个 HTTP 请求。
Spring Cloud Alibaba快速整合OpenFeign
1.添加依赖
1 <!‐‐ openfeign 远程调用 ‐‐>
2 <dependency>
3 <groupId>org.springframework.cloud</groupId>
4 <artifactId>spring‐cloud‐starter‐openfeign</artifactId>
5 </dependency>
2.编写调用接口+@FeignClient注解
1 @FeignClient(value = "mall‐order",path = "/order")
2 public interface OrderFeignService {
3
4 @RequestMapping("/findOrderByUserId/{userId}")
5 public R findOrderByUserId(@PathVariable("userId") Integer userId);
6 }
3.调用端在启动类上添加@EnableFeignClients
1 @SpringBootApplication
2 @EnableFeignClients
3 public class MallUserFeignDemoApplication {
4 public static void main(String[] args) {
5 SpringApplication.run(MallUserFeignDemoApplication.class, args);
6 }
7 }
4.发起调用,像调用本地方式一样调用远程服务
1 @RestController
2 @RequestMapping("/user")
3 public class UserController {
5 @Autowired
6 OrderFeignService orderFeignService;
7
8 @RequestMapping(value = "/findOrderByUserId/{id}")
9 public R findOrderByUserId(@PathVariable("id") Integer id) {
10 //feign调用
11 R result = orderFeignService.findOrderByUserId(id);
12 return result;
13 }
14 }
springcloud Feign的自定义配置及使用
日志配置
有时候我们遇到 Bug,比如接口调用失败、参数没收到等问题,或者想看看调用性能,就需要配置 Feign 的日志了,以此让 Feign 把请求信息输出来
1.定义一个配置类,指定日志级别
1 // 注意: 此处配置@Configuration注解就会全局生效,如果想指定对应微服务生效,就不
能配置
2 public class FeignConfig {
3 /**
4 * 日志级别
5 *
6 * @return
7 */
8 @Bean
9 public Logger.Level feignLoggerLevel() {
10 return Logger.Level.FULL;
11 }
12 }
可以看到日志等级有 4 种,分别是:
NONE【性能最佳,适用于生产】:不记录任何日志(默认值)。
BASIC【适用于生产环境追踪问题】:仅记录请求方法、URL、响应状态代码以及
执行时间。
HEADERS:记录BASIC级别的基础上,记录请求和响应的header。
FULL【比较适用于开发及测试环境定位问题】:记录请求和响应的header、body
和元数据。
局部配置,让调用的微服务生效,在@FeignClient 注解中指定使用的配置类
图灵课堂
3) 在yml配置文件中执行 Client 的日志级别才能正常输出日志,格式是"logging.level.feign接口包路径
=debug"
1 logging:
2 level:
3 com.tuling.mall.feigndemo.feign: debug
局部配置可以在yml中配置
对应属性配置类:
org.springframework.cloud.openfeign.FeignClientProperties.FeignClientConfiguration
1 feign:
2 client:
3 config:
4 mall‐order: #对应微服务
5 loggerLevel: FULL
契约配置
Spring Cloud 在 Feign 的基础上做了扩展,使用 Spring MVC 的注解来完成Feign的功
能。原生的 Feign 是不支持 Spring MVC 注解的,如果你想在 Spring Cloud 中使用原生的
注解方式来定义客户端也是可以的,通过配置契约来改变这个配置,Spring Cloud 中默认的
是 SpringMvcContract,
//修改契约配置,支持Feign原生的注解
1 /**
2 * 修改契约配置,支持Feign原生的注解
3 * @return
4 */
5 @Bean
6 public Contract feignContract() {
7 return new Contract.Default();
8 }
修改契约配置后,OrderFeignService 不再支持springmvc的注解,需要使用Feign原生的注解
OrderFeignService 中配置使用Feign原生的注解
1 @FeignClient(value = "mall‐order",path = "/order")
2 public interface OrderFeignService {
3 @RequestLine("GET /findOrderByUserId/{userId}")
4 public R findOrderByUserId(@Param("userId") Integer userId);
5 }
通过yml文件配置契约
feign:
2 client:
3 config:
4 mall‐order: #对应微服务
5 loggerLevel: FULL
6 contract: feign.Contract.Default #指定Feign原生注解契约配置
自定义拦截器实现认证逻辑
public class FeignAuthRequestInterceptor implements RequestInterceptor {
2 @Override
3 public void apply(RequestTemplate template) {
4 // 业务逻辑
5 String access_token = UUID.randomUUID().toString();
6 template.header("Authorization",access_token);
7 }
8 }
9
10 @Configuration // 全局配置
11 public class FeignConfig {
12 @Bean
13 public Logger.Level feignLoggerLevel() {
14 return Logger.Level.FULL;
15 }
16 /**
17 * 自定义拦截器
18 * @return
19 */
20 @Bean
21 public FeignAuthRequestInterceptor feignAuthRequestInterceptor(){
22 return new FeignAuthRequestInterceptor();
图灵课堂
23 }
24 }
可以在yml中配置
1 feign:
2 client:
3 config:
4 mall‐order: #对应微服务
5 requestInterceptors[0]: #配置拦截器
6 com.tuling.mall.feigndemo.interceptor.FeignAuthRequestInterceptor
超时时间配置
通过 Options 可以配置连接超时时间和读取超时时间,Options 的第一个参数是连接的超时
时间(ms),默认值是 2s;第二个是请求处理的超时时间(ms),默认值是 5s。
全局配置
1 @Configuration
2 public class FeignConfig {
3 @Bean
4 public Request.Options options() {
5 return new Request.Options(5000, 10000);
6 }
7 }
yml中配置
1 feign:
2 client:
3 config:
4 mall‐order: #对应微服务
5 # 连接超时时间,默认2s
6 connectTimeout: 5000
7 # 请求处理超时时间,默认5s
8 readTimeout: 10000
补充说明: Feign的底层用的是Ribbon,但超时时间以Feign配置为准
客户端组件配置
Feign 中默认使用 JDK 原生的 URLConnection 发送 HTTP 请求,我们可以集成别的组件来
替换掉 URLConnection,比如 Apache HttpClient,OkHttp。
Feign发起调用真正执行逻辑:feign.Client#execute
![](/qrcode.jpg)
配置apache httpclient
引入依赖
1 <!‐‐ Apache HttpClient ‐‐>
2 <dependency>
3 <groupId>org.apache.httpcomponents</groupId>
4 <artifactId>httpclient</artifactId>
5 <version>4.5.7</version>
6 </dependency>
7 <dependency>
8 <groupId>io.github.openfeign</groupId>
9 <artifactId>feign‐httpclient</artifactId>
10 <version>10.1.0</version>
11 </dependency>
然后修改yml配置,将 Feign 的 Apache HttpClient启用 :
1 feign:
2 #feign 使用 Apache HttpClient 可以忽略,默认开启
3 httpclient:
4 enabled: true
配置 OkHttp
引入依赖
1 <dependency>
2 <groupId>io.github.openfeign</groupId>
3 <artifactId>feign‐okhttp</artifactId>
4 </dependency>
然后修改yml配置,将 Feign 的 HttpClient 禁用,启用 OkHttp,配置如下:
1 feign:
2 #feign 使用 okhttp
3 httpclient:
4 enabled: false
5 okhttp:
6 enabled: true
GZIP 压缩配置
开启压缩可以有效节约网络资源,提升接口性能,我们可以配置 GZIP 来压缩数据:
1 feign:
2 # 配置 GZIP 来压缩数据
3 compression:
4 request:
5 enabled: true
6 # 配置压缩的类型
7 mime‐types: text/xml,application/xml,application/json
8 # 最小压缩值
图灵课堂
9 min‐request‐size: 2048
10 response:
11 enabled: true
只有当 Feign 的 Http Client 不是 okhttp3 的时候,压缩才会生效,配置源码在FeignAcceptGzipEncodingAutoConfiguration