Android Retrofit Parameterized @Headers

Question

Tôi đang sử dụng OAuth và tôi cần đặt mã thông báo OAuth vào tiêu đề của mình mỗi lần tôi thực hiện yêu cầu. Tôi thấy chú thích @Header, nhưng có cách nào để làm cho nó được tham số hóa để tôi có thể truyền vào lúc chạy không?

Dưới đây là khái niệm

@Header({Authorization:'OAuth {var}', api_version={var} })

Bạn có thể vượt qua họ trong lúc Runtime?

@GET("/users") 
void getUsers(
    @Header("Authorization") String auth, 
    @Header("X-Api-Version") String version, 
    Callback<User> callback 
) 

Answer 1

Ngoài việc sử dụng @Header tham số, tôi muốn sử dụng RequestInterceptor để cập nhật tất cả các yêu cầu của bạn mà không thay đổi giao diện của bạn. Sử dụng một cái gì đó như:

RestAdapter.Builder builder = new RestAdapter.Builder() 
    .setRequestInterceptor(new RequestInterceptor() { 
     @Override 
     public void intercept(RequestFacade request) { 
      request.addHeader("Accept", "application/json;versions=1"); 
      if (isUserLoggedIn()) { 
       request.addHeader("Authorization", getToken()); 
      }      
     } 
    }); 

p/s: Nếu bạn đang sử dụng Retrofit2, bạn nên chú ý Interceptor thay vì RequestInterceptor

Kể từ RequestInterceptor là không còn có sẵn trong Retrofit 2.0

Answer 2

Có, bạn có thể chuyển chúng trong thời gian chạy. Như một vấn đề của thực tế, khá nhiều chính xác như bạn gõ nó ra. Đây sẽ là trong lớp giao diện API của bạn, tên nói SecretApiInterface.java

public interface SecretApiInterface { 

    @GET("/secret_things") 
    SecretThing.List getSecretThings(@Header("Authorization") String token) 

} 

Sau đó, bạn vượt qua các thông số để giao diện này từ yêu cầu của bạn, một cái gì đó dọc theo những đường: (tập tin này sẽ là ví dụ SecretThingRequest. java)

public class SecretThingRequest extends RetrofitSpiceRequest<SecretThing.List, SecretApiInteface>{ 

    private String token; 

    public SecretThingRequest(String token) { 
     super(SecretThing.List.class, SecretApiInterface.class); 
     this.token = token; 
    } 

    @Override 
    public SecretThing.List loadDataFromNetwork() { 
     SecretApiInterface service = getService(); 
     return service.getSecretThings(Somehow.Magically.getToken()); 
    } 
} 

đâu Somehow.Magically.getToken() là một lời gọi phương thức trả về một mã thông báo, đó là tùy thuộc vào bạn ở đâu và làm thế nào bạn định nghĩa nó.

Bạn có thể có nhiều hơn một @Header("Blah") String blah chú thích trong việc triển khai giao diện, như trong trường hợp của bạn!

tôi thấy nó khó hiểu quá, the documentation nói rõ nó thay thế tiêu đề, nhưng nó KHÔNG!
Nó được trong thực tế bổ sung như với @Headers("hardcoded_string_of_liited_use") chú thích

Hope this helps;)

Answer 3

Câu trả lời được chấp nhận là cho phiên bản cũ của Retrofit. Đối với người xem trong tương lai, cách thực hiện điều này với Retrofit 2.0 đang sử dụng ứng dụng khách OkHttp tùy chỉnh:

OkHttpClient httpClient = new OkHttpClient.Builder() 
    .addInterceptor(new Interceptor() { 
    @Override 
    public Response intercept(Chain chain) throws IOException { 
     Builder ongoing = chain.request().newBuilder(); 
     ongoing.addHeader("Accept", "application/json;versions=1"); 
     if (isUserLoggedIn()) { 
     ongoing.addHeader("Authorization", getToken()); 
     } 
     return chain.proceed(ongoing.build()); 
    } 
    }) 
    .build(); 

Retrofit retrofit = new Retrofit.Builder() 
    // ... extra config 
    .client(httpClient) 
    .build(); 

Hy vọng nó sẽ giúp ai đó. :)