一.简介
Java项目中接口调用:
- HttpClient: Apache Jakarta Common下的子项目,用来提供高效的、最新的、功能丰富的支持 Http 协议的客户端编程工具包,并且它支持 HTTP 协议最新版本和建议。
- Okhttp:一个处理网络请求的开源项目,是安卓端最火的轻量级框架,由 Square 公司贡献,用于替代 HttpUrlConnection 和 Apache HttpClient。OkHttp 拥有简洁的 API、高效的性能,并支持多种协议(HTTP/2 和 SPDY)。
- HttpURLConnection:是 Java的标准类,它继承自 URLConnection,可用于向指定网站发送 GET 请求、POST 请求。HttpURLConnection 使用比较复杂,不像 HttpClient 那样容易使用。
- RestTemplate: Spring提供的用于访问 Rest 服务的客户端,RestTemplate 提供了多种便捷访问远程 HTTP 服务的方法,能够大大提高客户端的编写效率。
上面是常用的方法,我们下面介绍一个简单的Feign。Feign是一个声明式的REST的客户端,能让REST调用更加简单。Feign提供HTTP模板,通过编写简单的接口和插入注解,就可以定义好HTTP请求的参数,格式,地址等信息。Feign完全代理http请求,只需要像调用方法一样调用就可以完成服务请求。
Spring Cloud对Feign进行了封装,使其支持SpringMVC注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合用于支持负载均衡。
Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端Feign内置了Ribbon,用来做客户端负载均衡,去调用服务注册中心的服务。Feign的使用方式是:使用Feign的注解定义接口,调用这个接口,就可以调用服务注册中心的服务。
OpenFeign是Spring Cloud在Feign的基础上支持了SpringMVC的注解,如@RequesMapping等等。OpenFeign的@Feignclient可以解析SpringMVc的@RequestMapping注解下的接口,并通过动态代理的方式产生实现类,实现类中做负载均衡并调用其他服务。
二.OpenFeign
2.1 使用
1.增加依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
2.定义一个Feign的客户端,以接口形式存在:
// 使用 @FeignClient 注解来指定提供者的名字
@FeignClient(value = "eureka-client-provider")
public interface TestClient {
// 这里一定要注意需要使用的是提供者那端的请求相对路径,这里就相当于映射了
@RequestMapping(value = "/provider/xxx",
method = RequestMethod.POST)
CommonResponse<List<Plan>> getPlans(@RequestBody planGetRequest request);
}
3.在Controller层中像调用Service层一样调用(想要共用,可以单独创建一个API Client的公共项目,基于约定的形式,每写一个接口就写一个调用的Client,后面打成共用的Jar,无论哪个项目想使用,只需要调用公共的SDK jar,就可以了)
@RestController
public class TestController {
// 这里就相当于原来自动注入的 Service
@Autowired
private TestClient testClient;
// controller 调用 service 层代码
@RequestMapping(value = "/test", method = RequestMethod.POST)
public CommonResponse<List<Plan>> get(@RequestBody planGetRequest request) {
return testClient.getPlans(request);
}
}
4.在启动类上加上@EnableFeignClients注解,如果Feign定义的接口和启动类不在一个包名下,,还需要定制扫描的包名@EnableFeignClients(basePackages="")
2.2 源码分析
查看FeiginClient注解的源码:
@Target({ElementType.TYPE}) //表明注解使用在接口上
@Retention(RetentionPolicy.RUNTIME) //表示该注解会在Class字节码文件中存在,在运行时可以通过反射获取到
@Documented //该注解将被包含在JavaDoc中
public @interface FeignClient {
@AliasFor("name")
String value() default "";
/** @deprecated */
@Deprecated
String serviceId() default "";
String contextId() default "";
@AliasFor("value")
String name() default "";
String qualifier() default "";
String url() default "";
boolean decode404() default false;
Class<?>[] configuration() default {};
Class<?> fallback() default void.class;
Class<?> fallbackFactory() default void.class;
String path() default "";
boolean primary() default true;
}
@FeignClient注解用于创建声明式API接口,该接口是RESTFul风格的。在源码中,value()和name()一样,是被调用服务的ServiceId。url()直接填写硬编码的URL地址,decode404()是被解码,还是抛异常。configuration()指明FeignClient的配置类,默认的配置类为FeignClientsConfiguration类, 在缺省的情况下,这个类默认注入默认的Decoder,Encoder等配置类。fallback()是配置熔断器的处理类。
Feign通过处理注解生成Request模板,从而简化HTTP API的开发。开发人员可以使用注解的方式定制Request API模板。在发送Http Request请求之前,Feign通过处理注解的方法替换到Request模板的参数,生成真正的Request,并交给Java Http客户端去处理。利用这种方式,开发者只需要关注Feign注解模板的开发,而不用关注Http请求本身,简化HTTP请求的过程。
Feign通过包扫描注入FeignClient的Bean,该源码在FeignClientRegister类中。首先在程序启动时,会检查是否有@EnableFeignClients注解,如果有该注解,则开启包扫描,扫描被@FeignClient注解的接口,代码如下:
private void registerDefaultConfiguration(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
Map<String, Object> defaultAttrs = m