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

由于Retrofit 2.0中不再提供RequestInterceptor

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

希望它有所帮助。：）

Answer 4

改良版2.3.0

OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();
    okHttpClientBuilder
            .addInterceptor(new Interceptor() {
                @Override
                public okhttp3.Response intercept(Chain chain) throws IOException {
                    Request request = chain.request();
                    Request.Builder newRequest = request.newBuilder().header("Authorization", accessToken);
                    return chain.proceed(newRequest.build());
                }
            });

    Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(GithubService.BASE_URL)
            .client(okHttpClientBuilder.build())
            .addConverterFactory(GsonConverterFactory.create())
            .build();

我正在使用它来连接到GitHub。

Android Retrofit参数化@Headers

4 个答案: