Android Retrofit Parameterized @Headers

Question

我正在使用OAuth，每次发出请求时都需要将OAuth令牌放入我的标头中。我看到了@Header注释，但有没有办法让它参数化，以便我可以在运行时传入？

这里是

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

您可以将它们在运行时的概念？

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

Answer 1

除了使用@Header参数，我宁愿使用RequestInterceptor不改变你的界面更新所有请求。使用类似：

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：如果您正在使用Retrofit2，你应该注意到Interceptor代替RequestInterceptor

由于RequestInterceptor是不再可用在改造2.0

Answer 2

是的，你可以在运行时传递它们。事实上，几乎和你输入的一样。这将是你的API接口类，名叫说SecretApiInterface.java

public interface SecretApiInterface { 

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

} 

然后在请求中传递的参数为这个接口，类似的规定：（该文件将是例如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()); 
    } 
} 

凡Somehow.Magically.getToken()是一个方法调用返回一个令牌，它是由你在何处以及如何定义它。

您当然可以在接口实现中有多个@Header("Blah") String blah注释，就像您的情况一样！

我感到十分困惑过，the documentation明确表示，它取代头，但它不！
它实际上是在增加与@Headers("hardcoded_string_of_liited_use")注释

希望这有助于;）

Answer 3

接受的答案是旧版本的Retrofit。对于未来的观众的方式与Retrofit 2.0使用自定义OkHttp客户做到这一点：

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(); 

希望它可以帮助别人。 :)