web-dev-qa-db-ja.com

応答からヘッダーを取得(Retrofit / OkHttp Client)

RetrofitをOkHttpクライアントとJackson for Json Serializationで使用しており、応答のヘッダーを取得したい。

OkClientを拡張してインターセプトできることを知っています。ただし、これは逆シリアル化プロセスが開始される前に行われます。

基本的に必要なのは、デシリアライズされたJsonオブジェクトと一緒にヘッダーを取得することです。

38
dknaack

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>>_ でこれを行うことができます

41
EpicPandaForce

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
    }
});
35
Spark.Bao

あなたと同じように、ペイロードの横にヘッダーが必要でした。 Etagにアクセスする必要がありました。 retro-fooが必要ですが、それは可能です。これが私がしたことです。これは汚いサンプルなので、これをベストプラクティスのサンプルとして使用しないでください。

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);
2
whizzle