从响应中获取 Header(改造/OkHttp 客户端)
Getting Header from Response (Retrofit / OkHttp Client)
我正在将 Retrofit 与 OkHttp 客户端和 Jackson 一起用于 Json 序列化,并希望获得响应的 header。
我知道我可以扩展 OkClient
并拦截它。但这是在反序列化过程开始之前。
我基本上需要的是获得 header 以及反序列化的 Json Object.
使用Retrofit 1.9.0,如果使用接口的Callback异步版本,
@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>>
在 Retrofit 2.0.0 中,您可以这样获得 header:
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
}
});
就像你一样,我想要 headers 在有效载荷的旁边。我需要访问 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);
首先打印整个响应,body,代码,消息,header(通过日志记录或其他方式)并尝试从那里找到线索。
我建议您阅读 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") 整数计数器);
我正在将 Retrofit 与 OkHttp 客户端和 Jackson 一起用于 Json 序列化,并希望获得响应的 header。
我知道我可以扩展 OkClient 并拦截它。但这是在反序列化过程开始之前。
我基本上需要的是获得 header 以及反序列化的 Json Object.
使用Retrofit 1.9.0,如果使用接口的Callback异步版本,
@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>>
在 Retrofit 2.0.0 中,您可以这样获得 header:
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
}
});
就像你一样,我想要 headers 在有效载荷的旁边。我需要访问 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);
首先打印整个响应,body,代码,消息,header(通过日志记录或其他方式)并尝试从那里找到线索。
我建议您阅读 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") 整数计数器);