313 Star 3.4K Fork 719

dromara / forest

 / 详情

自动重定向控制

已完成
拥有者
创建于  
2021-09-19 02:26

之前版本无法正确处理 301、302、307 等重定向请求,而且 okhttp 和 httpclient 默认处理方式又有所不同,造成很多重定向相关的问题。

以下是新版本对重定向处理的办法

重定向请求的日志

默认自动触发重定向,重定向的请求日志如下:

[Forest] Request (okhttp3):
	[Redirect]: From POST http://localhost:59006/ -> 301
	POST http://localhost:59006/b HTTP

如何在自动重定向的模式下处理和获取信息

拦截器的 onRedirection 方法会在重定向地址转移请求发送前触发,以此获得以一次的Request和Response对象,
即返回 301、302 等状态码的响应对象。

同时,还能对地址转移请求做修改

public class RedirectInterceptor implements Interceptor<Object> {

    @Override
    public void onRedirection(ForestRequest<?> redirectReq, ForestRequest<?> prevReq, ForestResponse<?> prevRes) {
        // 获取转移前请求信息
        String prevUrl = prevReq.getUrl();
        // 获取转移前响应信息
        String location = prevRes.getHeader("Location");
        // 对地址转移请求做修改
        redirectReq.addBody("body", "xxx");
    }
}

除了拦截器可以截取转移前请求和响应对象外,也可以通过 OnRedirection 回调函数接口进行同样的操作:

// OnRedirection 为重定向回调函数,会在url转移前触发
 @Post("/")
ForestResponse<String> sendData(OnRedirection onRedirection);

... ...

ForestResponse<String> response = sendData((redirectReq, prevReq, prevRes) -> {
        // 获取转移前请求信息
        String prevUrl = prevReq.getUrl();
        // 获取转移前响应信息
        String location = prevRes.getHeader("Location");
        // 对地址转移请求做修改
        redirectReq.addBody("body", "xxx");
});

打开/关闭自动重定向

以上是第一种模式,即自动重定向模式,也可以关闭自动重定向, 可以有两种方式打开和关闭重定向:

  1. 打开/关闭全局自动重定向配置:
forest:
  ... ...
  # 全局自动重定向开关,默认为开启
  auto-redirection: false
  1. 除了全局开关,还可以使用 @Redirection 注解,它能控制到具体的接口和方法
// 打开整个接口方法的自动重定向
@Redirection
public interface MyTestClient {

    // 关闭某个方法的重定向
    @Redirection(false)
    @Get("/")
    String getData();
    
    ... ...
}

// 关闭整个接口方法的自动重定向
@Redirection(false)
public interface MyTestClient {

    // 打开某个方法的重定向
    @Redirection
    @Get("/")
    String getData();
    
    ... ...
}

如何在关闭自动重定向的模式下处理和获取信息

// 关闭了自动重定向
// 需要将方法返回值设为 ForestResponse 类型
@Redirection(false)
@Get("/")
ForestResponse<String> getData();

通过 ForestReposne.isRedirection() 判断是否需要重定向转移,再通过 ForestResponse.redirectionRequest() 获取重定向Url转移请求对象。

// 调用接口获得转移前的响应对象
ForestResponse<String> response = client.getData();
// 判断是否需要重定向转移
if (response.isRedirection()) {
    // 获得转移请求对象,并执行
    String result = response.redirectionRequest().executeAsString();
    ... ...
}

这时,拦截器和 OnRedirection 回调函数同样有效。

评论 (2)

公子骏 创建了任务
公子骏 关联仓库设置为dromara/forest
公子骏 任务状态待办的 修改为进行中
公子骏 负责人设置为公子骏
公子骏 添加了
 
新需求
标签
展开全部操作日志

公子爷顶的一批!!!

已在1.5.2版本实现

公子骏 任务状态进行中 修改为已完成

登录 后才可以发表评论

状态
负责人
里程碑
Pull Requests
关联的 Pull Requests 被合并后可能会关闭此 issue
分支
开始日期   -   截止日期
-
置顶选项
优先级
参与者(2)
1216742 dt flys 1594991700
Java
1
https://gitee.com/dromara/forest.git
git@gitee.com:dromara/forest.git
dromara
forest
forest

搜索帮助

14c37bed 8189591 565d56ea 8189591