Forest 是一个开源的 Java HTTP 客户端框架,它能够将 HTTP 的所有请求信息(包括 URL、Header 以及 Body 等信息)绑定到您自定义的 Interface 方法上,能够通过调用本地接口方法的方式发送 HTTP 请求。
官方链接:
🎁 新手介绍 | Forest
阿丹:
在之前的技术栈中没有涉及到这里,但是在近期的项目中涉及到了http请求的调用。于是学习和使用了新的技术栈。
导入依赖
<dependency>
<groupId>com.dtflys.forest</groupId>
<artifactId>forest-spring-boot-starter</artifactId>
<version>1.5.33</version>
</dependency>
JOSN框架依赖
注意:如果项目中已经存在了json的框架使用那么不需要导入这个依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.73</version>
</dependency>
XML框架依赖
<dependency>
<groupId>com.dtflys.forest</groupId>
<artifactId>forest-jaxb</artifactId>
<version>1.5.33</version>
</dependency>
spring-boot环境下的简单使用
在上面的依赖导入好了以后就可以进行去构建http请求的接口调用了。
在 Forest 中,所有的 HTTP 请求信息都要绑定到某一个接口的方法上,不需要编写具体的代码去发送请求。请求发送方通过调用事先定义好 HTTP 请求信息的接口方法,自动去执行 HTTP 发送请求的过程,其具体发送请求信息就是该方法对应绑定的 HTTP 请求信息
阿丹:
该说不说!这个方式是什么优雅简单!!!!
快速构建一个GET请求
1、创建一个接口
操作:
使用@Get注解,并且在这个注解value值中写入url
解读一下:
在前面的String说明了这个接口要返回一段字符串来
2、使用!!!你没看错就是直接使用!!!
首先在需要使用的地方使用@Resource直接注入
然后使用的时候直接进行调用即可!!!
3、效果演示!
你别看返回了一个json,但是它其实还是一个字符串,只是使用了测试工具进行了美化。
这个一定要知道!!!
进阶使用!!!!
学习展示一下官方是实例
如何构建请求?
构建请求头
public interface MyClient {
@Request(
url = "http://localhost:8080/hello/user",
headers = "Accept: text/plain"
)
String sendRequest(@Query("uname") String username);
}
上面的sendRequest
方法绑定的 HTTP 请求,定义了 URL 信息,以及把Accept:text/plain
加到了请求头中, 方法的参数String username
绑定了注解@Query("uname")
,它的作用是将调用者传入入参 username 时,自动将username
的值加入到 HTTP 的请求参数uname
中。
请求方法
HTTP 请求方法 | 请求注解 | 描述 | ||
---|---|---|---|---|
GET |
|
| ||
POST | @Post 、@PostRequest |
| ||
PUT | @Put 、@PutRequest |
| ||
HEAD | @HeadRequest |
| ||
DELETE | @Delete 、@DeleteRequest |
| ||
OPTIONS | @Options 、@OptionsRequest | 询问支持的方法 | ||
TRACE | @Trace 、@TraceRequest | 追踪路径 | ||
PATCH | @Patch 、@PatchRequest |
| ||
不定方法 |
|
|
其中在这个中使用的传递参数的方法是{value}的方式,同时在下面的形参中使用@Var注解的方式来赋值。
若不想在接口定义的时候直接定死为某个具体的 HTTP 请求方法,而是想从全局变量或方法参数中动态传入
可以使用 @Request
请求注解
/**
* 通过在 @Request 注解的 type 属性中定义字符串模板
* 在字符串模板中引用方法的参数
*/
@Request(
url = "http://localhost:8080/hello",
type = "{type}"
)
String simpleRequest(@Var("type") String type);
在调用改方法时通过参数传入 HTTP 请求方法类型(字符串类型,大小写不敏感)
// POST 请求
String result1 = simpleRequest("post");
// DELETE 请求
String result2 = simpleRequest("DELETE");
更多操作看官网文档很详细
🍭 请求头 | Forest