从响应中获取头信息(Retrofit / OkHttp客户端)

57
我正在使用Retrofit和OkHttp客户端以及Jackson进行Json序列化,并希望获取响应的标头。
我知道可以扩展OkClient并拦截它,但这是在反序列化过程开始之前发生的。
基本上我需要的是在反序列化JSON对象时同时获取标头。
4个回答

59

使用 Retrofit 1.9.0 版本时,如果您使用接口的异步回调版本,

@GET("/user")
void getUser(Callback<User> callback)

然后您的回调函数将收到一个Response对象。

    Callback<User> user = new Callback<User>() {
        @Override
        public void success(User user, Response response) {

        }

        @Override
        public void failure(RetrofitError error) {

        }
    }

具有名为getHeaders()的方法

    Callback<User> user = new Callback<User>() {
        @Override
        public void success(User user, Response response) {
            List<Header> headerList = response.getHeaders();
            for(Header header : headerList) {
                Log.d(TAG, header.getName() + " " + header.getValue());
            }
        }

对于Retrofit 2.0的接口,您可以使用Call<T>实现此功能。

对于Retrofit 2.0的Rx支持,您可以使用Observable<Result<T>>实现此功能。


1
在 Retrofit 1.9.0 中不支持,但在 Retrofit 2.0+ 中可以使用 Call<T>.execute() - EpicPandaForce
1
@murt 在 Github 存储库中最新的代码似乎可以允许您指定 Observable<Result<T>>,它会给您 response 作为参数,而 response 具有头信息。 - EpicPandaForce
1
@murt 实际上,现在我进一步阅读后,你应该能够获得Observable<Result<T>>,即使是使用你当前的版本。对于最初的错误信息,我很抱歉:( - EpicPandaForce
1
@Lester 显然我之前说错了,你应该可以获得一个 Observable<Result<T>>,其中也有头信息。 - EpicPandaForce
1
如果你正在寻找包含API头部和正文信息的RxJava + Retrofit完整响应,则可以使用此代码-> Observable<Response<ResponseBody>> - Kidus Tekeste
显示剩余4条评论

53
在Retrofit 2.0.0中,您可以像这样获取标题:
public interface Api {
    @GET("user")
    Call<User> getUser();
}

Call<User> call = api.getUser();
call.enqueue(new Callback<User>() {
    @Override
    public void onResponse(Call<User> call, Response<User> response) {
        // get headers
        Headers headers = response.headers();
        // get header value
        String cookie = response.headers().get("Set-Cookie");
        // TODO
    }

    @Override
    public void onFailure(Call<User> call, Throwable t) {
        // TODO
    }
});

如何循环遍历所有标题?我有4-5个标题,其中“set-cookie”是一个关键字。 - Prabs
6
使用 foreach 遍历列表,返回翻译后的文本:List<String> cookieList = headers.toMultimap().get("set-cookie"); - Prabs
或者像这样:headers.values("Set-Cookie"). - Edi

3

跟你一样,我想要头部信息与载荷并列。我需要访问ETag。这需要一些技巧,但是你可以做到。以下是我的做法。这只是一个简单的例子,请勿把它当作最佳实践的样本。

public static RestAdapter.Builder getRestBuilder(Context context) {
    GsonBuilder gsonBuilder = GsonBuilderUtils.getBuilder();
    Gson gson = gsonBuilder.create();
    // **
    // 1. create our own custom deserializer here
    // **
    final MyGsonConverter gsonConverter = new MyGsonConverter(gson);
    OkHttpClient httpClient = MyPersonalOkHttpFactory.getInstance().getAuthHttpClient(context);
    httpClient.networkInterceptors().add(new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Request originalRequest = chain.request();
            Response response = chain.proceed(originalRequest);
            // **
            // 2. add the headers from the Interceptor to our deserializer instance
            // **
            gsonConverter.headers = response.headers();
            return response;
        }
    });
    RestAdapter.Builder builder = new RestAdapter.Builder()
            .setClient(new OkClient(httpClient))
            .setEndpoint(Common.getApiOriginUrl())
            .setConverter(gsonConverter);
    return builder;
}

private static class MyGsonConverter extends GsonConverter {

    private Headers headers;

    public MyGsonConverter(Gson gson) {
        super(gson);
    }

    @Override
    public Object fromBody(TypedInput body, Type type) throws ConversionException {
        Object obj =  super.fromBody(body, type);
        // **
        // 3. at this point, gson is called and you have access to headers
        // do whatever you want here. I just set it on the return object.
        // ** 
        if (obj instanceof HeadersArrayList) {
            ((HeadersArrayList)obj).setHeaders(headers);
        }
        return obj;
    }
}

public class HeadersArrayList<K> extends ArrayList<K>{

    private Headers headers;

    public Headers getHeaders() {
        return headers;
    }

    public void setHeaders(Headers headers) {
        this.headers = headers;
    }
}

// the retrofit api for reference
@GET("/api/of/my/backend/{stuff}")
HeadersArrayList<String> getSomething(@Path("stuff") String stuff);

-3

首先打印整个响应、正文、代码、消息、标题(通过日志或其他方式)然后尝试从中找到线索。

我建议您阅读API文档,了解它要求的请求类型。

使用Postman检查以下哪一个是有效的: 1.form-data 2.x-www-form-Urlencoded 3.raw 4.binary

然后在接口方法声明中相应地设置注释。

例如:在我的情况下,它正在使用x-www-form-Urlencoded,所以我必须使用

@FormUrlEncoded @Headers("Content-Type: application/x-www-form-urlencoded")

在方法声明中进行说明。

然后使用@Field注释发送的每个值,例如:

Call<'ReturnObj'> Signup(@Field("name") String name, @Field("phoneNumber") long phoneNumber, @Field("password") String password, @Field("counter") int counter);


这并没有回答原帖。 - Miguel Alorda

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接