一、三步搞定 HTTP 请求
今天要给大家介绍的主角是 Feign 。Feign 是一个受到 Retrofit,JAXRS-2.0 和 WebSocket 启发的 Java 到 HTTP 客户端绑定器。 Feign 的第一个目标是降低 HTTP API 的复杂性。官网:https://github.com/OpenFeign/feign
- 首先导入 maven 坐标,我们选择 feign-jackson 集成 jackson 解析 JSON。10.X 版本需要 JDK1.8 以上。
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-jackson</artifactId>
<version>10.2.3</version>
</dependency>
- 编写接口使用注解来操作 Feign 如何发送 http 请求。
public interface LemonAPI {
@RequestLine("GET /user/formGet?username={username}&password={password}")
String get(@Param("username") String username, @Param("password") String password);
}
- 在 main 方法中调用 Feign.bulider()指定请求 uri 并且调用接口中的方法,最终在控制台打印结果返回值。
public class App {
public static void main(String[] args) {
LemonAPI lemonAPI = Feign.builder()
.target(LemonAPI.class, "http://localhost:8899");
String result = lemonAPI.get("abc", "123");
System.out.println(result);
}
}
二、Feign 接口注解
在定义接口时,需要使用 Feign 接口注解定义 Http 请求类型、请求头、请求体、请求参数等等。
注解 | 类型 | 说明 |
---|---|---|
@RequestLine | Method | 定义其请求方式和请求路径(UriTemplate)。请求路径以斜杠开始,中间可以使用{变量名称},表达式的值由@Param 注解提供。 |
@Param | Parameter | 定义变量模板,可通过表达式{变量名称}引用变量的值。 |
@Headers | Method, Type | 定义请求头,可以使用{变量名称},表达式的值由@Param 注解提供。 |
@QueryMap | Parameter | 定义 Map 或者 POJO 类型参数。 |
@HeaderMap | Parameter | 定义 Map 类型的请求头。 |
@Body | Method | 对@Param 扩展,配合@Headers 使用可定义 JSON、XML 类型参数。 |
例子 1:
//请求方式POST,请求路径/user/formPost
@RequestLine("POST /user/formPost")
//请求头表单提交方式
@Headers("Content-Type: application/x-www-form-urlencoded;charset=UTF-8")
//参数格式name1=value1&name2=value2,参数值由@Param对应提供
@Body("username={username}&password={password}")
String formPost(@Param("username") String username, @Param("password") String password);
例子 2:
//请求方式GET 请求路径/user/formGet?name1=value1&name2=value2,参数值由@Param对应提供
@RequestLine("GET /user/formGet?username={username}&password={password}")
String formGet(@Param("username") String username, @Param("password") String password);
//请求方式GET 请求路径/find,参数值由@QueryMap 提供,自动添加到uri后面
@RequestLine("GET /find")
String find(@QueryMap Map<String, Object> queryMap);
三、Feign API 介绍。
- target() 指定接口类型和 URL 地址返回接口 Http 代理对象,从而通过代理对象调用方法发送 HTTP 请求。
除了 target 方法之外,还有一些可选方法。如下: - client() Feign 在默认情况下使用的是 JDK 原生的 URLConnection 发送 HTTP 请求,通过 client 方法可配置其他 HTTP 客户端,如 HttpClient、OkHttpClient、Http2Client 等。
- options() 指定连接超时时长及响应超时时长,单位毫秒。
- retryer() 指定重试策略,参数分别是最小时间,最大时间,重连次数。
- encoder() decoder() 指定编码/解码方式默认是 String,可配置 Gson、Jackson、Sax 等。
- logger() logLevel() 指定日志和日志等级,可配置 SLF4J 等。
注意:如果需要使用 Jackson、SLF4J、Gson、Sax、OkHttpClient、Http2Client、HttpClient 等需要导入对应坐标。
例子:
LemonApi lemonApi = Feign.builder()
//使用OkHttpClient作为HTTP请求客户端
.client(new OkHttpClient())
//1000ms连接超时、5000ms响应超时
.options(new Options(1000, 5000))
//基础重连时间500ms,最大重连时间5000ms,尝试重连次数3次(每次重连时间在基础上*1.5但不能大于最大重连时间)
.retryer(new Retryer.Default(500,5000,3))
//使用Jackson编码和解码
.encoder(new JacksonEncoder())
.decoder(new JacksonDecoder())
//使用Feign自带日志并输出到项目路径logs/http.log下
.logger(new Logger.JavaLogger().appendToFile("logs/http.log"))
//日志级别FULL,记录请求和响应所有信息。
.logLevel(Logger.Level.FULL)
//设置请求URL,对LemonApi接口创建HTTP代理类。
.target(LemonApi.class, "http://localhost:8899");
//使用代理类发起HTTP请求
String formGet = lemonApi.formGet("abc", "123");
欢迎来到testingpai.com!
注册 关于